Overview of Electromagnetics in SimPEG¶
The API¶
Simulation¶

class
SimPEG.electromagnetics.base.
BaseEMSimulation
(*args, **kwargs)[source]¶ Bases:
SimPEG.simulation.BaseSimulation
Required Properties:
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 dictionarysurvey (
BaseSurvey
): a survey object, an instance of BaseSurvey
Optional Properties:
model (
Model
): Inversion model., a numpy array of <class ‘float’>, <class ‘int’> with shape (*, *) or (*)mu (
PhysicalProperty
): Magnetic Permeability (H/m), a physical property, Default: 1.2566370614359173e06mui (
PhysicalProperty
): Inverse Magnetic Permeability (m/H), a physical propertyrho (
PhysicalProperty
): Electrical resistivity (Ohm m), a physical propertyrhoMap (
Mapping
): Mapping of Electrical resistivity (Ohm m) to the inversion model., a SimPEG Mapsigma (
PhysicalProperty
): Electrical conductivity (S/m), a physical propertysigmaMap (
Mapping
): Mapping of Electrical conductivity (S/m) to the inversion model., a SimPEG Map
Other Properties:
rhoDeriv (
Derivative
): Derivative of Electrical resistivity (Ohm m) wrt the model.sigmaDeriv (
Derivative
): Derivative of Electrical conductivity (S/m) wrt the model.

property
sigma
¶ Electrical conductivity (S/m)

property
sigmaMap
¶ Mapping of Electrical conductivity (S/m) to the inversion model.

property
sigmaDeriv
¶ Derivative of Electrical conductivity (S/m) wrt the model.

property
rho
¶ Electrical resistivity (Ohm m)

property
rhoMap
¶ Mapping of Electrical resistivity (Ohm m) to the inversion model.

property
rhoDeriv
¶ Derivative of Electrical resistivity (Ohm m) wrt the model.

property
mu
¶ Magnetic Permeability (H/m)

property
mui
¶ Inverse Magnetic Permeability (m/H)

verbose
= False¶

storeInnerProduct
= True¶

property
deleteTheseOnModelUpdate
¶ matrices to be deleted if the model maps for conductivity and/or permeability are updated

property
Me
¶ Edge inner product matrix

property
MeI
¶ Edge inner product matrix

property
Mf
¶ Face inner product matrix

property
MfI
¶ Face inner product matrix

property
Vol
¶

property
MfMui
¶ Face inner product matrix for (mu^{1}). Used in the EB formulation

property
MfMuiI
¶ Inverse of
MfMui
.

property
MeMu
¶ Edge inner product matrix for (mu). Used in the HJ formulation

property
MeMuI
¶ Inverse of
MeMu

property
MeSigma
¶ Edge inner product matrix for (sigma). Used in the EB formulation

MeSigmaDeriv
(u, v=None, adjoint=False)[source]¶ Derivative of MeSigma with respect to the model times a vector (u)

property
MeSigmaI
¶ Inverse of the edge inner product matrix for (sigma).

property
MfRho
¶ Face inner product matrix for (rho). Used in the HJ formulation

property
MfRhoI
¶ Inverse of
MfRho
Sources¶

class
SimPEG.electromagnetics.base.
BaseEMSrc
(*args, **kwargs)[source]¶ Bases:
SimPEG.survey.BaseSrc
Base class for an EM sources
Required Properties:
integrate (
Boolean
): integrate the source term?, a boolean, Default: Falsereceiver_list (a list of
BaseRx
): receiver list, a list (each item is an instance of BaseRx)
Optional Properties:
location (
SourceLocationArray
): Location of the source [x, y, z] in 3D, a 1D array denoting the source location of <class ‘float’>, <class ‘int’> with shape (*)

eval
(simulation)[source]¶ \(s_m\) : magnetic source term
\(s_e\) : electric source term
 Parameters
simulation (BaseFDEMSimulation) – FDEM Simulation
 Return type
 Returns
tuple with magnetic source term and electric source term

evalDeriv
(simulation, v=None, adjoint=False)[source]¶ Derivatives of the source terms with respect to the inversion model 
s_mDeriv
: derivative of the magnetic source term s_eDeriv
: derivative of the electric source term Parameters
simulation (BaseFDEMSimulation) – FDEM Simulation
v (numpy.ndarray) – vector to take product with
adjoint (bool) – adjoint?
 Return type
 Returns
tuple with magnetic source term and electric source term derivatives times a vector

s_m
(simulation)[source]¶ Magnetic source term
 Parameters
simulation (BaseFDEMSimulation) – FDEM Simulation
 Return type
 Returns
magnetic source term on mesh

s_e
(simulation)[source]¶ Electric source term
 Parameters
simulation (BaseFDEMSimulation) – FDEM Simulation
 Return type
 Returns
electric source term on mesh

s_mDeriv
(simulation, v, adjoint=False)[source]¶ Derivative of magnetic source term with respect to the inversion model
 Parameters
simulation (BaseFDEMSimulation) – FDEM Simulation
v (numpy.ndarray) – vector to take product with
adjoint (bool) – adjoint?
 Return type
 Returns
product of magnetic source term derivative with a vector

s_eDeriv
(simulation, v, adjoint=False)[source]¶ Derivative of electric source term with respect to the inversion model
 Parameters
simulation (BaseFDEMSimulation) – FDEM Simulation
v (numpy.ndarray) – vector to take product with
adjoint (bool) – adjoint?
 Return type
 Returns
product of electric source term derivative with a vector