#include <timeInt.h>

Inheritance diagram for TimeIntegrator:

[legend]

Collaboration diagram for TimeIntegrator:

[legend]

Public Member Functions
	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

Additional Inherited Members
Public Attributes inherited from TimeIntegratorBase
Data *	data

Model *	model

Bcs *	bcs

FluxMethod *	fluxMethod

ModelExtension *	modelExtension

Detailed Description

General form of the time integrator

: Probably all time integrators will require the same `finalise' method. In this class, we implement that for all integrators to inherit.

Definition at line 85 of file timeInt.h.

Constructor & Destructor Documentation

◆ TimeIntegrator()

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

inline

Constructor.

: Stores pointers to all the relevant objects

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

Definition at line 100 of file timeInt.h.

◆ ~TimeIntegrator()

virtual TimeIntegrator::~TimeIntegrator ( )

inlinevirtual

Destructor.

Definition at line 104 of file timeInt.h.

Member Function Documentation

◆ finalise()

void TimeIntegrator::finalise	(	double *	cons,
		double *	prims,
		double *	aux
	)

inlinevirtual

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.First, the C2P is done for all interior cells, then we apply BCs.

Parameters

Implements TimeIntegratorBase.

Definition at line 117 of file timeInt.h.

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

timeInt.h