/usr/include/openturns/swig/GeometricProfile_doc.i is in libopenturns-dev 1.9-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 | %define OT_GeometricProfile_doc
"Geometric temperature profile.
Available constructor:
GeometricProfile()
GeometricProfile(*T0, c, iMax*)
Parameters
----------
T0 : float
Initial temperature
c : float
The geometric ratio
Should be in ]0,1[
iMax : int
Number of maximal iterations
Notes
-----
The temperature write:
.. math::
:nowrap:
\\\\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)
"
%enddef
%feature("docstring") OT::GeometricProfile
OT_GeometricProfile_doc
// ---------------------------------------------------------------------
%define OT_GeometricProfile_call_doc
"Compute the temperature T(i).
Parameters
----------
i : int
The index for whome we seek temperature
Returns
-------
temperature: float
The temperature
Examples
--------
>>> import openturns as ot
>>> # Define a profile
>>> T0 = 10.0
>>> iMax = 100
>>> c = 0.90
>>> geometricProfile = ot.GeometricProfile(T0, c, iMax)
>>> temperature = geometricProfile(5)
>>> print(temperature)
5.9049..."
%enddef
%feature("docstring") OT::GeometricProfile::operator()
OT_GeometricProfile_call_doc
// ---------------------------------------------------------------------
|