Input

class persalys.Input(*args)

Create an input variable.

Represents an input variable.

Parameters:
namestr

Name

valuefloat

Default value

distributionDistribution

Associated distribution

descriptionstr

Description text (optional)

Examples

>>> import openturns as ot
>>> import persalys
>>> F = persalys.Input('F', 0., ot.Normal(75000., 5000.), 'Traction load')
>>> R = persalys.Input('R', ot.Normal(75000., 5000.))
>>> S = persalys.Input('S', 10.5)

Methods

getClassName()

Accessor to the object's name.

getDescription()

Description accessor.

getDistribution()

Distribution accessor.

getDistributionParametersType()

Distribution parameters type accessor.

getFiniteDifferenceStep()

Finite difference step accessor.

getId()

Accessor to the object's id.

getName()

Accessor to the object's name.

getPythonScript()

Python script accessor.

getShadowedId()

Accessor to the object's shadowed id.

getValue()

Default value accessor.

getVisibility()

Accessor to the object's visibility state.

hasName()

Test if the object is named.

hasVisibleName()

Test if the object has a distinguishable name.

isStochastic()

Whether the variable is stochastic.

setDescription(description)

Description accessor.

setDistribution(distribution)

Distribution accessor.

setDistributionParametersType(...)

Distribution parameters type accessor.

setFiniteDifferenceStep(step)

Finite difference step accessor.

setName(name)

Accessor to the object's name.

setShadowedId(id)

Accessor to the object's shadowed id.

setStochastic(stoch)

Whether the variable is stochastic.

setValue(value)

Default value accessor.

setVisibility(visible)

Accessor to the object's visibility state.

getUnit

setUnit

__init__(*args)
getClassName()

Accessor to the object’s name.

Returns:
class_namestr

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

getDescription()

Description accessor.

Returns:
descriptionopenturns.Description

Text describing the variable

getDistribution()

Distribution accessor.

Returns:
distributionopenturns.Distribution

Distribution associated with the variable

getDistributionParametersType()

Distribution parameters type accessor.

Returns:
parametersTypeint

Distribution parameters index

getFiniteDifferenceStep()

Finite difference step accessor.

Returns:
stepfloat

Finite difference step used to define the gradient of the model’s function

getId()

Accessor to the object’s id.

Returns:
idint

Internal unique identifier.

getName()

Accessor to the object’s name.

Returns:
namestr

The name of the object.

getPythonScript()

Python script accessor.

Returns:
scriptstr

Python script to replay the analysis

getShadowedId()

Accessor to the object’s shadowed id.

Returns:
idint

Internal unique identifier.

getValue()

Default value accessor.

Returns:
valuefloat

Default value

getVisibility()

Accessor to the object’s visibility state.

Returns:
visiblebool

Visibility flag.

hasName()

Test if the object is named.

Returns:
hasNamebool

True if the name is not empty.

hasVisibleName()

Test if the object has a distinguishable name.

Returns:
hasVisibleNamebool

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

isStochastic()

Whether the variable is stochastic.

Returns:
isStochasticbool

Whether the variable is stochastic

setDescription(description)

Description accessor.

Parameters:
descriptionstr

Text describing the variable

setDistribution(distribution)

Distribution accessor.

Parameters:
distributionopenturns.Distribution

Distribution associated with the variable

setDistributionParametersType(distributionParametersType)

Distribution parameters type accessor.

Parameters:
parametersTypeint

Distribution parameters index

setFiniteDifferenceStep(step)

Finite difference step accessor.

Parameters:
stepfloat

Finite difference step used to define the gradient and the hessian of the model’s function. By default the step is equal to 1e-7. The gradient function is defined with the first order non-centered finite difference scheme and the hessian function with the second order centered finite difference scheme.

Notes

First order non-centered finite difference scheme:

\frac{\partial f_j}{\partial x_i} \approx \frac{f_j(x + \epsilon_i) - f_j(x)}
                                               {\epsilon_i}

Second order centered finite difference scheme:

\frac{\partial^2 f_k}{\partial x_i \partial x_j} \approx
                                   \frac{
                                      f_k(x + \epsilon_i + \epsilon_j) -
                                      f_k(x + \epsilon_i - \epsilon_j) +
                                      f_k(x - \epsilon_i - \epsilon_j) -
                                      f_k(x - \epsilon_i + \epsilon_j)}
                                   {4 \epsilon_i \epsilon_j}

setName(name)

Accessor to the object’s name.

Parameters:
namestr

The name of the object.

setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters:
idint

Internal unique identifier.

setStochastic(stoch)

Whether the variable is stochastic.

Parameters:
isStochasticbool

Whether the variable is stochastic

setValue(value)

Default value accessor.

Parameters:
valuefloat

Default value

setVisibility(visible)

Accessor to the object’s visibility state.

Parameters:
visiblebool

Visibility flag.