CppNoddy  0.92
Loading...
Searching...
No Matches
Public Member Functions | List of all members
CppNoddy::Example::Troesch_right_BC< _Type > Class Template Reference
Inheritance diagram for CppNoddy::Example::Troesch_right_BC< _Type >:
CppNoddy::Residual< _Type >

Public Member Functions

 Troesch_right_BC ()
 
void residual_fn (const DenseVector< _Type > &z, DenseVector< _Type > &B) const
 A blank virtual residual function method. 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< _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>
class CppNoddy::Example::Troesch_right_BC< _Type >

Definition at line 57 of file BVPTroesch.cpp.

Constructor & Destructor Documentation

◆ Troesch_right_BC()

template<typename _Type >
CppNoddy::Example::Troesch_right_BC< _Type >::Troesch_right_BC ( )
inline

Definition at line 50 of file BVPTroesch.cpp.

60: Residual<_Type> ( 1, 2 ) {}
A base class to be inherited by objects that define residuals.
Definition: Residual.h:15

Member Function Documentation

◆ residual_fn()

template<typename _Type >
void CppNoddy::Example::Troesch_right_BC< _Type >::residual_fn ( const DenseVector< _Type > &  state,
DenseVector< _Type > &  f 
) const
inlinevirtual

A blank virtual residual function method.

Parameters
stateThe unknown variable.
fThe residual function f(x).

Reimplemented from CppNoddy::Residual< _Type >.

Definition at line 62 of file BVPTroesch.cpp.

63 {
64 B[ 0 ] = z[ f ] - 1.;
65 }
@ f
Definition: BVPBerman.cpp:15

References f, and CppNoddy::Example::z().


The documentation for this class was generated from the following file:

© 2012

R.E. Hewitt