Induced Polarization

Todo: docs for IP!

API for IP codes

Simulation

class SimPEG.electromagnetics.static.induced_polarization.simulation.BaseIPSimulation(*args, **kwargs)[source]

Bases: SimPEG.electromagnetics.base.BaseEMSimulation

Required Properties:

  • counter (Counter): A SimPEG.utils.Counter object, an instance of Counter

  • data_type (StringChoice): IP data type, either “volt” or “apparent_chargeability”, Default: volt

  • mesh (BaseMesh): a discretize mesh instance, an instance of BaseMesh

  • sensitivity_path (String): path to store the sensitivty, a unicode string, Default: ./sensitivity/

  • None

  • solver_opts (Dictionary): solver options as a kwarg dict, a dictionary

  • survey (BaseSurvey): a survey object, an instance of BaseSurvey

Optional Properties:

  • eta (PhysicalProperty): Electrical Chargeability, a physical property

  • etaMap (Mapping): Mapping of Electrical Chargeability to the inversion model., a SimPEG Map

  • model (Model): Inversion model., a numpy array of <class ‘float’>, <class ‘int’> with shape (*, *) or (*)

  • mu (PhysicalProperty): Magnetic Permeability (H/m), a physical property, Default: 1.2566370614359173e-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

Other Properties:

  • etaDeriv (Derivative): Derivative of Electrical Chargeability wrt the model.

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

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

property sigma

Electrical conductivity (S/m)

property rho

Electrical resistivity (Ohm m)

property eta

Electrical Chargeability

property etaMap

Mapping of Electrical Chargeability to the inversion model.

property etaDeriv

Derivative of Electrical Chargeability wrt the model.

property data_type

data_type (StringChoice): IP data type, either “volt” or “apparent_chargeability”, Default: volt

fieldsPair[source]

alias of SimPEG.electromagnetics.static.resistivity.fields.FieldsDC

Ainv = None
storeJ = False
sign = None
gtgdiag = None
fields(m=None)[source]

u = fields(m) The field given the model. :param numpy.ndarray m: model :rtype: numpy.ndarray :return: u, the fields

dpred(m=None, f=None)[source]

Predicted data.

\[d_\text{pred} = Pf(m)\]
getJtJdiag(m, W=None)[source]

Return the diagonal of JtJ

getJ(m, f=None)[source]

Generate Full sensitivity matrix

Jvec(m, v, f=None)[source]

Jv = Jvec(m, v, f=None) Effect of J(m) on a vector v. :param numpy.ndarray m: model :param numpy.ndarray v: vector to multiply :param Fields f: fields :rtype: numpy.ndarray :return: Jv

forward(m, f=None)[source]
Jtvec(m, v, f=None)[source]

Compute adjoint sensitivity matrix (J^T) and vector (v) product.

getSourceTerm()[source]

takes concept of source and turns it into a matrix

delete_these_for_sensitivity()[source]
property deleteTheseOnModelUpdate

matrices to be deleted if the model maps for conductivity and/or permeability are updated

property MfRhoDerivMat

Derivative of MfRho with respect to the model

MfRhoIDeriv(u, v, adjoint=False)[source]

Derivative of MfRhoI with respect to the model.

property MeSigmaDerivMat

Derivative of MeSigma with respect to the model

MeSigmaDeriv(u, v, adjoint=False)[source]

Derivative of MeSigma with respect to the model times a vector (u)

class SimPEG.electromagnetics.static.induced_polarization.simulation.Simulation3DCellCentered(*args, **kwargs)[source]

Bases: SimPEG.electromagnetics.static.induced_polarization.simulation.BaseIPSimulation, SimPEG.electromagnetics.static.resistivity.simulation.Simulation3DCellCentered

Required Properties:

  • counter (Counter): A SimPEG.utils.Counter object, an instance of Counter

  • data_type (StringChoice): IP data type, either “volt” or “apparent_chargeability”, Default: volt

  • mesh (BaseMesh): a discretize mesh instance, an instance of BaseMesh

  • sensitivity_path (String): path to store the sensitivty, a unicode string, Default: ./sensitivity/

  • None

  • solver_opts (Dictionary): solver options as a kwarg dict, a dictionary

  • storeJ (Boolean): store the sensitivity matrix?, a boolean, Default: False

  • survey (Survey): a DC survey object, an instance of Survey

Optional Properties:

  • eta (PhysicalProperty): Electrical Chargeability, a physical property

  • etaMap (Mapping): Mapping of Electrical Chargeability to the inversion model., a SimPEG Map

  • model (Model): Inversion model., a numpy array of <class ‘float’>, <class ‘int’> with shape (*, *) or (*)

  • mu (PhysicalProperty): Magnetic Permeability (H/m), a physical property, Default: 1.2566370614359173e-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

Other Properties:

  • etaDeriv (Derivative): Derivative of Electrical Chargeability wrt the model.

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

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

fieldsPair[source]

alias of SimPEG.electromagnetics.static.resistivity.fields.Fields3DCellCentered

sign = 1.0
bc_type = 'Dirichlet'
class SimPEG.electromagnetics.static.induced_polarization.simulation.Simulation3DNodal(*args, **kwargs)[source]

Bases: SimPEG.electromagnetics.static.induced_polarization.simulation.BaseIPSimulation, SimPEG.electromagnetics.static.resistivity.simulation.Simulation3DNodal

Required Properties:

  • counter (Counter): A SimPEG.utils.Counter object, an instance of Counter

  • data_type (StringChoice): IP data type, either “volt” or “apparent_chargeability”, Default: volt

  • mesh (BaseMesh): a discretize mesh instance, an instance of BaseMesh

  • sensitivity_path (String): path to store the sensitivty, a unicode string, Default: ./sensitivity/

  • None

  • solver_opts (Dictionary): solver options as a kwarg dict, a dictionary

  • storeJ (Boolean): store the sensitivity matrix?, a boolean, Default: False

  • survey (Survey): a DC survey object, an instance of Survey

