Overview of Electromagnetics in SimPEG¶
The API¶
Problem¶

class
SimPEG.EM.Base.
BaseEMProblem
(mesh, **kwargs)[source]¶ Bases:
SimPEG.Problem.BaseProblem
Optional Properties:
 model (
Model
): Inversion model., a numpy array of <type ‘float’>, <type ‘int’> with shape (*)  mu (
PhysicalProperty
): Magnetic Permeability (H/m), a physical property, Default: 1.25663706144e06  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.

mu
¶ Magnetic Permeability (H/m)

mui
¶ Inverse Magnetic Permeability (m/H)

surveyPair
¶ The survey to pair with.
alias of
BaseSurvey

dataPair
¶ The data to pair with.
alias of
Data

mapPair
¶ Type of mapping to pair with
alias of
IdentityMap

solverOpts
= {}¶ Solver options

verbose
= False¶

deleteTheseOnModelUpdate
¶

Me
¶ Edge inner product matrix

MeI
¶ Edge inner product matrix

Mf
¶ Face inner product matrix

MfI
¶ Face inner product matrix

Vol
¶

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

MfMuiI
¶ Inverse of
MfMui
.

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

MeMuI
¶ Inverse of
MeMu

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

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

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

MfRhoI
¶ Inverse of
MfRho

rho
¶ Electrical resistivity (Ohm m)

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

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

sigma
¶ Electrical conductivity (S/m)

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

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

class
SimPEG.EM.Base.
BaseEMSurvey
(srcList, **kwargs)[source]¶ Bases:
SimPEG.Survey.BaseSurvey

eval
(f)[source]¶ Project fields to receiver locations
Parameters: u (Fields) – fields object Return type: numpy.ndarray Returns: data

Sources¶

class
SimPEG.EM.Base.
BaseEMSrc
(rxList, **kwargs)[source]¶ Bases:
SimPEG.Survey.BaseSrc
Required Properties:
 integrate (
Bool
): integrate the source term?, a boolean, Default: False

integrate
¶ integrate the source term?

eval
(prob)[source]¶  \(s_m\) : magnetic source term
 \(s_e\) : electric source term
Parameters: prob (BaseFDEMProblem) – FDEM Problem Return type: tuple Returns: tuple with magnetic source term and electric source term

evalDeriv
(prob, 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 termParameters:  prob (BaseFDEMProblem) – FDEM Problem
 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
(prob)[source]¶ Magnetic source term
Parameters: prob (BaseFDEMProblem) – FDEM Problem Return type: numpy.ndarray Returns: magnetic source term on mesh

s_e
(prob)[source]¶ Electric source term
Parameters: prob (BaseFDEMProblem) – FDEM Problem Return type: numpy.ndarray Returns: electric source term on mesh

s_mDeriv
(prob, v, adjoint=False)[source]¶ Derivative of magnetic source term with respect to the inversion model
Parameters:  prob (BaseFDEMProblem) – FDEM Problem
 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
(prob, v, adjoint=False)[source]¶ Derivative of electric source term with respect to the inversion model
Parameters:  prob (BaseFDEMProblem) – FDEM Problem
 v (numpy.ndarray) – vector to take product with
 adjoint (bool) – adjoint?
Return type: Returns: product of electric source term derivative with a vector
 integrate (