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 >:
AMRBase< VectorType, dim > controlable

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 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]
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]
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]
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]
template<class VectorType, class FlagType, int dim>
void Criterion< VectorType, FlagType, dim >::SetIsUsed ( const bool  sh  )  [inline]
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]
template<class VectorType, class FlagType, int dim>
const bool& Criterion< VectorType, FlagType, dim >::UpdateShadow (  )  const [inline]

Member Data Documentation

template<class VectorType, class FlagType, int dim>
bool Criterion< VectorType, FlagType, dim >::_IsUsed [protected]
template<class VectorType, class FlagType, int dim>
int Criterion< VectorType, FlagType, dim >::_MaxLevel[MAXCOMPONENTS] [protected]
template<class VectorType, class FlagType, int dim>
int Criterion< VectorType, FlagType, dim >::_Output [protected]
template<class VectorType, class FlagType, int dim>
bool Criterion< VectorType, FlagType, dim >::_ShadowCriterion [protected]
template<class VectorType, class FlagType, int dim>
bool Criterion< VectorType, FlagType, dim >::_UpdateShadow [protected]

The documentation for this class was generated from the following file:
Generated on Thu Jun 30 02:19:30 2016 for AMROC Fluid-solver Framework by  doxygen 1.6.3