GridFunctionVoid Class Reference

Common behaviour of dimensional-dependent GridFunctions. More...

#include <GridFunctionVoid.h>

Inheritance diagram for GridFunctionVoid:
GridFunction< GFType, dim >

List of all members.

Public Member Functions

 GridFunctionVoid (const int type, const int rank, const char name[], GridHierarchy &gh, const int loff, const int cfac, const int align, const int bndrywidth, const int extghwidth, const int cflag, const int bflag, const int adptbflag, const int extghflag)
 GridFunctionVoid (const int type, const int rank, const char name[], const int tsten, const int ssten, GridHierarchy &gh, const int loff, const int cfac, const int align, const int bndrywidth, const int extghwidth, const int cflag, const int bflag, const int adptbflag, const int extghflag)
 GridFunctionVoid (const int type, const int rank, const char name[], const int tsten, const int *ssten, GridHierarchy &gh, const int loff, const int cfac, const int align, const int bndrywidth, const int extghwidth, const int cflag, const int bflag, const int adptbflag, const int extghflag)
 GridFunctionVoid (const char name[], const int rank, const GridFunctionVoid &gfv, const int cflag, const int bflag, const int adptbflag, const int extghflag)
virtual ~GridFunctionVoid ()
void GF_SetGridFunctionType (const int gft)
void GF_SetCommType (const int cflag)
void GF_SetBoundaryType (const int bflag)
void GF_SetAdaptBoundaryType (const int adptbflag)
void GF_SetExternalGhostFlag (const int egflag)
void GF_SetInitializeFlag (const int flag)
void GF_SetUpdateFlag (const int flag)
void GF_SetProlongFlag (const int flag)
void GF_SetRestrictFlag (const int flag)
void GF_SetBndryUpdateFlag (const int flag)
void GF_SetAdaptBndryUpdateFlag (const int flag)
void GF_SetIOFlag (const int flag)
void GF_SetCheckpointFlag (const int flag)
int initialize ()
int update ()
int prolong ()
int Restrict ()
int bndry_update ()
int adaptbndry_update ()
int io ()
int checkpoint ()
void GF_BoundaryWidth (const int width)
void GF_ExternalGhostWidth (const int width)
void GF_SetSpaceStencil (const int s_sten)
void GF_SetSpaceStencil (const int *s_sten)
void GF_SetTimeStencil (const int t_sten)
void GF_SetAlignment (const int align)
void GF_SetTimeAlias (const int t, const int alias_to)
void GF_SetMaxRecomposeLevel (const int l)
int GF_Id () const
int GF_Type () const
char const * GF_Name () const
char * GF_Name ()
int GF_Rank () const
void GF_SetName (char *newname)
int factor () const
int GF_Alignment () const
int comm () const
int externalboundary () const
int adaptiveboundary () const
int externalghost () const
int composed () const
int comm_type () const
int boundary_type () const
int adaptiveboundary_type () const
int boundary_width () const
int externalghost_width () const
GridBoxListcurrent_ggbl () const
void set_current_ggbl (GridBoxList *gbl)
GridBoxListparent_lgbl () const
void set_parent_lgbl (GridBoxList *gbl)
GridBoxListchildren_lgbl () const
void set_children_lgbl (GridBoxList *gbl)
BBox usedbbox (const BBox &gb, const int &level, const int &align)
BBox usedbbox (const GridBox &gb, const int &level, const int &align)
 BBox internally used for allocation of GridData-object.