Optional Properties:

  • eta (PhysicalProperty): Electrical Chargeability, a physical property

  • etaMap (Mapping): Mapping of Electrical Chargeability to the inversion model., a SimPEG Map

  • model (Model): Inversion model., a numpy array of <class ‘float’>, <class ‘int’> with shape (*, *) or (*)

  • mu (PhysicalProperty): Magnetic Permeability (H/m), a physical property, Default: 1.2566370614359173e-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

Other Properties:

  • etaDeriv (Derivative): Derivative of Electrical Chargeability wrt the model.

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

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

fieldsPair[source]

alias of SimPEG.electromagnetics.static.resistivity.fields.Fields3DNodal

sign = -1.0
class SimPEG.electromagnetics.static.induced_polarization.simulation.Problem3D_N(*args, **kwargs)[source]

Bases: SimPEG.electromagnetics.static.induced_polarization.simulation.Simulation3DNodal

This class has been deprecated, see Simulation3DNodal for documentation

class SimPEG.electromagnetics.static.induced_polarization.simulation.Problem3D_CC(*args, **kwargs)[source]

Bases: SimPEG.electromagnetics.static.induced_polarization.simulation.Simulation3DCellCentered

This class has been deprecated, see Simulation3DCellCentered for documentation

class SimPEG.electromagnetics.static.induced_polarization.simulation_2d.BaseIPSimulation2D(*args, **kwargs)[source]

Bases: SimPEG.electromagnetics.static.resistivity.simulation_2d.BaseDCSimulation2D

Required Properties:

  • counter (Counter): A SimPEG.utils.Counter object, an instance of Counter

  • data_type (StringChoice): IP data type, either “volt” or “apparent_chargeability”, Default: volt

  • mesh (BaseMesh): a discretize mesh instance, an instance of BaseMesh

  • sensitivity_path (String): path to store the sensitivty, a unicode string, Default: ./sensitivity/

  • None

  • solver_opts (Dictionary): solver options as a kwarg dict, a dictionary

  • storeJ (Boolean): store the sensitivity matrix?, a boolean, Default: False

  • survey (Survey): a DC survey object, an instance of Survey

Optional Properties:

  • eta (PhysicalProperty): Electrical Chargeability (V/V), a physical property

  • etaMap (Mapping): Mapping of Electrical Chargeability (V/V) to the inversion model., a SimPEG Map

  • model (Model): Inversion model., a numpy array of <class ‘float’>, <class ‘int’> with shape (*, *) or (*)

  • mu (PhysicalProperty): Magnetic Permeability (H/m), a physical property, Default: 1.2566370614359173e-06

  • mui (PhysicalProperty): Inverse Magnetic Permeability (m/H), a physical property

  • nky (Integer): Number of kys to use in wavenumber space, an integer, Default: 11

  • 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:

  • etaDeriv (Derivative): Derivative of Electrical Chargeability (V/V) wrt the model.

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

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

property sigma

Electrical conductivity (S/m)

property rho

Electrical resistivity (Ohm m)

property eta

Electrical Chargeability (V/V)

property etaMap

Mapping of Electrical Chargeability (V/V) to the inversion model.

property etaDeriv

Derivative of Electrical Chargeability (V/V) wrt the model.

property data_type

data_type (StringChoice): IP data type, either “volt” or “apparent_chargeability”, Default: volt

fieldsPair[source]

alias of SimPEG.electromagnetics.static.resistivity.fields_2d.Fields2D

sign = None
fields(m)[source]

u = fields(m) The field given the model. :param numpy.ndarray m: model :rtype: numpy.ndarray :return: u, the fields

dpred(m=None, f=None)[source]

Predicted data.

\[d_\text{pred} = Pf(m)\]
Jvec(m, v, f=None)[source]

Compute sensitivity matrix (J) and vector (v) product.

forward(m, f=None)[source]
Jtvec(m, v, f=None)[source]

Compute adjoint sensitivity matrix (J^T) and vector (v) product.

property deleteTheseOnModelUpdate

matrices to be deleted if the model maps for conductivity and/or permeability are updated

property MeSigmaDerivMat

Derivative of MeSigma with respect to the model

MeSigmaDeriv(u, v, adjoint=False)[source]

Derivative of MeSigma with respect to the model times a vector (u)

property MccRhoiDerivMat

Derivative of MccRho with respect to the model

MccRhoiDeriv(u, v, adjoint=False)[source]

Derivative of MccRhoi with respect to the model.

property MnSigmaDerivMat

Derivative of MnSigma with respect to the model

MnSigmaDeriv(u, v, adjoint=False)[source]

Derivative of MnSigma with respect to the model times a vector (u)

class SimPEG.electromagnetics.static.induced_polarization.simulation_2d.Simulation2DCellCentered(*args, **kwargs)[source]

Bases: SimPEG.electromagnetics.static.induced_polarization.simulation_2d.BaseIPSimulation2D, SimPEG.electromagnetics.static.resistivity.simulation_2d.Simulation2DCellCentered

2.5D cell centered IP problem

Required Properties:

  • counter (Counter): A SimPEG.utils.Counter object, an instance of Counter

  • data_type (StringChoice): IP data type, either “volt” or “apparent_chargeability”, Default: volt

  • mesh (BaseMesh): a discretize mesh instance, an instance of BaseMesh

  • sensitivity_path (String): path to store the sensitivty, a unicode string, Default: ./sensitivity/

  • None

  • solver_opts (Dictionary): solver options as a kwarg dict, a dictionary

  • storeJ (Boolean): store the sensitivity matrix?, a boolean, Default: False

  • survey (Survey): a DC survey object, an instance of Survey

