IBTK::muParserCartGridFunction Class Reference

Class muParserCartGridFunction is an implementation of the strategy class CartGridFunction that allows for the run-time specification of (possibly spatially- and temporally-varying) functions which are used to set double precision values on standard SAMRAI SAMRAI::hier::PatchData objects. More...

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

Inheritance diagram for IBTK::muParserCartGridFunction:

Public Member Functions
	muParserCartGridFunction (std::string object_name, SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > input_db, SAMRAI::tbox::Pointer< SAMRAI::geom::CartesianGridGeometry< NDIM > > grid_geom)
	Constructor.
	~muParserCartGridFunction ()=default
	Empty destructor.
Public Member Functions inherited from IBTK::CartGridFunction
	CartGridFunction (std::string object_name="")
	The default constructor sets the name of the strategy object.
virtual	~CartGridFunction ()=default
	Empty virtual destructor.
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().

Methods to set patch interior data.
bool	isTimeDependent () const override
	Indicates whether the concrete CartGridFunction object is time-dependent.
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 > > level=SAMRAI::tbox::Pointer< SAMRAI::hier::PatchLevel< NDIM > >(nullptr)) override
	Virtual function to evaluate the function on the patch interior.

Additional Inherited Members
Protected Attributes inherited from IBTK::CartGridFunction
std::string	d_object_name

Detailed Description

Class muParserCartGridFunction is an implementation of the strategy class CartGridFunction that allows for the run-time specification of (possibly spatially- and temporally-varying) functions which are used to set double precision values on standard SAMRAI SAMRAI::hier::PatchData objects.

Member Function Documentation

isTimeDependent()

bool IBTK::muParserCartGridFunction::isTimeDependent ( ) const

overridevirtual

Indicates whether the concrete CartGridFunction object is time-dependent.

Implements IBTK::CartGridFunction.

setDataOnPatch()

void IBTK::muParserCartGridFunction::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 > >  level = SAMRAI::tbox::Pointer<SAMRAI::hier::PatchLevel<NDIM> >(nullptr)  )

overridevirtual

Virtual function to evaluate the function on the patch interior.

Implements IBTK::CartGridFunction.

---

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

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