CompBC Class Reference

#include <PetscCompGrid.H>

Inheritance diagram for CompBC:

[legend]

List of all members.

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)
Protected Attributes
PetscReal *	m_Rcoefs
IntVect	m_nGhosts
int	m_nSources
bool	m_isDefined

---

Constructor & Destructor Documentation

CompBC::CompBC

(

)

[inline]

CompBC::CompBC	(	int	a_nSource,
		IntVect	a_nGhosts
	)

virtual CompBC::~CompBC

(

)

[virtual]

---

Member Function Documentation

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

virtual void CompBC::createCoefs

(

)

[pure virtual]

Implemented in ConstDiriBC, and CompGridVTOBC.

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.

Referenced by operator()().

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
	)			[inline, virtual]

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.

References operator()().

IntVect CompBC::nGhosts

(

)

const [inline]

References m_nGhosts.

int CompBC::nSources

(

)

const [inline]

References m_nSources.

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

---

Member Data Documentation

PetscReal* CompBC::m_Rcoefs [protected]

IntVect CompBC::m_nGhosts [protected]

Referenced by nGhosts().

int CompBC::m_nSources [protected]

Referenced by nSources().

bool CompBC::m_isDefined [protected]

---

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

• PetscCompGrid.H