Optional Properties:

  • eta (PhysicalProperty): Electrical Chargeability (V/V), a physical property

  • etaMap (Mapping): Mapping of Electrical Chargeability (V/V) to the inversion model., a SimPEG Map

  • model (Model): Inversion model., a numpy array of <class ‘float’>, <class ‘int’> with shape (*, *) or (*)

  • mu (PhysicalProperty): Magnetic Permeability (H/m), a physical property, Default: 1.2566370614359173e-06

  • mui (PhysicalProperty): Inverse Magnetic Permeability (m/H), a physical property

  • nky (Integer): Number of kys to use in wavenumber space, an integer, Default: 11

  • 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:

  • etaDeriv (Derivative): Derivative of Electrical Chargeability (V/V) wrt the model.

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

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

fieldsPair[source]

alias of SimPEG.electromagnetics.static.resistivity.fields_2d.Fields2DCellCentered

bc_type = 'Mixed'
sign = 1.0
delete_these_for_sensitivity(sigma=None, rho=None)[source]
property MfRhoDerivMat

Derivative of MfRho with respect to the model

MfRhoIDeriv(u, v, adjoint=False)[source]

Derivative of MfRhoI with respect to the model.

class SimPEG.electromagnetics.static.induced_polarization.simulation_2d.Simulation2DNodal(*args, **kwargs)[source]

Bases: SimPEG.electromagnetics.static.induced_polarization.simulation_2d.BaseIPSimulation2D, SimPEG.electromagnetics.static.resistivity.simulation_2d.Simulation2DNodal

2.5D nodal IP problem

Required Properties:

  • counter (Counter): A SimPEG.utils.Counter object, an instance of Counter

  • data_type (StringChoice): IP data type, either “volt” or “apparent_chargeability”, Default: volt

  • mesh (BaseMesh): a discretize mesh instance, an instance of BaseMesh

  • sensitivity_path (String): path to store the sensitivty, a unicode string, Default: ./sensitivity/

  • None

  • solver_opts (Dictionary): solver options as a kwarg dict, a dictionary

  • storeJ (Boolean): store the sensitivity matrix?, a boolean, Default: False

  • survey (Survey): a DC survey object, an instance of Survey

Optional Properties:

  • eta (PhysicalProperty): Electrical Chargeability (V/V), a physical property

  • etaMap (Mapping): Mapping of Electrical Chargeability (V/V) to the inversion model., a SimPEG Map

  • model (Model): Inversion model., a numpy array of <class ‘float’>, <class ‘int’> with shape (*, *) or (*)

  • mu (PhysicalProperty): Magnetic Permeability (H/m), a physical property, Default: 1.2566370614359173e-06

  • mui (PhysicalProperty): Inverse Magnetic Permeability (m/H), a physical property

  • nky (Integer): Number of kys to use in wavenumber space, an integer, Default: 11

  • 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:

  • etaDeriv (Derivative): Derivative of Electrical Chargeability (V/V) wrt the model.

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

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

fieldsPair[source]

alias of SimPEG.electromagnetics.static.resistivity.fields_2d.Fields2DNodal

sign = -1.0
delete_these_for_sensitivity(sigma=None, rho=None)[source]
SimPEG.electromagnetics.static.induced_polarization.simulation_2d.Simulation2DCellCentred[source]

alias of SimPEG.electromagnetics.static.induced_polarization.simulation_2d.Simulation2DCellCentered

class SimPEG.electromagnetics.static.induced_polarization.simulation_2d.Problem2D_N(*args, **kwargs)[source]

Bases: SimPEG.electromagnetics.static.induced_polarization.simulation_2d.Simulation2DNodal

This class has been deprecated, see Simulation2DNodal for documentation

class SimPEG.electromagnetics.static.induced_polarization.simulation_2d.Problem2D_CC(*args, **kwargs)[source]

Bases: SimPEG.electromagnetics.static.induced_polarization.simulation_2d.Simulation2DCellCentered

This class has been deprecated, see Simulation2DCellCentered for documentation

API for Spectral IP codes

Simulation

class SimPEG.electromagnetics.static.spectral_induced_polarization.simulation.BaseSIPSimulation(*args, **kwargs)[source]

Bases: SimPEG.electromagnetics.base.BaseEMSimulation

Required Properties:

  • counter (Counter): A SimPEG.utils.Counter object, an instance of Counter

  • mesh (BaseMesh): a discretize mesh instance, an instance of BaseMesh

  • sensitivity_path (String): path to store the sensitivty, a unicode string, Default: ./sensitivity/

  • None

  • solver_opts (Dictionary): solver options as a kwarg dict, a dictionary

  • survey (Survey): an SIP survey object, an instance of Survey

Optional Properties:

  • c (PhysicalProperty): Frequency dependency, a physical property, Default: 0.5

  • cMap (Mapping): Mapping of Frequency dependency to the inversion model., a SimPEG Map

  • eta (PhysicalProperty): Electrical Chargeability (V/V), a physical property

  • etaMap (Mapping): Mapping of Electrical Chargeability (V/V) to the inversion model., a SimPEG Map

  • model (Model): Inversion model., a numpy array of <class ‘float’>, <class ‘int’> with shape (*, *) or (*)

  • mu (PhysicalProperty): Magnetic Permeability (H/m), a physical property, Default: 1.2566370614359173e-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

  • tau (PhysicalProperty): Time constant (s), a physical property, Default: 0.1

  • tauMap (Mapping): Mapping of Time constant (s) to the inversion model., a SimPEG Map

  • taui (PhysicalProperty): Inverse of time constant (1/s), a physical property

  • tauiMap (Mapping): Mapping of Inverse of time constant (1/s) to the inversion model., a SimPEG Map

Other Properties:

  • cDeriv (Derivative): Derivative of Frequency dependency wrt the model.

  • etaDeriv (Derivative): Derivative of Electrical Chargeability (V/V) wrt the model.

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

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

  • tauDeriv (Derivative): Derivative of Time constant (s) wrt the model.

  • tauiDeriv (Derivative): Derivative of Inverse of time constant (1/s) wrt the model.

property sigma

