/usr/include/openturns/swig/SORMResult_doc.i is in libopenturns-dev 1.7-3.
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 | %feature("docstring") OT::SORMResult
"Result of a SORM analysis.
Available constructors:
SORMResult(*designPoint, limitStateVariable, isInFailureSpace*)
Notes
-----
Structure created by the method run() of the :class:`~openturns.SORM`
class and obtained thanks to its method getResult().
Parameters
----------
designPoint : sequence of float
Design point in the standard space resulting from the optimization
algorithm.
limitStateVariable : :class:`~openturns.Event`
Event of which the probability is calculated.
isInFailureSpace : bool
Indicates whether the origin of the standard space is in the failure space.
See also
--------
Analytical, AnalyticalResult, FORM, FORMResult, StrongMaximumTest"
// ---------------------------------------------------------------------
%feature("docstring") OT::SORMResult::getEventProbabilityBreitung
"Accessor to the failure probability :math:`P_{Breitung}`.
Returns
-------
probability : positive float
The SORM failure probability :math:`P_{Breitung}` according to the
:ref:`Breitung <Breitung_formula>` approximation."
// ---------------------------------------------------------------------
%feature("docstring") OT::SORMResult::getEventProbabilityHohenBichler
"Accessor to the failure probability :math:`P_{Hohenbichler}`.
Returns
-------
probability : positive float
The SORM failure probability :math:`P_{Hohenbichler}` according to the
:ref:`Hohen Bichler <Hohenbichler_formula>` approximation."
// ---------------------------------------------------------------------
%feature("docstring") OT::SORMResult::getEventProbabilityTvedt
"Accessor to the failure probability :math:`P_{Tvedt}`.
Returns
-------
probability : positive float
The SORM failure probability :math:`P_{Tvedt}` according to the
:ref:`Tvedt <Tvedt_formula>` approximation."
// ---------------------------------------------------------------------
%feature("docstring") OT::SORMResult::getGeneralisedReliabilityIndexBreitung
"Accessor to the Generalised Reliability Index Breitung.
Returns
-------
index : float
Generalised reliability index evaluated from the Breitung SORM failure
probability.
.. math::
\\\\beta_{Breitung} = \\\\left \\\\{
\\\\begin{array}{ll}
\\\\displaystyle -\\\\Phi(P_{Breitung})
& \\\\text{if the standard space origin is not in the failure space} \\\\\\\\
\\\\displaystyle \\\\Phi(P_{Breitung}) & \\\\text{otherwise}
\\\\end{array}
\\\\right."
// ---------------------------------------------------------------------
%feature("docstring") OT::SORMResult::getGeneralisedReliabilityIndexHohenBichler
"Accessor to the Generalised Reliability Index HohenBichler.
Returns
-------
index : float
Generalised reliability index evaluated from the Hohen Bichler SORM failure
probability.
.. math::
\\\\beta_{Hohenbichler} = \\\\left \\\\{
\\\\begin{array}{ll}
\\\\displaystyle -\\\\Phi(P_{Hohenbichler})
& \\\\text{if the standard space origin is not in the failure space} \\\\\\\\
\\\\displaystyle \\\\Phi(P_{Hohenbichler}) & \\\\text{otherwise}
\\\\end{array}
\\\\right."
// ---------------------------------------------------------------------
%feature("docstring") OT::SORMResult::getGeneralisedReliabilityIndexTvedt
"Accessor to the Generalised Reliability Index Tvedt.
Returns
-------
index : float
Generalised reliability index evaluated from the Tvedt SORM failure
probability.
.. math::
\\\\beta_{Tvedt} = \\\\left \\\\{
\\\\begin{array}{ll}
\\\\displaystyle -\\\\Phi(P_{Tvedt})
& \\\\text{if the standard space origin is not in the failure space} \\\\\\\\
\\\\displaystyle \\\\Phi(P_{Tvedt}) & \\\\text{otherwise}
\\\\end{array}
\\\\right."
// ---------------------------------------------------------------------
%feature("docstring") OT::SORMResult::getSortedCurvatures
"Accessor to the sorted curvatures.
Returns
-------
curvatures : :class:`~openturns.NumericalPoint`
Curvatures of the standard limite state function at the standard design
point :math:`(\\\\kappa_i)_{1 \\\\leq i \\\\leq n-1}` with :math:`n` the dimension
of the random vector :math:`\\\\vect{X}`."
|