P1LagrangeInterpolation

(Source code, svg)

class P1LagrangeInterpolation(*args)

P1 interpolation of values between two meshes.

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.

Default algorithm is BoundingVolumeHierarchy built on the vertices and simplices of the inputMesh.

nearestNeighbourNearestNeighbourAlgorithm

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

Default algorithm is KDTree built on the vertices of the inputMesh.

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.
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.
hasName()	Test if the object is named.
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.

Notes

A P1LagrangeInterpolation is a particular FieldFunction. It allows one to evaluate a FieldFunction defined on a mesh (inputMesh) on another mesh (outputMesh) by piecewise linear interpolation.

The P1LagrangeInterpolation builds a projection matrix between the inputMesh and the outputMesh. Then, when evaluated on the field values attached to the inputMesh, it returns the field values attached to the outputMesh.

The dimension of the field values can change. But the dimension of both meshes must be the same.

__init__(*args)

getCallsNumber()

Get the number of calls of the function.

Returns:

callsNumberint

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

getClassName()

Accessor to the object’s name.

Returns:

class_namestr

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

getEnclosingSimplexAlgorithm()

Accessor to the algorithm used to find enclosing simplex.

Returns:

enclosingSimplexEnclosingSimplexAlgorithm

Enclosing simplex algorithm.

getInputDescription()

Get the description of the input field values.

Returns:

inputDescriptionDescription

Description of the input field values.

getInputDimension()

Get the dimension of the input field values.

Returns:

dint

Dimension of the input field values.

getInputMesh()

Get the mesh associated to the input domain.

Returns:

inputMeshMesh

The input mesh .

getMarginal(*args)

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

Parameters:

iint or list of ints,

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

Returns:

fieldFunctionFieldFunction

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

getName()

Accessor to the object’s name.

Returns:

namestr

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:

nearestNeighbourNearestNeighbourAlgorithm

Nearest neighbour algorithm.

getOutputDescription()

Get the description of the output field values.

Returns:

outputDescriptionDescription

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:

outputMeshMesh

The output mesh .

hasName()

Test if the object is named.

Returns:

hasNamebool

True if the name is not empty.

isActingPointwise()

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(dimension)

Accessor to dimension of fields which are evaluated.

Parameters:

dimensionint

Dimension of input fields which are going to be evaluated.

setInputDescription(inputDescription)

Set the description of the input field values.

Parameters:

inputDescriptionsequence of str

Description of the input field values.

setInputMesh(inputMesh)

Set the mesh associated to the input domain.

Parameters:

inputMeshMesh

The input mesh .

setName(name)

Accessor to the object’s name.

Parameters:

namestr

The name of the object.

setOutputDescription(outputDescription)

Set the description of the output field values.

Parameters:

outputDescriptionsequence of str

Describes the outputs of the output field values.

setOutputMesh(outputMesh)

Set the mesh associated to the output domain.

Parameters:

outputMeshMesh

The output mesh .