GridDataBlock< Type, dim > Class Template Reference

A single grid with data used within a GridFunction. More...

#include <GridDataBlock.h>

List of all members.

Public Member Functions
int	has_parents () const
const int &	parents () const
const GDB_Interaction *	parentlist () const
GDB_Interaction *	parentlist ()
const BBox &	parentbox (const int &j)
const int &	parentidx (const int &j)
int	has_children () const
const int &	children () const
const GDB_Interaction *	childlist () const
GDB_Interaction *	childlist ()
const BBox &	childbox (const int &j)
const int &	childidx (const int &j)
GDB_Interaction **	gdbReadInfo (const int proc)
GDB_Interaction **	gdbWriteInfo (const int proc)
const BBox &	boundingbox () const
const BBox &	interiorbox () const
const BBox &	databox () const
int	has_externalboundaries () const
int	has_externalboundary (const int dir) const
const int &	externalboundaries (const int dir) const
int	externalboundaries (const int dir)
const BBoxList *	externalbndrylist (const int dir) const
BBoxList *	externalbndrylist (const int dir)
int	has_adaptiveboundaries () const
int	has_adaptiveboundary (const int dir) const
const BBox &	adaptivebndrybox (const int dir) const
void	gdbPrintData (std::ostream &os) const
int	MemoryUsage ()
GridData< Type, dim > &	griddata ()
const GridData< Type, dim > &	griddata () const
Public Attributes
short	timenum
	timenum - 0 to 2*time_stencil
short	levelnum
Friends
class	GridFunction< Type, dim >
std::ostream &	operator<< (std::ostream &, const GridDataBlock< Type, dim > &)
std::ofstream &	operator<< (std::ofstream &, const GridDataBlock< Type, dim > &)
std::ifstream &	operator>> (std::ifstream &, GridDataBlock< Type, dim > &)
std::stringstream &	operator<< (std::stringstream &, const GridDataBlock< Type, dim > &)
std::stringstream &	operator>> (std::stringstream &, GridDataBlock< Type, dim > &)

---

Detailed Description

template<class Type, int dim>
class GridDataBlock< Type, dim >

A single grid with data used within a GridFunction.

This class creates storage and interaction information for a grid block at a particular level. A GridDataBlock knows its neighbours, parents of the coarser levels and its children on the finer level.

Author:

Ralf Deiterding, Manish Parashar

---

Member Function Documentation

template<class Type, int dim>

const BBox& GridDataBlock< Type, dim >::adaptivebndrybox

(

const int

dir

)

const [inline]

Referenced by GridFunction< GFType, dim >::GF_AdaptiveBndryUpdate().

template<class Type, int dim>

const BBox& GridDataBlock< Type, dim >::boundingbox

(

)

const [inline]

Referenced by GridFunction< GFType, dim >::GF_DebugPrintIntData(), GridFunction< GFType, dim >::GF_IO(), GridFunction< GFType, dim >::GF_Prolong(), GridFunction< GFType, dim >::GF_ReadGhosts(), and GridFunction< GFType, dim >::GF_Restrict().

template<class Type, int dim>

const BBox& GridDataBlock< Type, dim >::childbox

(

const int &

j

)

[inline]

template<class Type, int dim>

const int& GridDataBlock< Type, dim >::childidx

(

const int &

j

)

[inline]

template<class Type, int dim>

GDB_Interaction* GridDataBlock< Type, dim >::childlist

(

)

[inline]

template<class Type, int dim>

const GDB_Interaction* GridDataBlock< Type, dim >::childlist

(

)

const [inline]

Referenced by GridFunction< GFType, dim >::childlist().

template<class Type, int dim>

const int& GridDataBlock< Type, dim >::children

(

)

const [inline]

Referenced by GridFunction< GFType, dim >::children().

template<class Type, int dim>

const BBox& GridDataBlock< Type, dim >::databox

(

)

const [inline]

Referenced by GridFunction< GFType, dim >::GF_Checkpoint_StrStream_Memory().

template<class Type, int dim>

BBoxList* GridDataBlock< Type, dim >::externalbndrylist

(

const int

dir

)

[inline]

template<class Type, int dim>

const BBoxList* GridDataBlock< Type, dim >::externalbndrylist

(

const int

dir

)

const [inline]

Referenced by GridFunction< GFType, dim >::GF_ExternalBndryUpdate().

template<class Type, int dim>

int GridDataBlock< Type, dim >::externalboundaries

(

const int

dir

)

[inline]

template<class Type, int dim>

const int& GridDataBlock< Type, dim >::externalboundaries

(

const int

dir

)

const [inline]

template<class Type , int dim>

void GridDataBlock< Type, dim >::gdbPrintData

(

std::ostream &

os

)

const [inline]

References GridFunctionVoid::bndrybboxlist, GridFunctionVoid::gfid, GridDataBlock< Type, dim >::has_adaptiveboundary(), GridDataBlock< Type, dim >::has_externalboundary(), comm_service::proc_num(), and GridDataBlock< Type, dim >::timenum.

Referenced by operator<<().

template<class Type, int dim>

GDB_Interaction** GridDataBlock< Type, dim >::gdbReadInfo

(

const int

proc

)

[inline]

template<class Type, int dim>

GDB_Interaction** GridDataBlock< Type, dim >::gdbWriteInfo

