PythonFieldFunction

class PythonFieldFunction(inputMesh, inputDim, outputMesh, outputDim, func=None)

Override FieldFunction from Python.

Parameters:

inputMeshMesh

The input mesh

inputDimint,

Dimension of the values of the input field

outputMeshMesh

The output mesh

outputDimint,

Dimension of the values of the output field

funca callable python object

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

Examples

>>> import openturns as ot
>>> mesh = ot.Mesh(1)
>>> def myPyFunc(X):
...     mesh = X.getMesh()
...     values = X.getValues() * ([2.0]*X.getValues().getDimension())
...     values.setDescription(ot.Description.BuildDefault(values.getDimension(), 'Y'))
...     Y = ot.Field(mesh, values)
...     return Y
>>> inputDim = 2
>>> outputDim = 2
>>> myFunc = ot.PythonFieldFunction(mesh, inputDim, mesh, outputDim, myPyFunc)

Methods

__call__(*args)	Call self as a function.
getCallsNumber()	Get the number of calls of the function.
getClassName()	Accessor to the object's name.
getId()	Accessor to the object's id.
getImplementation()	Accessor to the underlying implementation.
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 field values.
getOutputDimension()	Get the dimension of the output field values.
getOutputMesh()	Get the mesh associated to the output domain.
isActingPointwise()	Whether the function acts point-wise.
setInputMesh(inputMesh)	Set the mesh associated to the input domain.
setName(name)	Accessor to the object's name.
setOutputMesh(outputMesh)	Set the mesh associated to the output domain.

__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__).

getId()

Accessor to the object’s id.

Returns:

idint

Internal unique identifier.

getImplementation()

Accessor to the underlying implementation.

Returns:

implImplementation

A copy of the underlying implementation object.

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.

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 .

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.

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.

setOutputMesh(outputMesh)

Set the mesh associated to the output domain.

Parameters:

outputMeshMesh

The output mesh .