Solver
Package: kwave.toolbox Superclasses: kwave.toolbox.FourierCollocation
Superclass of all kwave.toolbox solver classes.
Description
Abstract class used to define solvers in k-Wave. All solver classes should be derived from this class.
The Solver class codifies the common features of a solver in k-Wave. In particular, solvers must take grid, medium, source, sensor, and settings objects that define the problem specifics. These objects must use the same kwave.toolbox.Grid object. Solvers must also implement a run method as a common interface to obtaining the solution.
The Solver class is derived from kwave.toolbox.FourierCollocation. This superclass implements common methods to calculate differential operators using the Fourier collocation spectral method. See class documentation for further details.
The constructor calls the checkRequiredProperties method for the input medium, source, and sensor objects.
Classes derived from Solver should define padded variants of any PDE variables that can be accessed by the user, and implement set and get methods that add and remove the grid padding.
Input Arguments
kgrid- (kwave.toolbox.Grid) Object which defines the simulation grid size.medium- (kwave.toolbox.GridInput) Object which defines the medium properties.source- (kwave.toolbox.GridInput) Object which defines the source properties.sensor- (kwave.toolbox.sensor) Object which defines the sensor properties.settings- (kwave.toolbox.Settings) Object which defines the simulation settings.
Properties
Input objects:
medium- (kwave.toolbox.GridInput) Handle for medium object.source- (kwave.toolbox.GridInput) Handle for source object.sensor- (kwave.toolbox.sensor) Handle for sensor object.settings- (kwave.toolbox.Settings) Handle for settings object.
Template Methods
run
See Also
kwave.toolbox.FourierCollocationkwave.toolbox.Gridkwave.toolbox.GridInputkwave.toolbox.Sensorkwave.toolbox.Settings