---

RampBL Class Reference

#include <RampBL.H>

Inheritance diagram for RampBL:

[legend]Collaboration diagram for RampBL:

[legend]List of all members.

Public Methods
	RampBL (const int &a_upDir, const int &a_indepVar, const Real &a_start, const Real &a_rampSlope)
	RampBL (const RealVect &a_rampNormal, const Real &a_alpha)
virtual	~RampBL ()
virtual bool	isRegular (const Box &region, const Box &domain, const RealVect &origin, const Real &dx) const
virtual bool	isCovered (const Box &region, const Box &domain, const RealVect &origin, const Real &dx) const
pair< int, Side::LoHiSide >	upDirection (const RealVect &a_midpt, const IntVect &a_iv) const
virtual Real	localFuncValue (const RealVect &a_independentCoords, const int &a_upDirection, const IntVect &a_iv, const Box &a_domain, const RealVect &a_origin, const Real &a_dx) const
virtual BaseLevelSet *	new_baseLevelSet () const
Protected Attributes
pair< int, Side::LoHiSide >	m_upDir
RealVect	m_rampNormal
Real	m_alpha
Private Methods
	RampBL ()
	RampBL (const RampBL &a_ramplg)
void	operator= (const RampBL &a_ramplg)

---

Detailed Description

This is the workshop class for a ramp. It follows the BaseLevelSet base class.

---

Constructor & Destructor Documentation

RampBL::RampBL (  const int &    a_upDir, const int &    a_indepVar, const Real &    a_start, const Real &    a_rampSlope )

Returns rampSlope*(independentCoord[indepVar] - startVal); in 3D this makes a 2D ramp.

RampBL::RampBL (  const RealVect &    a_rampNormal, const Real &    a_alpha )

Returns nx*x + ny*y + nz*z = alpha

virtual RampBL::~RampBL (    )  [virtual]

RampBL::RampBL (    )  [inline, private]

RampBL::RampBL (  const RampBL &    a_ramplg )  [inline, private]

---

Member Function Documentation

virtual bool RampBL::isCovered (  const Box &    region, const Box &    domain, const RealVect &    origin, const Real &    dx )  const [virtual]

Return true if every cell in region is covered at the refinement described by dx. Implements BaseLevelSet.

virtual bool RampBL::isRegular (  const Box &    region, const Box &    domain, const RealVect &    origin, const Real &    dx )  const [virtual]

Return true if every cell in region is regular at the refinement described by dx. Implements BaseLevelSet.

virtual Real RampBL::localFuncValue (  const RealVect &    a_independentCoords, const int &    a_upDirection, const IntVect &    a_iv, const Box &    a_domain, const RealVect &    a_origin, const Real &    a_dx )  const [virtual]

Return the value at the dependent coordinate given the independent coordinates. \ Returns rampSlope*(independentCoord[indepVar] - startVal); Implements BaseLevelSet.

virtual BaseLevelSet* RampBL::new_baseLevelSet (    )  const [virtual]

Return a newly allocated derived class. The responsibility for deleting the memory is left to the calling function. Implements BaseLevelSet.

void RampBL::operator= (  const RampBL &    a_ramplg )  [inline, private]

pair<int, Side::LoHiSide> RampBL::upDirection (  const RealVect &    a_midpt, const IntVect &    a_iv )  const [virtual]

This returns the signed integer which most closely represents the normal direction. The first integer of the pair is of the interface at an irregular cell (which coordinate direction has the largest normal component). This will only be called if the cell is irregular. Implements BaseLevelSet.

---

Member Data Documentation

Real RampBL::m_alpha [protected]

RealVect RampBL::m_rampNormal [protected]

pair<int, Side::LoHiSide> RampBL::m_upDir [protected]

---

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

• RampBL.H

---