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
- f_FieldFunction
Notes
This class is a particular case of the general class
PointToFieldFunction
. Thus it doesn’t implement the gradient nor the hessian.Methods
Get the number of calls of the function.
Accessor to the object's name.
Accessor to the function of class
FieldFunction
.Accessor to the function of class
Function
.Get the description of the input vector.
Get the dimension of the input vector.
getMarginal
(*args)Get the marginal(s) at given indice(s).
getName
()Accessor to the object's name.
Get the description of the output field values.
Get the dimension of the output field values.
Get the output mesh.
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 of class
FieldFunction
.- Returns:
- f
FieldFunction
The function that acts on fields to produce fields.
- f
- getFunction()¶
Accessor to the function of class
Function
.- Returns:
- g
Function
The function that acts on points to produce points.
- g
- getInputDescription()¶
Get the description of the input vector.
- Returns:
- inputDescription
Description
Description of the input vector.
- inputDescription
- getInputDimension()¶
Get the dimension of the input vector.
- Returns:
- dint
Dimension of the input vector.
- getMarginal(*args)¶
Get the marginal(s) at given indice(s).
- Parameters:
- iint or list of ints,
Indice(s) of the marginal(s) to be extracted.
- Returns:
- function
PointToFieldFunction
The initial function restricted to the concerned marginal(s) at the indice(s) .
- function
- getName()¶
Accessor to the object’s name.
- Returns:
- namestr
The name of the object.
- getOutputDescription()¶
Get the description of the output field values.
- Returns:
- outputDescription
Description
Description of the output field values.
- outputDescription
- getOutputDimension()¶
Get the dimension of the output field values.
- Returns:
- d’int
Dimension of the output field values.
- getPointToFieldFunction()¶
Accessor to the function of class
PointToFieldFunction
.- Returns:
- func
PointToFieldFunction
The function or that acts on points to produce fields.
- func
- 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
Define a connection function with a field output