Electrical conductivity (S/m)

property rho

Electrical resistivity (Ohm m)

property eta

Electrical Chargeability (V/V)

property etaMap

Mapping of Electrical Chargeability (V/V) to the inversion model.

property etaDeriv

Derivative of Electrical Chargeability (V/V) wrt the model.

property tau

Time constant (s)

property tauMap

Mapping of Time constant (s) to the inversion model.

property tauDeriv

Derivative of Time constant (s) wrt the model.

property taui

Inverse of time constant (1/s)

property tauiMap

Mapping of Inverse of time constant (1/s) to the inversion model.

property tauiDeriv

Derivative of Inverse of time constant (1/s) wrt the model.

property c

Frequency dependency

property cMap

Mapping of Frequency dependency to the inversion model.

property cDeriv

Derivative of Frequency dependency wrt the model.

property survey

survey (Survey): an SIP survey object, an instance of Survey

fieldsPair[source]

alias of SimPEG.electromagnetics.static.resistivity.fields.FieldsDC

Ainv = None
actinds = None
storeJ = False
actMap = None
n_pulse = 1
property etaDeriv_store
property tauiDeriv_store
property tauDeriv_store
property cDeriv_store
get_t_over_tau(t)[source]
get_exponent(t)[source]
get_peta_step_off(exponent)[source]
get_peta_pulse_off(t)[source]

Compute pseudo-chargeability from a single pulse waveform

get_multi_pulse_response(t, pulse_func)[source]
get_peta(t)[source]
get_peta_eta_deriv_step_off(exponent)[source]
get_peta_eta_deriv_pulse_off(t)[source]

Compute derivative of pseudo-chargeability w.r.t eta from a single pulse waveform

get_peta_eta_deriv(t)[source]
PetaEtaDeriv(t, v, adjoint=False)[source]
get_peta_taui_deriv_step_off(exponent)[source]
get_peta_taui_deriv_pulse_off(t)[source]

Compute derivative of pseudo-chargeability w.r.t eta from a single pulse waveform

get_peta_taui_deriv(t)[source]
PetaTauiDeriv(t, v, adjoint=False)[source]
get_peta_c_deriv_step_off(exponent, t_over_tau)[source]
get_peta_c_deriv_pulse_off(t)[source]

Compute derivative of pseudo-chargeability w.r.t eta from a single pulse waveform

get_peta_c_deriv(t)[source]
PetaCDeriv(t, v, adjoint=False)[source]
fields(m)[source]

u = fields(m) The field given the model. :param numpy.ndarray m: model :rtype: numpy.ndarray :return: u, the fields

getJ(m, f=None)[source]

Generate Full sensitivity matrix

getJtJdiag(m, Wd)[source]

Compute JtJ using adjoint problem. Still we never form JtJ

forward(m, f=None)[source]
dpred(m, f=None)[source]

Predicted data.

\[d_\text{pred} = Pf(m)\]
Jvec(m, v, f=None)[source]

Jv = Jvec(m, v, f=None) Effect of J(m) on a vector v. :param numpy.ndarray m: model :param numpy.ndarray v: vector to multiply :param Fields f: fields :rtype: numpy.ndarray :return: Jv

Jtvec(m, v, f=None)[source]

Jtv = Jtvec(m, v, f=None) Effect of transpose of J(m) on a vector v. :param numpy.ndarray m: model :param numpy.ndarray v: vector to multiply :param Fields f: fields :rtype: numpy.ndarray :return: JTv

getSourceTerm()[source]

takes concept of source and turns it into a matrix

property deleteTheseOnModelUpdate

matrices to be deleted if the model maps for conductivity and/or permeability are updated

property MfRhoDerivMat

Derivative of MfRho with respect to the model

MfRhoIDeriv(u, v, adjoint=False)[source]

Derivative of MfRhoI with respect to the model.

property MeSigmaDerivMat

Derivative of MeSigma with respect to the model

MeSigmaDeriv(u, v, adjoint=False)[source]

Derivative of MeSigma with respect to the model times a vector (u)

class SimPEG.electromagnetics.static.spectral_induced_polarization.simulation.Simulation3DCellCentered(*args, **kwargs)[source]

Bases: SimPEG.electromagnetics.static.spectral_induced_polarization.simulation.BaseSIPSimulation, SimPEG.electromagnetics.static.induced_polarization.simulation.Simulation3DCellCentered

Required Properties:

  • counter (Counter): A SimPEG.utils.Counter object, an instance of Counter

  • data_type (StringChoice): IP data type, either “volt” or “apparent_chargeability”, Default: volt

  • mesh (BaseMesh): a discretize mesh instance, an instance of BaseMesh

  • sensitivity_path (String): path to store the sensitivty, a unicode string, Default: ./sensitivity/

  • None

  • solver_opts (Dictionary): solver options as a kwarg dict, a dictionary

  • storeJ (Boolean): store the sensitivity matrix?, a boolean, Default: False

  • survey (Survey): an SIP survey object, an instance of Survey

Optional Properties:

  • c (PhysicalProperty): Frequency dependency, a physical property, Default: 0.5

  • cMap (Mapping): Mapping of Frequency dependency to the inversion model., a SimPEG Map

  • eta (PhysicalProperty): Electrical Chargeability (V/V), a physical property

  • etaMap (Mapping): Mapping of Electrical Chargeability (V/V) to the inversion model., a SimPEG Map

  • model (Model): Inversion model., a numpy array of <class ‘float’>, <class ‘int’> with shape (*, *) or (*)

  • mu (PhysicalProperty): Magnetic Permeability (H/m), a physical property, Default: 1.2566370614359173e-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

  • tau (PhysicalProperty): Time constant (s), a physical property, Default: 0.1

  • tauMap (Mapping): Mapping of Time constant (s) to the inversion model., a SimPEG Map

  • taui (PhysicalProperty): Inverse of time constant (1/s), a physical property

  • tauiMap (Mapping): Mapping of Inverse of time constant (1/s) to the inversion model., a SimPEG Map

