esys.downunder.mappings Package

Classes

class esys.downunder.mappings.BoundedRangeMapping(s_min=0, s_max=1)

Bases: esys.downunder.mappings.Mapping

Maps an unbounded parameter to a bounded range. The mapping is smooth and continuous.

getDerivative(m)

returns the value for the derivative of the mapping for m

getInverse(s)

returns the value of the inverse of the mapping for s

getTypicalDerivative()

returns a typical value for the derivative

getValue(m)

returns the value of the mapping for m

class esys.downunder.mappings.DensityMapping(domain, z0=None, rho0=None, drho=None, beta=None)

Bases: esys.downunder.mappings.LinearMapping

Density mapping with depth weighting

rho = rho0 + drho * ( (x_2 - z0)/l_z)^(beta/2) ) * m

getDerivative(m)

returns the value for the derivative of the mapping for m

getInverse(p)

returns the value of the inverse of the mapping for s

getTypicalDerivative()

returns a typical value for the derivative

getValue(m)

returns the value of the mapping for m

class esys.downunder.mappings.LinearMapping(a=1, p0=0)

Bases: esys.downunder.mappings.Mapping

Maps a parameter by a linear transformation p = a * m + p0

getDerivative(m)

returns the value for the derivative of the mapping for m

getInverse(p)

returns the value of the inverse of the mapping for s

getTypicalDerivative()

returns a typical value for the derivative

getValue(m)

returns the value of the mapping for m

class esys.downunder.mappings.Mapping(*args)

Bases: object

An abstract mapping class to map level set functions m to physical parameters p.

getDerivative(m)

returns the value for the derivative of the mapping for m

getInverse(s)

returns the value of the inverse of the mapping for physical parameter p

getTypicalDerivative()

returns a typical value for the derivative

getValue(m)

returns the value of the mapping for m

class esys.downunder.mappings.SusceptibilityMapping(domain, z0=None, k0=None, dk=None, beta=None)

Bases: esys.downunder.mappings.LinearMapping

Susceptibility mapping with depth weighting

k = k0 + dk * ( (x_2 - z0)/l_z)^(beta/2) ) * m

getDerivative(m)

returns the value for the derivative of the mapping for m

getInverse(p)

returns the value of the inverse of the mapping for s

getTypicalDerivative()

returns a typical value for the derivative

getValue(m)

returns the value of the mapping for m

Functions

esys.downunder.mappings.boundingBoxEdgeLengths(domain)

Returns the edge lengths of the bounding box of a domain

Parameters:domain (escript.Domain) – a domain
Return type:list of float
esys.downunder.mappings.inf(arg)

Returns the minimum value over all data points.

Parameters:arg (float, int, escript.Data, numpy.ndarray) – argument
Returns:minimum value of arg over all components and all data points
Return type:float
Raises TypeError:
 if type of arg cannot be processed
esys.downunder.mappings.log(arg)

Returns the natural logarithm of argument arg.

Parameters:arg (float, escript.Data, Symbol, numpy.ndarray.) – argument
Return type:float, escript.Data, Symbol, numpy.ndarray depending on the type of arg
Raises TypeError:
 if the type of the argument is not expected
esys.downunder.mappings.sup(arg)

Returns the maximum value over all data points.

Parameters:arg (float, int, escript.Data, numpy.ndarray) – argument
Returns:maximum value of arg over all components and all data points
Return type:float
Raises TypeError:
 if type of arg cannot be processed
esys.downunder.mappings.tanh(arg)

Returns the hyperbolic tangent of argument arg.

Parameters:arg (float, escript.Data, Symbol, numpy.ndarray) – argument
Return type:float, escript.Data, Symbol, numpy.ndarray depending on the type of arg
Raises TypeError:
 if the type of the argument is not expected

Others

  • __all__
  • __builtins__
  • __copyright__
  • __doc__
  • __file__
  • __license__
  • __name__
  • __package__
  • __url__