Chombo + EB  3.2
Public Member Functions | Protected Attributes | List of all members
BCHolder Class Reference

#include <BCFunc.H>

Public Member Functions

 BCHolder ()
 BCHolder (BCFunc funcptr)
 Creates a BCHolder using a function pointer. More...
 BCHolder (RefCountedPtr< BCFunction > refptr)
 Creates a BCHolder using a BCFunction instance. More...
void operator() (FArrayBox &a_state, const Box &a_valid, const ProblemDomain &a_domain, Real a_dx, bool a_homogeneous, const DataIndex a_index=DataIndex())
void setTime (Real a_time)
RefCountedPtr< BCFunctiongetBCFunction ()
 Provides access to the bc function. More...

Protected Attributes

BCFunc m_funcptr
RefCountedPtr< BCFunctionm_bc

Detailed Description

This class is a catch-all that can use a function pointer or a BCFunction object to impose boundary conditions.

Constructor & Destructor Documentation

◆ BCHolder() [1/3]

BCHolder::BCHolder ( )

Default constructor. Seems like this should be disallowed, since BCHolder isn't sub-classable, and there's no way to set the member pointer after creation.

◆ BCHolder() [2/3]

BCHolder::BCHolder ( BCFunc  funcptr)

Creates a BCHolder using a function pointer.

◆ BCHolder() [3/3]

BCHolder::BCHolder ( RefCountedPtr< BCFunction refptr)

Creates a BCHolder using a BCFunction instance.

Member Function Documentation

◆ operator()()

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

Imposes a boundary condition on a solution whose state is described by the given FArrayBox. The signature for this method matches its counterpart in BCFunction.

◆ setTime()

void BCHolder::setTime ( Real  a_time)

Sets the time associated with the boundary condition, a la BCFunction::setTime. If this BCHolder holds a function pointer, this call does nothing.

◆ getBCFunction()

RefCountedPtr<BCFunction> BCHolder::getBCFunction ( )

Provides access to the bc function.

Member Data Documentation

◆ m_funcptr

BCFunc BCHolder::m_funcptr

◆ m_bc

RefCountedPtr<BCFunction> BCHolder::m_bc

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