PointToFieldConnection

class PointToFieldConnection(*args)

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

Available constructors:

PointToFieldConnection(f_FieldFunction, g_PointToField)

PointToFieldConnection(f_PointToField, g_Function)

Parameters:
f_FieldFunctionFieldFunction

Function that acts on fields and produces fields

f_PointToField, g_PointToFieldPointToFieldFunction

Function that acts on points and produces fields

g_FunctionFunction

Function that acts on points and produces points

Notes

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

Methods

getCallsNumber()

Get the number of calls of the function.

getClassName()

Accessor to the object's name.

getFieldFunction()

Accessor to the function f of class FieldFunction.

getFunction()

Accessor to the function g of class Function.

getInputDescription()

Get the description of the input vector.

getInputDimension()

Get the dimension of the input vector.

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.

getPointToFieldFunction()

Accessor to the function of class PointToFieldFunction.

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.
__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__).

getFieldFunction()

Accessor to the function f of class FieldFunction.

Returns:
fFieldFunction

The function f that acts on fields to produce fields.

getFunction()

Accessor to the function g of class Function.

Returns:
gFunction

The function g that acts on points to produce points.

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.

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.

getPointToFieldFunction()

Accessor to the function of class PointToFieldFunction.

Returns:
funcPointToFieldFunction

The function f or g that acts on points to produce fields.

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.

Examples using the class

Viscous free fall: metamodel of a field function

Viscous free fall: metamodel of a field function

Define a connection function with a field output

Define a connection function with a field output