1%define OT_LinearProfile_doc
2"Linear temperature profile.
3
4Available constructor:
5    LinearProfile(*T0, iMax*)
6
7
8Parameters
9----------
10T0 : float
11    Initial temperature
12iMax : int
13    Number of maximal iterations
14
15Notes
16-----
17The temperature write:
18
19.. math::
20    :nowrap:
21
22    \begin{equation*}
23        T(i) = T_0*(1 - \frac{i}{iMax}), i \in [0,iMax]
24    \end{equation*}
25
26Examples
27--------
28>>> import openturns as ot
29>>> # Define a profile
30>>> T0 = 10.0
31>>> iMax = 100
32>>> linearProfile = ot.LinearProfile(T0, iMax)
33"
34%enddef
35%feature("docstring") OT::LinearProfile
36OT_LinearProfile_doc
37// ---------------------------------------------------------------------
38%define OT_LinearProfile_call_doc
39"Compute the temperature T(i).
40
41Parameters
42----------
43i : int
44    The index for whome we seek temperature
45
46Returns
47-------
48temperature:  float
49    The temperature
50
51Examples
52--------
53>>> import openturns as ot
54>>> # Define a profile
55>>> T0 = 10.0
56>>> iMax = 100
57>>> linearProfile = ot.LinearProfile(T0, iMax)
58>>> temperature = linearProfile(10)
59>>> print(temperature)
609.0"
61%enddef
62%feature("docstring") OT::LinearProfile::operator()
63OT_LinearProfile_call_doc
64// ---------------------------------------------------------------------
65