CppNoddy  0.92
Loading...
Searching...
No Matches
Public Member Functions | List of all members
CppNoddy::Example::Diffusion_left_BC Class Reference

Define the boundary conditions. More...

Inheritance diagram for CppNoddy::Example::Diffusion_left_BC:
CppNoddy::Residual_with_coords< double > CppNoddy::Residual< _Type >

Public Member Functions

 Diffusion_left_BC ()
 
void residual_fn (const DenseVector< double > &z, DenseVector< double > &b) const
 
- Public Member Functions inherited from CppNoddy::Residual_with_coords< double >
 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...
 
double & coord (const unsigned &i)
 General handle access to the coordinates. More...
 
const double & 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< double >
std::vector< double > 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

Define the boundary conditions.

Definition at line 70 of file IBVPDiffusionNonlinear.cpp.

Constructor & Destructor Documentation

◆ Diffusion_left_BC()

CppNoddy::Example::Diffusion_left_BC::Diffusion_left_BC ( )
inline

Definition at line 74 of file IBVPDiffusionNonlinear.cpp.

74: Residual_with_coords<double> ( 1, 2, 1 ) {}
A base class to be inherited by objects that define residuals.

Member Function Documentation

◆ residual_fn()

void CppNoddy::Example::Diffusion_left_BC::residual_fn ( const DenseVector< double > &  z,
DenseVector< double > &  b 
) const
inline

Definition at line 76 of file IBVPDiffusionNonlinear.cpp.

77 {
78 b[ 0 ] = z[ U ] - 1.0;
79 }
@ U
Definition: BVPKarman.cpp:20

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


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

© 2012

R.E. Hewitt