PythonPointToFieldFunction

class PythonPointToFieldFunction(*args)

Override PointToFieldFunction from Python.

Parameters:
inputDim : positive int

Dimension of the input vector d

outputMesh : Mesh

The output mesh

outputDim : positive int

Dimension of the output field values d’

func : a callable python object

called on a Field object. Returns a Field. Default is None.

Examples

>>> import openturns as ot
>>> 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 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 d of the input vector.

getMarginal(*args)

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

Parameters:
i : int or list of ints, 0 \leq i < d

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

Returns:
function : PointToFieldFunction

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

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

getOutputMesh()

Get the output mesh.

Returns:
outputMesh : Mesh

The mesh \cM_{N'} 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.