CompBC Class Reference

#include <PetscCompGrid.H>

Inheritance diagram for CompBC:

Public Member Functions
	CompBC ()
	CompBC (int a_nSource, IntVect a_nGhosts)
virtual	~CompBC ()
void	define (int a_nSource, IntVect a_nGhosts)
virtual void	createCoefs ()=0
virtual void	operator() (FArrayBox &a_state, const Box &a_valid, const ProblemDomain &a_domain, Real a_dx, bool a_homogeneous)=0
virtual void	operator() (FArrayBox &a_state, const Box &a_valid, const ProblemDomain &a_domain, Real a_dx, const DataIndex &a_index, bool a_homogeneous)
IntVect	nGhosts () const
int	nSources () const
PetscReal	getCoef (int a_iSrc, int a_iGhost=0)
Public Member Functions inherited from BCFunction
	BCFunction ()
	Base class constructor. Called by all subclass constructors. More...
virtual	~BCFunction ()
	Destructor. More...
virtual void	setTime (const Real &a_time)
void	fillGhostCells (const LevelData< FArrayBox > &phi, const Real dx, const bool homogeneous)
	Fill the ghost cells for a single level. More...
void	fillGhostCells (const Vector< LevelData< FArrayBox > *> &phi, const Real dx0, const Vector< int > &refV, const bool homogeneous)
	Fill the ghost cells for a Hierarchy of levels. More...

Protected Attributes
PetscReal *	m_Rcoefs
IntVect	m_nGhosts
int	m_nSources
bool	m_isDefined

Constructor & Destructor Documentation

CompBC() [1/2]

CompBC::CompBC ( )

inline

References PetscCompGrid::define().

CompBC() [2/2]

CompBC::CompBC	(	int	a_nSource,
		IntVect	a_nGhosts
	)

~CompBC()

virtual CompBC::~CompBC ( )

virtual

Member Function Documentation

define()

void CompBC::define	(	int	a_nSource,
		IntVect	a_nGhosts
	)

createCoefs()

virtual void CompBC::createCoefs ( )

pure virtual

Implemented in ConstDiriBC, and CompGridVTOBC.

operator()() [1/2]

virtual void CompBC::operator() ( FArrayBox &  a_state, const Box &  a_valid, const ProblemDomain &  a_domain, Real  a_dx, bool  a_homogeneous  )

pure virtual

Computes values of a solution, , on ghost cells. These ghost values impose the boundary condition represented by the BCFunction object.

Parameters

a_state	The values of on the box given by a_valid.
a_valid	The box on which the boundary condition is to be imposed.
a_domain	The problem domain on which this boundary condition is imposed.
a_dx	The grid spacing.
a_homogeneous	If set to true, ghost values are computed for a homogeneous boundary condition. This is useful for multigrid solves.

Implements BCFunction.

Implemented in ConstDiriBC, and CompGridVTOBC.

operator()() [2/2]

virtual void CompBC::operator() ( FArrayBox &  a_state, const Box &  a_valid, const ProblemDomain &  a_domain, Real  a_dx, const DataIndex &  a_index, bool  a_homogeneous  )

inlinevirtual

Computes the values of on ghost cells specifying a data index. By default, this calls the version of the method without a DataIndex.

Parameters

a_state	The values of on the box given by a_valid.
a_valid	The box on which the boundary condition is to be imposed.
a_domain	The problem domain on which this boundary condition is imposed.
a_dx	The grid spacing.
a_index	A DataIndex that can be used in the calculation.
a_homogeneous	If set to true, ghost values are computed for a homogeneous boundary condition. This is useful for multigrid solves.

Reimplemented from BCFunction.

Reimplemented in CompGridVTOBC.

nGhosts()

IntVect CompBC::nGhosts ( ) const

inline

nSources()

int CompBC::nSources ( ) const

inline

getCoef()

PetscReal CompBC::getCoef	(	int	a_iSrc,
		int	a_iGhost = 0
	)

Member Data Documentation

m_Rcoefs

PetscReal* CompBC::m_Rcoefs

protected

m_nGhosts

IntVect CompBC::m_nGhosts

protected

m_nSources

int CompBC::m_nSources

protected

m_isDefined

bool CompBC::m_isDefined

protected

---

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

• PetscCompGrid.H