P1LagrangeInterpolation

class P1LagrangeInterpolation(*args)

P1 interpolation of values between two meshes.

This class is a FieldFunction, it first builds a projection matrix between two meshes, and can then interpolate a Field defined on input mesh onto a Field defined on output mesh.

Available constructors:

P1LagrangeInterpolation(inputMesh, outputMesh, dimension)

P1LagrangeInterpolation(inputMesh, outputMesh, dimension, enclosingSimplex, nearestNeighbour)

Parameters
inputMeshMesh

Input mesh.

outputMeshMesh

Output mesh.

dimensionint

Dimension of fields to evaluate.

enclosingSimplexEnclosingSimplexAlgorithm

Algorithm used to find the enclosing simplex of each output point in input mesh. If a point is not contained in any mesh simplex, the nearest point is used.

nearestNeighbourNearestNeighbourAlgorithm

Algorithm used to find nearest neighbour of an output point, when it is not contained in any simplex of input mesh.

Notes

A FieldFunction is usually defined by three numbers, the input dimension, and dimensions of input and output fields. Before evaluating a openturns.Field, classes check that its dimensions are the ones which had been declared.

This class is special because it can deal with fields of any dimension, and output field will have the same dimension as input field. This dimension is passed to constructor, but method setDimension() can be called to interpolate fields of different dimensions without having to rebuild the projection between meshes.

Methods

__call__(self, field)

Call self as a function.

getCallsNumber(self)

Get the number of calls of the function.

getClassName(self)

Accessor to the object’s name.

getEnclosingSimplexAlgorithm(self)

Accessor to the algorithm used to find enclosing simplex.

getId(self)

Accessor to the object’s id.

getInputDescription(self)

Get the description of the input field values.

getInputDimension(self)

Get the dimension of the input field values.

getInputMesh(self)

Get the mesh associated to the input domain.

getMarginal(self, \*args)

Get the marginal(s) at given indice(s).

getName(self)

Accessor to the object’s name.

getNearestNeighbourAlgorithm(self)

Accessor to the algorithm used to find nearest neighbours.

getOutputDescription(self)

Get the description of the output field values.

getOutputDimension(self)

Get the dimension of the output field values.

getOutputMesh(self)

Get the mesh associated to the output domain.

getShadowedId(self)

Accessor to the object’s shadowed id.

getVisibility(self)

Accessor to the object’s visibility state.

hasName(self)

Test if the object is named.

hasVisibleName(self)

Test if the object has a distinguishable name.

isActingPointwise(self)

Whether the function acts point-wise.

setDimension(self, dimension)

Accessor to dimension of fields which are evaluated.

setInputDescription(self, inputDescription)

Set the description of the input field values.

setInputMesh(self, inputMesh)

Set the mesh associated to the input domain.

setName(self, name)

Accessor to the object’s name.

setOutputDescription(self, outputDescription)

Set the description of the output field values.

setOutputMesh(self, outputMesh)

Set the mesh associated to the output domain.

setShadowedId(self, id)

Accessor to the object’s shadowed id.

setVisibility(self, visible)

Accessor to the object’s visibility state.
__init__(self, \*args)

Initialize self. See help(type(self)) for accurate signature.

getCallsNumber(self)

Get the number of calls of the function.

Returns
callsNumberint

Counts the number of times the function has been called since its creation.

getClassName(self)

Accessor to the object’s name.

Returns
class_namestr

The object class name (object.__class__.__name__).

getEnclosingSimplexAlgorithm(self)

Accessor to the algorithm used to find enclosing simplex.

Returns
enclosingSimplexEnclosingSimplexAlgorithm

Enclosing simplex algorithm.

getId(self)

Accessor to the object’s id.

Returns
idint

Internal unique identifier.

getInputDescription(self)

Get the description of the input field values.

Returns
inputDescriptionDescription

Description of the input field values.

getInputDimension(self)

Get the dimension of the input field values.

Returns
dint

Dimension d of the input field values.

getInputMesh(self)

Get the mesh associated to the input domain.

Returns
inputMeshMesh

The input mesh \cM_{N'}.

getMarginal(self, \*args)

Get the marginal(s) at given indice(s).

Parameters
iint or list of ints, 0 \leq i < d'

Indice(s) of the marginal(s) to be extracted.

Returns
fieldFunctionFieldFunction

The initial function restricted to the concerned marginal(s) at the indice(s) i.

getName(self)

Accessor to the object’s name.

Returns
namestr

The name of the object.

getNearestNeighbourAlgorithm(self)

Accessor to the algorithm used to find nearest neighbours.

This algorithm is used only when point is not contained in any simplex.

Returns
nearestNeighbourNearestNeighbourAlgorithm

Nearest neighbour algorithm.

getOutputDescription(self)

Get the description of the output field values.

Returns
outputDescriptionDescription

Description of the output field values.

getOutputDimension(self)

Get the dimension of the output field values.

Returns
d’int

Dimension d' of the output field values.

getOutputMesh(self)

Get the mesh associated to the output domain.

Returns
outputMeshMesh

The output mesh \cM_{N'}.

getShadowedId(self)

Accessor to the object’s shadowed id.

Returns
idint

Internal unique identifier.

getVisibility(self)

Accessor to the object’s visibility state.

Returns
visiblebool

Visibility flag.

hasName(self)

Test if the object is named.

Returns
hasNamebool

True if the name is not empty.

hasVisibleName(self)

Test if the object has a distinguishable name.

Returns
hasVisibleNamebool

True if the name is not empty and not the default one.

isActingPointwise(self)

Whether the function acts point-wise.

Returns
pointWisebool

Returns true if the function evaluation at each vertex depends only on the vertex or the value at the vertex.

setDimension(self, dimension)

Accessor to dimension of fields which are evaluated.

Parameters
dimensionint

Dimension of input fields which are going to be evaluated.

setInputDescription(self, inputDescription)

Set the description of the input field values.

Parameters
inputDescriptionsequence of str

Description of the input field values.

setInputMesh(self, inputMesh)

Set the mesh associated to the input domain.

Parameters
inputMeshMesh

The input mesh \cM_{N'}.

setName(self, name)

Accessor to the object’s name.

Parameters
namestr

The name of the object.

setOutputDescription(self, outputDescription)

Set the description of the output field values.

Parameters
outputDescriptionsequence of str

Describes the outputs of the output field values.

setOutputMesh(self, outputMesh)

Set the mesh associated to the output domain.

Parameters
outputMeshMesh

The output mesh \cM_{N'}.

setShadowedId(self, id)

Accessor to the object’s shadowed id.

Parameters
idint

Internal unique identifier.

setVisibility(self, visible)

Accessor to the object’s visibility state.

Parameters
visiblebool

Visibility flag.