GeometricProfile

class GeometricProfile(*args)

Geometric temperature profile.

Available constructor:

GeometricProfile()

GeometricProfile(T0, c, iMax)

Parameters:
T0float

Initial temperature

cfloat

The geometric ratio Should be in ]0,1[

iMaxint

Number of maximal iterations

Notes

The temperature write:

\begin{equation*}
    T(i) = T_0 * c^{i} \in [0,iMax]
\end{equation*}

Examples

>>> import openturns as ot
>>> # Define a profile
>>> T0 = 10.0
>>> iMax = 100
>>> c = 0.90
>>> geometricProfile = ot.GeometricProfile(T0, c, iMax)
Attributes:
thisown

The membership flag

Methods

__call__(i) Compute the temperature T(i).
getClassName() Accessor to the object’s name.
getIMax() Maximum index value accessor.
getId() Accessor to the object’s id.
getName() Accessor to the object’s name.
getShadowedId() Accessor to the object’s shadowed id.
getT0() Temperature origin 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.
setName(name) Accessor to the object’s name.
setShadowedId(id) Accessor to the object’s shadowed id.
setVisibility(visible) Accessor to the object’s visibility state.
__init__(*args)

Initialize self. See help(type(self)) for accurate signature.

getClassName()

Accessor to the object’s name.

Returns:
class_namestr

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

getIMax()

Maximum index value accessor.

Returns:
iMaxint

The maximum index value

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.

getShadowedId()

Accessor to the object’s shadowed id.

Returns:
idint

Internal unique identifier.

getT0()

Temperature origin accessor.

Returns:
t0float

The temperature origin

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.

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.

setVisibility(visible)

Accessor to the object’s visibility state.

Parameters:
visiblebool

Visibility flag.

thisown

The membership flag