int updatedvaluestep () const
void setupdatedvaluestep (const int ustep)
void GF_SetUserFlag (const int id, const short &f)
short GF_GetUserFlag (const int id)
void GF_FreeTmpStorage ()
virtual void GF_DeleteGDBStorage (const int t)
virtual void GF_Sync (const int time, const int level)
virtual void GF_Sync (const int time, const int level, const int axis, const int dir)
virtual void GF_WriteGhosts (const int time, const int level)
virtual void GF_WriteGhosts (const int time, const int level, const int axis, const int dir)
virtual void GF_ReadGhosts (const int time, const int level)
virtual void GF_ReadGhosts (const int time, const int level, const int axis, const int dir)
virtual void GF_Compose ()
virtual void GF_Recompose (int *reuse_possible, GridBoxList **ollist, GridBoxList **rlist, GridBoxList **slist, GridBoxList **olist)
virtual void GF_CheckpointRecompose ()
virtual void GF_CheckpointRecompose (std::stringstream &ifs)
virtual void GF_Checkpoint (std::ofstream &ofs)
virtual void GF_Checkpoint (std::stringstream &ofs)
virtual int GF_Checkpoint_StrStream_Memory ()
virtual void GF_CheckpointRestart (int proc=-1)
virtual void GF_CheckpointRestart (std::stringstream &ifs)

Protected Attributes

short gfid
short gftype
short gfrank
char * gfname
short overlap [DAGHMaxRank]
int loffset
int cfactor
short alignment
short bwidth
short extghostwidth
short comm_flag
short bndry_flag
short adaptbndry_flag
short extghost_flag
short compose_flag
short template_flag
short init_flag
short update_flag
short prolong_flag
short restrict_flag
short bndry_update_flag
short adaptbndry_update_flag
short io_flag
short chkpt_flag
int lmax_recompose
short time_sten_rad
short * space_sten_rad
short * time_alias
double * phys_time
GhostInteraction interactions
GF_Interaction *** ghost_send_info
short * ghost_recv_cnt
GF_Interaction *** ghost_recv_info
GridTableGhostRcv *** ghost_recv_server
GridTableDataRcv *** data_recv_server
BBoxList ** bndrybboxlist
BBoxList ** prolongbboxlist
GridBoxListcggbl
GridBoxListplgbl
GridBoxListclgbl
int updatedstep
GridTablegt
GridHierarchydagh
short userflags [(10)]
unsigned * rcvsize
unsigned * sndsize
BBoxsndbbox
short * sndindex
short * rcvindex
short * sndlevel
short * sndcnt

Friends

class GridHierarchy
std::ostream & operator<< (std::ostream &, const GridFunctionVoid &)
std::ofstream & operator<< (std::ofstream &, const GridFunctionVoid &)
std::ifstream & operator>> (std::ifstream &, GridFunctionVoid &)
std::stringstream & operator<< (std::stringstream &, const GridFunctionVoid &)
std::stringstream & operator>> (std::stringstream &, GridFunctionVoid &)

Detailed Description

Common behaviour of dimensional-dependent GridFunctions.

Author:
Manish Parashar, Ralf Deiterding (minor changes)

Constructor & Destructor Documentation

GridFunctionVoid::GridFunctionVoid ( const int  type,
const int  rank,
const char  name[],
GridHierarchy gh,
const int  loff,
const int  cfac,
const int  align,
const int  bndrywidth,
const int  extghwidth,
const int  cflag,
const int  bflag,
const int  adptbflag,
const int  extghflag 
)
GridFunctionVoid::GridFunctionVoid ( const int  type,
const int  rank,
const char  name[],
const int  tsten,
const int  ssten,
GridHierarchy gh,
const int  loff,
const int  cfac,
const int  align,
const int  bndrywidth,
const int  extghwidth,
const int  cflag,
const int  bflag,
const int  adptbflag,
const int  extghflag 
)
GridFunctionVoid::GridFunctionVoid ( const int  type,
const int  rank,
const char  name[],
const int  tsten,
const int *  ssten,
GridHierarchy gh,
const int  loff,
const int  cfac,
const int  align,
const int  bndrywidth,
const int  extghwidth,
const int  cflag,
const int  bflag,
const int  adptbflag,
const int  extghflag 
)
GridFunctionVoid::GridFunctionVoid ( const char  name[],
const int  rank,
const GridFunctionVoid gfv,
const int  cflag,
const int  bflag,
const int  adptbflag,
const int  extghflag 
)
GridFunctionVoid::~GridFunctionVoid (  )  [virtual]

