FieldFunctionalChaosResult

class FieldFunctionalChaosResult(*args)

Functional metamodel result.

Warning

This class is experimental and likely to be modified in future releases. To use it, import the openturns.experimental submodule.

Parameters:

inputKLResultCollectionsequence of KarhunenLoeveResult

List of input fields decompositions.

fceResultFunctionalChaosResult

Functional chaos decomposition.

outputKLResultCollectionsequence of KarhunenLoeveResult

List of output fields decompositions.

Methods

getClassName()	Accessor to the object's name.
getFCEResult()	Accessor to the chaos decomposition.
getFieldMetaModel()	Accessor to the metamodel.
getFieldToPointMetaModel()	Accessor to the metamodel.
getInputBlockIndices()	Accessor to the input block indices.
getInputKLResultCollection()	Accessor to the input fields decompositions.
getInputProcessSample()	Accessor to the input process sample.
getInputSample()	Accessor to the input sample.
getModesSample()	Accessor to the modes sample.
getName()	Accessor to the object's name.
getOutputBlockIndices()	Accessor to the output block indices.
getOutputKLResultCollection()	Accessor to the output fields decompositions.
getOutputProcessSample()	Accessor to the output process sample.
getOutputSample()	Accessor to the output sample.
getPointToFieldMetaModel()	Accessor to the metamodel.
hasName()	Test if the object is named.
setInputBlockIndices(inputBlockIndices)	Accessor to the input block indices.
setInputProcessSample(inputProcessSample)	Accessor to the input process sample.
setInputSample(inputSample)	Accessor to the input sample.
setMetaModel(*args)	Accessor to the metamodel.
setModesSample(modesSample)	Accessor to the modes sample.
setName(name)	Accessor to the object's name.
setOutputBlockIndices(outputBlockIndices)	Accessor to the output block indices.
setOutputProcessSample(outputProcessSample)	Accessor to the output process sample.
setOutputSample(outputSample)	Accessor to the output sample.

__init__(*args)

getClassName()

Accessor to the object’s name.

Returns:

class_namestr

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

getFCEResult()

Accessor to the chaos decomposition.

Returns:

fceResultFunctionalChaosResult

Functional chaos decomposition.

getFieldMetaModel()

Accessor to the metamodel.

Returns:

metamodelFieldFunction

Metamodel function.

getFieldToPointMetaModel()

Accessor to the metamodel.

Returns:

metamodelFieldToPointFunction

Metamodel function.

getInputBlockIndices()

Accessor to the input block indices.

Returns:

blockIndicesIndicesCollection

Independent components indices.

getInputKLResultCollection()

Accessor to the input fields decompositions.

Returns:

inputKLResultCollectionCollection of KarhunenLoeveResult

List of input fields decompositions.

getInputProcessSample()

Accessor to the input process sample.

Returns:

inputProcessSampleProcessSample

Input process sample.

getInputSample()

Accessor to the input sample.

Returns:

inputSampleSample

Input values.

getModesSample()

Accessor to the modes sample.

Returns:

modesSample

Projected modes values.

getName()

Accessor to the object’s name.

Returns:

namestr

The name of the object.

getOutputBlockIndices()

Accessor to the output block indices.

Returns:

blockIndicesIndicesCollection

Independent components indices.

getOutputKLResultCollection()

Accessor to the output fields decompositions.

Returns:

outputKLResultCollectionCollection of KarhunenLoeveResult

List of output fields decompositions.

getOutputProcessSample()

Accessor to the output process sample.

Returns:

outputProcessSampleProcessSample

Output process sample.

getOutputSample()

Accessor to the output sample.

Returns:

outputSampleSample

Output values.

getPointToFieldMetaModel()

Accessor to the metamodel.

Returns:

metamodelPointToFieldFunction

Metamodel function.

hasName()

Test if the object is named.

Returns:

hasNamebool

True if the name is not empty.

setInputBlockIndices(inputBlockIndices)

Accessor to the input block indices.

Parameters:

blockIndices2-d sequence of int

Independent components indices.

setInputProcessSample(inputProcessSample)

Accessor to the input process sample.

Parameters:

inputProcessSampleProcessSample

Input process sample.

setInputSample(inputSample)

Accessor to the input sample.

Parameters:

inputSampleSample

Input values.

setMetaModel(*args)

Accessor to the metamodel.

Parameters:

metamodelFieldToPointFunction

Metamodel function.

setModesSample(modesSample)

Accessor to the modes sample.

Parameters:

modesSample

Projected modes values.

setName(name)

Accessor to the object’s name.

Parameters:

namestr

The name of the object.

setOutputBlockIndices(outputBlockIndices)

Accessor to the output block indices.

Parameters:

blockIndices2-d sequence of int

Independent components indices.

setOutputProcessSample(outputProcessSample)

Accessor to the output process sample.

Parameters:

outputProcessSampleProcessSample

Output process sample.

setOutputSample(outputSample)

Accessor to the output sample.

Parameters:

outputSampleSample

Output values.

Examples using the class

Viscous free fall: metamodel of a field function

Viscous free fall: metamodel of a field function

Estimate Sobol indices on a field to point function

Estimate Sobol indices on a field to point function