VertexFieldToPointFunction

class VertexFieldToPointFunction(*args)

Restriction of a field function at some specific nodes.

Warning

This class is experimental and likely to be modified in future releases. To use it, import the openturns.experimental submodule.

Let \cM_N be a mesh of size N, I = \{ i_0, \dots, i_{N'-1} \} \in \llbracket 0, N-1 \rrbracket be a set of indices of cardinal N' \leq N and let d \geq 1 be an integer.

A VertexFieldToPointFunction f is defined by:

f: \left| \begin{array}{rcl} \cF(\cM_N, \Rset^d ) & \rightarrow & (\Rset^d)^{N'} \\ g & \mapsto & \vect{F} \end{array} \right.

where \vect{F} is a vector such that for all k \in \llbracket 0, N'-1 \rrbracket, we have:

\vect{F}[dk:(k+1)d] = g(v_{i_k}) \in \Rset^d

where v_{i_k} is the node of index i_k of the mesh \cM_N. In other words, we have:

\vect{F} = (g(v_{i_0}), \dots, g(v_{i_{N'-1}}))

Parameters:
inputMeshMesh

Mesh, \cM_N

dimensionint

Input, output dimension, d \geq 1

indicessequence of int

Mesh indices, I

Methods

getCallsNumber()

Get the number of calls of the function.

getClassName()

Accessor to the object's name.

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.

getOutputDescription()

Get the description of the output vector.

getOutputDimension()

Get the dimension of the output vector.

hasName()

Test if the object is named.

setInputDescription(inputDescription)

Set the description of the input field values.

setName(name)

Accessor to the object's name.

setOutputDescription(outputDescription)

Set the description of the output vector.

Examples

>>> import openturns as ot
>>> import openturns.experimental as otexp
>>> N = 10
>>> mesh = ot.RegularGrid(0, 1, N)
>>> f = otexp.VertexFieldToPointFunction(mesh, 1, [-1 % N])
__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__).

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 d of the input field values.

getInputMesh()

Get the mesh associated to the input domain.

Returns:
inputMeshMesh

The input mesh \cM_{N'}.

getMarginal(*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:
functionFieldToPointFunction

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

getName()

Accessor to the object’s name.

Returns:
namestr

The name of the object.

getOutputDescription()

Get the description of the output vector.

Returns:
outputDescriptionDescription

Description of the output vector.

getOutputDimension()

Get the dimension of the output vector.

Returns:
d’int

Dimension d' of the output vector.

hasName()

Test if the object is named.

Returns:
hasNamebool

True if the name is not empty.

setInputDescription(inputDescription)

Set the description of the input field values.

Parameters:
inputDescriptionsequence of str

Description of the input field values.

setName(name)

Accessor to the object’s name.

Parameters:
namestr

The name of the object.

setOutputDescription(outputDescription)

Set the description of the output vector.

Parameters:
outputDescriptionsequence of str

Description of the output vector.