simpeg.potential_fields.magnetics.Simulation3DDifferential#
- class simpeg.potential_fields.magnetics.Simulation3DDifferential(mesh, survey=None, mu=None, muMap=None, rem=None, remMap=None, storeJ=False, solver_dtype=<class 'numpy.float64'>, **kwargs)[source]#
Bases:
BaseMagneticPDESimulation
A secondary field simulation for magnetic data.
- Parameters:
- mesh
discretize.base.BaseMesh
- survey
magnetics.survey.Survey
- mu
float
, array_like Magnetic Permeability Model (H/ m). Set this for forward modeling or to fix while inverting for remanence. This is used if
muMap
is None.- muMap
simpeg.maps.IdentityMap
,optional
The mapping used to go from the simulation model to
mu
. Set this to invert formu
.- rem
float
, array_like Magnetic Polarization \(\mu_0 \mathbf{M}\) (nT). Set this for forward modeling or to fix remanent magnetization while inverting for permeability. This is used if
remMap
is None.- remMap
simpeg.maps.IdentityMap
,optional
The mapping used to go from the simulation model to \(\mu_0 \mathbf{M}\). Set this to invert for \(\mu_0 \mathbf{M}\).
- storeJ: bool
Whether to store the sensitivity matrix. If set to True
- solver_dtype: dtype, optional
Data type to use for the matrix that gets passed to the
solver
. Default to numpy.float64.
- mesh
Attributes
Cell center inner product matrix.
Cell center property inner product matrix.
Cell center property inner product inverse matrix.
Cell center property inner product matrix.
Cell center property inner product inverse matrix.
Edge inner product matrix.
Edge inner product inverse matrix.
Edge property inner product matrix.
Edge property inner product inverse matrix.
Edge property inner product matrix.
Edge property inner product inverse matrix.
Face inner product matrix.
Face inner product inverse matrix.
Face property inner product matrix.
Face property inner product inverse matrix.
Face property inner product matrix.
Face property inner product inverse matrix.
Node inner product matrix.
Node inner product inverse matrix.
Node property inner product matrix.
Node property inner product inverse matrix.
Node property inner product matrix.
Node property inner product inverse matrix.
A list of solver objects to clean when the model is updated
SimPEG
Counter
object to store iterations and run-times.HasModel.deleteTheseOnModelUpdate has been deprecated.
Mesh for the simulation.
The inversion model.
Magnetic permeability (h/m) physical property model.
Derivative of Magnetic Permeability (H/m) wrt the model.
Mapping of the inversion model to Magnetic Permeability (H/m).
Inverse magnetic permeability (m/h) physical property model.
Derivative of Inverse Magnetic Permeability (m/H) wrt the model.
Mapping of the inversion model to Inverse Magnetic Permeability (m/H).
True if a model is necessary
Magnetic polarization (nt) physical property model.
Derivative of Magnetic Polarization (nT) wrt the model.
Mapping of the inversion model to Magnetic Polarization (nT).
Path to directory where sensitivity file is stored.
Numerical solver used in the forward simulation.
Data type used by the solver.
Solver-specific parameters.
Whether to store the sensitivity matrix
The magnetic survey object.
Verbose progress printout.
MccI
Vol
Methods
Jtvec
(m, v[, f])Compute the Jacobian transpose times a vector for the model provided.
Jtvec_approx
(m, v[, f])Approximation of the Jacobian transpose times a vector for the model provided.
Jvec
(m, v[, f])Compute the Jacobian times a vector for the model provided.
Jvec_approx
(m, v[, f])Approximation of the Jacobian times a vector for the model provided.
MccMuDeriv
(u[, v, adjoint])Derivative of MccProperty with respect to the model.
MccMuIDeriv
(u[, v, adjoint])Derivative of MccPropertyI with respect to the model.
MccMuiDeriv
(u[, v, adjoint])Derivative of MccProperty with respect to the model.
MccMuiIDeriv
(u[, v, adjoint])Derivative of MccPropertyI with respect to the model.
MeMuDeriv
(u[, v, adjoint])Derivative of MeProperty with respect to the model.
MeMuIDeriv
(u[, v, adjoint])Derivative of MePropertyI with respect to the model.
MeMuiDeriv
(u[, v, adjoint])Derivative of MeProperty with respect to the model.
MeMuiIDeriv
(u[, v, adjoint])Derivative of MePropertyI with respect to the model.
MfMuDeriv
(u[, v, adjoint])Derivative of MfProperty with respect to the model.
MfMuIDeriv
(u[, v, adjoint])I Derivative of MfPropertyI with respect to the model.
MfMuiDeriv
(u[, v, adjoint])Derivative of MfProperty with respect to the model.
MfMuiIDeriv
(u[, v, adjoint])I Derivative of MfPropertyI with respect to the model.
MnMuDeriv
(u[, v, adjoint])Derivative of MnProperty with respect to the model.
MnMuIDeriv
(u[, v, adjoint])Derivative of MnPropertyI with respect to the model.
MnMuiDeriv
(u[, v, adjoint])Derivative of MnProperty with respect to the model.
MnMuiIDeriv
(u[, v, adjoint])Derivative of MnPropertyI with respect to the model.
dpred
([m, f])Predicted data for the model provided.
fields
(m)Return the computed geophysical fields for the model provided.
Computes the total magnetic polarization \(\mu_0\mathbf{M}\).
make_synthetic_data
(m[, relative_error, ...])Make synthetic data for the model and Gaussian noise provided.
residual
(m, dobs[, f])The data residual.
getJ
Notes
This simulation solves for the magnetostatic PDE:
\[\nabla \cdot \Vec{B} = 0\]where the constitutive relation is specified as:
\[\Vec{B} = \mu\Vec{H} + \mu_0\Vec{M_r}\]where \(\Vec{M_r}\) is a fixed magnetization unaffected by the inducing field and \(\mu\Vec{H}\) is the induced magnetization.