simpeg.electromagnetics.frequency_domain.Simulation3DHierarchicalMagneticFluxDensity

class simpeg.electromagnetics.frequency_domain.Simulation3DHierarchicalMagneticFluxDensity(mesh, survey=None, *, edge_area_conductance=None, edge_area_conductance_map=None, **kwargs)

Bases: BaseHierarchicalElectricalSimulation, Simulation3DMagneticFluxDensity

3D hierarchical FDEM simulation in terms of the magnetic flux field.

This simulation solves for the magnetic flux density at each frequency. In this formulation, the electric fields are defined on mesh edges and the magnetic flux density is defined on mesh faces; i.e. it is an EB formulation. This simulation adopts the hierarchical framework wherein:

• Thick structures are parameterized as conductivities at cell centers. This property and the corresponding mapping are set with sigma and sigmaMap.

• Sheet-like structures can be parameterized as conductances on mesh faces. This property and the corresponding mapping are set with face_conductance and face_conductance_map.

• Wire-like structures can be parameterized as area-integrated conductivities on mesh edges. This property and the corresponding mapping as set with edge_area_conductance and edge_area_conductance_map.

See the Notes section for a comprehensive description of the formulation.

Attributes

Mcc	Get cell inner product matrix.
MccI	Get inverse of cell inner product matrix.
MccMu	Get cell center property inner product matrix.
MccMuI	Get cell center property inner product inverse matrix.
MccMui	Get cell center property inner product matrix.
MccMuiI	Get cell center property inner product inverse matrix.
MccRho	Get cell center property inner product matrix.
MccRhoI	Get cell center property inner product inverse matrix.
MccSigma	Get cell center property inner product matrix.
MccSigmaI	Get cell center property inner product inverse matrix.
Me	Get edge inner product matrix.
MeI	Get inverse of edge inner product matrix.
MeMu	Get edge property inner product matrix.
MeMuI	Get edge property inner product inverse matrix.
MeMui	Get edge property inner product matrix.
MeMuiI	Get edge property inner product inverse matrix.
MeRho	Get edge property inner product matrix.
MeRhoI	Get edge property inner product inverse matrix.
MeSigma	Get conductivity inner-product matrix.
MeSigmaI	Get inverse of conductivity inner-product matrix.
Mf	Get face inner product matrix.
MfI	Get inverse of face inner product matrix.
MfMu	Get face property inner product matrix.
MfMuI	Get face property inner product inverse matrix.
MfMui	Get face property inner product matrix.
MfMuiI	Get face property inner product inverse matrix.
MfRho	Get face property inner product matrix.
MfRhoI	Get face property inner product inverse matrix.
MfSigma	Get face property inner product matrix.
MfSigmaI	Get face property inner product inverse matrix.
Mn	Get node inner product matrix.
MnI	Get inverse of node inner product matrix.
MnMu	Get node property inner product matrix.
MnMuI	Get node property inner product inverse matrix.
MnMui	Get node property inner product matrix.
MnMuiI	Get node property inner product inverse matrix.
MnRho	Get node property inner product matrix.
MnRhoI	Get node property inner product inverse matrix.
MnSigma	Get node property inner product matrix.
MnSigmaI	Get node property inner product inverse matrix.
Vol	Get volumes.
clean_on_model_update	A list of solver objects to clean when the model is updated
counter	SimPEG Counter object to store iterations and run-times.
deleteTheseOnModelUpdate	HasModel.deleteTheseOnModelUpdate has been deprecated.
edge_area_conductance	Electrical conductivity times cross-sectional area on edge elements (sm).
edge_area_conductance_deriv	Derivative of Electrical conductivity times cross-sectional area on edge elements (Sm).
edge_area_conductance_map	Mapping of the inversion model to Electrical conductivity times cross-sectional area on edge elements (Sm)..
face_conductance	Electrical conductivity times thickness on face elements (s).
face_conductance_deriv	Derivative of Electrical conductivity times thickness on face elements (S).
face_conductance_map	Mapping of the inversion model to Electrical conductivity times thickness on face elements (S)..
forward_only	Whether to store the factorizations of the inverses of the system matrices.
mesh	Mesh for the simulation.
model	The inversion model.
mu	Magnetic permeability (h/m) physical property model.
muDeriv	Derivative of Magnetic Permeability (H/m) wrt the model.
muMap	Mapping of the inversion model to Magnetic Permeability (H/m).
mui	Inverse magnetic permeability (m/h) physical property model.
muiDeriv	Derivative of Inverse Magnetic Permeability (m/H) wrt the model.
muiMap	Mapping of the inversion model to Inverse Magnetic Permeability (m/H).
needs_model	True if a model is necessary
permittivity	Dielectric permittivity (F/m)
rho	Electrical resistivity (ohm m) physical property model.
rhoDeriv	Derivative of Electrical resistivity (Ohm m) wrt the model.
rhoMap	Mapping of the inversion model to Electrical resistivity (Ohm m).
sensitivity_path	Path to directory where sensitivity file is stored.
sigma	Electrical conductivity (s/m) physical property model.
sigmaDeriv	Derivative of Electrical conductivity (S/m) wrt the model.
sigmaMap	Mapping of the inversion model to Electrical conductivity (S/m).
solver	Numerical solver used in the forward simulation.
solver_opts	Set solver-specific parameters.
storeInnerProduct	Whether to store inner product matrices
storeJ	Whether to compute and store the sensitivity matrix.
survey	The FDEM survey object.
verbose	Verbose progress printout.

