VieliPayneBCFunction Class Reference

BCFunction-derived class to handle velocity-solve BC's. More...

#include <VieliPayneIBC.H>

Inheritance diagram for VieliPayneBCFunction:

Collaboration diagram for VieliPayneBCFunction:

Public Member Functions
	VieliPayneBCFunction ()
	VieliPayneBCFunction (Vector< RefCountedPtr< LevelSigmaCS > > &a_vectCS, Vector< ProblemDomain > &a_vectDomain)
	~VieliPayneBCFunction ()
virtual void	define (Vector< RefCountedPtr< LevelSigmaCS > > &a_vectCS, Vector< ProblemDomain > &a_vectDomain)
virtual void	operator() (FArrayBox &a_state, const Box &a_valid, const ProblemDomain &a_domain, Real a_dx, bool a_homogeneous)
	this function throws an error since we need the DataIndex More...
virtual void	operator() (FArrayBox &a_state, const Box &a_valid, const ProblemDomain &a_domain, Real a_dx, const DataIndex &a_index, bool a_homogeneous)
	compute ghost-cell values for the velocity solve More...
Public Member Functions inherited from IceVelBCFunction
	IceVelBCFunction ()
	IceVelBCFunction (Vector< RefCountedPtr< LevelSigmaCS > > &a_vectCS, Vector< ProblemDomain > &a_vectDomain)
	~IceVelBCFunction ()

Protected Attributes
Vector< RefCountedPtr< LevelSigmaCS > >	m_vectCS
Vector< ProblemDomain >	m_vectDomain
Protected Attributes inherited from IceVelBCFunction
Vector< RefCountedPtr< LevelSigmaCS > >	m_vectCS
Vector< ProblemDomain >	m_vectDomain

Detailed Description

BCFunction-derived class to handle velocity-solve BC's.

in particular, this BCFunction contains the Vector<LevelSigmaCS* > which we need to define the marine boundary condition

Constructor & Destructor Documentation

VieliPayneBCFunction() [1/2]

VieliPayneBCFunction::VieliPayneBCFunction ( )

inline

References define(), operator()(), and ~VieliPayneBCFunction().

VieliPayneBCFunction() [2/2]

VieliPayneBCFunction::VieliPayneBCFunction	(	Vector< RefCountedPtr< LevelSigmaCS > > &	a_vectCS,
		Vector< ProblemDomain > &	a_vectDomain
	)

References VieliPayneIBC::define().

~VieliPayneBCFunction()

VieliPayneBCFunction::~VieliPayneBCFunction

(

)

Referenced by VieliPayneBCFunction().

Member Function Documentation

define()

void VieliPayneBCFunction::define ( Vector< RefCountedPtr< LevelSigmaCS > > &  a_vectCS, Vector< ProblemDomain > &  a_vectDomain  )

virtual

Implements IceVelBCFunction.

Referenced by VieliPayneBCFunction().

operator()() [1/2]

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

virtual

this function throws an error since we need the DataIndex

since we need the DataIndex to do the marine boundary condition, this function throws a MayDay::Error...

Implements IceVelBCFunction.

Referenced by VieliPayneBCFunction().

operator()() [2/2]

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

virtual

compute ghost-cell values for the velocity solve

References LevelSigmaCS::dx(), LevelSigmaCS::getFaceH(), LevelSigmaCS::gravity(), LevelSigmaCS::iceDensity(), LevelSigmaCS::waterDensity(), and zeroBCValueVP().

Member Data Documentation

m_vectCS

Vector<RefCountedPtr<LevelSigmaCS > > VieliPayneBCFunction::m_vectCS

protected

m_vectDomain

Vector<ProblemDomain> VieliPayneBCFunction::m_vectDomain

protected

---

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

• VieliPayneIBC.H
• VieliPayneIBC.cpp