Other Properties:

  • cDeriv (Derivative): Derivative of Frequency dependency wrt the model.

  • etaDeriv (Derivative): Derivative of Electrical Chargeability (V/V) wrt the model.

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

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

  • tauDeriv (Derivative): Derivative of Time constant (s) wrt the model.

  • tauiDeriv (Derivative): Derivative of Inverse of time constant (1/s) wrt the model.

fieldsPair[source]

alias of SimPEG.electromagnetics.static.resistivity.fields.Fields3DCellCentered

sign = 1.0
bc_type = 'Neumann'
class SimPEG.electromagnetics.static.spectral_induced_polarization.simulation.Simulation3DNodal(*args, **kwargs)[source]

Bases: SimPEG.electromagnetics.static.spectral_induced_polarization.simulation.BaseSIPSimulation, SimPEG.electromagnetics.static.induced_polarization.simulation.Simulation3DNodal

Required Properties:

  • counter (Counter): A SimPEG.utils.Counter object, an instance of Counter

  • data_type (StringChoice): IP data type, either “volt” or “apparent_chargeability”, Default: volt

  • mesh (BaseMesh): a discretize mesh instance, an instance of BaseMesh

  • sensitivity_path (String): path to store the sensitivty, a unicode string, Default: ./sensitivity/

  • None

  • solver_opts (Dictionary): solver options as a kwarg dict, a dictionary

  • storeJ (Boolean): store the sensitivity matrix?, a boolean, Default: False

  • survey (Survey): an SIP survey object, an instance of Survey

Optional Properties:

  • c (PhysicalProperty): Frequency dependency, a physical property, Default: 0.5

  • cMap (Mapping): Mapping of Frequency dependency to the inversion model., a SimPEG Map

  • eta (PhysicalProperty): Electrical Chargeability (V/V), a physical property

  • etaMap (Mapping): Mapping of Electrical Chargeability (V/V) to the inversion model., a SimPEG Map

  • model (Model): Inversion model., a numpy array of <class ‘float’>, <class ‘int’> with shape (*, *) or (*)

  • mu (PhysicalProperty): Magnetic Permeability (H/m), a physical property, Default: 1.2566370614359173e-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

  • tau (PhysicalProperty): Time constant (s), a physical property, Default: 0.1

  • tauMap (Mapping): Mapping of Time constant (s) to the inversion model., a SimPEG Map

  • taui (PhysicalProperty): Inverse of time constant (1/s), a physical property

  • tauiMap (Mapping): Mapping of Inverse of time constant (1/s) to the inversion model., a SimPEG Map

Other Properties:

  • cDeriv (Derivative): Derivative of Frequency dependency wrt the model.

  • etaDeriv (Derivative): Derivative of Electrical Chargeability (V/V) wrt the model.

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

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

  • tauDeriv (Derivative): Derivative of Time constant (s) wrt the model.

  • tauiDeriv (Derivative): Derivative of Inverse of time constant (1/s) wrt the model.

fieldsPair[source]

alias of SimPEG.electromagnetics.static.resistivity.fields.Fields3DNodal

sign = -1.0
SimPEG.electromagnetics.static.spectral_induced_polarization.simulation.Simulation3DCellCentred[source]

alias of SimPEG.electromagnetics.static.spectral_induced_polarization.simulation.Simulation3DCellCentered

class SimPEG.electromagnetics.static.spectral_induced_polarization.simulation.Problem3D_N(*args, **kwargs)[source]

Bases: SimPEG.electromagnetics.static.spectral_induced_polarization.simulation.Simulation3DNodal

This class has been deprecated, see Simulation3DNodal for documentation

class SimPEG.electromagnetics.static.spectral_induced_polarization.simulation.Problem3D_CC(*args, **kwargs)[source]

Bases: SimPEG.electromagnetics.static.spectral_induced_polarization.simulation.Simulation3DCellCentered

This class has been deprecated, see Simulation3DCellCentered for documentation

class SimPEG.electromagnetics.static.spectral_induced_polarization.simulation_2d.BaseSIPSimulation2D(*args, **kwargs)[source]

Bases: SimPEG.electromagnetics.static.induced_polarization.simulation_2d.BaseIPSimulation2D, SimPEG.electromagnetics.static.spectral_induced_polarization.simulation.BaseSIPSimulation

Required Properties:

  • counter (Counter): A SimPEG.utils.Counter object, an instance of Counter

  • data_type (StringChoice): IP data type, either “volt” or “apparent_chargeability”, Default: volt

  • mesh (BaseMesh): a discretize mesh instance, an instance of BaseMesh

  • sensitivity_path (String): path to store the sensitivty, a unicode string, Default: ./sensitivity/

  • None

  • solver_opts (Dictionary): solver options as a kwarg dict, a dictionary

  • storeJ (Boolean): store the sensitivity matrix?, a boolean, Default: False

  • survey (Survey): an SIP survey object, an instance of Survey

Optional Properties:

  • c (PhysicalProperty): Frequency dependency, a physical property, Default: 1.0

  • cMap (Mapping): Mapping of Frequency dependency to the inversion model., a SimPEG Map

  • eta (PhysicalProperty): Electrical Chargeability (V/V), a physical property

  • etaMap (Mapping): Mapping of Electrical Chargeability (V/V) to the inversion model., a SimPEG Map

  • model (Model): Inversion model., a numpy array of <class ‘float’>, <class ‘int’> with shape (*, *) or (*)

  • mu (PhysicalProperty): Magnetic Permeability (H/m), a physical property, Default: 1.2566370614359173e-06

  • mui (PhysicalProperty): Inverse Magnetic Permeability (m/H), a physical property

  • nky (Integer): Number of kys to use in wavenumber space, an integer, Default: 11

  • 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

  • tau (PhysicalProperty): Time constant (s), a physical property, Default: 0.1

  • tauMap (Mapping): Mapping of Time constant (s) to the inversion model., a SimPEG Map

  • taui (PhysicalProperty): Inverse of time constant (1/s), a physical property

  • tauiMap (Mapping): Mapping of Inverse of time constant (1/s) to the inversion model., a SimPEG Map

