- Home
- About DUNE
- Download
- Documentation
- Community
- Development
Dune::DifferentiableFunction< DT, RT, n, m > Class Template Reference
[Functions Hierarchy]
#include <functions.hh>
Inheritance diagram for Dune::DifferentiableFunction< DT, RT, n, m >:
Detailed Description
template<class DT, class RT, int n, int m>
class Dune::DifferentiableFunction< DT, RT, n, m >
Abstract base class for differentiable functions.
Extends Function by the evaluation of partial derivatives up to a given order.
Template parameters are:
- DT type for components of the input vector
- RT type for the return values
- n dimension of the input space
- m number of components of the vector-valued function
Public Types | |
| enum | |
| export dimension of domain and range | |
| typedef DT | DomainFieldType |
| export type for domain components | |
| typedef RT | RangeFieldType |
| export type for range components | |
Public Member Functions | |
| virtual RT | derivative (int comp, const Dune::FieldVector< int, n > &d, const Dune::FieldVector< DT, n > &x) const=0 |
| evaluate partial derivative | |
| virtual int | order () const=0 |
| return number of partial derivatives that can be taken | |
| virtual RT | eval (int comp, const Dune::FieldVector< DT, n > &x) const=0 |
| evaluate single component comp at global point x | |
| virtual void | evalall (const Dune::FieldVector< DT, n > &x, Dune::FieldVector< RT, m > &y) const=0 |
| evaluate all components at point x and store result in y | |
Member Function Documentation
template<class DT, class RT, int n, int m>
| virtual RT Dune::DifferentiableFunction< DT, RT, n, m >::derivative | ( | int | comp, | |
| const Dune::FieldVector< int, n > & | d, | |||
| const Dune::FieldVector< DT, n > & | x | |||
| ) | const [pure virtual] |
evaluate partial derivative
Evaluate partial derivative of a component of the vector-valued function.
- Parameters:
-
[in] comp number of component that should be differentiated [in] d vector giving order of derivative for each variable [in] x position where derivative is to be evaluated
- Returns:
- value of the derivative
Implemented in Dune::DifferentiableGridFunctionAdapter< G, RT, m >, Dune::DifferentiableFunctionDefault< DT, RT, n, m >, Dune::P1Function< GV, RT, LC, m >, Dune::GridFunctionGlobalDifferentiationDefault< GV, RT, 1 >, Dune::GridFunctionGlobalDifferentiationDefault< G::LeafGridView, RT, 1 >, Dune::GridFunctionGlobalDifferentiationDefault< G::LevelGridView, RT, 1 >, Dune::P1Function< G::LevelGridView, RT, Dune::LevelCommunicate< G >, m >, and Dune::P1Function< G::LeafGridView, RT, Dune::LeafCommunicate< G >, m >.
template<class DT, class RT, int n, int m>
| virtual int Dune::DifferentiableFunction< DT, RT, n, m >::order | ( | ) | const [pure virtual] |
return number of partial derivatives that can be taken
A DifferentiableFunction can say how many derivatives exist and can be safely evaluated.
Implemented in Dune::DifferentiableGridFunctionAdapter< G, RT, m >, Dune::C1Function< DT, RT, n, m >, Dune::H1Function< DT, RT, n, m >, Dune::HdivFunction< DT, RT, n, m >, Dune::ElementwiseCInfinityFunction< G, RT, m >, Dune::P1Function< GV, RT, LC, m >, Dune::P2Function< GridType, RT, IS, m >, Dune::H1Function< G::LeafGridView::Grid::ctype, RT, G::LeafGridView::Grid::dimension, m >, Dune::H1Function< G::LeafGridView::Grid::ctype, RT, G::LeafGridView::Grid::dimension, 1 >, Dune::H1Function< GV::Grid::ctype, RT, GV::Grid::dimension, 1 >, Dune::H1Function< G::ctype, RT, G::dimension, m >, Dune::H1Function< G::LevelGridView::Grid::ctype, RT, G::LevelGridView::Grid::dimension, 1 >, Dune::H1Function< GridType::ctype, RT, GridType::dimension, m >, Dune::H1Function< GV::Grid::ctype, RT, GV::Grid::dimension, m >, Dune::H1Function< G::LevelGridView::Grid::ctype, RT, G::LevelGridView::Grid::dimension, m >, Dune::ElementwiseCInfinityFunction< G::LeafGridView::Grid, RT, m >, Dune::ElementwiseCInfinityFunction< G::LevelGridView::Grid, RT, m >, Dune::ElementwiseCInfinityFunction< GridType, RT, m >, Dune::ElementwiseCInfinityFunction< GV::Grid, RT, m >, Dune::P1Function< G::LevelGridView, RT, Dune::LevelCommunicate< G >, m >, Dune::P1Function< G::LeafGridView, RT, Dune::LeafCommunicate< G >, m >, Dune::P2Function< G, RT, G::template Codim< 0 >::LevelIndexSet, m >, and Dune::P2Function< G, RT, G::template Codim< 0 >::LeafIndexSet, m >.
template<class DT, class RT, int n, int m>
| virtual RT Dune::FunctionBase< DT, RT, n, m >::eval | ( | int | comp, | |
| const Dune::FieldVector< DT, n > & | x | |||
| ) | const [pure virtual, inherited] |
evaluate single component comp at global point x
Evaluate a single component of the vector-valued function.
- Parameters:
-
[in] comp number of component to be evaluated [in] x position to be evaluated
- Returns:
- value of the component
Implemented in Dune::GridFunctionAdapter< G, RT, m >, Dune::DifferentiableGridFunctionAdapter< G, RT, m >, Dune::GridLevelLeafFunctionAdapter< G, RT, m >, Dune::GridLeafFunctionAdapter< G, IS, RT, m >, Dune::GridFunctionGradient< G, RT >, Dune::GridFunctionMinus< G, RT, m >, Dune::GridFunctionGlobalEvalDefault< GV, RT, 1 >, Dune::GridFunctionGlobalEvalDefault< G::LevelGridView, RT, m >, Dune::GridFunctionGlobalEvalDefault< G::LeafGridView, RT, 1 >, Dune::GridFunctionGlobalEvalDefault< G::LeafGridView, RT, m >, and Dune::GridFunctionGlobalEvalDefault< G::LevelGridView, RT, 1 >.
template<class DT, class RT, int n, int m>
| virtual void Dune::FunctionBase< DT, RT, n, m >::evalall | ( | const Dune::FieldVector< DT, n > & | x, | |
| Dune::FieldVector< RT, m > & | y | |||
| ) | const [pure virtual, inherited] |
evaluate all components at point x and store result in y
Evaluation function for all components at once.
- Parameters:
-
[in] x position to be evaluated [out] y result vector to be filled
Implemented in Dune::FunctionDefault< DT, RT, n, m >.
The documentation for this class was generated from the following file: