KarhunenLoeveLifting¶
- class KarhunenLoeveLifting(*args)¶
Function dedicated to the lift of Karhunen-Loeve coefficients into a field.
- Parameters:
- KLResult
KarhunenLoeveResult
The result structure created by a
KarhunenLoeveAlgorithm
- KLResult
Notes
The class
KarhunenLoeveLifting
is a specific functionPointToFieldFunction
dedicated to the lift of Karhunen-Loeve coefficients into a field.See the documentation of
KarhunenLoeveResult
to get information on the lift function.The function acts on a vector of coefficients (
Point
) to create a field associated to the Karhunen-Loeve mesh (Mesh
).Methods
Get the number of calls of the function.
Accessor to the object's name.
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.
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__).
- 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. output vector.
- Returns:
- function
KarhunenLoeveLifting
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.
- 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