simpeg.maps.BaseParametric#

class simpeg.maps.BaseParametric(mesh, slope=None, slopeFact=1.0, active_cells=None, indActive=None, **kwargs)[source]#

Base class for parametric mappings from simple geological structures to meshes.

Parameters:

meshdiscretize.BaseMesh: A discretize mesh
slopefloat, optional: Directly set the scaling parameter slope which sets the sharpness of boundaries between units.
slopeFactfloat, optional: Set sharpness of boundaries between units based on minimum cell size. If set, the scalaing parameter slope = slopeFact / dh.
active_cellsnumpy.ndarray, optional: 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.
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.

Attributes

`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 mapping acts on.
`shape`	Dimensions of the mapping operator
`slope`	Defines the sharpness of the boundaries.
`slopeFact`	Defines the slope scaled by the mesh.
`x`	X cell center locations (active) for the output of the mapping.
`y`	Y cell center locations (active) for the output of the mapping.
`z`	Z cell center locations (active) for the output of the mapping.

active_cells

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`(D)	The transform inverse is not implemented.
`test`([m, num, random_seed])	Derivative test for the mapping.