Overview of Potential Fields in SimPEG¶
The API¶
Simulation¶

class
SimPEG.potential_fields.base.
BasePFSimulation
(*args, **kwargs)[source]¶ Bases:
SimPEG.simulation.LinearSimulation
Required Properties:
actInd (
Array
): Array of active cells (ground), a list or numpy array of <class ‘bool’>, <class ‘int’> with shape (*)counter (
Counter
): A SimPEG.utils.Counter object, an instance of Countermesh (
BaseMesh
): a discretize mesh instance, an instance of BaseMeshsensitivity_path (
String
): path to store the sensitivty, a unicode string, Default: ./sensitivity/None
solver_opts (
Dictionary
): solver options as a kwarg dict, a dictionarystore_sensitivities (
StringChoice
): Compute and store G, any of “disk”, “ram”, “forward_only”, Default: ramsurvey (
BaseSurvey
): a survey object, an instance of BaseSurvey
Optional Properties:
linear_model (
PhysicalProperty
): The model for a linear problem, a physical propertymodel (
Model
): Inversion model., a numpy array of <class ‘float’>, <class ‘int’> with shape (*, *) or (*)model_map (
Mapping
): Mapping of The model for a linear problem to the inversion model., a SimPEG Map
Other Properties:
model_deriv (
Derivative
): Derivative of The model for a linear problem wrt the model.

property
actInd
¶ actInd (
Array
): Array of active cells (ground), a list or numpy array of <class ‘bool’>, <class ‘int’> with shape (*)

property
store_sensitivities
¶ store_sensitivities (
StringChoice
): Compute and store G, any of “disk”, “ram”, “forward_only”, Default: ram

evaluate_integral
()[source]¶ Compute the forward linear relationship between the model and the physics at a point. :param self: :return:

property
forwardOnly
¶ The forwardOnly property has been deprecated. Please set the store_sensitivites property instead. This will be removed in version 0.15.0 of SimPEG

property
parallelized
¶ The parallelized property has been removed. If interested, try out loading dask for parallelism by doing
import SimPEG.dask
. This will be removed in version 0.15.0 of SimPEG

property
n_cpu
¶ The parallelized property has been removed. If interested, try out loading dask for parallelism by doing
import SimPEG.dask
. This will be removed in version 0.15.0 of SimPEG