Inheritance diagram for CppNoddy::Example::Harmonic_left_BC< _Type >:

Public Member Functions
	Harmonic_left_BC ()

void	residual_fn (const DenseVector< _Type > &z, DenseVector< _Type > &B) const
	A blank virtual residual function method. More...

	Harmonic_left_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< _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...

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_complex &	delta ()

const D_complex &	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< 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< _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 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< _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...

Protected Attributes inherited from CppNoddy::Residual< D_complex >
DenseMatrix< D_complex >	JAC_AT_LAST_STATE
	Jacobian for the last state vector. More...

DenseVector< D_complex >	FN_AT_LAST_STATE
	Residual for the last state vector. More...

DenseVector< D_complex >	LAST_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

template<typename _Type>
class CppNoddy::Example::Harmonic_left_BC< _Type >

Definition at line 47 of file BVPHarmonic.cpp.

Constructor & Destructor Documentation

◆ Harmonic_left_BC() [1/2]

template<typename _Type >

CppNoddy::Example::Harmonic_left_BC< _Type >::Harmonic_left_BC ( )

inline

Definition at line 39 of file BVPHarmonic.cpp.

50: Residual<_Type> ( 1, 2 ) {}

CppNoddy::Residual

A base class to be inherited by objects that define residuals.

Definition: Residual.h:15

References Utils_Fill::fill_identity(), and m.

◆ Harmonic_left_BC() [2/2]

template<typename _Type >

CppNoddy::Example::Harmonic_left_BC< _Type >::Harmonic_left_BC ( )

inline

Definition at line 61 of file EVPHarmonicLocal.cpp.

61: Residual<D_complex> ( 2, 3 ) {}

Member Function Documentation

◆ residual_fn() [1/2]

template<typename _Type >

void CppNoddy::Example::Harmonic_left_BC< _Type >::residual_fn	(	const DenseVector< _Type > &	state,
		DenseVector< _Type > &	f
	)		const

inlinevirtual

A blank virtual residual function method.

Parameters

state	The unknown variable.
f	The residual function f(x).

Reimplemented from CppNoddy::Residual< _Type >.

Definition at line 52 of file BVPHarmonic.cpp.

      {
        B[ 0 ] = z[ f ];
      }

◆ residual_fn() [2/2]

template<typename _Type >

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

inlinevirtual

A blank virtual residual function method.

Parameters

state	The unknown variable.
f	The residual function f(x).

Reimplemented from CppNoddy::Residual< D_complex >.

Definition at line 63 of file EVPHarmonicLocal.cpp.

      {
        B[ 0 ] = z[ f ];
        B[ 1 ] = z[ fd ] - 1.0; // arbitrary amplitude
      }

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

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

Tests/BVP/BVPHarmonic.cpp
Tests/EVP/EVPHarmonicLocal.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Harmonic_left_BC() [1/2]

◆ Harmonic_left_BC() [2/2]

Member Function Documentation

◆ residual_fn() [1/2]

◆ residual_fn() [2/2]