Welcome to nsfds3’s documentation!

Quickstart

• Introducing nsfds3
  • Dependencies
  • Installation
• Configuration file
  • Introduction
  • About [geometry] section
    • Grid
    • Buffer zones
    • Obstacles and transformations
  • About wall sources
  • About [sources] and [initial pulses] sections
  • Note on the use of .wav files as sources
  • Examples
• Command line
  • Basics
  • The solve subcommand
  • The make subcommand
    • Work with sounds
    • Work with movies
  • The show subcommand
• Custom Use
  • Introduction
  • nsfds3 files
    • hdf5 files
    • cfg and msh pickle files

API

• Computational Grid (nsfds3.cpgrid)
  • CartesianGrid
    • CartesianGrid.axis
    • CartesianGrid.find_subdomains()
    • CartesianGrid.from_cfg()
    • CartesianGrid.get_obstacles()
    • CartesianGrid.make_grid()
    • CartesianGrid.paxis
    • CartesianGrid.show()
    • CartesianGrid.stretched_axis
  • ComputationDomains
    • ComputationDomains.find_domains()
    • ComputationDomains.get_cuboids()
    • ComputationDomains.is_valid
    • ComputationDomains.show()
  • CurvilinearGrid
    • CurvilinearGrid.check_metrics()
    • CurvilinearGrid.make_grid()
  • Obstacle
  • ObstacleSet
    • ObstacleSet.check_boxes()
    • ObstacleSet.flatten()
    • ObstacleSet.get_obstacle_by_face()
    • ObstacleSet.get_obstacle_by_sid()
    • ObstacleSet.is_out_of_bounds()
    • ObstacleSet.is_too_close()
    • ObstacleSet.unflatten()
  • TestCases
    • TestCases.Lcell()
    • TestCases.Ocell()
    • TestCases.Tcell()
    • TestCases.Ucell()
    • TestCases.base()
    • TestCases.curv_mountain()
    • TestCases.edges()
    • TestCases.empty()
    • TestCases.evolution_sine()
    • TestCases.overlapped1()
    • TestCases.overlapped2()
    • TestCases.single()
    • TestCases.single_source()
    • TestCases.superimposed1()
    • TestCases.superimposed2()
  • build_mesh()
• The solver (nsfds3.solver)
  • CfgSetup
    • CfgSetup.check_version()
    • CfgSetup.dt
    • CfgSetup.frequencies
    • CfgSetup.get_grid_backup()
    • CfgSetup.has_grid_backup
    • CfgSetup.load()
    • CfgSetup.ndim
    • CfgSetup.overwrite()
    • CfgSetup.parse_literal()
    • CfgSetup.run()
    • CfgSetup.version
    • CfgSetup.write()
  • CustomInitialConditions
    • CustomInitialConditions.check()
    • CustomInitialConditions.check_older_run()
    • CustomInitialConditions.custom
    • CustomInitialConditions.has_old_fields
    • CustomInitialConditions.resume()
    • CustomInitialConditions.show()
    • CustomInitialConditions.super_gaussian()
    • CustomInitialConditions.vars
  • FDTD
    • FDTD.run()
    • FDTD.save_objects()
    • FDTD.show()
  • SourceSet
    • SourceSet.Bx
    • SourceSet.By
    • SourceSet.Bz
    • SourceSet.Rx
    • SourceSet.S0
    • SourceSet.evolution
    • SourceSet.k
    • SourceSet.kwargs
    • SourceSet.kx
    • SourceSet.ky
    • SourceSet.kz
    • SourceSet.on
    • SourceSet.update()
• Visualize data (nsfds3.graphics)
  • CPViewer
  • MPLViewer
    • MPLViewer.close()
    • MPLViewer.movie()
    • MPLViewer.probes()
    • MPLViewer.show()
    • MPLViewer.spectrogram()
  • MeshViewer
    • MeshViewer.grid()
    • MeshViewer.objects()
• Utilities (nsfds3.utils)
  • get_objects()
  • get_pressure()
  • get_probes()
  • probes_to_wavfile()

What's new?

• What’s new?
• Changelog
  • (unreleased)
    • New
    • Changes
    • Fix
    • Other
• Known Bugs

Navigation

• Homepage

Index

• Index

• Search Page