Methods

Jtvec(m, v[, f])	Compute the adjoint sensitivity matrix times a vector.
Jtvec_approx(m, v[, f])	Approximation of the Jacobian transpose times a vector for the model provided.
Jvec(m, v[, f])	Compute the sensitivity matrix times a vector.
Jvec_approx(m, v[, f])	Approximation of the Jacobian times a vector for the model provided.
MccMuDeriv(u[, v, adjoint])	Get derivative of MccProperty with respect to the model.
MccMuIDeriv(u[, v, adjoint])	Get derivative of MccPropertyI with respect to the model.
MccMuiDeriv(u[, v, adjoint])	Get derivative of MccProperty with respect to the model.
MccMuiIDeriv(u[, v, adjoint])	Get derivative of MccPropertyI with respect to the model.
MccRhoDeriv(u[, v, adjoint])	Get derivative of MccProperty with respect to the model.
MccRhoIDeriv(u[, v, adjoint])	Get derivative of MccPropertyI with respect to the model.
MccSigmaDeriv(u[, v, adjoint])	Get derivative of MccProperty with respect to the model.
MccSigmaIDeriv(u[, v, adjoint])	Get derivative of MccPropertyI with respect to the model.
MeMuDeriv(u[, v, adjoint])	Get derivative of MeProperty with respect to the model.
MeMuIDeriv(u[, v, adjoint])	Get derivative of MePropertyI with respect to the model.
MeMuiDeriv(u[, v, adjoint])	Get derivative of MeProperty with respect to the model.
MeMuiIDeriv(u[, v, adjoint])	Get derivative of MePropertyI with respect to the model.
MeRhoDeriv(u[, v, adjoint])	Get derivative of MeProperty with respect to the model.
MeRhoIDeriv(u[, v, adjoint])	Get derivative of MePropertyI with respect to the model.
MeSigmaDeriv(u[, v, adjoint])	Compute derivative operation for conductivity inner-product matrix.
MeSigmaIDeriv(u[, v, adjoint])	Compute derivative operation for inversion of conductivity inner-product matrix.
MfMuDeriv(u[, v, adjoint])	Get derivative of MfProperty with respect to the model.
MfMuIDeriv(u[, v, adjoint])	Get derivative of MfPropertyI with respect to the model.
MfMuiDeriv(u[, v, adjoint])	Get derivative of MfProperty with respect to the model.
MfMuiIDeriv(u[, v, adjoint])	Get derivative of MfPropertyI with respect to the model.
MfRhoDeriv(u[, v, adjoint])	Get derivative of MfProperty with respect to the model.
MfRhoIDeriv(u[, v, adjoint])	Get derivative of MfPropertyI with respect to the model.
MfSigmaDeriv(u[, v, adjoint])	Get derivative of MfProperty with respect to the model.
MfSigmaIDeriv(u[, v, adjoint])	Get derivative of MfPropertyI with respect to the model.
MnMuDeriv(u[, v, adjoint])	Get derivative of MnProperty with respect to the model.
MnMuIDeriv(u[, v, adjoint])	Get derivative of MnPropertyI with respect to the model.
MnMuiDeriv(u[, v, adjoint])	Get derivative of MnProperty with respect to the model.
MnMuiIDeriv(u[, v, adjoint])	Get derivative of MnPropertyI with respect to the model.
MnRhoDeriv(u[, v, adjoint])	Get derivative of MnProperty with respect to the model.
MnRhoIDeriv(u[, v, adjoint])	Get derivative of MnPropertyI with respect to the model.
MnSigmaDeriv(u[, v, adjoint])	Get derivative of MnProperty with respect to the model.
MnSigmaIDeriv(u[, v, adjoint])	Get derivative of MnPropertyI with respect to the model.
dpred([m, f])	Predicted data for the model provided.
fields([m])	Compute and return the fields for the model provided.
fieldsPair
getA(freq)	Get system matrix for the frequency provided.
getADeriv(freq, u, v[, adjoint])	Get derivative operation for the system matrix times a vector.
getADeriv_mui(freq, u, v[, adjoint])	Get inverse permeability derivative operation for the system matrix times a vector.
getADeriv_sigma(freq, u, v[, adjoint])	Get conductivity derivative operation for the system matrix times a vector.
getJ(m[, f])	Generate the full sensitivity matrix.
getJtJdiag(m[, W, f])	Return the diagonal of \(\mathbf{J^T J}\).
getRHS(freq)	Get right-hand sides for the given frequency.
getRHSDeriv(freq, src, v[, adjoint])	Get right-hand side derivative times a vector for a given source and frequency.
getSourceTerm(freq)	Return the discrete source terms for the frequency provided.
make_synthetic_data(m[, relative_error, ...])	Make synthetic data for the model and Gaussian noise provided.
residual(m, dobs[, f])	The data residual.