Other Properties:

  • cDeriv (Derivative): Derivative of Frequency dependency wrt the model.

  • etaDeriv (Derivative): Derivative of Electrical Chargeability (V/V) wrt the model.

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

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

  • tauDeriv (Derivative): Derivative of Time constant (s) wrt the model.

  • tauiDeriv (Derivative): Derivative of Inverse of time constant (1/s) wrt the model.

property eta

Electrical Chargeability (V/V)

property etaMap

Mapping of Electrical Chargeability (V/V) to the inversion model.

property etaDeriv

Derivative of Electrical Chargeability (V/V) wrt the model.

property tau

Time constant (s)

property tauMap

Mapping of Time constant (s) to the inversion model.

property tauDeriv

Derivative of Time constant (s) wrt the model.

property taui

Inverse of time constant (1/s)

property tauiMap

Mapping of Inverse of time constant (1/s) to the inversion model.

property tauiDeriv

Derivative of Inverse of time constant (1/s) wrt the model.

property c

Frequency dependency

property cMap

Mapping of Frequency dependency to the inversion model.

property cDeriv

Derivative of Frequency dependency wrt the model.

property survey

survey (Survey): an SIP survey object, an instance of Survey

fieldsPair[source]

alias of SimPEG.electromagnetics.static.resistivity.fields_2d.Fields2D

actinds = None
actMap = None
property etaDeriv_store
property tauiDeriv_store
property tauDeriv_store
property cDeriv_store
getJ(m, f=None)[source]

Generate Full sensitivity matrix

forward(m, f=None)[source]
dpred(m, f=None)[source]

Predicted data.

\[d_\text{pred} = Pf(m)\]
Jvec(m, v, f=None)[source]

Compute sensitivity matrix (J) and vector (v) product.

Jtvec(m, v, f=None)[source]

Compute adjoint sensitivity matrix (J^T) and vector (v) product.

getJtJdiag(m)[source]

Compute JtJ using adjoint problem. Still we never form JtJ

property MfRhoDerivMat

Derivative of MfRho with respect to the model

MfRhoIDeriv(u, v, adjoint=False)[source]

Derivative of MfRhoI with respect to the model.

property MeSigmaDerivMat

Derivative of MeSigma with respect to the model

MeSigmaDeriv(u, v, adjoint=False)[source]

Derivative of MeSigma with respect to the model times a vector (u)

property MnSigmaDerivMat

Derivative of MnSigma with respect to the model

MnSigmaDeriv(u, v, adjoint=False)[source]

Derivative of MnSigma with respect to the model times a vector (u)

property MccRhoiDerivMat

Derivative of MccRho with respect to the model

MccRhoiDeriv(u, v, adjoint=False)[source]

Derivative of MccRhoi with respect to the model.

property deleteTheseOnModelUpdate

matrices to be deleted if the model maps for conductivity and/or permeability are updated

class SimPEG.electromagnetics.static.spectral_induced_polarization.simulation_2d.Simulation2DCellCentered(*args, **kwargs)[source]

Bases: SimPEG.electromagnetics.static.spectral_induced_polarization.simulation_2d.BaseSIPSimulation2D, SimPEG.electromagnetics.static.induced_polarization.simulation_2d.Simulation2DCellCentered

2.5D cell centered Spectral IP problem

Required Properties:

  • counter (Counter): A SimPEG.utils.Counter object, an instance of Counter

  • data_type (StringChoice): IP data type, either “volt” or “apparent_chargeability”, Default: volt

  • mesh (BaseMesh): a discretize mesh instance, an instance of BaseMesh

  • sensitivity_path (String): path to store the sensitivty, a unicode string, Default: ./sensitivity/

  • None

  • solver_opts (Dictionary): solver options as a kwarg dict, a dictionary

  • storeJ (Boolean): store the sensitivity matrix?, a boolean, Default: False

  • survey (Survey): an SIP survey object, an instance of Survey

Optional Properties:

  • c (PhysicalProperty): Frequency dependency, a physical property, Default: 1.0

  • cMap (Mapping): Mapping of Frequency dependency to the inversion model., a SimPEG Map

  • eta (PhysicalProperty): Electrical Chargeability (V/V), a physical property

  • etaMap (Mapping): Mapping of Electrical Chargeability (V/V) to the inversion model., a SimPEG Map

  • model (Model): Inversion model., a numpy array of <class ‘float’>, <class ‘int’> with shape (*, *) or (*)

  • mu (PhysicalProperty): Magnetic Permeability (H/m), a physical property, Default: 1.2566370614359173e-06

  • mui (PhysicalProperty): Inverse Magnetic Permeability (m/H), a physical property

  • nky (Integer): Number of kys to use in wavenumber space, an integer, Default: 11

  • 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

  • tau (PhysicalProperty): Time constant (s), a physical property, Default: 0.1

  • tauMap (Mapping): Mapping of Time constant (s) to the inversion model., a SimPEG Map

  • taui (PhysicalProperty): Inverse of time constant (1/s), a physical property

  • tauiMap (Mapping): Mapping of Inverse of time constant (1/s) to the inversion model., a SimPEG Map

Other Properties:

  • cDeriv (Derivative): Derivative of Frequency dependency wrt the model.

  • etaDeriv (Derivative): Derivative of Electrical Chargeability (V/V) wrt the model.

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

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

  • tauDeriv (Derivative): Derivative of Time constant (s) wrt the model.

  • tauiDeriv (Derivative): Derivative of Inverse of time constant (1/s) wrt the model.

fieldsPair[source]

alias of SimPEG.electromagnetics.static.resistivity.fields_2d.Fields2DCellCentered

