simpeg.regularization.RegularizationMesh#

class simpeg.regularization.RegularizationMesh(mesh, active_cells=None, **kwargs)[source]#

Bases: BaseSimPEG

Regularization Mesh

The RegularizationMesh class is used to construct differencing and averaging operators for the objective function(s) defining the regularization. In practice, these operators are not constructed by creating instances of RegularizationMesh. The operators are instead constructed (and sometimes stored) when called as a property of the mesh. The RegularizationMesh class is built using much of the functionality from the discretize.operators.differential_operators.DiffOperators class. However, operators constructed using the RegularizationMesh class have been modified to act only on interior faces and active cells in the inversion, thus reducing computational cost.

Parameters:
meshdiscretize.base.BaseMesh

Mesh on which the discrete set of model parameters are defined.

active_cellsNone, (n_cells, ) numpy.ndarray of bool

Boolean array defining the set of mesh cells that are active in the inversion. If None, all cells are active.

Attributes

Pac

Projection matrix from active cells to all mesh cells.

Pafx

Projection matrix from active x-faces to all x-faces in the mesh.

Pafy

Projection matrix from active y-faces to all y-faces in the mesh.

Pafz

Projection matrix from active z-faces to all z-faces in the mesh.

active_cells

Active cells on the regularization mesh.

aveCC2Fx

Averaging operator from active x-faces to active cell centers.

aveCC2Fy

Averaging operator from active y-faces to active cell centers.

aveCC2Fz

Averaging operator from active z-faces to active cell centers.

aveFx2CC

Averaging operator from active cell centers to active x-faces.

aveFy2CC

Averaging operator from active cell centers to active y-faces.

aveFz2CC

Averaging operator from active cell centers to active z-faces.

average_face_to_cell

Averaging operator from faces to cell centers.

base_length

Smallest dimension (i.e. edge length) for smallest cell in the mesh.

cellDiffx

cell_gradient_x.cellDiffx has been deprecated.

cellDiffy

cell_gradient_y.cellDiffy has been deprecated.

cellDiffz

cell_gradient_z.cellDiffz has been deprecated.

cell_distances_x

Cell center distance array along the x-direction.

cell_distances_y

Cell center distance array along the y-direction.

cell_distances_z

Cell center distance array along the z-direction.

cell_gradient

Cell gradient operator (cell centers to faces).

cell_gradient_x

Cell-centered x-derivative operator on active cells.

cell_gradient_y

Cell-centered y-derivative operator on active cells.

cell_gradient_z

Cell-centered z-derivative operator on active cells.

dim

Dimension of regularization mesh.

nC

Number of active cells.

n_cells

Number of active cells.

vol

Volumes of active mesh cells.

regularization_type