SRCAnalysis

class persalys.SRCAnalysis(*args)

Run a SRC sensitivity analysis.

Parameters

namestr

Name

physicalModelPhysicalModel

Physical model

simulationsNumberint

Simulations number (optional). By default it is 10000.

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 SRC analysis:

>>> analysis = persalys.SRCAnalysis('anAnalysis', myPhysicalModel, 1000)
>>> analysis.run()

Get the result:

>>> result = analysis.getResult()
>>> indices = result.getIndices()

Methods

getBlockSize()	Block size accessor.
getClassName()	Accessor to the object's name.
getErrorMessage()	Error message accessor.
getFailedInputSample()	Failed input sample accessor.
getInterestVariables()	Get the variables to analyse.
getName()	Accessor to the object's name.
getPhysicalModel()	Physical model accessor.
getPythonScript()	Physical model accessor.
getResult()	Result accessor.
getSeed()	Seed accessor.
getSimulationsNumber()	Simulations number accessor.
getWarningMessage()	Warning message accessor.
hasName()	Test if the object is named.
hasValidResult()	Whether the analysis has been run.
isReliabilityAnalysis()	Whether the analysis involves reliability.
isRunning()	Whether the analysis is running.
run()	Launch the analysis.
setBlockSize(size)	Block size accessor.
setInterestVariables(variablesNames)	Set the variables to analyse.
setName(name)	Accessor to the object's name.
setSeed(seed)	Seed accessor.
setSimulationsNumber(number)	Simulations number accessor.

canBeLaunched
getElapsedTime
getErrorDescription
getParentObserver

__init__(*args)

getBlockSize()

Block size accessor.

Returns

blockSizepositive int

Number of terms analysed together. It is set by default to 1.

getClassName()

Accessor to the object’s name.

Returns

class_namestr

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

getErrorMessage()

Error message accessor.

Returns

messagestr

Error message if the analysis failed

getFailedInputSample()

Failed input sample accessor.

Returns

sampleopenturns.Sample

Sample with the failed input values

getInterestVariables()

Get the variables to analyse.

Returns

variablesNamessequence of str

Names of the variables to analyse

getName()

Accessor to the object’s name.

Returns

namestr

The name of the object.

getPhysicalModel()

Physical model accessor.

Returns

modelPhysicalModel

Physical model

getPythonScript()

Physical model accessor.

Returns

scriptstr

Python script to replay the analysis

getResult()

Result accessor.

Returns

resultSRCResult

Result

getSeed()

Seed accessor.

Returns

seedint

Seed value

getSimulationsNumber()

Simulations number accessor.

Returns

numberint

Number of simulations

getWarningMessage()

Warning message accessor.

Returns

messagestr

Warning message which can appear during the analysis computation

hasName()

Test if the object is named.

Returns

hasNamebool

True if the name is not empty.

hasValidResult()

Whether the analysis has been run.

Returns

hasValidResultbool

Whether the analysis has already been run

isReliabilityAnalysis()

Whether the analysis involves reliability.

Returns

isReliabilityAnalysisbool

Whether the analysis involves a reliability analysis

isRunning()

Whether the analysis is running.

Returns

isRunningbool

Whether the analysis is running

run()

Launch the analysis.

setBlockSize(size)

Block size accessor.

Parameters

blockSizepositive int

Number of terms analysed together. It is set by default to 1.

setInterestVariables(variablesNames)

Set the variables to analyse.

Parameters

variablesNamessequence of str

Names of the variables to analyse

setName(name)

Accessor to the object’s name.

Parameters

namestr

The name of the object.

setSeed(seed)

Seed accessor.

Parameters

seedint

Seed value

setSimulationsNumber(number)

Simulations number accessor.

Parameters

numberint

Number of simulations. By default it is 10000.