An equation object base class used in the BVP/IVP classes. More...
#include <Equation.h>
Inheritance diagram for CppNoddy::Equation< _Type, _Xtype >:
Public Member Functions | |
| Equation (const unsigned &order) | |
| Constructor for equation class. More... | |
| virtual | ~Equation () |
| An empty destructor, virtual since we have virtual methods. More... | |
 Public Member Functions inherited from CppNoddy::Residual_with_coords< _Type, _Xtype > | |
| Residual_with_coords (const unsigned &order, const unsigned &ncoords) | |
| Constructor for a 'square' residual object that is, N residuals for N unknowns. More... | |
| Residual_with_coords (const unsigned &order, const unsigned &nvars, const unsigned &ncoords) | |
| Constructor for a 'non-square' residual object that is, there are less residual constraints than unknowns. More... | |
| virtual | ~Residual_with_coords () |
| An empty destructor. More... | |
| _Xtype & | coord (const unsigned &i) |
| General handle access to the coordinates. More... | |
| const _Xtype & | coord (const unsigned &i) const |
| General handle access to the coordinates. More... | |
| Public Member Functions inherited from CppNoddy::Residual< _Type > | |
| Residual (const unsigned &order) | |
| Constructor for a 'square' residual object that is, N residuals for N unknowns. More... | |
| Residual (const unsigned &order, const unsigned &nvars) | |
| Constructor for a 'non-square' residual object that is, there are less residual constraints than unknowns. More... | |
| virtual | ~Residual () |
| An empty destructor, virtual since we have virtual methods. More... | |
| void | update (const DenseVector< _Type > &state) |
| Update the Residual object for the current set of state variables. More... | |
| const DenseVector< _Type > & | residual () const |
| Return a handle to the residuals corresponding to the last update state. More... | |
| const DenseMatrix< _Type > & | jacobian () const |
| Retrun a handle to the Jacobian of the residual corresponding to the last update state. More... | |
| _Type & | delta () |
| const _Type & | delta () const |
| unsigned | get_order () const |
| Get the order of the residual vector. More... | |
| unsigned | get_number_of_vars () const |
| Get the number of variables that this residual condition is defined for. More... | |
| virtual void | residual_fn (const DenseVector< _Type > &state, DenseVector< _Type > &f) const |
| A blank virtual residual function method. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from CppNoddy::Residual< _Type > | |
| virtual void | jacobian (const DenseVector< _Type > &state, DenseMatrix< _Type > &jac) const |
| Because the residual evaluation at the current state is assumed to have already been done by the 'update' method, this routine is protected. More... | |
| Protected Attributes inherited from CppNoddy::Residual_with_coords< _Type, _Xtype > | |
| std::vector< _Xtype > | coords |
| The coordinates stored for this residual. More... | |
| Protected Attributes inherited from CppNoddy::Residual< _Type > | |
| DenseMatrix< _Type > | JAC_AT_LAST_STATE |
| Jacobian for the last state vector. More... | |
| DenseVector< _Type > | FN_AT_LAST_STATE |
| Residual for the last state vector. More... | |
| DenseVector< _Type > | LAST_STATE |
| The last state vector. More... | |
| _Type | DELTA |
| A default step for FD computation of the Jacobian. More... | |
| unsigned | ORDER_OF_SYSTEM |
| The order of the system of equations. More... | |
| unsigned | NUMBER_OF_VARS |
| The number of elements in the state vector. More... | |
Detailed Description
template<typename _Type, typename _Xtype = double>
class CppNoddy::Equation< _Type, _Xtype >
class CppNoddy::Equation< _Type, _Xtype >
An equation object base class used in the BVP/IVP classes.
An equation object is essentially a ('square') residual object with an independent variable data member and access methods. By 'square' we mean that it defines N residuals and N state variables.
Definition at line 22 of file Equation.h.
Constructor & Destructor Documentation
◆ Equation()
template<typename _Type , typename _Xtype >
| CppNoddy::Equation< _Type, _Xtype >::Equation | ( | const unsigned & | order | ) |
Constructor for equation class.
- Parameters
-
order The order of the system
Definition at line 11 of file Equation.cpp.
11 :
12 Residual_with_coords<_Type, _Xtype>(order, 1) {
13 }
◆ ~Equation()
template<typename _Type , typename _Xtype >
|
virtual |
An empty destructor, virtual since we have virtual methods.
Definition at line 16 of file Equation.cpp.
16 {
17 }
The documentation for this class was generated from the following files:
- include/Equation.h
- src/Equation.cpp
