---

BoxEdgeBC Class Reference

class to do edge-centered physical boundary conditions More...

#include <edgeGhostBC.H>

Inheritance diagram for BoxEdgeBC:

[legend]Collaboration diagram for BoxEdgeBC:

[legend]List of all members.

Public Methods
virtual	~BoxEdgeBC ()
	BoxEdgeBC ()
	BoxEdgeBC (int a_dir, Side::LoHiSide a_sd)
	sets interval to be (0,0)
	BoxEdgeBC (int a_dir, Side::LoHiSide a_sd, const Interval &a_comps)
	BoxEdgeBC (int a_dir, Side::LoHiSide a_sd, const Interval &a_comps, IndexType &a_ixtype)
const IndexType &	ixType () const
	returns the type of centering of this edge-centered BC
void	ixType (const IndexType &a_ixType)
Protected Methods
virtual BoxGhostBC *	new_boxghostbc () const
	virtual constructor workaround
void	define (int a_dir, Side::LoHiSide a_sd)
	sets interval to be (0,0)
void	define (int a_dir, Side::LoHiSide a_sd, const Interval &a_comps)
void	define (int a_dir, Side::LoHiSide a_sd, const Interval &a_comps, IndexType &a_ixtype)
virtual void	applyInhomogeneousBCs (FArrayBox &a_state, const ProblemDomain &a_domain, Real a_dx) const
virtual void	applyHomogeneousBCs (FArrayBox &a_state, const ProblemDomain &a_domain, Real a_dx) const
virtual void	fillBCValues (FArrayBox &a_neumfac, FArrayBox &a_dircfac, FArrayBox &a_inhmval, Real a_dx, const ProblemDomain &a_domain) const
virtual void	applyInhomogeneousBCs (FArrayBox &a_state, const Box &a_domain, Real a_dx) const
	deprecated interface
virtual void	applyHomogeneousBCs (FArrayBox &a_state, const Box &a_domain, Real a_dx) const
	deprecated interface
virtual void	fillBCValues (FArrayBox &a_neumfac, FArrayBox &a_dircfac, FArrayBox &a_inhmval, Real a_dx, const Box &a_domain) const
	deprecated interface
virtual void	applyBCs (const Box &a_bcbox, FArrayBox &a_state, const FArrayBox &a_neumfac, const FArrayBox &a_dircfac, const FArrayBox &a_inhmval, Real a_dx) const

---

Detailed Description

class to do edge-centered physical boundary conditions

BoxEdgeBC is designed to do physical BC's on edge centered data. It is derived from BoxGhostBC so that it can be used seamlessly with BoxGhostBCs.

---

Constructor & Destructor Documentation

virtual BoxEdgeBC::~BoxEdgeBC (    )  [virtual]

BoxEdgeBC::BoxEdgeBC (    )

BoxEdgeBC::BoxEdgeBC (  int    a_dir, Side::LoHiSide    a_sd )

sets interval to be (0,0)

BoxEdgeBC::BoxEdgeBC (  int    a_dir, Side::LoHiSide    a_sd, const Interval &    a_comps )

BoxEdgeBC::BoxEdgeBC (  int    a_dir, Side::LoHiSide    a_sd, const Interval &    a_comps, IndexType &    a_ixtype )

---

Member Function Documentation

virtual void BoxEdgeBC::applyBCs (  const Box &    a_bcbox, FArrayBox &    a_state, const FArrayBox &    a_neumfac, const FArrayBox &    a_dircfac, const FArrayBox &    a_inhmval, Real    a_dx )  const [protected, virtual]

Actually applies the boundary conditions defined by the values in a_neumfac, a_dircfac, and a_inhmval to a_state in the region defined by a_bcBox (which should be the appropriate ghost cells) Reimplemented from BoxGhostBC.

virtual void BoxEdgeBC::applyHomogeneousBCs (  FArrayBox &    a_state, const Box &    a_domain, Real    a_dx )  const [protected, virtual]

deprecated interface Reimplemented from BoxGhostBC.

virtual void BoxEdgeBC::applyHomogeneousBCs (  FArrayBox &    a_state, const ProblemDomain &    a_domain, Real    a_dx )  const [protected, virtual]

Apply the homogeneous form of the boundary conditions to a_state along the boundary of a_domain. Reimplemented from BoxGhostBC.

virtual void BoxEdgeBC::applyInhomogeneousBCs (  FArrayBox &    a_state, const Box &    a_domain, Real    a_dx )  const [protected, virtual]

deprecated interface Reimplemented from BoxGhostBC.

virtual void BoxEdgeBC::applyInhomogeneousBCs (  FArrayBox &    a_state, const ProblemDomain &    a_domain, Real    a_dx )  const [protected, virtual]

Apply the inhomogeneous form of the boundary conditions to a_state along the boundary of a_domain. Reimplemented from BoxGhostBC.

void BoxEdgeBC::define (  int    a_dir, Side::LoHiSide    a_sd, const Interval &    a_comps, IndexType &    a_ixtype )  [protected]

void BoxEdgeBC::define (  int    a_dir, Side::LoHiSide    a_sd, const Interval &    a_comps )  [protected]

Full define function Reimplemented from BoxGhostBC.

void BoxEdgeBC::define (  int    a_dir, Side::LoHiSide    a_sd )  [protected]

sets interval to be (0,0) Reimplemented from BoxGhostBC.

virtual void BoxEdgeBC::fillBCValues (  FArrayBox &    a_neumfac, FArrayBox &    a_dircfac, FArrayBox &    a_inhmval, Real    a_dx, const Box &    a_domain )  const [protected, virtual]

deprecated interface Implements BoxGhostBC. Reimplemented in edgeDirichletBC.

virtual void BoxEdgeBC::fillBCValues (  FArrayBox &    a_neumfac, FArrayBox &    a_dircfac, FArrayBox &    a_inhmval, Real    a_dx, const ProblemDomain &    a_domain )  const [protected, virtual]

Pure-virtual Worker function to fill arrays which define the boundary condition. Essentially, if the boundary condition is represented as A*phi + B*dphi/dn = C, then a_dircfac is A, a_neumfac is B, and a_inhmval is C. Implements BoxGhostBC. Reimplemented in edgeDirichletBC.

void BoxEdgeBC::ixType (  const IndexType &    a_ixType )

const IndexType& BoxEdgeBC::ixType (    )  const

returns the type of centering of this edge-centered BC

virtual BoxGhostBC* BoxEdgeBC::new_boxghostbc (    )  const [protected, virtual]

virtual constructor workaround Implements BoxGhostBC. Reimplemented in edgeDirichletBC.

---

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

• edgeGhostBC.H

---