METHOD
Public Member Functions | Public Attributes | List of all members
TimeIntegratorBase Class Referenceabstract

#include <timeInt.h>

Inheritance diagram for TimeIntegratorBase:
Inheritance graph
[legend]
Collaboration diagram for TimeIntegratorBase:
Collaboration graph
[legend]

Public Member Functions

 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
 
virtual void finalise (double *cons, double *prims, double *aux)=0
 

Public Attributes

Data * data
 
Model * model
 
Bcs * bcs
 
FluxMethod * fluxMethod
 
ModelExtension * modelExtension
 

Detailed Description

Abstract base class for time integrator

Abstract base class for all types of time integrators. Integrators require data to operate on, model for the flux functions and the boundary conditions to apply one the step has been made

Definition at line 18 of file timeInt.h.

Constructor & Destructor Documentation

◆ TimeIntegratorBase()

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

Constructor.

Stores pointers to all the relevant objects
Parameters
[in]*dataPointer to Data class containing global simulation data
[in]*modelpointer to Model object
[in]*bcspointer to Bcs object
[in]*fluxMethodpointer to FluxMethod object
[in]*modelExtensionpointer to the ModelExtension object

Definition at line 43 of file timeInt.h.

◆ ~TimeIntegratorBase()

virtual TimeIntegratorBase::~TimeIntegratorBase ( )
inlinevirtual

Destructor.

Definition at line 47 of file timeInt.h.

Member Function Documentation

◆ finalise()

virtual void TimeIntegratorBase::finalise ( double *  cons,
double *  prims,
double *  aux 
)
pure virtual

Finalise a step.

After the interior (physical) cells have been updated by an integrator, we must perform the C2P transformation and apply any boundary conditions. This is to be done via this method.

Parameters

Implemented in TimeIntegrator.

◆ step()

virtual void TimeIntegratorBase::step ( double *  cons,
double *  prims,
double *  aux,
double  dt = 0 
)
pure virtual

Perform a single timestep on the conserved variables.

Every integrator must perform a single timestep on the conserved variables. This `step' function is called from within the main simulation loop.`
Parameters

Implemented in RK4_10, RK4, RK3, RK2B, RK2, RKSplit2, SSP2322, SSP3, SSP2, and BackwardsRK2.

Member Data Documentation

◆ bcs

Bcs* TimeIntegratorBase::bcs

Pointer to boundary conditions, Bcs, object.

Definition at line 26 of file timeInt.h.

◆ data

Data* TimeIntegratorBase::data

Pointer to Data class containing global simulation data.

Definition at line 22 of file timeInt.h.

◆ fluxMethod

FluxMethod* TimeIntegratorBase::fluxMethod

Pointer to FluxMethod object.

Definition at line 28 of file timeInt.h.

◆ model

Model* TimeIntegratorBase::model

Pointer to Model object, contains governing equations and spectral decomposition.

Definition at line 24 of file timeInt.h.

◆ modelExtension

ModelExtension* TimeIntegratorBase::modelExtension

Pointer to model extension class.

Definition at line 30 of file timeInt.h.

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