simpeg.maps.MuRelative#
- class simpeg.maps.MuRelative(mesh=None, nP=None, **kwargs)[source]#
Bases:
IdentityMap
Mapping that computes the magnetic permeability given a set of relative permeabilities.
Where \(\boldsymbol{\mu_r}\) defines a set of relative permeabilities,
MuRelative
creates a mapping \(\boldsymbol{\mu}(\boldsymbol{\mu_r})\) that computes the corresponding magnetic permeabilities of every element in \(\boldsymbol{\mu_r}\); i.e.:\[\boldsymbol{\mu}(\boldsymbol{\mu_r}) = \mu_0 \boldsymbol{\mu_r}\]where \(\mu_0\) is the permeability of free space.
- Parameters:
- mesh
discretize.BaseMesh
The number of parameters accepted by the mapping is set to equal the number of mesh cells.
- nP
int
Set the number of parameters accepted by the mapping directly. Used if the number of parameters is known. Used generally when the number of parameters is not equal to the number of cells in a mesh.
- mesh
Attributes
Determine whether or not this mapping is a linear operation.
The mesh used for the mapping
Number of parameters the mapping acts on.
Dimensions of the mapping operator
Methods
deriv
(m[, v])Derivative of mapping with respect to the input parameters.
dot
(map1)Multiply two mappings to create a
simpeg.maps.ComboMap
.inverse
(m)Apply the inverse mapping to an array.
test
([m, num, random_seed])Derivative test for the mapping.