Notes

Here, we start with the Maxwell’s equations in the frequency-domain where a \(+i\omega t\) Fourier convention is used:

\[\begin{split}\begin{aligned} &\nabla \times \vec{E} + i\omega \vec{B} = \vec{S}_m \\ &\nabla \times \vec{H} - \vec{J} = \vec{S}_e \end{aligned}\end{split}\]

where \(\vec{S}_e\) is an electric source term that defines a source current density, and \(\vec{S}_m\) magnetic source term that defines a source magnetic flux density. We define the constitutive relations for the electrical conductivity \(\sigma\) and magnetic permeability \(\mu\) as:

\[\begin{split}\vec{J} &= \sigma \vec{E} \\ \vec{H} &= \mu^{-1} \vec{B}\end{split}\]

We then take the inner products of all previous expressions with a vector test function \(\vec{u}\). Through vector calculus identities and the divergence theorem, we obtain:

\[\begin{split}& \int_\Omega \vec{u} \cdot (\nabla \times \vec{E}) \, dv + i \omega \int_\Omega \vec{u} \cdot \vec{B} \, dv = \int_\Omega \vec{u} \cdot \vec{S}_m \, dv \\ & \int_\Omega (\nabla \times \vec{u}) \cdot \vec{H} \, dv - \oint_{\partial \Omega} \vec{u} \cdot (\vec{H} \times \hat{n}) \, da - \int_\Omega \vec{u} \cdot \vec{J} \, dv = \int_\Omega \vec{u} \cdot \vec{S}_j \, dv \\ & \int_\Omega \vec{u} \cdot \vec{J} \, dv = \int_\Omega \vec{u} \cdot \sigma \vec{E} \, dv \\ & \int_\Omega \vec{u} \cdot \vec{H} \, dv = \int_\Omega \vec{u} \cdot \mu^{-1} \vec{B} \, dv\end{split}\]