sign = 1.0
bc_type = 'Mixed'
class SimPEG.electromagnetics.static.spectral_induced_polarization.simulation_2d.Simulation2DNodal(*args, **kwargs)[source]

Bases: SimPEG.electromagnetics.static.spectral_induced_polarization.simulation_2d.BaseSIPSimulation2D, SimPEG.electromagnetics.static.induced_polarization.simulation_2d.Simulation2DNodal

2.5D nodal Spectral IP problem

Required Properties:

  • counter (Counter): A SimPEG.utils.Counter object, an instance of Counter

  • data_type (StringChoice): IP data type, either “volt” or “apparent_chargeability”, Default: volt

  • mesh (BaseMesh): a discretize mesh instance, an instance of BaseMesh

  • sensitivity_path (String): path to store the sensitivty, a unicode string, Default: ./sensitivity/

  • None

  • solver_opts (Dictionary): solver options as a kwarg dict, a dictionary

  • storeJ (Boolean): store the sensitivity matrix?, a boolean, Default: False

  • survey (Survey): an SIP survey object, an instance of Survey

Optional Properties:

  • c (PhysicalProperty): Frequency dependency, a physical property, Default: 1.0

  • cMap (Mapping): Mapping of Frequency dependency to the inversion model., a SimPEG Map

  • eta (PhysicalProperty): Electrical Chargeability (V/V), a physical property

  • etaMap (Mapping): Mapping of Electrical Chargeability (V/V) to the inversion model., a SimPEG Map

  • model (Model): Inversion model., a numpy array of <class ‘float’>, <class ‘int’> with shape (*, *) or (*)

  • mu (PhysicalProperty): Magnetic Permeability (H/m), a physical property, Default: 1.2566370614359173e-06

  • mui (PhysicalProperty): Inverse Magnetic Permeability (m/H), a physical property

  • nky (Integer): Number of kys to use in wavenumber space, an integer, Default: 11

  • 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

  • tau (PhysicalProperty): Time constant (s), a physical property, Default: 0.1

  • tauMap (Mapping): Mapping of Time constant (s) to the inversion model., a SimPEG Map

  • taui (PhysicalProperty): Inverse of time constant (1/s), a physical property

  • tauiMap (Mapping): Mapping of Inverse of time constant (1/s) to the inversion model., a SimPEG Map

Other Properties:

  • cDeriv (Derivative): Derivative of Frequency dependency wrt the model.

  • etaDeriv (Derivative): Derivative of Electrical Chargeability (V/V) wrt the model.

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

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

  • tauDeriv (Derivative): Derivative of Time constant (s) wrt the model.

  • tauiDeriv (Derivative): Derivative of Inverse of time constant (1/s) wrt the model.

fieldsPair[source]

alias of SimPEG.electromagnetics.static.resistivity.fields_2d.Fields2DNodal

sign = -1.0
SimPEG.electromagnetics.static.spectral_induced_polarization.simulation_2d.Simulation2DCellCentred[source]

alias of SimPEG.electromagnetics.static.spectral_induced_polarization.simulation_2d.Simulation2DCellCentered

class SimPEG.electromagnetics.static.spectral_induced_polarization.simulation_2d.Problem2D_N(*args, **kwargs)[source]

Bases: SimPEG.electromagnetics.static.spectral_induced_polarization.simulation_2d.Simulation2DNodal

This class has been deprecated, see Simulation2DNodal for documentation

class SimPEG.electromagnetics.static.spectral_induced_polarization.simulation_2d.Problem2D_CC(*args, **kwargs)[source]

Bases: SimPEG.electromagnetics.static.spectral_induced_polarization.simulation_2d.Simulation2DCellCentered

This class has been deprecated, see Simulation2DCellCentered for documentation

Survey

class SimPEG.electromagnetics.static.spectral_induced_polarization.survey.Survey(*args, **kwargs)[source]

Bases: SimPEG.survey.BaseTimeSurvey

Spectral induced polarization survey

Required Properties:

  • counter (Counter): A SimPEG counter object, an instance of Counter

  • source_list (a list of BaseSrc): A list of sources for the survey, a list (each item is an instance of BaseSrc)

n_pulse = 2
T = 8.0
property source_list

source_list (a list of BaseSrc): A list of sources for the survey, a list (each item is an instance of BaseSrc)

property n_locations
SimPEG.electromagnetics.static.spectral_induced_polarization.survey.from_dc_to_sip_survey(survey_dc, times)[source]

Generate sip survey from dc survey

class SimPEG.electromagnetics.static.spectral_induced_polarization.receivers.BaseRx(*args, **kwargs)[source]

Bases: SimPEG.survey.BaseTimeRx

Required Properties:

  • data_type (StringChoice): Type of DC-IP survey, any of “volt”, “apparent_resistivity”, “apparent_chargeability”, Default: volt

  • locations (RxLocationArray): Locations of the receivers (nRx x nDim), an array of receiver locations of <class ‘float’>, <class ‘int’> with shape (*, *)

  • orientation (StringChoice): orientation of the receiver. Must currently be ‘x’, ‘y’, ‘z’, any of “x”, “y”, “z”

  • projField (StringChoice): field to be projected in the calculation of the data, any of “phi”, “e”, “j”, Default: phi

  • projTLoc (StringChoice): location on the time mesh where the data are projected from, either “N” or “CC”, Default: N

  • storeProjections (Boolean): Store calls to getP (organized by mesh), a boolean, Default: True

  • times (Array): times where the recievers measure data, a list or numpy array of <class ‘float’>, <class ‘int’> with shape (*)

property orientation

orientation (StringChoice): orientation of the receiver. Must currently be ‘x’, ‘y’, ‘z’, any of “x”, “y”, “z”

property projField

projField (StringChoice): field to be projected in the calculation of the data, any of “phi”, “e”, “j”, Default: phi

property data_type

