SimPEG.regularization.RegularizationMesh#

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

Bases: SimPEG.props.BaseSimPEG

Regularization Mesh

This contains the operators used in the regularization. Note that these are not necessarily true differential operators, but are constructed from a discretize Mesh.

Parameters

mesh (discretize.base.BaseMesh) – problem mesh
active_cells (numpy.ndarray) – bool array, size nC, that is True where we have active cells. Used to reduce the operators so we regularize only on active cells

Attributes

`Pac`	Projection matrix that takes from the reduced space of active cells to full modelling space (ie.
`Pafx`	Projection matrix that takes from the reduced space of active x-faces to full modelling space (ie.
`Pafy`	Projection matrix that takes from the reduced space of active y-faces to full modelling space (ie.
`Pafz`	Projection matrix that takes from the reduced space of active z-faces to full modelling space (ie.
`active_cells`	A boolean array indicating whether a cell is active
`aveCC2Fx`	Averaging from active x-faces to active cell centers.
`aveCC2Fy`	Averaging matrix from active y-faces to active cell centers.
`aveCC2Fz`	Averaging matrix from active z-faces to active cell centers.
`aveFx2CC`	Averaging from active cell centers to active x-faces.
`aveFy2CC`	Averaging from active cell centers to active y-faces.
`aveFz2CC`	Averaging from active cell centers to active z-faces.
`average_face_to_cell`	Vertically stacked matrix of cell averaging operators from active cell centers to active faces along each dimension of the mesh.
`base_length`	The smallest core cell size.
`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`	Vertically stacked matrix of cell gradients along each dimension of the mesh.
`cell_gradient_x`	Cell centered gradient matrix for active cells in the x-direction.
`cell_gradient_y`	Cell centered gradient matrix for active cells in the y-direction.
`cell_gradient_z`	Cell centered gradient matrix for active cells in the z-direction.
`dim`	Dimension of regularization mesh (1D, 2D, 3D)
`nC`	Number of cells being regularized.
`vol`	Reduced volume vector.

regularization_type