Assuming natural boundary conditions, the surface integral is zero.

The hierarchical approach assumes the existence of infinitesimally thin plate-like regions between adjacent mesh faces and infinitesimally thin wire-like regions between adjacent mesh edges. We re-express the inner-product with Ohm’s law as follows:

\[\begin{split}\int_\Omega \vec{u} \cdot \vec{j} \, dv =& \sum_{n}^{nc} \int \vec{u} \cdot \sigma_n \vec{e} \, dv \\ &+ \sum_{n}^{nf} \int \vec{u} \cdot \tau_n \vec{e} \, da \\ &+ \sum_{n}^{ne} \int \vec{u} \cdot \kappa_n \vec{e} \, d\ell\end{split}\]

where \(\sigma_n\) is the conductivity in cell n, \(\tau_n\) is the face conductance on face n, and \(\kappa_n\) is the area-integrated conductivity on edge n.

The above expressions are discretized in space according to the finite volume method. The discrete electric fields \(\mathbf{e}\) are defined on mesh edges, and the discrete magnetic flux densities \(\mathbf{b}\) are defined on mesh faces. This implies \(\mathbf{j}\) must be defined on mesh edges and \(\mathbf{h}\) must be defined on mesh faces. Where \(\mathbf{u_e}\) and \(\mathbf{u_f}\) represent test functions discretized to edges and faces, respectively, we obtain the following set of discrete inner-products:

\[\begin{split}&\mathbf{u_f^T M_f C e} + i \omega \mathbf{u_f^T M_f b} = \mathbf{u_f^T M_f s_m} \\ &\mathbf{u_e^T C^T M_f h} - \mathbf{u_e^T M_e j} = \mathbf{u_e^T s_e} \\ &\mathbf{u_e^T M_e j} = \mathbf{u_e^T M_{e\Sigma} e} \\ &\mathbf{u_f^T M_f h} = \mathbf{u_f^T M_{f \mu} b}\end{split}\]

where:

\[\mathbf{M_{e\Sigma}} = \mathbf{M_{e\sigma} + M_{e\tau} + M_{e\kappa}}\]

and

• \(\mathbf{C}\) is the discrete curl operator

• \(\mathbf{s_m}\) and \(\mathbf{s_e}\) are the integrated magnetic and electric source terms, respectively

• \(\mathbf{M_e}\) is the edge inner-product matrix

• \(\mathbf{M_f}\) is the face inner-product matrix

• \(\mathbf{M_{e\sigma}}\) is the inner-product matrix for electrical conductivities projected to edges

• \(\mathbf{M_{e\tau}}\) is the inner-product matrix for conductances projected to edges

• \(\mathbf{M_{e\kappa}}\) is the inner-product matrix for area integrated conductivities projected to edges

• \(\mathbf{M_{f\frac{1}{\mu}}}\) is the inner-product matrix for inverse permeabilities projected to faces

By cancelling like-terms and combining the discrete expressions to solve for the magnetic flux density, we obtain:

\[\mathbf{A \, b} = \mathbf{q}\]

where

• \(\mathbf{A}=\mathbf{C M_{e\Sigma}^{-1}C^T M_{f\frac{1}{\mu}}}+i\omega \mathbf{I}\)

• \(\mathbf{q}=\mathbf{C M_{e\Sigma}^{-1}s_e} + \mathbf{s_m}\)