simpeg.maps.InjectActiveFaces#

class simpeg.maps.InjectActiveFaces(mesh, active_faces=None, value_inactive=0.0, nF=None)[source]#

Bases: IdentityMap

Map active faces model to all faces of a mesh.

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

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

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

Parameters:
meshdiscretize.BaseMesh

A discretize mesh

active_facesnumpy.ndarray

Active faces array. Can be a boolean numpy.ndarray of length mesh.nF or a numpy.ndarray of int containing the indices of the active faces.

value_inactivefloat or numpy.ndarray

The physical property value assigned to all inactive faces in the mesh

Attributes

active_faces

Return indices of active mesh faces.

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.

value_inactive

Return physical property value assigned to all inactive faces.

Methods

deriv(m[, v])

Return derivative of the mapping with respect to the input parameters.

dot(map1)

Multiply two mappings to create a simpeg.maps.ComboMap.

inverse(u)

Compute the inverse projection operation.

test([m, num, random_seed])

Derivative test for the mapping.