References phys_time, space_sten_rad, and time_alias.


Member Function Documentation

int GridFunctionVoid::adaptbndry_update (  )  [inline]

References adaptbndry_update_flag, and DAGHTrue.

int GridFunctionVoid::adaptiveboundary (  )  const [inline]
int GridFunctionVoid::adaptiveboundary_type (  )  const [inline]
int GridFunctionVoid::bndry_update (  )  [inline]

References bndry_update_flag, and DAGHTrue.

int GridFunctionVoid::boundary_type (  )  const [inline]
int GridFunctionVoid::boundary_width (  )  const [inline]

References bwidth.

GridBoxList* GridFunctionVoid::children_lgbl (  )  const [inline]

References clgbl.

int GridFunctionVoid::comm ( void   )  const [inline]

Reimplemented in GridFunction< GFType, dim >.

References comm_flag, and DAGHNoComm.

int GridFunctionVoid::comm_type (  )  const [inline]

References comm_flag.

int GridFunctionVoid::composed (  )  const [inline]

References compose_flag, and DAGHTrue.

GridBoxList* GridFunctionVoid::current_ggbl (  )  const [inline]

References cggbl.

int GridFunctionVoid::externalboundary (  )  const [inline]
int GridFunctionVoid::externalghost (  )  const [inline]

References DAGHTrue, and extghost_flag.

int GridFunctionVoid::externalghost_width (  )  const [inline]

References extghostwidth.

int GridFunctionVoid::factor (  )  const [inline]
int GridFunctionVoid::GF_Alignment (  )  const [inline]

References alignment.

void GridFunctionVoid::GF_BoundaryWidth ( const int  width  )  [inline]

References bwidth.

Referenced by SetBoundaryWidth().

void GridFunctionVoid::GF_Checkpoint ( std::stringstream &  ofs  )  [virtual]

Reimplemented in GridFunction< GFType, dim >.

void GridFunctionVoid::GF_Checkpoint ( std::ofstream &  ofs  )  [virtual]
int GridFunctionVoid::GF_Checkpoint_StrStream_Memory (  )  [virtual]

Reimplemented in GridFunction< GFType, dim >.

void GridFunctionVoid::GF_CheckpointRecompose ( std::stringstream &  ifs  )  [virtual]

Reimplemented in GridFunction< GFType, dim >.

void GridFunctionVoid::GF_CheckpointRecompose (  )  [virtual]
void GridFunctionVoid::GF_CheckpointRestart ( std::stringstream &  ifs  )  [virtual]

Reimplemented in GridFunction< GFType, dim >.

void GridFunctionVoid::GF_CheckpointRestart ( int  proc = -1  )  [virtual]
void GridFunctionVoid::GF_Compose (  )  [virtual]
void GridFunctionVoid::GF_DeleteGDBStorage ( const int  t  )  [virtual]

Referenced by GF_SetTimeAlias().

void GridFunctionVoid::GF_ExternalGhostWidth ( const int  width  )  [inline]

References extghostwidth.

Referenced by SetExternalGhostWidth().

void GridFunctionVoid::GF_FreeTmpStorage (  ) 
short GridFunctionVoid::GF_GetUserFlag ( const int  id  )  [inline]

References DAGHGFVFlagNum, and userflags.

Referenced by GetUserFlag().

int GridFunctionVoid::GF_Id (  )  const [inline]

References gfid.

char* GridFunctionVoid::GF_Name (  )  [inline]

References gfname.

char const* GridFunctionVoid::GF_Name (  )  const [inline]
int GridFunctionVoid::GF_Rank (  )  const [inline]

References gfrank.

virtual void GridFunctionVoid::GF_ReadGhosts ( const int  time,
const int  level,
const int  axis,
const int  dir 
) [inline, virtual]

Reimplemented in GridFunction< GFType, dim >.

