FORMImportanceSamplingAnalysis

class persalys.FORMImportanceSamplingAnalysis(*args)

Run a FORM analysis followed by an importance sampling for reliability analysis.

Parameters:

name : str

Name

limitState : LimitState

Limit state

Examples

>>> import openturns as ot
>>> import persalys

Create the model:

>>> R = persalys.Input('R', 0., ot.LogNormalMuSigma(300., 30., 0.).getDistribution(), 'Yield strength')
>>> F = persalys.Input('F', 0., ot.Normal(75000., 5000.), 'Traction load')
>>> G = persalys.Output('G', 'deviation')
>>> myPhysicalModel = persalys.SymbolicPhysicalModel('myPhysicalModel', [R, F], [G], ['R-F/(pi_*100.0)'])

Create the limit state:

>>> limitState = persalys.LimitState('ls1', myPhysicalModel, 'G', ot.Less(), 0.)

Process the reliability analysis:

>>> analysis = persalys.FORMImportanceSamplingAnalysis('myAnalysis', limitState)
>>> analysis.setMaximumCalls(1000)
>>> analysis.run()

Get the result:

>>> result = analysis.getResult()
>>> pf = result.getSimulationResult().getProbabilityEstimate()

Methods

getBlockSize() Block size accessor.
getClassName() Accessor to the object’s name.
getErrorMessage() Error message accessor.
getFORMResult() FORM result accessor.
getId() Accessor to the object’s id.
getInterestVariables() Get the variables to analyse.
getLimitState() Limit-state accessor.
getMaximumCalls() Maximum calls accessor.
getMaximumCoefficientOfVariation() Maximum coefficient of variation accessor.
getMaximumElapsedTime() Maximum elapsed time accessor.
getName() Accessor to the object’s name.
getOptimizationAlgorithm() Accessor to the optimization algorithm used to find the design point.
getPhysicalModel() Physical model accessor.
getPhysicalStartingPoint() Physical starting point accessor.
getPythonScript() Physical model accessor.
getResult() Result accessor.
getSeed() Seed accessor.
getShadowedId() Accessor to the object’s shadowed id.
getStandardSpaceDesignPoint() Accessor to standard space design point.
getVisibility() Accessor to the object’s visibility state.
getWarningMessage() Warning message accessor.
hasName() Test if the object is named.
hasValidResult() Whether the analysis has been run.
hasVisibleName() Test if the object has a distinguishable name.
isReliabilityAnalysis() Whether the analysis involves reliability.
isRunning() Whether the analysis is running.
run() Launch the analysis.
setBlockSize(size) Block size accessor.
setInterestVariables(outputsNames) Set the variables to analyse.
setMaximumCalls(maxi) Maximum calls accessor.
setMaximumCoefficientOfVariation(coef) Maximum coefficient of variation accessor.
setMaximumElapsedTime(seconds) Maximum elapsed time accessor.
setName(name) Accessor to the object’s name.
setOptimizationAlgorithm(solver) Accessor to the optimization algorithm used to find the design point.
setPhysicalStartingPoint(point) Physical starting point accessor.
setSeed(seed) Seed accessor.
setShadowedId(id) Accessor to the object’s shadowed id.
setStandardSpaceDesignPoint(point) Accessor to standard space design point.
setVisibility(visible) Accessor to the object’s visibility state.
__init__(*args)
getBlockSize()

Block size accessor.

Returns:

size : int

Number of terms in the probability simulation estimator grouped together. It is set by default to 1.

getClassName()

Accessor to the object’s name.

Returns:

class_name : str

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

getErrorMessage()

Error message accessor.

Returns:

message : str

Error message if the analysis failed

getFORMResult()

FORM result accessor.

Returns:

result : openturns.FORMResult

Result of the FORM analysis

getId()

Accessor to the object’s id.

Returns:

id : int

Internal unique identifier.

getInterestVariables()

Get the variables to analyse.

Returns:

variablesNames : sequence of str

Names of the variables to analyse

getLimitState()

Limit-state accessor.

Returns:

limitState : LimitState

The Limit-state.

getMaximumCalls()

