Overview of Electromagnetics in SimPEG

The API

Problem

class SimPEG.EM.Base.BaseEMProblem(mesh, **kwargs)[source]

Bases: SimPEG.Problem.BaseProblem

Optional

Parameters:
  • 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.25663706144e-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

Immutable

Attribute rhoDeriv:
 (Derivative) - Derivative of Electrical resistivity (Ohm m) wrt the model.
Attribute 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

class Solver(A, **kwargs)

Bases: object

Type of solver to pair with

clean()
BaseEMProblem.solverOpts = {}

Solver options

BaseEMProblem.verbose = False
BaseEMProblem.deleteTheseOnModelUpdate
BaseEMProblem.Me

Edge inner product matrix

BaseEMProblem.MeI

Edge inner product matrix

BaseEMProblem.Mf

Face inner product matrix

BaseEMProblem.MfI

Face inner product matrix

BaseEMProblem.Vol
BaseEMProblem.MfMui

Face inner product matrix for (mu^{-1}). Used in the E-B formulation

BaseEMProblem.MfMuiDeriv(u)[source]

Derivative of MfMui with respect to the model.

BaseEMProblem.MfMuiI

Inverse of MfMui.

BaseEMProblem.MfMuiIDeriv(u)[source]

Derivative of MfMui with respect to the model

BaseEMProblem.MeMu

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

BaseEMProblem.MeMuDeriv(u)[source]

Derivative of MeMu with respect to the model.

BaseEMProblem.MeMuI

Inverse of MeMu

BaseEMProblem.MeMuIDeriv(u)[source]

Derivative of MeMuI with respect to the model

BaseEMProblem.MeSigma

Edge inner product matrix for (sigma). Used in the E-B formulation

BaseEMProblem.MeSigmaDeriv(u)[source]

Derivative of MeSigma with respect to the model

BaseEMProblem.MeSigmaI

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

BaseEMProblem.MeSigmaIDeriv(u)[source]

Derivative of MeSigmaI with respect to the model

BaseEMProblem.MfRho

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

BaseEMProblem.MfRhoDeriv(u)[source]

Derivative of MfRho with respect to the model.

BaseEMProblem.MfRhoI

Inverse of MfRho

BaseEMProblem.MfRhoIDeriv(u)[source]

Derivative of MfRhoI with respect to the model.

BaseEMProblem.rho

Electrical resistivity (Ohm m)

BaseEMProblem.rhoDeriv

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

BaseEMProblem.rhoMap

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

BaseEMProblem.sigma

Electrical conductivity (S/m)

BaseEMProblem.sigmaDeriv

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

BaseEMProblem.sigmaMap

Mapping of Electrical conductivity (S/m) to the inversion 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
evalDeriv(f)[source]

Sources

class SimPEG.EM.Base.BaseEMSrc(rxList, **kwargs)[source]

Bases: SimPEG.Survey.BaseSrc

Required

Parameters: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 term

Parameters:
Return type:

tuple

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

numpy.ndarray

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

numpy.ndarray

Returns:

product of electric source term derivative with a vector