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

Public Member Functions

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

Additional Inherited Members

- Protected Member Functions inherited from CppNoddy::Residual< D_complex >
virtual void jacobian (const DenseVector< D_complex > &state, DenseMatrix< D_complex > &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< D_complex >
DenseMatrix< D_complexJAC_AT_LAST_STATE
 Jacobian for the last state vector. More...
 
DenseVector< D_complexFN_AT_LAST_STATE
 Residual for the last state vector. More...
 
DenseVector< D_complexLAST_STATE
 The last state vector. More...
 
D_complex 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

Definition at line 141 of file EVPOrrSommerfeldEasy_lapack.cpp.

Constructor & Destructor Documentation

◆ OS_bvp_right_BC() [1/2]

CppNoddy::Example::OS_bvp_right_BC::OS_bvp_right_BC ( )
inline

Definition at line 145 of file EVPOrrSommerfeldEasy_lapack.cpp.

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

◆ OS_bvp_right_BC() [2/2]

CppNoddy::Example::OS_bvp_right_BC::OS_bvp_right_BC ( )
inline

Definition at line 145 of file EVPOrrSommerfeldNeutralCurve_lapack.cpp.

145: Residual<D_complex> ( 2, 5 ) {}

Member Function Documentation

◆ residual_fn() [1/2]

void CppNoddy::Example::OS_bvp_right_BC::residual_fn ( const DenseVector< D_complex > &  state,
DenseVector< D_complex > &  f 
) const
inlinevirtual

A blank virtual residual function method.

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

Reimplemented from CppNoddy::Residual< D_complex >.

Definition at line 147 of file EVPOrrSommerfeldEasy_lapack.cpp.

148 {
149 B[ 0 ] = z[ phi ];
150 B[ 1 ] = z[ phid ];
151 }

References phi, phid, and CppNoddy::Example::z().

◆ residual_fn() [2/2]

void CppNoddy::Example::OS_bvp_right_BC::residual_fn ( const DenseVector< D_complex > &  state,
DenseVector< D_complex > &  f 
) const
inlinevirtual

A blank virtual residual function method.

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

Reimplemented from CppNoddy::Residual< D_complex >.

Definition at line 147 of file EVPOrrSommerfeldNeutralCurve_lapack.cpp.

148 {
149 B[ 0 ] = z[ phi ];
150 B[ 1 ] = z[ phid ];
151 }

References phi, phid, and CppNoddy::Example::z().


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

© 2012

R.E. Hewitt