Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members

DomainGhostBC Class Reference

Class to enforce ghost-cell based boundary conditions. More...

#include <GhostBC.H>

Collaboration diagram for DomainGhostBC:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 DomainGhostBC ()
 Null constructor.
 ~DomainGhostBC ()
 Destructor.
void setBoxGhostBC (const BoxGhostBC &a_ghostBC)
 Set boundary conditions at a face to those defined in a_ghostBC.
const List< BoxGhostBC * > & operator() (int a_direction, Side::LoHiSide a_side) const
 Access function -- returns a reference to the BC on the given face.
void applyHomogeneousBCs (FArrayBox &a_state, const Box &a_domain, Real a_dx) const
 Deprecated function -- use ProblemDomain instead of a Box for the domain.
void applyHomogeneousBCs (FArrayBox &a_state, const ProblemDomain &a_domain, Real a_dx) const
 apply boundary conditions on all sides of state which abut domain edge
void applyInhomogeneousBCs (FArrayBox &a_state, const Box &a_domain, Real a_dx) const
 Deprecated function -- use ProblemDomain instead of a Box for the domain.
void applyInhomogeneousBCs (FArrayBox &a_state, const ProblemDomain &a_domain, Real a_dx) const
 Apply boundary conditions on all sides of state which abut the domain edge *.
DomainGhostBCoperator= (const DomainGhostBC &a_dgbcin)
 Assignment operator.
 DomainGhostBC (const DomainGhostBC &a_dgbcin)
 Copy constructor.

Protected Member Functions

bool isBCDefined (const int a_dir, const Side::LoHiSide a_side) const
void resetBoxGhostBC (const int a_dir, const Side::LoHiSide a_side)

Protected Attributes

Tuple< List< BoxGhostBC * >,
SpaceDim
m_loGhostBC
Tuple< List< BoxGhostBC * >,
SpaceDim
m_hiGhostBC

Detailed Description

Class to enforce ghost-cell based boundary conditions.

This class holds a domain's worth of boxghostbcs, at least one for each face. The user adds BoxGhostBC-derived objects for each face to enforce boundary conditions. If the solution is phi and the face normal direction is x, the boundary conditions at a face may often be expressed as A*phi + B*dphi/dx = C. The class derived from BoxGhostBC provides a function to to fill A B and C. DomainGhostBC calls this function and fills the ghost cells outside the domain appropriately. Because BoxGhostBC operates on a component Interval, more than one BoxGhostBC per side is supported, to support the case where different components have different boundary conditions.


Constructor & Destructor Documentation

DomainGhostBC::DomainGhostBC  ) 
 

Null constructor.

DomainGhostBC::~DomainGhostBC  ) 
 

Destructor.

DomainGhostBC::DomainGhostBC const DomainGhostBC a_dgbcin  ) 
 

Copy constructor.


Member Function Documentation

void DomainGhostBC::applyHomogeneousBCs FArrayBox a_state,
const ProblemDomain a_domain,
Real  a_dx
const
 

apply boundary conditions on all sides of state which abut domain edge

void DomainGhostBC::applyHomogeneousBCs FArrayBox a_state,
const Box a_domain,
Real  a_dx
const
 

Deprecated function -- use ProblemDomain instead of a Box for the domain.

void DomainGhostBC::applyInhomogeneousBCs FArrayBox a_state,
const ProblemDomain a_domain,
Real  a_dx
const
 

Apply boundary conditions on all sides of state which abut the domain edge *.

void DomainGhostBC::applyInhomogeneousBCs FArrayBox a_state,
const Box a_domain,
Real  a_dx
const
 

Deprecated function -- use ProblemDomain instead of a Box for the domain.

bool DomainGhostBC::isBCDefined const int  a_dir,
const Side::LoHiSide  a_side
const [protected]
 

Returns true if this GhostBC is defined

const List<BoxGhostBC*>& DomainGhostBC::operator() int  a_direction,
Side::LoHiSide  a_side
const
 

Access function -- returns a reference to the BC on the given face.

DomainGhostBC& DomainGhostBC::operator= const DomainGhostBC a_dgbcin  ) 
 

Assignment operator.

void DomainGhostBC::resetBoxGhostBC const int  a_dir,
const Side::LoHiSide  a_side
[protected]
 

Resets BC in the given direction and side to an unset state (deletes any existing BC's and returns to an empty list)

void DomainGhostBC::setBoxGhostBC const BoxGhostBC a_ghostBC  ) 
 

Set boundary conditions at a face to those defined in a_ghostBC.

Adds a_ghostBC to whatever BCs are already defined for the gviven side and face.


Member Data Documentation

Tuple<List<BoxGhostBC*>, SpaceDim> DomainGhostBC::m_hiGhostBC [protected]
 

Contains the hi-side boundary conditions

Tuple<List<BoxGhostBC*>, SpaceDim> DomainGhostBC::m_loGhostBC [protected]
 

Contains the lo-side boundary conditions


The documentation for this class was generated from the following file:
Generated on Wed Oct 5 14:00:39 2005 for Chombo&AMRSelfGravity by  doxygen 1.4.1