Flagging< VectorType, FlagType, dim > Class Template Reference

Generic base-class for flagging. More...

#include <Flagging.h>

Inheritance diagram for Flagging< VectorType, FlagType, dim >:

List of all members.

Public Types
typedef GridFunction< FlagType, dim >	flag_fct_type
typedef Criterion< VectorType, FlagType, dim >	criterion_type
Public Member Functions
	Flagging ()
virtual	~Flagging ()
virtual void	SetFlags (const int Time, const int Level, double t, double dt)=0
virtual void	register_at (ControlDevice &Ctrl)
virtual void	register_at (ControlDevice &Ctrl, const std::string &prefix)
virtual void	init ()
virtual void	update ()
virtual void	finish ()
virtual void	SetupData (GridHierarchy *gh, const int &ghosts)
void	AddCriterion (criterion_type *crit)
void	EliminateCriterion (criterion_type *crit)
void	DeleteCriterion (criterion_type *crit)
void	DeleteAllCriterions ()
criterion_type *	CriterionP (const int n)
criterion_type &	Criterion_ (const int n)
const criterion_type &	Criterion_ (const int n) const
const int &	NCrit () const
void	SetBufferwidth (const int buffw)
const int &	Bufferwidth () const
int	Bufferwidth ()
flag_fct_type &	Flags ()
const flag_fct_type &	Flags () const
Protected Attributes
criterion_type **	_crit
int	_ncrit
flag_fct_type *	_flag
char	flagName [DAGHBktGFNameWidth]
int	_Bufferwidth

---

Detailed Description

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

Generic base-class for flagging.

The class allocates a GridFunction< FlagType > for the flags.

Author:

Ralf Deiterding

Version:

1.0

Date:

Jan-2002

---

Member Typedef Documentation

template<class VectorType, class FlagType, int dim>

typedef Criterion<VectorType,FlagType,dim> Flagging< VectorType, FlagType, dim >::criterion_type

Reimplemented in AMRFlagging< VectorType, FixupType, FlagType, dim >, AMRFlagging< MicroType, FixupType, FlagType, DIM >, and AMRFlagging< VectorType, FixupType, FlagType, DIM >.

template<class VectorType, class FlagType, int dim>

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

Reimplemented in AMRFlagging< VectorType, FixupType, FlagType, dim >, AMRFlagging< MicroType, FixupType, FlagType, DIM >, and AMRFlagging< VectorType, FixupType, FlagType, DIM >.

---

Constructor & Destructor Documentation

template<class VectorType, class FlagType, int dim>

Flagging< VectorType, FlagType, dim >::Flagging

(

)

[inline]

template<class VectorType, class FlagType, int dim>

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

(

)

[inline, virtual]

---

Member Function Documentation

template<class VectorType, class FlagType, int dim>

void Flagging< VectorType, FlagType, dim >::AddCriterion

(

criterion_type *

crit

)

[inline]

Referenced by AMRGFMSolver< MicroType, FixupType, FlagType, DIM >::init().

template<class VectorType, class FlagType, int dim>

int Flagging< VectorType, FlagType, dim >::Bufferwidth

(

)

[inline]

template<class VectorType, class FlagType, int dim>

const int& Flagging< VectorType, FlagType, dim >::Bufferwidth

(

)

const [inline]

Referenced by Flagging< MicroType, FlagType, dim >::SetupData().

template<class VectorType, class FlagType, int dim>

const criterion_type& Flagging< VectorType, FlagType, dim >::Criterion_

(

const int

n

)

const [inline]

template<class VectorType, class FlagType, int dim>

criterion_type& Flagging< VectorType, FlagType, dim >::Criterion_

(

const int

n

)

[inline]

Referenced by Flagging< MicroType, FlagType, dim >::finish(), Flagging< MicroType, FlagType, dim >::init(), Flagging< MicroType, FlagType, dim >::register_at(), AMRFlagging< VectorType, FixupType, FlagType, DIM >::SetFlags(), Flagging< MicroType, FlagType, dim >::SetupData(), Flagging< MicroType, FlagType, dim >::update(), and AMRFlagging< VectorType, FixupType, FlagType, DIM >::update().

template<class VectorType, class FlagType, int dim>

criterion_type* Flagging< VectorType, FlagType, dim >::CriterionP

(

const int

n

)

[inline]

template<class VectorType, class FlagType, int dim>

void Flagging< VectorType, FlagType, dim >::DeleteAllCriterions

(

)

[inline]

template<class VectorType, class FlagType, int dim>

void Flagging< VectorType, FlagType, dim >::DeleteCriterion

(

criterion_type *

crit

)

[inline]

Referenced by Flagging< MicroType, FlagType, dim >::DeleteAllCriterions().

template<class VectorType, class FlagType, int dim>

void Flagging< VectorType, FlagType, dim >::EliminateCriterion

(

criterion_type *

crit

)

[inline]

Referenced by Flagging< MicroType, FlagType, dim >::DeleteCriterion().

template<class VectorType, class FlagType, int dim>

virtual void Flagging< VectorType, FlagType, dim >::finish

(

)

[inline, virtual]

Reimplemented from AMRBase< VectorType, dim >.

Referenced by AMRSolverBase< MicroType, FixupType, FlagType, dim >::finish().

template<class VectorType, class FlagType, int dim>

