ProbResult

ProbResult()

A class to represent the result of a probabilistic analysis.

Attributes h : float or None Water level. prob_cond : float Conditional probability of failure. converged : bool Indicates whether the analysis has converged. z_val : float or None Value of the limit state function. physical_design : dict of str to float or None Physical space design point. standard_design : dict of str to float or None Standard space design point. importancefactors : dict of str to float or None Importance factors. functionevals : int Number of function evaluations. mechanism : str or None Type of the limit state function.

Attributes

Name Description
converged Returns True when the argument is true, False otherwise.
functionevals int([x]) -> integer
h The type of the None singleton.
importancefactors The type of the None singleton.
mechanism The type of the None singleton.
physical_design The type of the None singleton.
prob_cond The type of the None singleton.
standard_design The type of the None singleton.
z_val The type of the None singleton.

Methods

Name Description
from_FORM_result Create a ProbResult from a FORM analysis.
from_sim_result Create a ProbResult from a simulation analysis.

from_FORM_result

ProbResult.from_FORM_result(h, optimAlgo, otzfunc, result, z_type)

Create a ProbResult from a FORM analysis.

Parameters

Name Type Description Default
h float Water level. required
optimAlgo ot.AbdoRackwitz or ot.Cobyla Optimization algorithm used in the FORM analysis. required
otzfunc ot.Function OpenTURNS Python function representing the limit state function. required
result ot.FORMResult Result of the FORM analysis. required
z_type str Type of the limit state function. required

from_sim_result

ProbResult.from_sim_result(h, algo, otzfunc, distribution, result, z_type)

Create a ProbResult from a simulation analysis.

Parameters

Name Type Description Default
h float Water level. required
algo ot.ProbabilitySimulationAlgorithm or ot.DirectionalSampling Simulation algorithm used in the analysis. required
otzfunc ot.PythonFunction or ot.MemoizeFunction OpenTURNS Python function representing the limit state function. required
distribution ot.ComposedDistribution Distribution of the input variables. required
result ot.OptimizationResult Result of the simulation analysis. required
z_type str Type of the limit state function. required