simpeg.simulation.BaseSimulation

class simpeg.simulation.BaseSimulation(mesh=None, survey=None, solver=None, solver_opts=None, sensitivity_path=None, counter=None, verbose=False, **kwargs)

Bases: HasModel

Base class for all geophysical forward simulations in SimPEG.

The BaseSimulation class defines properties and methods inherited by practical simulation classes in SimPEG.

Important

This class is not meant to be instantiated. You should inherit from it to create your own simulation class.

Parameters:

meshdiscretize.base.BaseMesh, optional

Mesh on which the forward problem is discretized.

surveysimpeg.survey.BaseSurvey, optional

The survey for the simulation.

solverNone or pymatsolver.base.Base, optional

Numerical solver used to solve the forward problem. If None, an appropriate solver specific to the simulation class is set by default.

solver_optsdict, optional

Solver-specific parameters. If None, default parameters are used for the solver set by solver. Otherwise, the dict must contain appropriate pairs of keyword arguments and parameter values for the solver. Please visit pymatsolver to learn more about solvers and their parameters.

sensitivity_pathstr, optional

Path to directory where sensitivity file is stored.

counterNone or simpeg.utils.Counter

SimPEG Counter object to store iterations and run-times.

verbosebool, optional

Verbose progress printout.

Attributes

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	A list of properties stored on this object to delete when the model is updated
mesh	Mesh for the simulation.
model	The inversion model.
needs_model	True if a model is necessary
sensitivity_path	Path to directory where sensitivity file is stored.
solver	Numerical solver used in the forward simulation.
solver_opts	Solver-specific parameters.
survey	The survey for the simulation.
verbose	Verbose progress printout.

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.
dpred([m, f])	Predicted data for the model provided.
fields([m])	Return the computed geophysical fields for the model provided.
make_synthetic_data(m[, relative_error, ...])	Make synthetic data for the model and Gaussian noise provided.
residual(m, dobs[, f])	The data residual.

Galleries and Tutorials using simpeg.simulation.BaseSimulation

Maps: ComboMaps

Maps: ComboMaps

PF: Gravity: Tiled Inversion Linear

PF: Gravity: Tiled Inversion Linear

Magnetic inversion on a TreeMesh with remanence

Magnetic inversion on a TreeMesh with remanence

Magnetic inversion on a TreeMesh

Magnetic inversion on a TreeMesh

Magnetic Amplitude inversion on a TreeMesh

Magnetic Amplitude inversion on a TreeMesh

DC Analytic Dipole

DC Analytic Dipole

3D DC inversion of Dipole Dipole array

3D DC inversion of Dipole Dipole array

Parametric DC inversion with Dipole Dipole array

Parametric DC inversion with Dipole Dipole array

2D inversion of Loop-Loop EM Data

2D inversion of Loop-Loop EM Data

Time-domain CSEM for a resistive cube in a deep marine setting

Time-domain CSEM for a resistive cube in a deep marine setting

EM: TDEM: Permeable Target, Inductive Source

EM: TDEM: Permeable Target, Inductive Source

EM: TDEM: 1D: Inversion

EM: TDEM: 1D: Inversion

EM: TDEM: 1D: Inversion with VTEM waveform

EM: TDEM: 1D: Inversion with VTEM waveform

MT: 3D: Forward

MT: 3D: Forward

Predict Response from a Conductive and Magnetically Viscous Earth

Predict Response from a Conductive and Magnetically Viscous Earth

Method of Equivalent Sources for Removing VRM Responses

Method of Equivalent Sources for Removing VRM Responses

FLOW: Richards: 1D: Forward Simulation

FLOW: Richards: 1D: Forward Simulation

FLOW: Richards: 1D: Inversion

FLOW: Richards: 1D: Inversion

Petrophysically guided inversion (PGI): Linear example

Petrophysically guided inversion (PGI): Linear example

Petrophysically guided inversion: Joint linear example with nonlinear relationships

Petrophysically guided inversion: Joint linear example with nonlinear relationships

Heagy et al., 2017 1D RESOLVE and SkyTEM Bookpurnong Inversions

Heagy et al., 2017 1D RESOLVE and SkyTEM Bookpurnong Inversions

Heagy et al., 2017 1D RESOLVE Bookpurnong Inversion

Heagy et al., 2017 1D RESOLVE Bookpurnong Inversion

Heagy et al., 2017 Casing Example

Heagy et al., 2017 Casing Example

Heagy et al., 2017 1D FDEM and TDEM inversions

Heagy et al., 2017 1D FDEM and TDEM inversions

PF: Gravity: Laguna del Maule Bouguer Gravity

PF: Gravity: Laguna del Maule Bouguer Gravity

FLOW: Richards: 1D: Celia1990

FLOW: Richards: 1D: Celia1990

EM: Schenkel and Morrison Casing Model

EM: Schenkel and Morrison Casing Model

Straight Ray with Volume Data Misfit Term

Straight Ray with Volume Data Misfit Term

