FieldToFieldConnection¶

class FieldToFieldConnection(*args)¶

Composition function $f \circ g$ where $g$ acts on fields and $f$ produces fields.

Available constructors:

FieldToPointConnection(f_FieldFunction, g_FieldFunction)

FieldToPointConnection(f_PointToField, g_FieldToPoint)

Parameters:

f_FieldFunction, g_FieldFunctionFieldFunction: Function that acts on fields and produces fields
g_FieldToPointFieldToPointFunction: Function that acts on fields and produces points
f_PointToFieldPointToFieldFunction: Function that acts on points and produces points

Notes

This class is a particular case of the general class FieldFunction. Thus it doesn’t implement the gradient nor the hessian.

Methods

`__call__`(*args)	Call self as a function.
`getCallsNumber`()	Get the number of calls of the function.
`getClassName`()	Accessor to the object's name.
`getFieldToPointFunction`()	Accessor to the function $g$ of class `FieldToPointFunction`.
`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.
`getInputMesh`()	Get the mesh associated to the input domain.
`getLeftFieldFunction`()	Accessor to the function $f$ of class `FieldFunction`.
`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.
`getPointToFieldFunction`()	Accessor to the function $f$ of class `PointToFieldFunction`.
`getRightFieldFunction`()	Accessor to the function $g$ of class `FieldFunction`.
`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.
`isActingPointwise`()	Whether the function acts point-wise.
`setInputDescription`(inputDescription)	Set the description of the input field values.
`setInputMesh`(inputMesh)	Set the mesh associated to the input domain.
`setName`(name)	Accessor to the object's name.
`setOutputDescription`(outputDescription)	Set the description of the output field values.
`setOutputMesh`(outputMesh)	Set the mesh associated to the output domain.
`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__).

getFieldToPointFunction()¶

Accessor to the function $g$ of class FieldToPointFunction.

Returns:

gFieldToPointFunction: The function $g$ that acts on fields to produce points.

getId()¶

Accessor to the object’s id.

Returns:

idint: Internal unique identifier.

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 $d$ of the input field values.

getInputMesh()¶

Get the mesh associated to the input domain.

Returns:

inputMeshMesh: The input mesh $\cM_{N'}$ .

getLeftFieldFunction()¶

Accessor to the function $f$ of class FieldFunction.

Returns:

fFieldFunction: The function $f$ that acts on fields to produce fields.

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:

fieldFunctionFieldFunction: 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 mesh associated to the output domain.

Returns:

outputMeshMesh: The output mesh $\cM_{N'}$ .

getPointToFieldFunction()¶

Accessor to the function $f$ of class PointToFieldFunction.

Returns:

fPointToFieldFunction: The function $f$ that acts on points to produce fields.

getRightFieldFunction()¶

Accessor to the function $g$ of class FieldFunction.

Returns:

gFieldFunction: The function $g$ that acts on fields to produce fields.

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.

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.

setInputDescription(inputDescription)¶

Set the description of the input field values.

Parameters:

inputDescriptionsequence of str: Description of the input field values.

setInputMesh(inputMesh)¶

Set the mesh associated to the input domain.

Parameters:

inputMeshMesh: The input mesh $\cM_{N'}$ .

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: Describes the outputs of the output field values.

setOutputMesh(outputMesh)¶

Set the mesh associated to the output domain.

Parameters:

outputMeshMesh: The output mesh $\cM_{N'}$ .

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.

Examples using the class¶

Metamodel of a field function

OpenTURNS

An Open source initiative for the Treatment of Uncertainties, Risks'N Statistics

Table of Contents

Previous topic

Next topic

This Page

FieldToFieldConnection¶

Examples using the class¶