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

#include <ibtk/CartGridFunction.h>

Inheritance diagram for IBTK::CartGridFunction:

[legend]

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

virtual	~CartGridFunction ()=default
	Empty virtual destructor. More...

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. More...

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(). More...

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...

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. More...

	CartGridFunction (const CartGridFunction &from)=delete
	Copy constructor. More...

CartGridFunction &	operator= (const CartGridFunction &that)=delete
	Assignment operator. More...

Constructor & Destructor Documentation

◆ CartGridFunction() [1/2]

IBTK::CartGridFunction::CartGridFunction ( std::string object_name = "" )

◆ ~CartGridFunction()

virtual IBTK::CartGridFunction::~CartGridFunction ( )

virtualdefault

◆ CartGridFunction() [2/2]

IBTK::CartGridFunction::CartGridFunction ( const CartGridFunction & from )

privatedelete

Note: This constructor is not implemented and should not be used.

Parameters

from	The value to copy to this object.

Member Function Documentation

◆ isTimeDependent()

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

pure virtual

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

◆ setDataOnPatchHierarchy()

virtual 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

See also: setDataOnPatch

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

◆ 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`
	)

virtual

See also: setDataOnPatch

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

◆ 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

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

◆ operator=()

CartGridFunction& IBTK::CartGridFunction::operator= ( const CartGridFunction & that )

privatedelete

Note: This operator is not implemented and should not be used.

Parameters

that	The value to assign to this object.

Returns: A reference to this object.

Member Data Documentation

◆ d_object_name

std::string IBTK::CartGridFunction::d_object_name

protected

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

ibtk/include/ibtk/CartGridFunction.h

Public Member Functions

Methods to set patch interior data.