Criterion< VectorType, FlagType, dim > Class Template Reference

Generic base-class for a flagging criterion. More...

#include <Criterion.h>

Inheritance diagram for Criterion< VectorType, FlagType, 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 GridFunction< DataType, dim >	grid_fct_type
typedef GridData< DataType, dim >	grid_data_type
typedef GridFunction< FlagType, dim >	flag_fct_type
typedef GridData< FlagType, dim >	flag_data_type
typedef Vector< DataType, MAXCOMPONENTS >	max_vector_type
Public Member Functions
	Criterion ()
virtual	~Criterion ()
virtual bool	SetFlags (vec_grid_fct_type &u, grid_fct_type &work, flag_fct_type &flags, const int &cnt, const int &Time, const int &Level, const double &t, const FlagType &FlagValue)=0
virtual void	OutputName (char *name, int cnt)=0
void	SetIsUsed (const bool sh)
const bool &	IsUsed () const
void	SetShadowCriterion (const bool sh)
const bool &	ShadowCriterion () const
void	SetUpdateShadow (const bool sh)
const bool &	UpdateShadow () const
void	SetNcnt (const int &cnt)
const int &	Ncnt () const
bool	OutputFlags () const
const int &	MaxLevel (const int &i) const
Protected Attributes
bool	_IsUsed
bool	_ShadowCriterion
bool	_UpdateShadow
int	_Ncnt
int	_Output
int	_MaxLevel [MAXCOMPONENTS]

---

Detailed Description

template<class VectorType, class FlagType, int dim>
class Criterion< VectorType, FlagType, dim >

Generic base-class for a flagging criterion.

Author:

Ralf Deiterding

Version:

1.0

Date:

Jul-2004

---

Member Typedef Documentation

template<class VectorType, class FlagType, int dim>

typedef GridData<FlagType,dim> Criterion< VectorType, FlagType, dim >::flag_data_type

template<class VectorType, class FlagType, int dim>

typedef GridFunction<FlagType,dim> Criterion< VectorType, FlagType, dim >::flag_fct_type

Reimplemented in StdCriterion< VectorType, FlagType, 1 >, StdCriterion< VectorType, FlagType, 2 >, StdCriterion< VectorType, FlagType, 3 >, LimiterCriterion< VectorType, FlagType, 1 >, LimiterCriterion< VectorType, FlagType, 2 >, and LimiterCriterion< VectorType, FlagType, 3 >.

template<class VectorType, class FlagType, int dim>

typedef GridData<DataType,dim> Criterion< VectorType, FlagType, dim >::grid_data_type

Reimplemented in StdCriterion< VectorType, FlagType, 1 >, StdCriterion< VectorType, FlagType, 2 >, StdCriterion< VectorType, FlagType, 3 >, LimiterCriterion< VectorType, FlagType, 1 >, LimiterCriterion< VectorType, FlagType, 2 >, LimiterCriterion< VectorType, FlagType, 3 >, PhiCriterion< VectorType, FlagType, 1 >, PhiCriterion< VectorType, FlagType, 2 >, and PhiCriterion< VectorType, FlagType, 3 >.

template<class VectorType, class FlagType, int dim>

typedef GridFunction<DataType,dim> Criterion< VectorType, FlagType, dim >::grid_fct_type

Reimplemented in StdCriterion< VectorType, FlagType, 1 >, StdCriterion< VectorType, FlagType, 2 >, StdCriterion< VectorType, FlagType, 3 >, LimiterCriterion< VectorType, FlagType, 1 >, LimiterCriterion< VectorType, FlagType, 2 >, LimiterCriterion< VectorType, FlagType, 3 >, PhiCriterion< VectorType, FlagType, 1 >, PhiCriterion< VectorType, FlagType, 2 >, and PhiCriterion< VectorType, FlagType, 3 >.

template<class VectorType, class FlagType, int dim>

typedef Vector<DataType,MAXCOMPONENTS> Criterion< VectorType, FlagType, dim >::max_vector_type

template<class VectorType, class FlagType, int dim>

typedef base::vec_grid_data_type Criterion< VectorType, FlagType, dim >::vec_grid_data_type

Reimplemented from AMRBase< VectorType, dim >.

template<class VectorType, class FlagType, int dim>

typedef base::vec_grid_fct_type Criterion< VectorType, FlagType, dim >::vec_grid_fct_type

Reimplemented from AMRBase< VectorType, dim >.

---

Constructor & Destructor Documentation

template<class VectorType, class FlagType, int dim>

Criterion< VectorType, FlagType, dim >::Criterion

(

)

[inline]

template<class VectorType, class FlagType, int dim>

virtual Criterion< VectorType, FlagType, dim >::~Criterion

(

)

[inline, virtual]

---

Member Function Documentation