1D Forward Simulation for a Single Sounding

1D Forward Simulation for a Single Sounding

1D Forward Simulation with Chargeable and/or Magnetic Viscosity

1D Forward Simulation with Chargeable and/or Magnetic Viscosity

1D Forward Simulation with User-Defined Waveforms

1D Forward Simulation with User-Defined Waveforms

3D Forward Simulation for Transient Response on a Cylindrical Mesh

3D Forward Simulation for Transient Response on a Cylindrical Mesh

3D Forward Simulation with User-Defined Waveforms

3D Forward Simulation with User-Defined Waveforms

1D Inversion of Time-Domain Data for a Single Sounding

1D Inversion of Time-Domain Data for a Single Sounding

2.5D Forward Simulation of a DCIP Line

2.5D Forward Simulation of a DCIP Line

DC/IP Forward Simulation in 3D

DC/IP Forward Simulation in 3D

2.5D DC Resistivity and IP Least-Squares Inversion

2.5D DC Resistivity and IP Least-Squares Inversion

3D Least-Squares Inversion of DC and IP Data

3D Least-Squares Inversion of DC and IP Data

1D Forward Simulation for a Single Sounding

1D Forward Simulation for a Single Sounding

1D Forward Simulation for a Susceptible and Chargeable Earth

1D Forward Simulation for a Susceptible and Chargeable Earth

3D Forward Simulation on a Cylindrical Mesh

3D Forward Simulation on a Cylindrical Mesh

3D Forward Simulation on a Tree Mesh

3D Forward Simulation on a Tree Mesh

1D Inversion of for a Single Sounding

1D Inversion of for a Single Sounding

Forward Simulation of Gravity Anomaly Data on a Tensor Mesh

Forward Simulation of Gravity Anomaly Data on a Tensor Mesh

Forward Simulation of Gradiometry Data on a Tree Mesh

Forward Simulation of Gradiometry Data on a Tree Mesh

Least-Squares Inversion of Gravity Anomaly Data

Least-Squares Inversion of Gravity Anomaly Data

Sparse Norm Inversion of Gravity Anomaly Data

Sparse Norm Inversion of Gravity Anomaly Data

Compare weighting strategy with Inversion of surface Gravity Anomaly Data

Compare weighting strategy with Inversion of surface Gravity Anomaly Data

Simulate a 1D Sounding over a Layered Earth

Simulate a 1D Sounding over a Layered Earth

DC Resistivity Forward Simulation in 2.5D

DC Resistivity Forward Simulation in 2.5D

DC Resistivity Forward Simulation in 3D

DC Resistivity Forward Simulation in 3D

Least-Squares 1D Inversion of Sounding Data

Least-Squares 1D Inversion of Sounding Data

Sparse 1D Inversion of Sounding Data

Sparse 1D Inversion of Sounding Data

Parametric 1D Inversion of Sounding Data

Parametric 1D Inversion of Sounding Data

2.5D DC Resistivity Least-Squares Inversion

2.5D DC Resistivity Least-Squares Inversion

2.5D DC Resistivity Inversion with Sparse Norms

2.5D DC Resistivity Inversion with Sparse Norms

3D Least-Squares Inversion of DC Resistivity Data

3D Least-Squares Inversion of DC Resistivity Data

Forward Simulation of Total Magnetic Intensity Data

Forward Simulation of Total Magnetic Intensity Data

Forward Simulation of Gradiometry Data for Magnetic Vector Models

Forward Simulation of Gradiometry Data for Magnetic Vector Models

Sparse Norm Inversion for Total Magnetic Intensity Data on a Tensor Mesh

Sparse Norm Inversion for Total Magnetic Intensity Data on a Tensor Mesh

Linear Least-Squares Inversion

Linear Least-Squares Inversion

Sparse Inversion with Iteratively Re-Weighted Least-Squares

Sparse Inversion with Iteratively Re-Weighted Least-Squares

Response from a Homogeneous Layer for Different Waveforms

Response from a Homogeneous Layer for Different Waveforms

Forward Simulation of VRM Response on a Tree Mesh

Forward Simulation of VRM Response on a Tree Mesh

Forward Simulation Including Inductive Response

Forward Simulation Including Inductive Response

Forward Simulation for Straight Ray Tomography in 2D

Forward Simulation for Straight Ray Tomography in 2D

Sparse Norm Inversion of 2D Seismic Tomography Data

Sparse Norm Inversion of 2D Seismic Tomography Data

Joint PGI of Gravity + Magnetic on an Octree mesh using full petrophysical information

Joint PGI of Gravity + Magnetic on an Octree mesh using full petrophysical information

Joint PGI of Gravity + Magnetic on an Octree mesh without petrophysical information

Joint PGI of Gravity + Magnetic on an Octree mesh without petrophysical information

Cross-gradient Joint Inversion of Gravity and Magnetic Anomaly Data

Cross-gradient Joint Inversion of Gravity and Magnetic Anomaly Data