# PointToFieldConnection¶

class PointToFieldConnection(*args)

Composition function where acts on points and produces fields.

Available constructors:

PointToFieldConnection(f_FieldFunction, g_PointToField)

PointToFieldConnection(f_PointToField, g_Function)

Parameters: f_FieldFunction : FieldFunction Function that acts on fields and produces fields f_PointToField, g_PointToField : PointToFieldFunction Function that acts on points and produces fields g_Function : Function 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 of class FieldFunction. getFunction() Accessor to the function of class Function. getId() Accessor to the object’s id. 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. 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. setShadowedId(id) Accessor to the object’s shadowed id. setVisibility(visible) Accessor to the object’s visibility state.
 __call__
__init__(*args)

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

getCallsNumber()

Get the number of calls of the function.

Returns: callsNumber : int Counts the number of times the function has been called since its creation.
getClassName()

Accessor to the object’s name.

Returns: class_name : str The object class name (object.__class__.__name__).
getFieldFunction()

Accessor to the function of class FieldFunction.

Returns: f : FieldFunction The function that acts on fields to produce fields.
getFunction()

Accessor to the function of class Function.

Returns: g : Function The function that acts on points to produce points.
getId()

Accessor to the object’s id.

Returns: id : int Internal unique identifier.
getInputDescription()

Get the description of the input vector.

Returns: inputDescription : Description Description of the input vector.
getInputDimension()

Get the dimension of the input vector.

Returns: d : int Dimension of the input vector.
getMarginal(*args)

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

Parameters: i : int or list of ints, Indice(s) of the marginal(s) to be extracted. function : PointToFieldFunction The initial function restricted to the concerned marginal(s) at the indice(s) .
getName()

Accessor to the object’s name.

Returns: name : str The name of the object.
getOutputDescription()

Get the description of the output field values.

Returns: outputDescription : Description Description of the output field values.
getOutputDimension()

Get the dimension of the output field values.

Returns: d’ : int Dimension of the output field values.
getOutputMesh()

Get the output mesh.

Returns: outputMesh : Mesh The mesh of the output field.
getPointToFieldFunction()

Accessor to the function of class PointToFieldFunction.

Returns: func : PointToFieldFunction The function or that acts on points to produce fields.
getShadowedId()

Accessor to the object’s shadowed id.

Returns: id : int Internal unique identifier.
getVisibility()

Accessor to the object’s visibility state.

Returns: visible : bool Visibility flag.
hasName()

Test if the object is named.

Returns: hasName : bool True if the name is not empty.
hasVisibleName()

Test if the object has a distinguishable name.

Returns: hasVisibleName : bool True if the name is not empty and not the default one.
setInputDescription(inputDescription)

Set the description of the input vector.

Parameters: inputDescription : sequence of str Description of the input vector.
setName(name)

Accessor to the object’s name.

Parameters: name : str The name of the object.
setOutputDescription(outputDescription)

Set the description of the output field values.

Parameters: outputDescription : sequence of str Description of the output field values.
setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters: id : int Internal unique identifier.
setVisibility(visible)

Accessor to the object’s visibility state.

Parameters: visible : bool Visibility flag.