simpeg.electromagnetics.natural_source.receivers.Admittance

class simpeg.electromagnetics.natural_source.receivers.Admittance(locations_e, locations_h=None, orientation='xx', component='real', storeProjections=False)

Bases: _ElectricAndMagneticReceiver

Receiver class for data types derived from the 3D admittance tensor.

This class is used to simulate data types that can be derived from the admittance tensor:

\[\begin{split}\begin{bmatrix} Y_{xx} & Y_{xy} \\ Y_{yx} & Y_{yy} \\ Y_{zx} & Y_{zy} \end{bmatrix} = \begin{bmatrix} H_x^{(x)} & H_x^{(y)} \\ H_y^{(x)} & H_y^{(y)} \\ H_z^{(x)} & H_z^{(y)} \end{bmatrix}_{\, r} \; \begin{bmatrix} E_x^{(x)} & E_x^{(y)} \\ E_y^{(x)} & E_y^{(y)} \end{bmatrix}_b^{-1}\end{split}\]

where superscripts \((x)\) and \((y)\) denote signals corresponding to incident planewaves whose electric fields are polarized along the x and y-directions respectively. Note that in simpeg, natural source EM data are defined according to standard xyz coordinates; i.e. (x,y,z) is (Easting, Northing, Z +ve up).

Parameters:

locations_e(n_loc, n_dim) array_like

Locations where the electric fields are measured.

locations_h(n_loc, n_dim) array_like, optional

Locations where the magnetic fields are measured. Defaults to the same locations as electric field measurements, locations_e.

orientation{‘xx’, ‘xy’, ‘yx’, ‘yy’, ‘zx’, ‘zy’}

Admittance receiver orientation. Specifies the admittance tensor element \(Y_{ij}\) corresponding to the data. The data type is specified by the component input argument.

component{‘real’, ‘imag’, ‘complex’}

Admittance data type. For the admittance element \(Y_{ij}\) specified by the orientation input argument, the receiver can be set to compute the following: - ‘real’: Real component of the admittance (A/V) - ‘imag’: Imaginary component of the admittance (A/V) - ‘complex’: The complex admittance is returned. Do not use for inversion!

storeProjectionsbool

Whether to cache to internal projection matrices.

Attributes

component	Admittance data type.
locations	Locations of the two field measurements.
locations_e	Electric field measurement locations
locations_h	Magnetic field measurement locations
nD	Number of data associated with the receiver object.
orientation	Receiver orientation.
uid	Universal unique identifier

Methods

eval(src, mesh, f)	Not implemented for BaseRx
evalDeriv(src, mesh, f[, du_dm_v, v, adjoint])	Not implemented for BaseRx
getP(mesh, projected_grid[, location_id])	Get projection matrix from mesh to specified receiver locations.