ValueFunction¶
-
class
ValueFunction
(*args)¶ Function mapping a field to a field.
- Available constructors:
ValueFunction(spatialDim=1)
ValueFunction(g, spatialDim=1)
Parameters: - g :
Function
Function
.
- spatialDim : int,
Dimension
of the domain
.
See also
FieldFunction
,VertexFunction
,VertexValueFunction
,OpenTURNSPythonFunction
,PythonFunction
Notes
Value functions act on fields to produce fields such that:
with
,
and
a mesh of
.
A value function keeps the mesh unchanged: the input mesh is equal to the output mesh.
The field
is defined by the function
:
The first constructor builds an object which evaluation operator is not defined (it throws a NotYetImplementedException). The instanciation of such an object is used to extract an actual
ValueFunction
from aStudy
.Examples
>>> import openturns as ot
Create the function
defined by:
>>> g = ot.SymbolicFunction('x', 'x^2')
Convert
into a value function with
the dimension of the mesh of the field on which
will be applied:
>>> n = 1 >>> myValueFunction = ot.ValueFunction(g, n) >>> # Create a TimeSeries >>> tg = ot.RegularGrid(0.0, 0.2, 6) >>> data = ot.Sample(tg.getN(), g.getInputDimension()) >>> for i in range(data.getSize()): ... for j in range(data.getDimension()): ... data[i, j] = i * data.getDimension() + j >>> ts = ot.TimeSeries(tg, data) >>> print(ts) [ t v0 ] 0 : [ 0 0 ] 1 : [ 0.2 1 ] 2 : [ 0.4 2 ] 3 : [ 0.6 3 ] 4 : [ 0.8 4 ] 5 : [ 1 5 ] >>> print(myValueFunction(ts)) [ t y0 ] 0 : [ 0 0 ] 1 : [ 0.2 1 ] 2 : [ 0.4 4 ] 3 : [ 0.6 9 ] 4 : [ 0.8 16 ] 5 : [ 1 25 ]
Methods
getCallsNumber
()Get the number of calls of the function. getClassName
()Accessor to the object’s name. getFunction
()Get the function .
getId
()Accessor to the object’s id. getInputDescription
()Get the description of the input field values. getInputDimension
()Get the dimension of the input field values. 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
(inputMesh)Get the mesh associated to the output domain. getShadowedId
()Accessor to the object’s shadowed id. getSpatialDimension
()Get the dimension of the input domain. getVisibility
()Accessor to the object’s visibility state. hasName
()Test if the object is named. hasVisibleName
()Test if the object has a distinguishable name. 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 field values. setShadowedId
(id)Accessor to the object’s shadowed id. setVisibility
(visible)Accessor to the object’s visibility state. __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__).
-
getFunction
()¶ Get the function
.
Returns: - g :
Function
Function
.
Examples
>>> import openturns as ot >>> g = ot.SymbolicFunction('x', 'x^2') >>> n = 1 >>> myValueFunction = ot.ValueFunction(g, n) >>> print(myValueFunction.getFunction()) [x]->[x^2]
- g :
-
getId
()¶ Accessor to the object’s id.
Returns: - id : int
Internal unique identifier.
-
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: - d : int
Dimension
of the input field values.
-
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.
Returns: - function :
ValueFunction
The initial function restricted to the concerned marginal(s) at the indice(s)
.
- i : int or list of ints,
-
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.
- outputDescription :
-
getOutputDimension
()¶ Get the dimension of the output field values.
Returns: - d’ : int
Dimension
of the output field values.
-
getOutputMesh
(inputMesh)¶ Get the mesh associated to the output domain.
Returns: - outputMesh :
Mesh
The output mesh
.
- outputMesh :
-
getShadowedId
()¶ Accessor to the object’s shadowed id.
Returns: - id : int
Internal unique identifier.
-
getSpatialDimension
()¶ Get the dimension of the input domain.
Returns: - spatialDim : int,
Dimension
of the input domain
.
-
getVisibility
()¶ Accessor to the object’s visibility state.
Returns: - visible : bool
Visibility flag.
-
hasName
()¶ Test if the object is named.
Returns: - hasName : bool
True if the name is not empty.
-
hasVisibleName
()¶ Test if the object has a distinguishable name.
Returns: - hasVisibleName : bool
True if the name is not empty and not the default one.
-
setInputDescription
(inputDescription)¶ Set the description of the input field values.
Parameters: - inputDescription : sequence of str
Description of the input field values.
-
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
Describes the outputs of the output field values.
-
setShadowedId
(id)¶ Accessor to the object’s shadowed id.
Parameters: - id : int
Internal unique identifier.
-
setVisibility
(visible)¶ Accessor to the object’s visibility state.
Parameters: - visible : bool
Visibility flag.