FunctionalChaosSobolIndices¶
-
class
FunctionalChaosSobolIndices
(*args)¶ Sensitivity analysis based on functional chaos expansion.
- Available constructors:
- FunctionalChaosSobolIndices(functionalChaosResult)
Parameters: - functionalChaosResult :
FunctionalChaosResult
A functional chaos result resulting from a polynomial chaos decomposition.
Notes
This structure is created from a FunctionalChaosResult in order to evaluate the Sobol indices associated to the polynomial chaos decomposition of the model.
Methods
getClassName
()Accessor to the object’s name. getFunctionalChaosResult
()Accessor to the functional chaos result. getId
()Accessor to the object’s id. getName
()Accessor to the object’s name. getShadowedId
()Accessor to the object’s shadowed id. getSobolGroupedIndex
(*args)Get the grouped Sobol indices. getSobolIndex
(*args)Get the Sobol indices. getSobolTotalIndex
(*args)Get the total Sobol indices. getVisibility
()Accessor to the object’s visibility state. hasName
()Test if the object is named. hasVisibleName
()Test if the object has a distinguishable name. setName
(name)Accessor to the object’s name. setShadowedId
(id)Accessor to the object’s shadowed id. setVisibility
(visible)Accessor to the object’s visibility state. summary
()Summary accessor. -
__init__
(*args)¶ Initialize self. See help(type(self)) for accurate signature.
-
getClassName
()¶ Accessor to the object’s name.
Returns: - class_name : str
The object class name (object.__class__.__name__).
-
getFunctionalChaosResult
()¶ Accessor to the functional chaos result.
Returns: - functionalChaosResult :
FunctionalChaosResult
The functional chaos result resulting from a polynomial chaos decomposition.
- functionalChaosResult :
-
getId
()¶ Accessor to the object’s id.
Returns: - id : int
Internal unique identifier.
-
getName
()¶ Accessor to the object’s name.
Returns: - name : str
The name of the object.
-
getShadowedId
()¶ Accessor to the object’s shadowed id.
Returns: - id : int
Internal unique identifier.
-
getSobolGroupedIndex
(*args)¶ Get the grouped Sobol indices.
Parameters: - i : int or sequence of int,
Indice(s) of the variable(s) we want the associated grouped Sobol indices.
is the dimension of the input variables.
Returns: - s : float
The grouped Sobol indice.
- i : int or sequence of int,
-
getSobolIndex
(*args)¶ Get the Sobol indices.
Parameters: - i : int or sequence of int,
Indice(s) of the variable(s) we want the associated Sobol indices.
is the dimension of the input variables.
- out_marginal : int
Output marginal Default value is 0
Returns: - s : float
The Sobol indice.
- i : int or sequence of int,
-
getSobolTotalIndex
(*args)¶ Get the total Sobol indices.
Parameters: - i : int or sequence of int,
Indice(s) of the variable(s) we want the associated total Sobol indices.
is the dimension of the input variables.
- out_marginal : int
Output marginal Default value is 0
Returns: - s : float
The total Sobol indice.
- i : int or sequence of int,
-
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.
-
setName
(name)¶ Accessor to the object’s name.
Parameters: - name : str
The name of the object.
-
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.
-
summary
()¶ Summary accessor.
Returns: - summary : str
A text summary of the sensitivity analysis to be shown in a console.