IBAMR::HeavisideForcingFunction Class Reference

Class HeavisideForcingFunction computes \( H \nabla \cdot \vec{u} \). This is required to solve the advection equation for Heaviside in conservative form.

#include <ibamr/HeavisideForcingFunction.h>

Inheritance diagram for IBAMR::HeavisideForcingFunction:

Public Member Functions
	HeavisideForcingFunction (const std::string &object_name, SAMRAI::tbox::Pointer< IBAMR::AdvDiffHierarchyIntegrator > adv_diff_solver, SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > > H_var, SAMRAI::tbox::Pointer< SAMRAI::pdat::FaceVariable< NDIM, double > > U_adv_var)
	Class constructor. More...
	~HeavisideForcingFunction ()=default
	Empty destructor. More...
bool	isTimeDependent () const override
	Indicates whether the concrete TemperatureInitialCondition object is time-dependent. More...
void	setDataOnPatchHierarchy (int data_idx, SAMRAI::tbox::Pointer< SAMRAI::hier::Variable< NDIM > > var, SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > > hierarchy, double data_time, bool initial_time=false, int coarsest_ln=-1, int finest_ln=-1) override
	Evaluate the function on the patch interiors on the specified levels of the patch hierarchy using the virtual function setDataOnPatch(). More...
void	setDataOnPatch (const int data_idx, SAMRAI::tbox::Pointer< SAMRAI::hier::Variable< NDIM > > var, SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM > > patch, const double data_time, const bool initial_time=false, SAMRAI::tbox::Pointer< SAMRAI::hier::PatchLevel< NDIM > > patch_level=nullptr) override
	Evaluate the function on the patch interior. More...

Private Member Functions
	HeavisideForcingFunction ()=delete
	HeavisideForcingFunction (const HeavisideForcingFunction &from)=delete
HeavisideForcingFunction &	operator= (const HeavisideForcingFunction &that)=delete

Private Attributes
SAMRAI::tbox::Pointer< IBAMR::AdvDiffHierarchyIntegrator >	d_adv_diff_solver
SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > >	d_H_var
SAMRAI::tbox::Pointer< SAMRAI::pdat::FaceVariable< NDIM, double > >	d_U_adv_var

Methods to set patch interior data.
virtual void	setDataOnPatchLevel (int data_idx, SAMRAI::tbox::Pointer< SAMRAI::hier::Variable< NDIM > > var, SAMRAI::tbox::Pointer< SAMRAI::hier::PatchLevel< NDIM > > patch_level, double data_time, bool initial_time=false)
	Evaluate the function on the patch interiors on the specified level of the patch hierarchy using the virtual function setDataOnPatch(). More...
std::string	d_object_name

Constructor & Destructor Documentation

HeavisideForcingFunction() [1/3]

IBAMR::HeavisideForcingFunction::HeavisideForcingFunction	(	const std::string &	object_name,
		SAMRAI::tbox::Pointer< IBAMR::AdvDiffHierarchyIntegrator >	adv_diff_solver,
		SAMRAI::tbox::Pointer< SAMRAI::pdat::CellVariable< NDIM, double > >	H_var,
		SAMRAI::tbox::Pointer< SAMRAI::pdat::FaceVariable< NDIM, double > >	U_adv_var
	)

~HeavisideForcingFunction()

IBAMR::HeavisideForcingFunction::~HeavisideForcingFunction ( )

default

HeavisideForcingFunction() [2/3]

IBAMR::HeavisideForcingFunction::HeavisideForcingFunction ( )

privatedelete

Deleted default constructor.

HeavisideForcingFunction() [3/3]

IBAMR::HeavisideForcingFunction::HeavisideForcingFunction ( const HeavisideForcingFunction &  from )

privatedelete

Deleted copy constructor.

Member Function Documentation

isTimeDependent()

bool IBAMR::HeavisideForcingFunction::isTimeDependent ( ) const

overridevirtual

Implements IBTK::CartGridFunction.

setDataOnPatchHierarchy()

void IBAMR::HeavisideForcingFunction::setDataOnPatchHierarchy ( int  data_idx, SAMRAI::tbox::Pointer< SAMRAI::hier::Variable< NDIM > >  var, SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > >  hierarchy, double  data_time, bool  initial_time = false, int  coarsest_ln = -1, int  finest_ln = -1  )

overridevirtual

See also

setDataOnPatch

Reimplemented from IBTK::CartGridFunction.

setDataOnPatch()

void IBAMR::HeavisideForcingFunction::setDataOnPatch ( const int  data_idx, SAMRAI::tbox::Pointer< SAMRAI::hier::Variable< NDIM > >  var, SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM > >  patch, const double  data_time, const bool  initial_time = false, SAMRAI::tbox::Pointer< SAMRAI::hier::PatchLevel< NDIM > >  patch_level = nullptr  )

overridevirtual

Implements IBTK::CartGridFunction.

operator=()

HeavisideForcingFunction& IBAMR::HeavisideForcingFunction::operator= ( const HeavisideForcingFunction &  that )

privatedelete

Deleted assignment operator.

setDataOnPatchLevel()

virtual void IBTK::CartGridFunction::setDataOnPatchLevel ( int  data_idx, SAMRAI::tbox::Pointer< SAMRAI::hier::Variable< NDIM > >  var, SAMRAI::tbox::Pointer< SAMRAI::hier::PatchLevel< NDIM > >  patch_level, double  data_time, bool  initial_time = false  )

virtualinherited

See also

setDataOnPatch

Reimplemented in IBTK::CartGridFunctionSet, and IBAMR::CFINSForcing.

Member Data Documentation

d_adv_diff_solver

SAMRAI::tbox::Pointer<IBAMR::AdvDiffHierarchyIntegrator> IBAMR::HeavisideForcingFunction::d_adv_diff_solver

private

Pointer to advection-diffusion solver.

d_H_var

SAMRAI::tbox::Pointer<SAMRAI::pdat::CellVariable<NDIM, double> > IBAMR::HeavisideForcingFunction::d_H_var

private

Liquid fraction variable.

d_U_adv_var

SAMRAI::tbox::Pointer<SAMRAI::pdat::FaceVariable<NDIM, double> > IBAMR::HeavisideForcingFunction::d_U_adv_var

private

Advection velocity variable.

d_object_name

std::string IBTK::CartGridFunction::d_object_name

protectedinherited

---

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

• include/ibamr/HeavisideForcingFunction.h