# 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: inputMesh : Mesh Input mesh. outputMesh : Mesh Output mesh. dimension : int Dimension of fields to evaluate. enclosingSimplex : EnclosingSimplexAlgorithm 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. nearestNeighbour : NearestNeighbourAlgorithm 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

 getCallsNumber() Get the number of calls of the function. getClassName() Accessor to the object’s name. getEnclosingSimplexAlgorithm() Accessor to the algorithm used to find enclosing simplex. getId() Accessor to the object’s id. getInputDescription() Get the description of the input field values. getInputDimension() Get the dimension of the input field values. getInputMesh() Get the mesh associated to the input domain. getMarginal(*args) Get the marginal(s) at given indice(s). getName() Accessor to the object’s name. getNearestNeighbourAlgorithm() Accessor to the algorithm used to find nearest neighbours. getOutputDescription() Get the description of the output field values. getOutputDimension() Get the dimension of the output field values. getOutputMesh() Get the mesh associated to the output domain. getShadowedId() Accessor to the object’s shadowed id. getVisibility() Accessor to the object’s visibility state. hasName() Test if the object is named. hasVisibleName() Test if the object has a distinguishable name. isActingPointwise() Whether the function acts point-wise. setDimension(dimension) Accessor to dimension of fields which are evaluated. setInputDescription(inputDescription) Set the description of the input field values. setInputMesh(inputMesh) Set the mesh associated to the input domain. setName(name) Accessor to the object’s name. setOutputDescription(outputDescription) Set the description of the output field values. setOutputMesh(outputMesh) Set the mesh associated to the output domain. setShadowedId(id) Accessor to the object’s shadowed id. setVisibility(visible) Accessor to the object’s visibility state.
 __call__ getSpatialDimension
__init__(*args)

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

getCallsNumber()

Get the number of calls of the function.

Returns: callsNumber : int Counts the number of times the function has been called since its creation.
getClassName()

Accessor to the object’s name.

Returns: class_name : str The object class name (object.__class__.__name__).
getEnclosingSimplexAlgorithm()

Accessor to the algorithm used to find enclosing simplex.

Returns: enclosingSimplex : EnclosingSimplexAlgorithm Enclosing simplex algorithm.
getId()

Accessor to the object’s id.

Returns: id : int Internal unique identifier.
getInputDescription()

Get the description of the input field values.

Returns: inputDescription : Description Description of the input field values.
getInputDimension()

Get the dimension of the input field values.

Returns: d : int Dimension of the input field values.
getInputMesh()

Get the mesh associated to the input domain.

Returns: inputMesh : Mesh The input mesh .
getMarginal(*args)

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

Parameters: i : int or list of ints, Indice(s) of the marginal(s) to be extracted. fieldFunction : FieldFunction The initial function restricted to the concerned marginal(s) at the indice(s) .
getName()

Accessor to the object’s name.

Returns: name : str The name of the object.
getNearestNeighbourAlgorithm()

Accessor to the algorithm used to find nearest neighbours.

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

Returns: nearestNeighbour : NearestNeighbourAlgorithm Nearest neighbour algorithm.
getOutputDescription()

Get the description of the output field values.

Returns: outputDescription : Description Description of the output field values.
getOutputDimension()

Get the dimension of the output field values.

Returns: d’ : int Dimension of the output field values.
getOutputMesh()

Get the mesh associated to the output domain.

Returns: outputMesh : Mesh The output mesh .
getShadowedId()

Accessor to the object’s shadowed id.

Returns: id : int Internal unique identifier.
getVisibility()

Accessor to the object’s visibility state.

Returns: visible : bool Visibility flag.
hasName()

Test if the object is named.

Returns: hasName : bool True if the name is not empty.
hasVisibleName()

Test if the object has a distinguishable name.

Returns: hasVisibleName : bool True if the name is not empty and not the default one.
isActingPointwise()

Whether the function acts point-wise.

Returns: pointWise : bool Returns true if the function evaluation at each vertex depends only on the vertex or the value at the vertex.
setDimension(dimension)

Accessor to dimension of fields which are evaluated.

Parameters: dimension : int Dimension of input fields which are going to be evaluated.
setInputDescription(inputDescription)

Set the description of the input field values.

Parameters: inputDescription : sequence of str Description of the input field values.
setInputMesh(inputMesh)

Set the mesh associated to the input domain.

Parameters: inputMesh : Mesh The input mesh .
setName(name)

Accessor to the object’s name.

Parameters: name : str The name of the object.
setOutputDescription(outputDescription)

Set the description of the output field values.

Parameters: outputDescription : sequence of str Describes the outputs of the output field values.
setOutputMesh(outputMesh)

Set the mesh associated to the output domain.

Parameters: outputMesh : Mesh The output mesh .
setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters: id : int Internal unique identifier.
setVisibility(visible)

Accessor to the object’s visibility state.

Parameters: visible : bool Visibility flag.