ParametricPointToFieldFunction¶
- class ParametricPointToFieldFunction(*args)¶
Parametric Point to Field function.
It defines a parametric function from function by freezing the variables marked by the indices set to the values of referencePoint.
- Parameters:
- function
PointToFieldFunction
Function with full parameters from which the parametric function is built.
- indicessequence of int
Indices of the frozen variables.
- referencePointsequence of float
Values of the frozen variables. Must be of size of indices.
- function
Examples
>>> import openturns as ot >>> size = 5 >>> mesh = ot.RegularGrid(0.0, 0.1, size) >>> def f(X): ... Y = [ot.Point(X)*i for i in range(size)] ... return Y >>> inputDim = 2 >>> outputDim = 2 >>> function = ot.PythonPointToFieldFunction(inputDim, mesh, outputDim, f)
Then create another function by freezing the parameter x2=5.0:
>>> g = ot.ParametricPointToFieldFunction(function, [1], [5.0]) >>> print(g.getInputDescription()) [x0] >>> print(g([1.0])) [ y0 y1 ] 0 : [ 0 0 ] 1 : [ 1 5 ] 2 : [ 2 10 ] 3 : [ 3 15 ] 4 : [ 4 20 ]
Methods
Get the number of calls of the function.
Accessor to the object's name.
Function accessor.
Get the description of the input vector.
Get the dimension of the input vector.
Indices positions accessor.
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 output mesh.
Parameter accessor.
Parameters positions accessor.
hasName
()Test if the object is named.
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.
setParameter
(parameter)Parameter accessor.
- __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__).
- getFunction()¶
Function accessor.
- Returns:
- function
PointToFieldFunction
Function with full parameters from which the parametric function is built.
- function
- getInputDescription()¶
Get the description of the input vector.
- Returns:
- inputDescription
Description
Description of the input vector.
- inputDescription
- getInputDimension()¶
Get the dimension of the input vector.
- Returns:
- dint
Dimension of the input vector.
- getInputPositions()¶
Indices positions accessor.
- Returns:
- indices
Indices
Positions of the inputs in the underlying function.
- indices
- 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:
- function
PointToFieldFunction
The initial function restricted to the concerned marginal(s) at the indice(s) .
- function
- 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.
- getParametersPositions()¶
Parameters positions accessor.
- Returns:
- parameters_positions
Indices
Positions of the parameters in the underlying function.
- parameters_positions
- hasName()¶
Test if the object is named.
- Returns:
- hasNamebool
True if the name is not empty.
- setInputDescription(inputDescription)¶
Set the description of the input vector.
- Parameters:
- inputDescriptionsequence of str
Description of the input vector.
- setName(name)¶
Accessor to the object’s name.
- Parameters:
- namestr
The name of the object.
- setOutputDescription(outputDescription)¶
Set the description of the output field values.
- Parameters:
- outputDescriptionsequence of str
Description of the output field values.