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
functionPointToFieldFunction

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.

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

__call__(*args)

Call self as a function.

getCallsNumber()

Get the number of calls of the function.

getClassName()

Accessor to the object's name.

getFunction()

Function accessor.

getId()

Accessor to the object's id.

getInputDescription()

Get the description of the input vector.

getInputDimension()

Get the dimension of the input vector.

getInputPositions()

Indices positions accessor.

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.

getParameter()

Parameter accessor.

getParametersPositions()

Parameters positions accessor.

getShadowedId()

Accessor to the object's shadowed id.

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 vector.

setName(name)

Accessor to the object's name.

setOutputDescription(outputDescription)

Set the description of the output field values.

setParameter(parameter)

Parameter accessor.

setShadowedId(id)

Accessor to the object's shadowed id.

setVisibility(visible)

Accessor to the object's visibility state.
__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
functionPointToFieldFunction

Function with full parameters from which the parametric function is built.

getId()

Accessor to the object’s id.

Returns
idint

Internal unique identifier.

getInputDescription()

Get the description of the input vector.

Returns
inputDescriptionDescription

Description of the input vector.

getInputDimension()

Get the dimension of the input vector.

Returns
dint

Dimension d of the input vector.

getInputPositions()

Indices positions accessor.

Returns
indicesIndices

Positions of the inputs in the underlying function.

getMarginal(*args)

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

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

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

Returns
functionPointToFieldFunction

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

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

getOutputMesh()

Get the output mesh.

Returns
outputMeshMesh

The mesh \cM_{N'} of the output field.

getParameter()

Parameter accessor.

Returns
parameterPoint

Parameter value.

getParametersPositions()

Parameters positions accessor.

Returns
parameters_positionsIndices

Positions of the parameters in the underlying function.

getShadowedId()

Accessor to the object’s shadowed id.

Returns
idint

Internal unique identifier.

getVisibility()

Accessor to the object’s visibility state.

Returns
visiblebool

Visibility flag.

hasName()

Test if the object is named.

Returns
hasNamebool

True if the name is not empty.

hasVisibleName()

Test if the object has a distinguishable name.

Returns
hasVisibleNamebool

True if the name is not empty and not the default one.

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.

setParameter(parameter)

Parameter accessor.

Parameters
parameterPoint

Parameter value.

setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters
idint

Internal unique identifier.

setVisibility(visible)

Accessor to the object’s visibility state.

Parameters
visiblebool

Visibility flag.