simpeg.maps.InjectActiveCells#

class simpeg.maps.InjectActiveCells(mesh, active_cells=None, value_inactive=0.0, nC=None, indActive=None, valInactive=0.0)[source]#

Bases: IdentityMap

Map active cells model to all cell of a mesh.

The InjectActiveCells class is used to define the mapping when the model consists of physical property values for a set of active mesh cells; e.g. cells below topography. For a discrete set of model parameters \(\mathbf{m}\) defined on a set of active cells, the mapping \(\mathbf{u}(\mathbf{m})\) is defined as:

\[\mathbf{u}(\mathbf{m}) = \mathbf{Pm} + \mathbf{d}\, m_\perp\]

where \(\mathbf{P}\) is a (nC , nP) projection matrix from active cells to all mesh cells, and \(\mathbf{d}\) is a (nC , 1) matrix that projects the inactive cell value \(m_\perp\) to all inactive mesh cells.

Parameters:

meshdiscretize.BaseMesh: A discretize mesh
active_cellsnumpy.ndarray: Active cells array. Can be a boolean numpy.ndarray of length mesh.nC or a numpy.ndarray of int containing the indices of the active cells.
value_inactivefloat or numpy.ndarray: The physical property value assigned to all inactive cells in the mesh
indActivenumpy.ndarray: Deprecated since version 0.23.0: Argument indActive is deprecated in favor of active_cells and will be removed in SimPEG v0.24.0.
valInactivefloat or numpy.ndarray: Deprecated since version 0.23.0: Argument valInactive is deprecated in favor of value_inactive and will be removed in SimPEG v0.24.0.

Attributes

`active_cells`
`indActive`	active_cells.indActive has been deprecated.
`is_linear`	Determine whether or not this mapping is a linear operation.
`mesh`	The mesh used for the mapping
`nP`	Number of parameters the model acts on.
`shape`	Dimensions of the mapping
`valInactive`	value_inactive.valInactive has been deprecated.
`value_inactive`	The physical property value assigned to all inactive cells in the mesh.

Methods

`deriv`(m[, v])	Derivative of the mapping with respect to the input parameters.
`dot`(map1)	Multiply two mappings to create a `simpeg.maps.ComboMap`.
`inverse`(u)	Recover the model parameters (active cells) from a set of physical property values defined on the entire mesh.
`test`([m, num, random_seed])	Derivative test for the mapping.