PostAnalyticalSimulation¶

class PostAnalyticalSimulation(*args)¶

Post analytical simulation.

Methods

`drawProbabilityConvergence`(*args)	Draw the probability convergence at a given level.
`getAnalyticalResult`()	Accessor to the analytical result.
`getBlockSize`()	Accessor to the block size.
`getClassName`()	Accessor to the object's name.
`getControlProbability`()	Accessor to the control probability.
`getConvergenceStrategy`()	Accessor to the convergence strategy.
`getEvent`()	Accessor to the event.
`getMaximumCoefficientOfVariation`()	Accessor to the maximum coefficient of variation.
`getMaximumOuterSampling`()	Accessor to the maximum iterations number.
`getMaximumStandardDeviation`()	Accessor to the maximum standard deviation.
`getMaximumTimeDuration`()	Accessor to the maximum duration.
`getName`()	Accessor to the object's name.
`getResult`()	Accessor to the results.
`hasName`()	Test if the object is named.
`run`()	Launch simulation.
`setBlockSize`(blockSize)	Accessor to the block size.
`setConvergenceStrategy`(convergenceStrategy)	Accessor to the convergence strategy.
`setMaximumCoefficientOfVariation`(...)	Accessor to the maximum coefficient of variation.
`setMaximumOuterSampling`(maximumOuterSampling)	Accessor to the maximum iterations number.
`setMaximumStandardDeviation`(...)	Accessor to the maximum standard deviation.
`setMaximumTimeDuration`(maximumTimeDuration)	Accessor to the maximum duration.
`setName`(name)	Accessor to the object's name.
`setProgressCallback`(*args)	Set up a progress callback.
`setStopCallback`(*args)	Set up a stop callback.

See also

openturns.EventSimulation.setBlockSize
openturns.EventSimulation.setMaximumOuterSampling
openturns.ResourceMap
openturns.SimulationResult

Notes

It launches the simulation and creates a SimulationResult, structure containing all the results obtained after simulation. It computes the probability of occurrence of the given event by computing the empirical mean of a sample of size at most outerSampling * blockSize, this sample being built by blocks of size blockSize. It allows one to use efficiently the distribution of the computation as well as it allows one to deal with a sample size $> 2^{32}$ by a combination of blockSize and outerSampling.

setBlockSize(blockSize)¶

Accessor to the block size.

Parameters:

blockSizeint, $blockSize \geq 1$: Number of simultaneous evaluations of the limit-state function. It is set by default to 1.

Notes

If the function supports batch evaluations this parameter can be set to the number of available CPUs to benefit from parallel execution (multithreading, multiprocessing, …); except for the Directional Sampling, where we recommend to set it to 1. It also decides the frequency of the stopping criteria and progress callbacks update as they are called once the whole block of fonction evaluations is completed.

setConvergenceStrategy(convergenceStrategy)¶

Accessor to the convergence strategy.

Parameters:

storage_strategyHistoryStrategy: Storage strategy used to store the values of the probability estimator and its variance during the simulation algorithm.

setMaximumCoefficientOfVariation(maximumCoefficientOfVariation)¶

Accessor to the maximum coefficient of variation.

Parameters:

coefficientfloat: Maximum coefficient of variation of the simulated sample.

setMaximumOuterSampling(maximumOuterSampling)¶

Accessor to the maximum iterations number.

Parameters:

outerSamplingint: Maximum number of iterations, each iteration performing a block of evaluations.

setMaximumStandardDeviation(maximumStandardDeviation)¶

Accessor to the maximum standard deviation.

Parameters:

sigmafloat, $\sigma > 0$: Maximum standard deviation of the estimator.

setMaximumTimeDuration(maximumTimeDuration)¶

Accessor to the maximum duration.

Parameters:

maximumTimeDurationfloat: Maximum optimization duration in seconds.

setName(name)¶

Accessor to the object’s name.

Parameters:

namestr: The name of the object.

setProgressCallback(*args)¶

Set up a progress callback.

Can be used to programmatically report the progress of a simulation.

Parameters:

callbackcallable: Takes a float as argument as percentage of progress.

Examples

>>> import sys
>>> import openturns as ot
>>> experiment = ot.MonteCarloExperiment()
>>> X = ot.RandomVector(ot.Normal())
>>> Y = ot.CompositeRandomVector(ot.SymbolicFunction(['X'], ['1.1*X']), X)
>>> event = ot.ThresholdEvent(Y, ot.Less(), -2.0)
>>> algo = ot.ProbabilitySimulationAlgorithm(event, experiment)
>>> algo.setMaximumOuterSampling(100)
>>> algo.setMaximumCoefficientOfVariation(-1.0)
>>> def report_progress(progress):
...     sys.stderr.write('-- progress=' + str(progress) + '%\n')
>>> algo.setProgressCallback(report_progress)
>>> algo.run()

setStopCallback(*args)¶

Set up a stop callback.

Can be used to programmatically stop a simulation.

Parameters:

callbackcallable: Returns an int deciding whether to stop or continue.

Examples

Stop a Monte Carlo simulation algorithm using a time limit

>>> import openturns as ot
>>> experiment = ot.MonteCarloExperiment()
>>> X = ot.RandomVector(ot.Normal())
>>> Y = ot.CompositeRandomVector(ot.SymbolicFunction(['X'], ['1.1*X']), X)
>>> event = ot.ThresholdEvent(Y, ot.Less(), -2.0)
>>> algo = ot.ProbabilitySimulationAlgorithm(event, experiment)
>>> algo.setMaximumOuterSampling(10000000)
>>> algo.setMaximumCoefficientOfVariation(-1.0)
>>> algo.setMaximumTimeDuration(0.1)
>>> algo.run()