(

const int

proc

)

[inline]

template<class Type, int dim>

const GridData<Type,dim>& GridDataBlock< Type, dim >::griddata

(

)

const [inline]

template<class Type, int dim>

GridData<Type,dim>& GridDataBlock< Type, dim >::griddata

(

)

[inline]

Referenced by GridDataBlock< GFType, dim >::databox(), GridFunction< GFType, dim >::GF_AdaptiveBndryUpdate(), GridFunction< GFType, dim >::GF_CheckpointRestart(), GridFunction< GFType, dim >::GF_Copy(), GridFunction< GFType, dim >::GF_DebugPrintData(), GridFunction< GFType, dim >::GF_DebugPrintIntData(), GridFunction< GFType, dim >::GF_divide(), GridFunction< GFType, dim >::GF_equals(), GridFunction< GFType, dim >::GF_ExternalBndryUpdate(), GridFunction< GFType, dim >::GF_Fill(), GridFunction< GFType, dim >::GF_IO(), GridFunction< GFType, dim >::GF_maxval(), GridFunction< GFType, dim >::GF_minus(), GridFunction< GFType, dim >::GF_minval(), GridFunction< GFType, dim >::GF_multiply(), GridFunction< GFType, dim >::GF_norm(), GridFunction< GFType, dim >::GF_plus(), GridFunction< GFType, dim >::GF_product(), GridFunction< GFType, dim >::GF_Prolong(), GridFunction< GFType, dim >::GF_Read(), GridFunction< GFType, dim >::GF_ReadGhosts(), GridFunction< GFType, dim >::GF_Restrict(), GridFunction< GFType, dim >::GF_sum(), operator<<(), and operator>>().

template<class Type, int dim>

int GridDataBlock< Type, dim >::has_adaptiveboundaries

(

)

const [inline]

template<class Type, int dim>

int GridDataBlock< Type, dim >::has_adaptiveboundary

(

const int

dir

)

const [inline]

Referenced by GridDataBlock< Type, dim >::gdbPrintData().

template<class Type, int dim>

int GridDataBlock< Type, dim >::has_children

(

)

const [inline]

Referenced by GridFunction< GFType, dim >::has_children().

template<class Type, int dim>

int GridDataBlock< Type, dim >::has_externalboundaries

(

)

const [inline]

template<class Type, int dim>

int GridDataBlock< Type, dim >::has_externalboundary

(

const int

dir

)

const [inline]

Referenced by GridDataBlock< Type, dim >::gdbPrintData().

template<class Type, int dim>

int GridDataBlock< Type, dim >::has_parents

(

)

const [inline]

Referenced by GridFunction< GFType, dim >::has_parents().

template<class Type, int dim>

const BBox& GridDataBlock< Type, dim >::interiorbox

(

)

const [inline]

Referenced by GridFunction< GFType, dim >::GF_Read(), and GridFunction< GFType, dim >::GF_Write().

template<class Type , int dim>

int GridDataBlock< Type, dim >::MemoryUsage

(

)

[inline]

References GridFunctionVoid::bndrybboxlist, GridFunctionVoid::comm_flag, DAGHFalse, DAGHTrue, and comm_service::proc_num().

template<class Type, int dim>

const BBox& GridDataBlock< Type, dim >::parentbox

(

const int &

j

)

[inline]

template<class Type, int dim>

const int& GridDataBlock< Type, dim >::parentidx

(

const int &

j

)

[inline]

template<class Type, int dim>

GDB_Interaction* GridDataBlock< Type, dim >::parentlist

(

)

[inline]

template<class Type, int dim>

const GDB_Interaction* GridDataBlock< Type, dim >::parentlist

(

)

const [inline]

Referenced by GridFunction< GFType, dim >::parentlist().

template<class Type, int dim>

const int& GridDataBlock< Type, dim >::parents

(

)

const [inline]

Referenced by GridFunction< GFType, dim >::parents().

---

Friends And Related Function Documentation

template<class Type, int dim>

friend class GridFunction< Type, dim > [friend]

template<class Type, int dim>

std::stringstream& operator<<	(	std::stringstream &	ofs,
		const GridDataBlock< Type, dim > &	gdb
	)			[friend]

template<class Type, int dim>

std::ofstream& operator<<	(	std::ofstream &	ofs,
		const GridDataBlock< Type, dim > &	gdb
	)			[friend]

template<class Type, int dim>

std::ostream& operator<<	(	std::ostream &	os,
		const GridDataBlock< Type, dim > &	gdb
	)			[friend]

template<class Type, int dim>

std::stringstream& operator>>	(	std::stringstream &	ifs,
		GridDataBlock< Type, dim > &	gdb
	)			[friend]

template<class Type, int dim>

std::ifstream& operator>>	(	std::ifstream &	ifs,
		GridDataBlock< Type, dim > &	gdb
	)			[friend]

---

Member Data Documentation

template<class Type, int dim>

short GridDataBlock< Type, dim >::levelnum

Referenced by operator<<(), and operator>>().

template<class Type, int dim>

short GridDataBlock< Type, dim >::timenum

timenum - 0 to 2*time_stencil

Referenced by GridDataBlock< Type, dim >::gdbPrintData(), operator<<(), and operator>>().

---

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

• amroc/hds/GridDataBlock.h
• amroc/hds/GridDataBlock.ipp