FieldMonteCarloResult

class persalys.FieldMonteCarloResult(*args)

Get the results of a Monte Carlo analysis with mesh.

Methods

getClassName()	Accessor to the object’s name.
getCorrelationFunction()	Correlation function accessor.
getDesignOfExperiment()	Design of experiments accessor.
getElapsedTime()	Elapsed time in seconds to perform the analysis.
getId()	Accessor to the object’s id.
getKarhunenLoeveResults()
getLowerQuantileSample()	Lower quantile accessor.
getMeanSample()	Mean trajectory accessor.
getName()	Accessor to the object’s name.
getProcessSample()	Output values accessor.
getShadowedId()	Accessor to the object’s shadowed id.
getUpperQuantileSample()	Upper quantile accessor.
getVisibility()	Accessor to the object’s visibility state.
getXiSamples()	distribution values accessor.
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.

__init__(*args)

getClassName()

Accessor to the object’s name.

Returns:

class_name : str

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

getCorrelationFunction()

Correlation function accessor.

Returns:

functions : sequence of openturns.Function

Correlation function for each output

getDesignOfExperiment()

Design of experiments accessor.

Returns:

design : DesignOfExperiment

Design of experiments containing the analysed points

getElapsedTime()

Elapsed time in seconds to perform the analysis.

Returns:

time : double

Elapsed time in seconds to perform the analysis

getId()

Accessor to the object’s id.

Returns:

id : int

Internal unique identifier.

getLowerQuantileSample()

Lower quantile accessor.

Returns:

sample : openturns.Sample

Lower quantile trajectory for each output at level defined in persalys.FieldMonteCarloAnalysis.getQuantileLevel()

getMeanSample()

Mean trajectory accessor.

Returns:

sample : openturns.Sample

Mean trajectory for each output

getName()

Accessor to the object’s name.

Returns:

name : str

The name of the object.

getProcessSample()

Output values accessor.

Returns:

sample : openturns.ProcessSample

Output values

getShadowedId()

Accessor to the object’s shadowed id.

Returns:

id : int

Internal unique identifier.

getUpperQuantileSample()

Upper quantile accessor.

Returns:

sample : openturns.Sample

Upper quantile trajectory for each output at 1-level defined in persalys.FieldMonteCarloAnalysis.getQuantileLevel()

getVisibility()

Accessor to the object’s visibility state.

Returns:

visible : bool

Visibility flag.

getXiSamples()

distribution values accessor.

Returns:

samples : sequence of openturns.Sample

Distribution values of the variables of the Karhunen Loeve decomposition

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.