RKPlus Class Reference

#include <RKPlus.h>

Inheritance diagram for RKPlus:

Collaboration diagram for RKPlus:

Public Member Functions
	RKPlus (Data *data, Model *model, Bcs *bcs, FluxMethod *fluxMethod, ModelExtension *modelExtension=NULL)
virtual	~RKPlus ()
virtual void	rhs (double *cons, double *prims, double *aux, double *rhsVec)
Public Member Functions inherited from TimeIntegrator
	TimeIntegrator (Data *data, Model *model, Bcs *bcs, FluxMethod *fluxMethod, ModelExtension *modelExtension=NULL)
virtual	~TimeIntegrator ()
void	finalise (double *cons, double *prims, double *aux)
Public Member Functions inherited from TimeIntegratorBase
	TimeIntegratorBase (Data *data, Model *model, Bcs *bcs, FluxMethod *fluxMethod, ModelExtension *modelExtension=NULL)
virtual	~TimeIntegratorBase ()
virtual void	step (double *cons, double *prims, double *aux, double dt=0)=0

Public Attributes
double *	fluxCont
Public Attributes inherited from TimeIntegratorBase
Data *	data
Model *	model
Bcs *	bcs
FluxMethod *	fluxMethod
ModelExtension *	modelExtension

Detailed Description

< Base for RKPlus classes

For the higher order RK intergrators, we are going to bundle the source and the flux into a RHS function

Definition at line 35 of file RKPlus.h.

Constructor & Destructor Documentation

RKPlus()

RKPlus::RKPlus	(	Data *	data,
		Model *	model,
		Bcs *	bcs,
		FluxMethod *	fluxMethod,
		ModelExtension *	modelExtension = NULL
	)

Constructor.

Constructor requires simulation data and the flux and source functions from the model class. Stores the necessary pointer.

Parameters

[in]	*data	Pointer to Data class containing global simulation data
[in]	*model	pointer to Model object
[in]	*bcs	pointer to Bcs object
[in]	*fluxMethod	pointer to FluxMethod object
[in]	*modelExtension	pointer to the ModelExtension object

See also

TimeIntegrator::TimeIntegrator

~RKPlus()

virtual RKPlus::~RKPlus ( )

virtual

Member Function Documentation

rhs()

virtual void RKPlus::rhs ( double *  cons, double *  prims, double *  aux, double *  rhsVec  )

virtual

Right-hand side evaluator.

Evaluate the RHS of the ODE by combining all sources and flux terms.

The rhs function calculates the following:

\begin{align} \mathcal{L}(U) = \Psi(U) + \Delta t \mathcal{F}(U) \end{align}

where \(\Psi\) is the sum of all source terms, and \(\mathcal{F}\) is the numerical flux function.

Parameters

[in]	*cons	pointer to conserved vector work array. Size is \(N_{cons} \times N_x \times N_y \times N_z\)
[in]	*prims	pointer to primitive vector work array. Size is \(N_{prims} \times N_x \times N_y \times N_z\)
[in]	*aux	pointer to auxiliary vector work array. Size is \(N_{aux} \times N_x \times N_y \times N_z\)
[out]	*rhsVec	pointer to rhs vector. Size is \(N_{cons} \times N_x \times N_y \times N_z\)

Member Data Documentation

fluxCont

double* RKPlus::fluxCont

Temporary work array to store numerical flux.

Definition at line 39 of file RKPlus.h.

---

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

• RKPlus.h