IBTK::CartGridFunction Class Reference

Class CartGridFunction provides an abstract interface for objects for evaluating functions to set values in SAMRAI::hier::PatchData objects. More...

#include </home/runner/work/IBAMR/IBAMR/ibtk/include/ibtk/CartGridFunction.h>

Inheritance diagram for IBTK::CartGridFunction:

Public Member Functions
	CartGridFunction (std::string object_name="")
	The default constructor sets the name of the strategy object.
virtual	~CartGridFunction ()=default
	Empty virtual destructor.

Methods to set patch interior data.
std::string	d_object_name
virtual bool	isTimeDependent () const =0
	Indicates whether the concrete CartGridFunction object is time-dependent.
virtual 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=invalid_level_number, int finest_ln=invalid_level_number)
	Evaluate the function on the patch interiors on the specified levels of the patch hierarchy using the virtual function setDataOnPatch().
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().
virtual void	setDataOnPatch (int data_idx, SAMRAI::tbox::Pointer< SAMRAI::hier::Variable< NDIM > > var, SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM > > patch, double data_time, bool initial_time=false, SAMRAI::tbox::Pointer< SAMRAI::hier::PatchLevel< NDIM > > patch_level=SAMRAI::tbox::Pointer< SAMRAI::hier::PatchLevel< NDIM > >(nullptr))=0
	Pure virtual function to evaluate the function on the patch interior.

Detailed Description

Class CartGridFunction provides an abstract interface for objects for evaluating functions to set values in SAMRAI::hier::PatchData objects.

Member Function Documentation

isTimeDependent()

virtual bool IBTK::CartGridFunction::isTimeDependent ( ) const

pure virtual

Indicates whether the concrete CartGridFunction object is time-dependent.

Implemented in IBTK::CartGridFunctionSet, IBTK::muParserCartGridFunction, IBAMR::AdvDiffStochasticForcing, IBAMR::CFINSForcing, IBAMR::HeavisideForcingFunction, IBAMR::IBHierarchyIntegrator::IBEulerianForceFunction, IBAMR::IBHierarchyIntegrator::IBEulerianSourceFunction, IBAMR::INSStaggeredStochasticForcing, IBAMR::MarangoniSurfaceTensionForceFunction, IBAMR::PhaseChangeDivUSourceFunction, IBAMR::SpongeLayerForceFunction, IBAMR::StaggeredStokesOpenBoundaryStabilizer, and IBAMR::SurfaceTensionForceFunction.

setDataOnPatch()

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

pure virtual

Pure virtual function to evaluate the function on the patch interior.

Implemented in IBAMR::HeavisideForcingFunction, IBAMR::AdvDiffStochasticForcing, IBAMR::CFINSForcing, IBAMR::INSStaggeredStochasticForcing, IBAMR::PhaseChangeDivUSourceFunction, IBTK::muParserCartGridFunction, IBAMR::IBHierarchyIntegrator::IBEulerianForceFunction, IBAMR::IBHierarchyIntegrator::IBEulerianSourceFunction, IBAMR::MarangoniSurfaceTensionForceFunction, IBAMR::SpongeLayerForceFunction, IBAMR::StaggeredStokesOpenBoundaryStabilizer, IBAMR::SurfaceTensionForceFunction, and IBTK::CartGridFunctionSet.

setDataOnPatchHierarchy()

void IBTK::CartGridFunction::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 = invalid_level_number, int  finest_ln = invalid_level_number  )

virtual

Evaluate the function on the patch interiors on the specified levels of the patch hierarchy using the virtual function setDataOnPatch().

See also

setDataOnPatch

Reimplemented in IBAMR::AdvDiffStochasticForcing, IBAMR::CFINSForcing, IBAMR::IBHierarchyIntegrator::IBEulerianForceFunction, IBAMR::INSStaggeredStochasticForcing, IBAMR::HeavisideForcingFunction, IBAMR::MarangoniSurfaceTensionForceFunction, IBAMR::PhaseChangeDivUSourceFunction, IBAMR::SurfaceTensionForceFunction, and IBTK::CartGridFunctionSet.

setDataOnPatchLevel()

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  )

virtual

Evaluate the function on the patch interiors on the specified level of the patch hierarchy using the virtual function setDataOnPatch().

See also

setDataOnPatch

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

---

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

• /home/runner/work/IBAMR/IBAMR/ibtk/include/ibtk/CartGridFunction.h
• /home/runner/work/IBAMR/IBAMR/ibtk/src/utilities/CartGridFunction.cpp