/usr/include/openturns/swig/FieldFunctionImplementation_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 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 | %define OT_FieldFunction_doc
"Field function.
Available constructors:
FieldFunction(*meshDimension=1*)
FieldFunction(*function, meshDimension=1*)
Parameters
----------
function : :class:`~openturns.Function`
Function :math:`g: \\\\Rset^d \\\\mapsto \\\\Rset^q` used to define a
:class:`~openturns.ValueFunction` object.
meshDimension : int, :math:`n \\\\geq 0`
Dimension of the mesh :math:`\\\\cM`.
Notes
-----
Field functions are functions being able to act on fields.
Two particular field functions are defined:
the :class:`spatial function <openturns.ValueFunction>` and
the :class:`temporal function <openturns.VertexValueFunction>`.
A field function
:math:`f_{dyn}:\\\\cD \\\\times \\\\Rset^d \\\\mapsto \\\\cD' \\\\times \\\\Rset^q`
where :math:`\\\\cD \\\\in \\\\Rset^n` and :math:`\\\\cD' \\\\in \\\\Rset^p` is defined by:
.. math::
f_{dyn}(\\\\vect{t}, \\\\vect{x}) = (t'(\\\\vect{t}), v'(\\\\vect{t}, \\\\vect{x}))
with :math:`t': \\\\cD \\\\mapsto \\\\cD'` and
:math:`v': \\\\cD \\\\times \\\\Rset^d \\\\mapsto \\\\Rset^q`.
A field function :math:`f_{dyn}` transforms a multivariate stochastic
process:
.. math::
X: \\\\Omega \\\\times \\\\cD \\\\mapsto \\\\Rset^d
where :math:`\\\\cD \\\\in \\\\Rset^n` is discretized according to the mesh :math:`\\\\cM`
into the multivariate stochastic process:
.. math::
Y=f_{dyn}(X)
such that:
.. math::
Y: \\\\Omega \\\\times \\\\cD' \\\\mapsto \\\\Rset^q
where the mesh :math:`\\\\cD' \\\\in \\\\Rset^p` is discretized according to the
:math:`\\\\cM'`.
A field function :math:`f_{dyn}` also acts on fields and produces fields of
possibly different dimension (:math:`q\\\\neq d`) and mesh (:math:`\\\\cD \\\\neq \\\\cD'`
or :math:`\\\\cM \\\\neq \\\\cM'`).
OpenTURNS only proposes field functions where :math:`\\\\cD'=\\\\cD` and
:math:`\\\\cM'=\\\\cM` which means that :math:`t'=Id` through the *spatial function*
and the *temporal function*. It follows that the process :math:`Y` shares the
same mesh with :math:`X`, only its values have changed."
%enddef
%feature("docstring") OT::FieldFunctionImplementation
OT_FieldFunction_doc
// ---------------------------------------------------------------------
%define OT_FieldFunction_getCallsNumber_doc
"Get the number of calls of a FieldFunction.
Returns
-------
callsNumber : int
Counts the number of times the FieldFunction has been called since its
creation."
%enddef
%feature("docstring") OT::FieldFunctionImplementation::getCallsNumber
OT_FieldFunction_getCallsNumber_doc
// ---------------------------------------------------------------------
%define OT_FieldFunction_getInputDescription_doc
"Get the description of the inputs.
Returns
-------
inputDescription : :class:`~openturns.Description`
Describes the inputs of the function."
%enddef
%feature("docstring") OT::FieldFunctionImplementation::getInputDescription
OT_FieldFunction_getInputDescription_doc
// ---------------------------------------------------------------------
%define OT_FieldFunction_getInputDimension_doc
"Get the dimension of the input.
Returns
-------
d : int
Input dimension :math:`d` of the function."
%enddef
%feature("docstring") OT::FieldFunctionImplementation::getInputDimension
OT_FieldFunction_getInputDimension_doc
// ---------------------------------------------------------------------
%define OT_FieldFunction_getMarginal_doc
"Get the marginal(s) at given indice(s).
Parameters
----------
i : int or list of ints, :math:`0 \\\\leq i < d`
Indice(s) of the marginal(s) needed. :math:`d` is the dimension of the
FieldFunction.
Returns
-------
fieldFunction : :class:`~openturns.FieldFunction`
FieldFunction restricted to the concerned marginal(s) at the indice(s)
:math:`i` of the field function :math:`f_{dyn}`."
%enddef
%feature("docstring") OT::FieldFunctionImplementation::getMarginal
OT_FieldFunction_getMarginal_doc
// ---------------------------------------------------------------------
%define OT_FieldFunction_getOutputMesh_doc
"Get the mesh associated to the output process.
Returns
-------
outputMesh : :class:`~openturns.Mesh`
The mesh of the output process."
%enddef
%feature("docstring") OT::FieldFunctionImplementation::getOutputMesh
OT_FieldFunction_getOutputMesh_doc
// ---------------------------------------------------------------------
%define OT_FieldFunction_getSpatialDimension_doc
"Get the dimension of the mesh.
Returns
-------
spatialDimension : int, :math:`n \\\\geq 0`
Dimension of the mesh :math:`\\\\cM`."
%enddef
%feature("docstring") OT::FieldFunctionImplementation::getSpatialDimension
OT_FieldFunction_getSpatialDimension_doc
// ---------------------------------------------------------------------
%define OT_FieldFunction_getOutputDescription_doc
"Get the description of the outputs.
Returns
-------
outputDescription : :class:`~openturns.Description`
Describes the outputs of the function."
%enddef
%feature("docstring") OT::FieldFunctionImplementation::getOutputDescription
OT_FieldFunction_getOutputDescription_doc
// ---------------------------------------------------------------------
%define OT_FieldFunction_getOutputDimension_doc
"Get the dimension of the output.
Returns
-------
q : int
Output dimension :math:`q` of the function."
%enddef
%feature("docstring") OT::FieldFunctionImplementation::getOutputDimension
OT_FieldFunction_getOutputDimension_doc
// ---------------------------------------------------------------------
%feature("docstring") OT::FieldFunctionImplementation::setInputDescription
"Set the description of the inputs.
Parameters
----------
inputDescription : sequence of str
Describes the inputs of the function."
// ---------------------------------------------------------------------
%feature("docstring") OT::FieldFunctionImplementation::setOutputDescription
"Set the description of the outputs.
Parameters
----------
outputDescription : sequence of str
Describes the outputs of the function."
|