# PointToFieldFunction¶

class PointToFieldFunction(*args)

Function mapping a point into a field.

Parameters: inputDim : int, Dimension of the input vector outputMesh : Mesh The output mesh outputDim : int, Dimension of the output field

Notes

Point to field functions act on points to produce fields:

with a mesh of .

A field is represented by a collection of elements of where is a vertex of and the associated value in .

The two first constructors build an object which evaluation operator is not defined (it throws a NotYetImplementedException). The instanciation of such an object is used to extract an actual PointToFieldFunction from a Study.

Examples

>>> import openturns as ot


Use the class OpenTURNSPythonPointToFieldFunction to create a function that acts a vector of dimension and returns a field defined by:

• the mesh that discretizes into 10 regular intervalls of length 0.1 ()
• the value associated to the vertex number is ()

Using the class OpenTURNSPythonFieldToPointFunction allows to define a persistent state between the evaluations of the function.

>>> class FUNC(ot.OpenTURNSPythonPointToFieldFunction):
...     def __init__(self):
...         mesh = ot.RegularGrid(0.0, 0.1, 11)
...         super(FUNC, self).__init__(2, mesh, 2)
...         self.setInputDescription(['R', 'S'])
...         self.setOutputDescription(['T', 'U'])
...     def _exec(self, X):
...         size = self.getOutputMesh().getVerticesNumber()
...         Y = [ot.Point(X)*i for i in range(size)]
...         return Y
>>> F = FUNC()


Create the associated PointToFieldFunction:

>>> myFunc = ot.PointToFieldFunction(F)


It is also possible to create a PointToFieldFunction from a python function as follows:

>>> mesh = ot.RegularGrid(0.0, 0.1, 11)
>>> def myPyFunc(X):
...     size = 11
...     Y = [ot.Point(X)*i for i in range(size)]
...     return Y
>>> inputDim = 2
>>> outputDim = 2
>>> myFunc = ot.PythonPointToFieldFunction(inputDim, mesh, outputDim, myPyFunc)


Evaluation the function on a vector:

>>> Yfield = myFunc([1.1, 2.2])


Methods

 getCallsNumber() Get the number of calls of the function. getClassName() Accessor to the object’s name. getId() Accessor to the object’s id. getImplementation(*args) Accessor to the underlying implementation. getInputDescription() Get the description of the input vector. getInputDimension() Get the dimension of the input vector. getMarginal(*args) Get the marginal(s) at given indice(s). getName() Accessor to the object’s name. getOutputDescription() Get the description of the output field values. getOutputDimension() Get the dimension of the output field values. getOutputMesh() Get the output mesh. setInputDescription(inputDescription) Set the description of the input vector. setName(name) Accessor to the object’s name. setOutputDescription(outputDescription) Set the description of the output field values.
 __call__
__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__).
getId()

Accessor to the object’s id.

Returns: id : int Internal unique identifier.
getImplementation(*args)

Accessor to the underlying implementation.

Returns: impl : Implementation The implementation class.
getInputDescription()

Get the description of the input vector.

Returns: inputDescription : Description Description of the input vector.
getInputDimension()

Get the dimension of the input vector.

Returns: d : int Dimension of the input vector.
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. function : PointToFieldFunction 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.
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 output mesh.

Returns: outputMesh : Mesh The mesh of the output field.
setInputDescription(inputDescription)

Set the description of the input vector.

Parameters: inputDescription : sequence of str Description of the input vector.
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 Description of the output field values.