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

Define a residual function using the boundary conditions for the Blasius profile. More...

Inheritance diagram for CppNoddy::Example::Blasius_residual:
CppNoddy::Residual< double >

Public Member Functions

 Blasius_residual ()
 
 ~Blasius_residual ()
 
void residual_fn (const DenseVector< double > &unknown, DenseVector< double > &BC) const
 implement a residual function. More...
 
- Public Member Functions inherited from CppNoddy::Residual< double >
 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< double > &state)
 Update the Residual object for the current set of state variables. More...
 
const DenseVector< double > & residual () const
 Return a handle to the residuals corresponding to the last update state. More...
 
const DenseMatrix< double > & jacobian () const
 Retrun a handle to the Jacobian of the residual corresponding to the last update state. More...
 
double & delta ()
 
const double & 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< double > &state, DenseVector< double > &f) const
 A blank virtual residual function method. More...
 

Public Attributes

ODE_IVP< double > * ode
 

Additional Inherited Members

- Protected Member Functions inherited from CppNoddy::Residual< double >
virtual void jacobian (const DenseVector< double > &state, DenseMatrix< double > &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< double >
DenseMatrix< double > JAC_AT_LAST_STATE
 Jacobian for the last state vector. More...
 
DenseVector< double > FN_AT_LAST_STATE
 Residual for the last state vector. More...
 
DenseVector< double > LAST_STATE
 The last state vector. More...
 
double 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 a residual function using the boundary conditions for the Blasius profile.

Definition at line 48 of file BlasiusShooting.cpp.

Constructor & Destructor Documentation

◆ Blasius_residual()

CppNoddy::Example::Blasius_residual::Blasius_residual ( )
inline

Definition at line 53 of file BlasiusShooting.cpp.

53 : Residual<double> ( 1 )
54 {
55 // instantiate the Blasius equation as our problem
56 eqn = new Blasius_equation;
57 // instantiate an ODE in [0,20] with a maximum of
58 // 1000 integrator steps, using this problem equation
59 ode = new ODE_IVP<double>( eqn, 0.0, 20.0, 1000 );
60 // let's keep the history of the IVP for output in main
61 }
A templated object for real/complex vector system of first-order ordinary differential equations.
Definition: ODE_IVP.h:20
A base class to be inherited by objects that define residuals.
Definition: Residual.h:15

References ode.

◆ ~Blasius_residual()

CppNoddy::Example::Blasius_residual::~Blasius_residual ( )
inline

Definition at line 63 of file BlasiusShooting.cpp.

64 {
65 // clean up the created objects
66 delete ode;
67 delete eqn;
68 }

References ode.

Member Function Documentation

◆ residual_fn()

void CppNoddy::Example::Blasius_residual::residual_fn ( const DenseVector< double > &  unknown,
DenseVector< double > &  BC 
) const
inlinevirtual

implement a residual function.

Reimplemented from CppNoddy::Residual< double >.

Definition at line 71 of file BlasiusShooting.cpp.

72 {
73 DenseVector<double> u( 3, 0.0 ); // 3 variables of Blasius problem
74 u[ 0 ] = 0.0; // f = 0
75 u[ 1 ] = 0.0; // f' = 0
76 u[ 2 ] = unknown[ 0 ]; // f'' = unknown
77 // shoot with the RKF method, tolerance of 1.e-9
78 u = ode -> shoot45( u, 1.e-7, 0.01 );
79 // return the residual of f'(infty) = 1 condition
80 BC[ 0 ] = u[ 1 ] - 1.;
81 }
An DenseVector class – a dense vector object.
Definition: DenseVector.h:34

References ode, and u.

Member Data Documentation

◆ ode

ODE_IVP<double>* CppNoddy::Example::Blasius_residual::ode

Definition at line 51 of file BlasiusShooting.cpp.

Referenced by Blasius_residual(), main(), residual_fn(), and ~Blasius_residual().


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

© 2012

R.E. Hewitt