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

__call__(self, \*args)

Call self as a function.

getCallsNumber(self)

Get the number of calls of the function.

getClassName(self)

Accessor to the object’s name.

getFieldFunction(self)

Accessor to the function f of class FieldFunction.

getFunction(self)

Accessor to the function g of class Function.

getId(self)

Accessor to the object’s id.

getInputDescription(self)

Get the description of the input vector.

getInputDimension(self)

Get the dimension of the input vector.

getMarginal(self, \*args)

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

getName(self)

Accessor to the object’s name.

getOutputDescription(self)

Get the description of the output field values.

getOutputDimension(self)

Get the dimension of the output field values.

getOutputMesh(self)

Get the output mesh.

getPointToFieldFunction(self)

Accessor to the function of class PointToFieldFunction.

getShadowedId(self)

Accessor to the object’s shadowed id.

getVisibility(self)

Accessor to the object’s visibility state.

hasName(self)

Test if the object is named.

hasVisibleName(self)

Test if the object has a distinguishable name.

setInputDescription(self, inputDescription)

Set the description of the input vector.

setName(self, name)

Accessor to the object’s name.

setOutputDescription(self, outputDescription)

Set the description of the output field values.

setShadowedId(self, id)

Accessor to the object’s shadowed id.

setVisibility(self, visible)

Accessor to the object’s visibility state.
__init__(self, \*args)

Initialize self. See help(type(self)) for accurate signature.

getCallsNumber(self)

Get the number of calls of the function.

Returns
callsNumberint

Counts the number of times the function has been called since its creation.

getClassName(self)

Accessor to the object’s name.

Returns
class_namestr

The object class name (object.__class__.__name__).

getFieldFunction(self)

Accessor to the function f of class FieldFunction.

Returns
fFieldFunction

The function f that acts on fields to produce fields.

getFunction(self)

Accessor to the function g of class Function.

Returns
gFunction

The function g that acts on points to produce points.

getId(self)

Accessor to the object’s id.

Returns
idint

Internal unique identifier.

getInputDescription(self)

Get the description of the input vector.

Returns
inputDescriptionDescription

Description of the input vector.

getInputDimension(self)

Get the dimension of the input vector.

Returns
dint

Dimension d of the input vector.

getMarginal(self, \*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(self)

Accessor to the object’s name.

Returns
namestr

The name of the object.

getOutputDescription(self)

Get the description of the output field values.

Returns
outputDescriptionDescription

Description of the output field values.

getOutputDimension(self)

Get the dimension of the output field values.

Returns
d’int

Dimension d' of the output field values.

getOutputMesh(self)

Get the output mesh.

Returns
outputMeshMesh

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

getPointToFieldFunction(self)

Accessor to the function of class PointToFieldFunction.

Returns
funcPointToFieldFunction

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

getShadowedId(self)

Accessor to the object’s shadowed id.

Returns
idint

Internal unique identifier.

getVisibility(self)

Accessor to the object’s visibility state.

Returns
visiblebool

Visibility flag.

hasName(self)

Test if the object is named.

Returns
hasNamebool

True if the name is not empty.

hasVisibleName(self)

Test if the object has a distinguishable name.

Returns
hasVisibleNamebool

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

setInputDescription(self, inputDescription)

Set the description of the input vector.

Parameters
inputDescriptionsequence of str

Description of the input vector.

setName(self, name)

Accessor to the object’s name.

Parameters
namestr

The name of the object.

setOutputDescription(self, outputDescription)

Set the description of the output field values.

Parameters
outputDescriptionsequence of str

Description of the output field values.

setShadowedId(self, id)

Accessor to the object’s shadowed id.

Parameters
idint

Internal unique identifier.

setVisibility(self, visible)

Accessor to the object’s visibility state.

Parameters
visiblebool

Visibility flag.