template<class VectorType, class FlagType, int dim>

const bool& Criterion< VectorType, FlagType, dim >::IsUsed

(

)

const [inline]

Referenced by AMRFlagging< VectorType, FixupType, FlagType, DIM >::SetFlags(), and AMRFlagging< VectorType, FixupType, FlagType, DIM >::update().

template<class VectorType, class FlagType, int dim>

const int& Criterion< VectorType, FlagType, dim >::MaxLevel

(

const int &

i

)

const [inline]

template<class VectorType, class FlagType, int dim>

const int& Criterion< VectorType, FlagType, dim >::Ncnt

(

)

const [inline]

Referenced by AMRFlagging< VectorType, FixupType, FlagType, DIM >::SetFlags().

template<class VectorType, class FlagType, int dim>

bool Criterion< VectorType, FlagType, dim >::OutputFlags

(

)

const [inline]

template<class VectorType, class FlagType, int dim>

virtual void Criterion< VectorType, FlagType, dim >::OutputName	(	char *	name,
		int	cnt
	)			[pure virtual]

Referenced by AMRFlagging< VectorType, FixupType, FlagType, DIM >::SetFlags().

template<class VectorType, class FlagType, int dim>

virtual bool Criterion< VectorType, FlagType, dim >::SetFlags	(	vec_grid_fct_type &	u,
		grid_fct_type &	work,
		flag_fct_type &	flags,
		const int &	cnt,
		const int &	Time,
		const int &	Level,
		const double &	t,
		const FlagType &	FlagValue
	)			[pure virtual]

Referenced by AMRFlagging< VectorType, FixupType, FlagType, DIM >::SetFlags().

template<class VectorType, class FlagType, int dim>

void Criterion< VectorType, FlagType, dim >::SetIsUsed

(

const bool

sh

)

[inline]

Referenced by AMRFlagging< VectorType, FixupType, FlagType, DIM >::update().

template<class VectorType, class FlagType, int dim>

void Criterion< VectorType, FlagType, dim >::SetNcnt

(

const int &

cnt

)

[inline]

template<class VectorType, class FlagType, int dim>

void Criterion< VectorType, FlagType, dim >::SetShadowCriterion

(

const bool

sh

)

[inline]

template<class VectorType, class FlagType, int dim>

void Criterion< VectorType, FlagType, dim >::SetUpdateShadow

(

const bool

sh

)

[inline]

template<class VectorType, class FlagType, int dim>

const bool& Criterion< VectorType, FlagType, dim >::ShadowCriterion

(

)

const [inline]

Referenced by AMRFlagging< VectorType, FixupType, FlagType, DIM >::SetFlags(), and AMRFlagging< VectorType, FixupType, FlagType, DIM >::update().

template<class VectorType, class FlagType, int dim>

const bool& Criterion< VectorType, FlagType, dim >::UpdateShadow

(

)

const [inline]

Referenced by AMRFlagging< VectorType, FixupType, FlagType, DIM >::update().

---

Member Data Documentation

template<class VectorType, class FlagType, int dim>

bool Criterion< VectorType, FlagType, dim >::_IsUsed [protected]

Referenced by Criterion< VectorType, FlagType, 1 >::IsUsed(), and Criterion< VectorType, FlagType, 1 >::SetIsUsed().

template<class VectorType, class FlagType, int dim>

int Criterion< VectorType, FlagType, dim >::_MaxLevel[MAXCOMPONENTS] [protected]

Referenced by Criterion< VectorType, FlagType, 1 >::Criterion(), and Criterion< VectorType, FlagType, 1 >::MaxLevel().

template<class VectorType, class FlagType, int dim>

int Criterion< VectorType, FlagType, dim >::_Ncnt [protected]

Referenced by Criterion< VectorType, FlagType, 1 >::Criterion(), Criterion< VectorType, FlagType, 1 >::Ncnt(), and Criterion< VectorType, FlagType, 1 >::SetNcnt().

template<class VectorType, class FlagType, int dim>

int Criterion< VectorType, FlagType, dim >::_Output [protected]

Referenced by Criterion< VectorType, FlagType, 1 >::OutputFlags().

template<class VectorType, class FlagType, int dim>

bool Criterion< VectorType, FlagType, dim >::_ShadowCriterion [protected]

Referenced by Criterion< VectorType, FlagType, 1 >::SetShadowCriterion(), and Criterion< VectorType, FlagType, 1 >::ShadowCriterion().

template<class VectorType, class FlagType, int dim>

bool Criterion< VectorType, FlagType, dim >::_UpdateShadow [protected]

Referenced by Criterion< VectorType, FlagType, 1 >::SetUpdateShadow(), and Criterion< VectorType, FlagType, 1 >::UpdateShadow().

---

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

• amroc/amr/Criterion.h