RIMIntegrator< VectorType, dim > Class Template Reference

Basic class for derivation of RIMIntegrator. More...

#include <RIMIntegrator.h>

Inheritance diagram for RIMIntegrator< VectorType, dim >:

List of all members.

Public Types
typedef base::vec_grid_fct_type	vec_grid_fct_type
typedef base::vec_grid_data_type	vec_grid_data_type
typedef generic_fortran_func	generic_func_type
typedef void(*	check_1_func_type )(FI(1, VectorType), BI, const INTEGER &meqn, const INTEGER &mout, INTEGER &result)
typedef void(*	check_2_func_type )(FI(2, VectorType), BI, const INTEGER &meqn, const INTEGER &mout, INTEGER &result)
typedef void(*	check_3_func_type )(FI(3, VectorType), BI, const INTEGER &meqn, const INTEGER &mout, INTEGER &result)
typedef void(*	step_func_type )(const INTEGER &nx, const INTEGER &ny, const INTEGER &nbc, const INTEGER &neqn, const DOUBLE &dx, const DOUBLE &dy, VectorType ux[], VectorType uxold[], const DOUBLE &dt, DOUBLE &cfl, VectorType fx[], VectorType fy[])
Public Member Functions
	RIMIntegrator (generic_func_type step)
	RIMIntegrator (generic_func_type step, generic_func_type chk)
	~RIMIntegrator ()
virtual void	register_at (ControlDevice &Ctrl, const std::string &prefix)
virtual void	register_at (ControlDevice &Ctrl)
virtual void	SetupData (GridHierarchy *gh, const int &ghosts)
virtual double	CalculateGrid (vec_grid_data_type &NewStateVec, vec_grid_data_type &OldStateVec, vec_grid_data_type *Flux[], const int &level, const double &t, const double &dt, const int &mpass)
virtual void	AllocGridFluxes (const BBox &bb, vec_grid_data_type **&Flux)
virtual void	DeAllocGridFluxes (vec_grid_data_type **&Flux)
virtual void	ResetGridFluxes (vec_grid_data_type **&Flux)
virtual int	ControlGrid (vec_grid_data_type &StateVec, const int &level, const BBox &where, const double &time, const int verbose)
const int &	NCheck () const
virtual int	NMethodOrder () const
int	NMaxPass () const
void	SetCheckFunc (generic_func_type check)
generic_func_type	GetCheckFunc () const
void	SetStepFunc (generic_func_type step)
generic_func_type	GetStepFunc () const
Protected Attributes
generic_func_type	f_step
generic_func_type	f_chk
std::string	_name
int	_order
int	_check
VectorType *	FluxData

---

Detailed Description

template<class VectorType, int dim>
class RIMIntegrator< VectorType, dim >

Basic class for derivation of RIMIntegrator.

This class capsulates the methods of RIMIntegrator that are independent of the spatial dimension.

---

Member Typedef Documentation

template<class VectorType, int dim>

typedef void(* RIMIntegrator< VectorType, dim >::check_1_func_type)(FI(1, VectorType), BI, const INTEGER &meqn, const INTEGER &mout, INTEGER &result)

template<class VectorType, int dim>

typedef void(* RIMIntegrator< VectorType, dim >::check_2_func_type)(FI(2, VectorType), BI, const INTEGER &meqn, const INTEGER &mout, INTEGER &result)

template<class VectorType, int dim>

typedef void(* RIMIntegrator< VectorType, dim >::check_3_func_type)(FI(3, VectorType), BI, const INTEGER &meqn, const INTEGER &mout, INTEGER &result)

template<class VectorType, int dim>

typedef generic_fortran_func RIMIntegrator< VectorType, dim >::generic_func_type

template<class VectorType, int dim>

typedef void(* RIMIntegrator< VectorType, dim >::step_func_type)(const INTEGER &nx, const INTEGER &ny, const INTEGER &nbc, const INTEGER &neqn, const DOUBLE &dx, const DOUBLE &dy, VectorType ux[], VectorType uxold[], const DOUBLE &dt, DOUBLE &cfl, VectorType fx[], VectorType fy[])

template<class VectorType, int dim>

typedef base::vec_grid_data_type RIMIntegrator< VectorType, dim >::vec_grid_data_type

Reimplemented from Integrator< VectorType, dim >.

template<class VectorType, int dim>

typedef base::vec_grid_fct_type RIMIntegrator< VectorType, dim >::vec_grid_fct_type

Reimplemented from Integrator< VectorType, dim >.

---

Constructor & Destructor Documentation

template<class VectorType, int dim>

RIMIntegrator< VectorType, dim >::RIMIntegrator

(

generic_func_type

step

)

[inline]

template<class VectorType, int dim>

RIMIntegrator< VectorType, dim >::RIMIntegrator	(	generic_func_type	step,
		generic_func_type	chk
	)			[inline]

template<class VectorType, int dim>

RIMIntegrator< VectorType, dim >::~RIMIntegrator

(

)

[inline]

---

Member Function Documentation

template<class VectorType, int dim>

virtual void RIMIntegrator< VectorType, dim >::AllocGridFluxes	(	const BBox &	bb,
		vec_grid_data_type **&	Flux
	)			[inline, virtual]

Implements Integrator< VectorType, dim >.