Maximum calls accessor.

Returns:

maxCalls : positive int

The maximum calls of the function.

getMaximumCoefficientOfVariation()

Maximum coefficient of variation accessor.

Returns:

maxCoef : double

The maximum coefficient of variation. It is set by default to 0.01.

getMaximumElapsedTime()

Maximum elapsed time accessor.

Returns:

maxTime : positive int

The maximum elapsed time in seconds. It is set by default to 60 seconds.

getName()

Accessor to the object’s name.

Returns:

name : str

The name of the object.

getOptimizationAlgorithm()

Accessor to the optimization algorithm used to find the design point.

Returns:

algorithm : openturns.OptimizationAlgorithm

Optimization algorithm used to research the design point. Cobyla is the default used algorithm.

getPhysicalModel()

Physical model accessor.

Returns:

model : PhysicalModel

Physical model

getPhysicalStartingPoint()

Physical starting point accessor.

Returns:

point : openturns.Point

Physical starting point. By default it set to the mean of the composed distribution of the physical model

getPythonScript()

Physical model accessor.

Returns:

script : str

Python script to replay the analysis

getResult()

Result accessor.

Returns:

result : SimulationReliabilityResult

Result

getSeed()

Seed accessor.

Returns:

seed : int

Seed

getShadowedId()

Accessor to the object’s shadowed id.

Returns:

id : int

Internal unique identifier.

getStandardSpaceDesignPoint()

Accessor to standard space design point.

Returns:

point : openturns.Point

Standard space design point. It is the mean of the Normal distribution used to sample.

getVisibility()

Accessor to the object’s visibility state.

Returns:

visible : bool

Visibility flag.

getWarningMessage()

Warning message accessor.

Returns:

message : str

Warning message which can appear during the analysis computation

hasName()

Test if the object is named.

Returns:

hasName : bool

True if the name is not empty.

hasValidResult()

Whether the analysis has been run.

Returns:

hasValidResult : bool

Whether the analysis has already been run

hasVisibleName()

Test if the object has a distinguishable name.

Returns:

hasVisibleName : bool

True if the name is not empty and not the default one.

isReliabilityAnalysis()

Whether the analysis involves reliability.

Returns:

isReliabilityAnalysis : bool

Whether the analysis involves a reliability analysis

isRunning()

Whether the analysis is running.

Returns:

isRunning : bool

Whether the analysis is running

run()

Launch the analysis.

setBlockSize(size)

Block size accessor.

Parameters:

size : int

Number of terms in the probability simulation estimator grouped together. It is set by default to 1.

setInterestVariables(outputsNames)

Set the variables to analyse.

Parameters:

variablesNames : sequence of str

Names of the variables to analyse

setMaximumCalls(maxi)

Maximum calls accessor.

Parameters:

maxCalls : positive int

The maximum calls of the function.

setMaximumCoefficientOfVariation(coef)

Maximum coefficient of variation accessor.

Parameters:

maxCoef : double

The maximum coefficient of variation. It is set by default to 0.01.

setMaximumElapsedTime(seconds)

Maximum elapsed time accessor.

Parameters:

maxTime : positive int

The maximum elapsed time in seconds. It is set by default to 60 seconds.

setName(name)

Accessor to the object’s name.

Parameters:

name : str

The name of the object.

setOptimizationAlgorithm(solver)

Accessor to the optimization algorithm used to find the design point.

Parameters:

algorithm : openturns.OptimizationAlgorithm

Optimization algorithm used to research the design point. Cobyla is the default used algorithm.

setPhysicalStartingPoint(point)

Physical starting point accessor.

Parameters:

point : sequence of float

Physical starting point. By default it set to the mean of the composed distribution of the physical model

setSeed(seed)

Seed accessor.

Parameters:

seed : int

Seed

setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters:

id : int

Internal unique identifier.

setStandardSpaceDesignPoint(point)

Accessor to standard space design point.

Parameters:

point : sequence of float

Standard space design point. It is the mean of the Normal distribution used to sample

setVisibility(visible)

Accessor to the object’s visibility state.

Parameters:

visible : bool

Visibility flag.