data_type (StringChoice): Type of DC-IP survey, any of “volt”, “apparent_resistivity”, “apparent_chargeability”, Default: volt

property dc_voltage
projGLoc(f)[source]

Grid Location projection (e.g. Ex Fy …)

getTimeP(timesall)[source]

Returns the time projection matrix.

Note

This is not stored in memory, but is created on demand.

eval(src, mesh, f)[source]
evalDeriv(src, mesh, f, v, adjoint=False)[source]
class SimPEG.electromagnetics.static.spectral_induced_polarization.receivers.Dipole(*args, **kwargs)[source]

Bases: SimPEG.electromagnetics.static.spectral_induced_polarization.receivers.BaseRx

Dipole receiver

Required Properties:

  • data_type (StringChoice): Type of DC-IP survey, any of “volt”, “apparent_resistivity”, “apparent_chargeability”, Default: volt

  • locations (a list of RxLocationArray): list of locations of each electrode in a dipole receiver, a list (each item is an array of receiver locations of <class ‘float’>, <class ‘int’> with shape (*, *)) with length between 1 and 2

  • orientation (StringChoice): orientation of the receiver. Must currently be ‘x’, ‘y’, ‘z’, any of “x”, “y”, “z”

  • projField (StringChoice): field to be projected in the calculation of the data, any of “phi”, “e”, “j”, Default: phi

  • projTLoc (StringChoice): location on the time mesh where the data are projected from, either “N” or “CC”, Default: N

  • storeProjections (Boolean): Store calls to getP (organized by mesh), a boolean, Default: True

  • times (Array): times where the recievers measure data, a list or numpy array of <class ‘float’>, <class ‘int’> with shape (*)

property locations

locations (a list of RxLocationArray): list of locations of each electrode in a dipole receiver, a list (each item is an array of receiver locations of <class ‘float’>, <class ‘int’> with shape (*, *)) with length between 1 and 2

property locations_m

Locations of the M-electrodes

property locations_n

Locations of the N-electrodes

property nD

Number of data in the receiver.

property nRx

nD.nRx has been deprecated. See nD for documentation

getP(mesh, Gloc)[source]

Returns the projection matrices as a list for all components collected by the receivers.

Note

Projection matrices are stored as a dictionary (mesh, timeMesh) if storeProjections is True

class SimPEG.electromagnetics.static.spectral_induced_polarization.receivers.Pole(*args, **kwargs)[source]

Bases: SimPEG.electromagnetics.static.spectral_induced_polarization.receivers.BaseRx

Pole receiver

Required Properties:

  • data_type (StringChoice): Type of DC-IP survey, any of “volt”, “apparent_resistivity”, “apparent_chargeability”, Default: volt

  • locations (RxLocationArray): Locations of the receivers (nRx x nDim), an array of receiver locations of <class ‘float’>, <class ‘int’> with shape (*, *)

  • orientation (StringChoice): orientation of the receiver. Must currently be ‘x’, ‘y’, ‘z’, any of “x”, “y”, “z”

  • projField (StringChoice): field to be projected in the calculation of the data, any of “phi”, “e”, “j”, Default: phi

  • projTLoc (StringChoice): location on the time mesh where the data are projected from, either “N” or “CC”, Default: N

  • storeProjections (Boolean): Store calls to getP (organized by mesh), a boolean, Default: True

  • times (Array): times where the recievers measure data, a list or numpy array of <class ‘float’>, <class ‘int’> with shape (*)

property nD

Number of data in the receiver.

property nRx

nD.nRx has been deprecated. See nD for documentation

getP(mesh, Gloc)[source]

Returns the projection matrices as a list for all components collected by the receivers.

Note

Projection matrices are stored as a dictionary (mesh, timeMesh) if storeProjections is True

class SimPEG.electromagnetics.static.spectral_induced_polarization.sources.BaseSrc(*args, **kwargs)[source]

Bases: SimPEG.survey.BaseSrc

Required Properties:

  • current (Float): Source current, a float, Default: 1.0

  • receiver_list (a list of BaseRx): receiver list, a list (each item is an instance of BaseRx)

Optional Properties:

  • location (SourceLocationArray): Location of the source [x, y, z] in 3D, a 1D array denoting the source location of <class ‘float’>, <class ‘int’> with shape (*)

property current

current (Float): Source current, a float, Default: 1.0

eval(simulation)[source]
evalDeriv(simulation)[source]
property nD

Number of data

property vnD

Vector number of data

class SimPEG.electromagnetics.static.spectral_induced_polarization.sources.Dipole(*args, **kwargs)[source]

Bases: SimPEG.electromagnetics.static.spectral_induced_polarization.sources.BaseSrc

Dipole source

Required Properties:

  • current (Float): Source current, a float, Default: 1.0

  • location (a list of SourceLocationArray): location of the source electrodes, a list (each item is a 1D array denoting the source location of <class ‘float’>, <class ‘int’> with shape (*))

  • receiver_list (a list of BaseRx): receiver list, a list (each item is an instance of BaseRx)

property loc

loc has been deprecated. See location for documentation

property location

location (a list of SourceLocationArray): location of the source electrodes, a list (each item is a 1D array denoting the source location of <class ‘float’>, <class ‘int’> with shape (*))

property location_a

Location of the A-electrode

property location_b

Location of the B-electrode

eval(simulation)[source]
class SimPEG.electromagnetics.static.spectral_induced_polarization.sources.Pole(*args, **kwargs)[source]

Bases: SimPEG.electromagnetics.static.spectral_induced_polarization.sources.BaseSrc

Pole source

Required Properties:

  • current (Float): Source current, a float, Default: 1.0

  • receiver_list (a list of BaseRx): receiver list, a list (each item is an instance of BaseRx)

Optional Properties:

  • location (SourceLocationArray): Location of the source [x, y, z] in 3D, a 1D array denoting the source location of <class ‘float’>, <class ‘int’> with shape (*)

eval(simulation)[source]