virtual void GridFunctionVoid::GF_ReadGhosts ( const int  time,
const int  level 
) [inline, virtual]
void GridFunctionVoid::GF_Recompose ( int *  reuse_possible,
GridBoxList **  ollist,
GridBoxList **  rlist,
GridBoxList **  slist,
GridBoxList **  olist 
) [virtual]
void GridFunctionVoid::GF_SetAdaptBndryUpdateFlag ( const int  flag  )  [inline]
void GridFunctionVoid::GF_SetAdaptBoundaryType ( const int  adptbflag  )  [inline]

References adaptbndry_flag.

Referenced by SetAdaptBoundaryType().

void GridFunctionVoid::GF_SetAlignment ( const int  align  )  [inline]

References alignment.

Referenced by SetAlignment().

void GridFunctionVoid::GF_SetBndryUpdateFlag ( const int  flag  )  [inline]

References bndry_update_flag.

Referenced by SetBndryUpdateFlag().

void GridFunctionVoid::GF_SetBoundaryType ( const int  bflag  )  [inline]

References bndry_flag.

Referenced by SetBoundaryType().

void GridFunctionVoid::GF_SetCheckpointFlag ( const int  flag  )  [inline]
void GridFunctionVoid::GF_SetCommType ( const int  cflag  )  [inline]

References comm_flag.

Referenced by SetCommType().

void GridFunctionVoid::GF_SetExternalGhostFlag ( const int  egflag  )  [inline]

References extghost_flag.

Referenced by SetExternalGhostFlag().

void GridFunctionVoid::GF_SetGridFunctionType ( const int  gft  ) 
void GridFunctionVoid::GF_SetInitializeFlag ( const int  flag  )  [inline]

References init_flag.

void GridFunctionVoid::GF_SetIOFlag ( const int  flag  )  [inline]

References io_flag.

Referenced by SetIOFlag().

void GridFunctionVoid::GF_SetMaxRecomposeLevel ( const int  l  )  [inline]

References lmax_recompose.

void GridFunctionVoid::GF_SetName ( char *  newname  )  [inline]

References gfname.

void GridFunctionVoid::GF_SetProlongFlag ( const int  flag  )  [inline]

References prolong_flag.

Referenced by SetProlongFlag().

void GridFunctionVoid::GF_SetRestrictFlag ( const int  flag  )  [inline]

References restrict_flag.

Referenced by SetRestrictFlag().

void GridFunctionVoid::GF_SetSpaceStencil ( const int *  s_sten  ) 

References gfrank, and space_sten_rad.

void GridFunctionVoid::GF_SetSpaceStencil ( const int  s_sten  ) 

References gfrank, and space_sten_rad.

Referenced by SetSpaceStencil().

void GridFunctionVoid::GF_SetTimeAlias ( const int  t,
const int  alias_to 
) [inline]
void GridFunctionVoid::GF_SetTimeStencil ( const int  t_sten  ) 

References time_alias, and time_sten_rad.

Referenced by SetTimeStencil().

void GridFunctionVoid::GF_SetUpdateFlag ( const int  flag  )  [inline]

References update_flag.

void GridFunctionVoid::GF_SetUserFlag ( const int  id,
const short &  f 
) [inline]

References DAGHGFVFlagNum, and userflags.

Referenced by SetUserFlag().

virtual void GridFunctionVoid::GF_Sync ( const int  time,
const int  level,
const int  axis,
const int  dir 
) [inline, virtual]

Reimplemented in GridFunction< GFType, dim >.

virtual void GridFunctionVoid::GF_Sync ( const int  time,
const int  level 
) [inline, virtual]

Reimplemented in GridFunction< GFType, dim >.

int GridFunctionVoid::GF_Type (  )  const [inline]

References gftype.

virtual void GridFunctionVoid::GF_WriteGhosts ( const int  time,
const int  level,
const int  axis,
const int  dir 
) [inline, virtual]

Reimplemented in GridFunction< GFType, dim >.

