OptimizationAnalysis¶

class persalys.OptimizationAnalysis(*args)¶

Perform the optimization analysis of a model.

Parameters:

name : str

Name

physicalModel : PhysicalModel

Physical model

solverName : str

Optimization algorithm name (optional). Use GetSolverNames() to list available names.

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 Model evaluation:

>>> analysis = persalys.OptimizationAnalysis('anAnalysis', myPhysicalModel, 'TNC')
>>> analysis.setInterestVariables(['G'])
>>> analysis.run()

Get the result:

>>> result = analysis.getResult()
>>> x = result.getOptimalPoint()
>>> y = result.getOptimalValue()

Methods

`GetSolverNames`()	Accessor to the list of solver names.
`getBounds`()	Accessor to bounds.
`getClassName`()	Accessor to the object’s name.
`getErrorMessage`()	Error message accessor.
`getId`()	Accessor to the object’s id.
`getInterestVariables`()	Get the variables to analyse.
`getMaximumAbsoluteError`()	Accessor to maximum allowed absolute error.
`getMaximumConstraintError`()	Accessor to maximum allowed constraint error.
`getMaximumEvaluationNumber`()	Accessor to maximum allowed number of evaluations.
`getMaximumRelativeError`()	Accessor to maximum allowed relative error.
`getMaximumResidualError`()	Accessor to maximum allowed residual error.
`getMinimization`()	Test whether this is a minimization or maximization problem.
`getName`()	Accessor to the object’s name.
`getPhysicalModel`()	Physical model accessor.
`getPythonScript`()	Physical model accessor.
`getResult`()	Accessor to optimization result.
`getShadowedId`()	Accessor to the object’s shadowed id.
`getSolverName`()	Accessor to solver name
`getStartingPoint`()	Accessor to starting point.
`getVariableInputs`()	Accessor to variable input names
`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.
`setBounds`(bounds)	Accessor to bounds.
`setInterestVariables`(variablesNames)	Set the variables to analyse.
`setMaximumAbsoluteError`(maximumAbsoluteError)	Accessor to maximum allowed absolute error.
`setMaximumConstraintError`(maximumConstraintError)	Accessor to maximum allowed constraint error.
`setMaximumEvaluationNumber`(…)	Accessor to maximum allowed number of evaluations.
`setMaximumRelativeError`(maximumRelativeError)	Accessor to maximum allowed relative error.
`setMaximumResidualError`(maximumResidualError)	Accessor to maximum allowed residual error.
`setMinimization`(minimization)	Tell whether this is a minimization or maximization problem.
`setName`(name)	Accessor to the object’s name.
`setShadowedId`(id)	Accessor to the object’s shadowed id.
`setSolverName`(name)	Accessor to solver name
`setStartingPoint`(startingPoint)	Accessor to starting point.
`setVariableInputs`(inputs)	Accessor to variable input names
`setVisibility`(visible)	Accessor to the object’s visibility state.

__init__(*args)¶

static GetSolverNames()¶

Accessor to the list of solver names.

Returns:

names : Description

List of available solver names.

getBounds()¶

Accessor to bounds.

Returns:

bounds : Interval

Problem bounds.

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

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

getMaximumAbsoluteError()¶

Accessor to maximum allowed absolute error.

Returns:

maximumAbsoluteError : float

Maximum allowed absolute error.

getMaximumConstraintError()¶

Accessor to maximum allowed constraint error.

Returns:

maximumConstraintError : float

Maximum allowed constraint error.

getMaximumEvaluationNumber()¶

Accessor to maximum allowed number of evaluations.

Returns:

N : int

Maximum allowed number of evaluations

getMaximumRelativeError()¶

Accessor to maximum allowed relative error.

Returns:

maximumRelativeError : float

Maximum allowed relative error.

getMaximumResidualError()¶

Accessor to maximum allowed residual error.

Returns:

maximumResidualError : float

Maximum allowed residual error.

getMinimization()¶

Test whether this is a minimization or maximization problem.

Returns:

value : bool

True if this is a minimization problem (default), False otherwise.

getName()¶

Accessor to the object’s name.

Returns:

name : str

The name of the object.

getPhysicalModel()¶

Physical model accessor.

Returns:

model : PhysicalModel

Physical model

getPythonScript()¶

Physical model accessor.

Returns:

script : str

Python script to replay the analysis

getResult()¶

Accessor to optimization result.

Returns:

result : OptimizationResult

Result class.

getShadowedId()¶

Accessor to the object’s shadowed id.

Returns:

id : int

Internal unique identifier.

getSolverName()¶

Accessor to solver name

Returns:

solver : str

Solver name

getStartingPoint()¶

Accessor to starting point.

Returns:

startingPoint : Point

Starting point.

getVariableInputs()¶

Accessor to variable input names

Returns:

inputs : Description

Variable input names. It is set by default to the list of inputs of the model.

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.

setBounds(bounds)¶

Accessor to bounds.

Parameters:

bounds : Interval

Problem bounds.

setInterestVariables(variablesNames)¶

Set the variables to analyse.

Parameters:

variablesNames : sequence of str

Names of the variables to analyse

setMaximumAbsoluteError(maximumAbsoluteError)¶

Accessor to maximum allowed absolute error.

Parameters:

maximumAbsoluteError : float

Maximum allowed absolute error.

setMaximumConstraintError(maximumConstraintError)¶

Accessor to maximum allowed constraint error.

Parameters:

maximumConstraintError : float

Maximum allowed constraint error.

setMaximumEvaluationNumber(maximumEvaluationNumber)¶

Accessor to maximum allowed number of evaluations.

Parameters:

N : int

Maximum allowed number of evaluations.

setMaximumRelativeError(maximumRelativeError)¶

Accessor to maximum allowed relative error.

Parameters:

maximumRelativeError : float

Maximum allowed relative error.

setMaximumResidualError(maximumResidualError)¶

Accessor to maximum allowed residual error.

Parameters:

maximumResidualError : float

Maximum allowed residual error.

setMinimization(minimization)¶

Tell whether this is a minimization or maximization problem.

Parameters:

minimization : bool

True if this is a minimization problem, False otherwise.

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.

setSolverName(name)¶

Accessor to solver name

Parameters:

solver : str

Solver name. Use GetSolverNames() to list available names.

setStartingPoint(startingPoint)¶

Accessor to starting point.

Parameters:

startingPoint : sequence of float

Starting point.

setVariableInputs(inputs)¶

Accessor to variable input names

Parameters:

inputs : sequence of str

Variable input names. It is set by default to the list of inputs of the model.

setVisibility(visible)¶

Accessor to the object’s visibility state.

Parameters:

visible : bool

Visibility flag.

OptimizationAnalysis¶

Previous topic

Next topic

This Page