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 Counter

  • mesh (BaseMesh): a discretize mesh instance, an instance of BaseMesh

  • sensitivity_path (String): path to store the sensitivty, a unicode string, Default: ./sensitivity/

  • None

  • solver_opts (Dictionary): solver options as a kwarg dict, a dictionary

  • survey (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.25663706212e-06

  • mui (PhysicalProperty): Inverse Magnetic Permeability (m/H), a physical property

  • rho (PhysicalProperty): Electrical resistivity (Ohm m), a physical property

  • rhoMap (Mapping): Mapping of Electrical resistivity (Ohm m) to the inversion model., a SimPEG Map

  • sigma (PhysicalProperty): Electrical conductivity (S/m), a physical property

  • sigmaMap (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 E-B formulation

MfMuiDeriv(u, v=None, adjoint=False)[source]

Derivative of MfMui with respect to the model.

property MfMuiI

Inverse of MfMui.

MfMuiIDeriv(u, v=None, adjoint=False)[source]

Derivative of MfMui with respect to the model

property MeMu

Edge inner product matrix for (mu). Used in the H-J formulation

MeMuDeriv(u, v=None, adjoint=False)[source]

Derivative of MeMu with respect to the model.

property MeMuI

Inverse of MeMu

MeMuIDeriv(u, v=None, adjoint=False)[source]

Derivative of MeMuI with respect to the model

property MeSigma

Edge inner product matrix for (sigma). Used in the E-B 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).

MeSigmaIDeriv(u, v=None, adjoint=False)[source]

Derivative of MeSigmaI with respect to the model

property MfRho

Face inner product matrix for (rho). Used in the H-J formulation

MfRhoDeriv(u, v=None, adjoint=False)[source]

Derivative of MfRho with respect to the model.

property MfRhoI

Inverse of MfRho

MfRhoIDeriv(u, v=None, adjoint=False)[source]

Derivative of MfRhoI with respect to the model.

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: False

  • receiver_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 (*)

property integrate

integrate (Boolean): integrate the source term?, a boolean, Default: False

eval(simulation)[source]

  • \(s_m\) : magnetic source term

  • \(s_e\) : electric source term

Parameters

simulation (BaseFDEMSimulation) – FDEM Simulation

Return type

tuple

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
Return type

tuple

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

numpy.ndarray

Returns

magnetic source term on mesh

s_e(simulation)[source]

Electric source term

Parameters

simulation (BaseFDEMSimulation) – FDEM Simulation

Return type

numpy.ndarray

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
Return type

numpy.ndarray

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
Return type

numpy.ndarray

Returns

product of electric source term derivative with a vector