virtual void GridFunctionVoid::GF_WriteGhosts ( const int  time,
const int  level 
) [inline, virtual]
int GridFunctionVoid::initialize (  )  [inline]

References DAGHTrue, and init_flag.

int GridFunctionVoid::io (  )  [inline]
GridBoxList* GridFunctionVoid::parent_lgbl (  )  const [inline]

References plgbl.

int GridFunctionVoid::prolong (  )  [inline]
int GridFunctionVoid::Restrict (  )  [inline]
void GridFunctionVoid::set_children_lgbl ( GridBoxList gbl  )  [inline]

References clgbl.

void GridFunctionVoid::set_current_ggbl ( GridBoxList gbl  )  [inline]

References cggbl.

void GridFunctionVoid::set_parent_lgbl ( GridBoxList gbl  )  [inline]

References plgbl.

void GridFunctionVoid::setupdatedvaluestep ( const int  ustep  )  [inline]

References updatedstep.

Referenced by SetUpdatedValueStep().

int GridFunctionVoid::update (  )  [inline]

References DAGHTrue, and update_flag.

int GridFunctionVoid::updatedvaluestep (  )  const [inline]

References updatedstep.

Referenced by UpdatedValueAt().

BBox GridFunctionVoid::usedbbox ( const GridBox gb,
const int &  level,
const int &  align 
) [inline]

BBox internally used for allocation of GridData-object.

References GridBox::gbBBox(), and usedbbox().

Referenced by usedbbox().

BBox GridFunctionVoid::usedbbox ( const BBox gb,
const int &  level,
const int &  align 
)

Friends And Related Function Documentation

friend class GridHierarchy [friend]

Reimplemented in GridFunction< GFType, dim >.

std::stringstream& operator<< ( std::stringstream &  ofs,
const GridFunctionVoid gfv 
) [friend]
std::ofstream& operator<< ( std::ofstream &  ofs,
const GridFunctionVoid gfv 
) [friend]
std::ostream& operator<< ( std::ostream &  os,
const GridFunctionVoid gfv 
) [friend]
std::stringstream& operator>> ( std::stringstream &  ifs,
GridFunctionVoid gfv 
) [friend]
std::ifstream& operator>> ( std::ifstream &  ifs,
GridFunctionVoid gfv 
) [friend]

Member Data Documentation

int GridFunctionVoid::cfactor [protected]

Referenced by factor(), and usedbbox().

short GridFunctionVoid::chkpt_flag [protected]

Referenced by checkpoint(), and GF_SetCheckpointFlag().

short GridFunctionVoid::compose_flag [protected]

Referenced by composed().

short GridFunctionVoid::init_flag [protected]

Referenced by GF_SetInitializeFlag(), and initialize().

short GridFunctionVoid::io_flag [protected]

Referenced by GF_SetIOFlag(), and io().

short GridFunctionVoid::overlap[DAGHMaxRank] [protected]
short GridFunctionVoid::prolong_flag [protected]

Referenced by GF_SetProlongFlag(), and prolong().

short* GridFunctionVoid::rcvindex [protected]

Referenced by GF_FreeTmpStorage().

unsigned* GridFunctionVoid::rcvsize [protected]

Referenced by GF_FreeTmpStorage().

Referenced by GF_SetRestrictFlag(), and Restrict().

Referenced by GF_FreeTmpStorage().

short* GridFunctionVoid::sndcnt [protected]

Referenced by GF_FreeTmpStorage().

short* GridFunctionVoid::sndindex [protected]

Referenced by GF_FreeTmpStorage().

short* GridFunctionVoid::sndlevel [protected]

Referenced by GF_FreeTmpStorage().

short GridFunctionVoid::update_flag [protected]

Referenced by GF_SetUpdateFlag(), and update().


The documentation for this class was generated from the following files:
Generated on Thu Jun 30 02:19:00 2016 for AMROC's Hierachical Data Structures by  doxygen 1.6.3