template<class VectorType, int dim>

virtual double RIMIntegrator< VectorType, dim >::CalculateGrid	(	vec_grid_data_type &	NewStateVec,
		vec_grid_data_type &	OldStateVec,
		vec_grid_data_type *	Flux[],
		const int &	level,
		const double &	t,
		const double &	dt,
		const int &	mpass
	)			[inline, virtual]

Implements Integrator< VectorType, dim >.

template<class VectorType, int dim>

virtual int RIMIntegrator< VectorType, dim >::ControlGrid	(	vec_grid_data_type &	StateVec,
		const int &	level,
		const BBox &	where,
		const double &	time,
		const int	verbose
	)			[inline, virtual]

Implements Integrator< VectorType, dim >.

Referenced by RIMIntegrator< VectorType, DIM >::CalculateGrid().

template<class VectorType, int dim>

virtual void RIMIntegrator< VectorType, dim >::DeAllocGridFluxes

(

vec_grid_data_type **&

Flux

)

[inline, virtual]

Implements Integrator< VectorType, dim >.

template<class VectorType, int dim>

generic_func_type RIMIntegrator< VectorType, dim >::GetCheckFunc

(

)

const [inline]

template<class VectorType, int dim>

generic_func_type RIMIntegrator< VectorType, dim >::GetStepFunc

(

)

const [inline]

template<class VectorType, int dim>

const int& RIMIntegrator< VectorType, dim >::NCheck

(

)

const [inline]

Referenced by RIMIntegrator< VectorType, DIM >::CalculateGrid(), and RIMIntegrator< VectorType, DIM >::SetupData().

template<class VectorType, int dim>

int RIMIntegrator< VectorType, dim >::NMaxPass

(

)

const [inline]

Referenced by RIMIntegrator< VectorType, DIM >::SetupData().

template<class VectorType, int dim>

virtual int RIMIntegrator< VectorType, dim >::NMethodOrder

(

)

const [inline, virtual]

Implements Integrator< VectorType, dim >.

template<class VectorType, int dim>

virtual void RIMIntegrator< VectorType, dim >::register_at

(

ControlDevice &

Ctrl

)

[inline, virtual]

Reimplemented from Integrator< VectorType, dim >.

template<class VectorType, int dim>

virtual void RIMIntegrator< VectorType, dim >::register_at	(	ControlDevice &	Ctrl,
		const std::string &	prefix
	)			[inline, virtual]

Reimplemented from Integrator< VectorType, dim >.

Referenced by RIMIntegrator< VectorType, DIM >::register_at().

template<class VectorType, int dim>

virtual void RIMIntegrator< VectorType, dim >::ResetGridFluxes

(

vec_grid_data_type **&

Flux

)

[inline, virtual]

Implements Integrator< VectorType, dim >.

Referenced by RIMIntegrator< VectorType, DIM >::CalculateGrid().

template<class VectorType, int dim>

void RIMIntegrator< VectorType, dim >::SetCheckFunc

(

generic_func_type

check

)

[inline]

template<class VectorType, int dim>

void RIMIntegrator< VectorType, dim >::SetStepFunc

(

generic_func_type

step

)

[inline]

template<class VectorType, int dim>

virtual void RIMIntegrator< VectorType, dim >::SetupData	(	GridHierarchy *	gh,
		const int &	ghosts
	)			[inline, virtual]

Reimplemented from AMRBase< VectorType, dim >.

---

Member Data Documentation

template<class VectorType, int dim>

int RIMIntegrator< VectorType, dim >::_check [protected]

Referenced by RIMIntegrator< VectorType, DIM >::NCheck(), and RIMIntegrator< VectorType, DIM >::register_at().

template<class VectorType, int dim>

std::string RIMIntegrator< VectorType, dim >::_name [protected]

Referenced by RIMIntegrator< VectorType, DIM >::register_at(), and RIMIntegrator< VectorType, DIM >::RIMIntegrator().

template<class VectorType, int dim>

int RIMIntegrator< VectorType, dim >::_order [protected]

Referenced by RIMIntegrator< VectorType, DIM >::NMethodOrder().

template<class VectorType, int dim>

generic_func_type RIMIntegrator< VectorType, dim >::f_chk [protected]

Referenced by RIMIntegrator< VectorType, DIM >::ControlGrid(), RIMIntegrator< VectorType, DIM >::GetCheckFunc(), and RIMIntegrator< VectorType, DIM >::SetCheckFunc().

template<class VectorType, int dim>

generic_func_type RIMIntegrator< VectorType, dim >::f_step [protected]

Referenced by RIMIntegrator< VectorType, DIM >::CalculateGrid(), RIMIntegrator< VectorType, DIM >::GetStepFunc(), and RIMIntegrator< VectorType, DIM >::SetStepFunc().

template<class VectorType, int dim>

VectorType* RIMIntegrator< VectorType, dim >::FluxData [protected]

Referenced by RIMIntegrator< VectorType, DIM >::AllocGridFluxes(), RIMIntegrator< VectorType, DIM >::DeAllocGridFluxes(), RIMIntegrator< VectorType, DIM >::RIMIntegrator(), and RIMIntegrator< VectorType, DIM >::~RIMIntegrator().

---

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

• amroc/rim/RIMIntegrator.h