FieldFunction¶
- class FieldFunction(*args)¶
Function mapping a field to a field.
- Parameters:
Notes
Field functions act on fields to produce fields:
with a mesh of , a mesh of .
A field is represented by a collection of elements of where is a vertex of and the associated value in .
The constructor builds an object which evaluation operator is not defined (it throws a NotYetImplementedException). The instantiation of such an object is used to extract an actual
FieldFunction
from aStudy
.Examples
>>> import openturns as ot
Using the class
OpenTURNSPythonFieldFunction
allows one to define a persistent state between the evaluations of the function.>>> class FUNC(ot.OpenTURNSPythonFieldFunction): ... def __init__(self): ... # first argument: ... mesh = ot.RegularGrid(0.0, 0.1, 11) ... super(FUNC, self).__init__(mesh, 2, mesh, 2) ... self.setInputDescription(['R', 'S']) ... self.setOutputDescription(['T', 'U']) ... def _exec(self, X): ... Xs = ot.Sample(X) ... Y = Xs * ([2.0]*Xs.getDimension()) ... return Y >>> F = FUNC()
Create the associated FieldFunction:
>>> myFunc = ot.FieldFunction(F)
It is also possible to create a FieldFunction from a python function as follows:
>>> mesh = ot.RegularGrid(0.0, 0.1, 11) >>> def myPyFunc(X): ... Xs = ot.Sample(X) ... values = Xs * ([2.0]*Xs.getDimension()) ... return values >>> inputDim = 2 >>> outputDim = 2 >>> myFunc = ot.PythonFieldFunction(mesh, inputDim, mesh, outputDim, myPyFunc)
Evaluate the function on a field:
>>> X = ot.Field(mesh, ot.Normal(2).getSample(11)) >>> Y = myFunc(X)
Methods
Get the number of calls of the function.
Accessor to the object's name.
getId
()Accessor to the object's id.
Accessor to the underlying implementation.
Get the description of the input field values.
Get the dimension of the input field values.
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.
Get the description of the output field values.
Get the dimension of the output field values.
Get the mesh associated to the output domain.
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:
- inputDescription
Description
Description of the input field values.
- inputDescription
- getInputDimension()¶
Get the dimension of the input field values.
- Returns:
- dint
Dimension of the input field values.
- 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:
- fieldFunction
FieldFunction
The initial function restricted to the concerned marginal(s) at the indice(s) .
- fieldFunction
- getName()¶
Accessor to the object’s name.
- Returns:
- namestr
The name of the object.
- getOutputDescription()¶
Get the description of the output field values.
- Returns:
- outputDescription
Description
Description of the output field values.
- outputDescription
- 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:
- outputMesh
Mesh
The output mesh .
- outputMesh
- 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:
- inputMesh
Mesh
The input mesh .
- inputMesh
- setName(name)¶
Accessor to the object’s name.
- Parameters:
- namestr
The name of the object.