const flag_fct_type& Flagging< VectorType, FlagType, dim >::Flags

(

)

const [inline]

template<class VectorType, class FlagType, int dim>

flag_fct_type& Flagging< VectorType, FlagType, dim >::Flags

(

)

[inline]

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

template<class VectorType, class FlagType, int dim>

virtual void Flagging< VectorType, FlagType, dim >::init

(

)

[inline, virtual]

Reimplemented from AMRBase< VectorType, dim >.

Reimplemented in FlaggingSpecific, FlaggingSpecific, FlaggingSpecific, FlaggingSpecific, FlaggingSpecific, and FlaggingSpecific.

Referenced by AMRSolverBase< MicroType, FixupType, FlagType, dim >::init().

template<class VectorType, class FlagType, int dim>

const int& Flagging< VectorType, FlagType, dim >::NCrit

(

)

const [inline]

Referenced by Flagging< MicroType, FlagType, dim >::DeleteAllCriterions(), Flagging< MicroType, FlagType, dim >::finish(), Flagging< MicroType, FlagType, dim >::init(), Flagging< MicroType, FlagType, dim >::register_at(), AMRFlagging< VectorType, FixupType, FlagType, DIM >::SetFlags(), Flagging< MicroType, FlagType, dim >::SetupData(), Flagging< MicroType, FlagType, dim >::update(), and AMRFlagging< VectorType, FixupType, FlagType, DIM >::update().

template<class VectorType, class FlagType, int dim>

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

Reimplemented from AMRBase< VectorType, dim >.

template<class VectorType, class FlagType, int dim>

virtual void Flagging< VectorType, FlagType, dim >::register_at

(

ControlDevice &

Ctrl

)

[inline, virtual]

Reimplemented from AMRBase< VectorType, dim >.

Referenced by AMRSolverBase< MicroType, FixupType, FlagType, dim >::register_at().

template<class VectorType, class FlagType, int dim>

void Flagging< VectorType, FlagType, dim >::SetBufferwidth

(

const int

buffw

)

[inline]

Referenced by AMRSolver< VectorType, FixupType, FlagType, DIM >::SetupData().

template<class VectorType, class FlagType, int dim>

virtual void Flagging< VectorType, FlagType, dim >::SetFlags	(	const int	Time,
		const int	Level,
		double	t,
		double	dt
	)			[pure virtual]

Implemented in AMRFlagging< VectorType, FixupType, FlagType, dim >, AMRFlagging< MicroType, FixupType, FlagType, DIM >, and AMRFlagging< VectorType, FixupType, FlagType, DIM >.

template<class VectorType, class FlagType, int dim>

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

Reimplemented from AMRBase< VectorType, dim >.

Referenced by AMRSolverBase< MicroType, FixupType, FlagType, dim >::SetupGridHierarchy().

template<class VectorType, class FlagType, int dim>

virtual void Flagging< VectorType, FlagType, dim >::update

(

)

[inline, virtual]

Reimplemented from AMRBase< VectorType, dim >.

Reimplemented in AMRFlagging< VectorType, FixupType, FlagType, dim >, AMRFlagging< MicroType, FixupType, FlagType, DIM >, and AMRFlagging< VectorType, FixupType, FlagType, DIM >.

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

---

Member Data Documentation

template<class VectorType, class FlagType, int dim>

int Flagging< VectorType, FlagType, dim >::_Bufferwidth [protected]

Referenced by Flagging< MicroType, FlagType, dim >::Bufferwidth(), and Flagging< MicroType, FlagType, dim >::SetBufferwidth().

template<class VectorType, class FlagType, int dim>

criterion_type** Flagging< VectorType, FlagType, dim >::_crit [protected]

Referenced by Flagging< MicroType, FlagType, dim >::AddCriterion(), Flagging< MicroType, FlagType, dim >::Criterion_(), Flagging< MicroType, FlagType, dim >::CriterionP(), Flagging< MicroType, FlagType, dim >::DeleteAllCriterions(), Flagging< MicroType, FlagType, dim >::EliminateCriterion(), Flagging< MicroType, FlagType, dim >::Flagging(), and Flagging< MicroType, FlagType, dim >::~Flagging().

template<class VectorType, class FlagType, int dim>

flag_fct_type* Flagging< VectorType, FlagType, dim >::_flag [protected]

Referenced by Flagging< MicroType, FlagType, dim >::finish(), Flagging< MicroType, FlagType, dim >::Flagging(), Flagging< MicroType, FlagType, dim >::Flags(), Flagging< MicroType, FlagType, dim >::SetupData(), and Flagging< MicroType, FlagType, dim >::~Flagging().

template<class VectorType, class FlagType, int dim>

int Flagging< VectorType, FlagType, dim >::_ncrit [protected]

Referenced by Flagging< MicroType, FlagType, dim >::AddCriterion(), Flagging< MicroType, FlagType, dim >::Criterion_(), Flagging< MicroType, FlagType, dim >::CriterionP(), Flagging< MicroType, FlagType, dim >::EliminateCriterion(), and Flagging< MicroType, FlagType, dim >::NCrit().

template<class VectorType, class FlagType, int dim>

char Flagging< VectorType, FlagType, dim >::flagName[DAGHBktGFNameWidth] [protected]

Referenced by Flagging< MicroType, FlagType, dim >::SetupData().

---

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

• amroc/amr/Flagging.h