|
Opm::MathToolbox< ScalarT, true > Struct Template Reference
Member Typedef Documentation
template<class ScalarT >
The type used to represent function evaluations. In general, that is the value of the function plus a number of derivatives at the evaluation point. In the case of the scalar toolbox, no derivatives will be evaluated.
template<class ScalarT >
The type used to represent scalar values. Member Function Documentation
template<class ScalarT >
The absolute value. References Opm::LocalAd::abs().
template<class ScalarT >
The arcus cosine of a value. References Opm::LocalAd::acos().
template<class ScalarT >
The arcus sine of a value. References Opm::LocalAd::asin().
template<class ScalarT >
The arcus tangens of a value. References Opm::LocalAd::atan().
template<class ScalarT >
The arcus tangens of a value. References Opm::LocalAd::atan2().
template<class ScalarT >
The cosine of a value. References Opm::LocalAd::cos().
template<class ScalarT >
Given a scalar value, return an evaluation of a constant function. For this toolbox, an evaluation is the value, so this method is the identity function. In general, this returns an evaluation object for which all derivatives are zero.
template<class ScalarT >
Given a scalar value, return an evaluation of a linear function. i.e., Create an evaluation which represents f(x) = x and the derivatives with regard to x. For scalar evaluations (which do not consider derivatives), this method does nothing.
template<class ScalarT >
The natural exponentiation of a value. References Opm::LocalAd::exp().
template<class ScalarT >
The natural logarithm of a value. References Opm::LocalAd::log().
template<class ScalarT >
The maximum of two arguments. References Opm::LocalAd::max().
template<class ScalarT >
The minimum of two arguments. References Opm::LocalAd::min().
template<class ScalarT >
Pass a value through if it is an evaluation, or create a constant evaluation if it is a scalar. In some sense, this method is the opposite of "toLhs()": If the function argument is a Scalar, an Evaluation which represents a constant value is returned, if the argument is an Evaluation, it is returned as is. This method makes it possible to uniformly handle the cases where some condition is either given by a constant value or as a value which depends on other variables. (E.g. boundary conditions.)
template<class ScalarT >
Exponentiation to an arbitrary base. References Opm::LocalAd::pow().
template<class ScalarT >
The sine of a value. References Opm::LocalAd::sin().
template<class ScalarT >
The square root of a value. References Opm::LocalAd::sqrt().
template<class ScalarT >
The tangens of a value. References Opm::LocalAd::tan().
template<class ScalarT >
template<class LhsEval >
Given a function evaluation, constrain it to its value (if necessary). If the left hand side is a scalar and the right hand side is an evaluation, the scalar gets the value of the right hand side assigned. Also if both sides are scalars, this method returns the identity. The final case (left hand side being an evaluation, right hand side is a scalar) yields a compiler error. The purpose of this method is to be able to transparantly use evaluation objects in scalar computations.
template<class ScalarT >
Return the value of the function at a given evaluation point. For this toolbox, an evaluation is the value, so this method is the identity function. The documentation for this struct was generated from the following file: |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||