SiblingInfo Class Reference

#include <SiblingInfo.h>

Inheritance diagram for SiblingInfo:

Collaboration diagram for SiblingInfo:

Public Member Functions
	~SiblingInfo ()
	destructor
	SiblingInfo ()
	default constructor
	SiblingInfo (const SiblingInfo &X)
	copy constructor
	SiblingInfo (const int siblingGridIndex, const Box &ghostBox, const Box &siblingBox)
	main constructor for this class
SiblingInfo &	operator= (const SiblingInfo &X)
	assignment operator
virtual aString	getClassName (void)
	return the name of this class, namely "SiblingInfo"
virtual Integer	get (const GenericDataBase &db, const aString &name)
	reads from a database
virtual Integer	put (const GenericDataBase &db, const aString &name) const
	writes to a database
virtual void	consistencyCheck (void) const
	error and consistency checking
const Box &	getGhostBox (void) const
	returns the ghost box on the grid owning this object
const Box &	getSiblingBox (void) const
	returns the box on the sibling that lies atop the ghost box on the grid owning this object
void	setGhostBox (const Box &box)
	set the ghost box
void	setSiblingBox (const Box &box)
	set the sibling box
Public Member Functions inherited from ParentChildSiblingBase
	ParentChildSiblingBase ()
	default constructor
	ParentChildSiblingBase (const ParentChildSiblingBase &X, const CopyType ct=DEEP)
	copy constructor
	ParentChildSiblingBase (const int)
	main constructor for this class
ParentChildSiblingBase &	operator= (const ParentChildSiblingBase &X)
	assignment operator
virtual	~ParentChildSiblingBase ()
	virtual destructor
const int	getGridIndex (void) const
	access functions for the grid index
void	setGridIndex (const int index)

Friends
ostream &	operator<< (ostream &s, const SiblingInfo &siblingInfo)
	writes a description of siblingInfo to the output stream s

Additional Inherited Members
Protected Attributes inherited from ParentChildSiblingBase
int	gridIndex
	index into the adaptive grid collection
aString	className
	the name of this class, i.e. "ParentChildSiblingBase" is stored in this variable

Constructor & Destructor Documentation

SiblingInfo::~SiblingInfo

(

)

destructor

SiblingInfo::SiblingInfo

(

)

default constructor

SiblingInfo::SiblingInfo

(

const SiblingInfo &

X

)

copy constructor

SiblingInfo::SiblingInfo	(	const int	siblingGridIndex,
		const Box &	ghostBox,
		const Box &	siblingBox
	)

main constructor for this class

Member Function Documentation

void SiblingInfo::consistencyCheck ( void  ) const

virtual

error and consistency checking

Reimplemented from ParentChildSiblingBase.

References ParentChildSiblingBase::consistencyCheck().

Integer SiblingInfo::get ( const GenericDataBase &  db, const aString &  name  )

virtual

reads from a database

Reimplemented from ParentChildSiblingBase.

virtual aString SiblingInfo::getClassName ( void  )

inlinevirtual

return the name of this class, namely "SiblingInfo"

Reimplemented from ParentChildSiblingBase.

const Box& SiblingInfo::getGhostBox ( void  ) const

inline

returns the ghost box on the grid owning this object

Referenced by operator=().

const Box& SiblingInfo::getSiblingBox ( void  ) const

inline

returns the box on the sibling that lies atop the ghost box on the grid owning this object

Referenced by operator=().

SiblingInfo & SiblingInfo::operator=

(

const SiblingInfo &

X

)

assignment operator

References assert, getGhostBox(), getSiblingBox(), and ParentChildSiblingBase::operator=().

Integer SiblingInfo::put ( const GenericDataBase &  db, const aString &  name  ) const

virtual

writes to a database

Reimplemented from ParentChildSiblingBase.

void SiblingInfo::setGhostBox ( const Box &  box )

inline

set the ghost box

References assert.

void SiblingInfo::setSiblingBox ( const Box &  box )

inline

set the sibling box

References assert.

Friends And Related Function Documentation

ostream& operator<< ( ostream &  s, const SiblingInfo &  siblingInfo  )

friend

writes a description of siblingInfo to the output stream s

---

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

• SiblingInfo.h
• SiblingInfo.C