IBTK::CartGridFunctionSet Class Reference

Class CartGridFunctionSet is a concrete CartGridFunction that is used to allow multiple CartGridFunction objects to act as a single function.

#include <ibtk/CartGridFunctionSet.h>

Inheritance diagram for IBTK::CartGridFunctionSet:

Public Member Functions
	CartGridFunctionSet (std::string object_name="")
	The default constructor sets the name of the strategy object and sets the collection of functions to be empty. More...
virtual	~CartGridFunctionSet ()=default
	Empty virtual destructor. More...
void	addFunction (SAMRAI::tbox::Pointer< CartGridFunction > fcn)
	Add a CartGridFunction to the set of functions grouped together by this object. More...

Methods to set patch interior data.
std::vector< SAMRAI::tbox::Pointer< CartGridFunction > >	d_fcns
bool	isTimeDependent () const override
	Indicates whether the concrete CartGridFunctionSet 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=invalid_level_number, int finest_ln=invalid_level_number) override
	Evaluate the function on the patch interiors on the specified levels of the patch hierarchy using the implementations of setDataOnPatchHierarchy() provided by the component function objects. More...
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) override
	Evaluate the function on the patch interiors on the specified level of the patch hierarchy using the implementations of setDataOnPatchLevel() provided by the component function objects. More...
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)) override
	Evaluate the function on the patch interior using the implementations of setDataOnPatch() provided by the component function objects. More...
	CartGridFunctionSet (const CartGridFunctionSet &from)=delete
	Copy constructor. More...
CartGridFunctionSet &	operator= (const CartGridFunctionSet &that)=delete
	Assignment operator. More...

Constructor & Destructor Documentation

CartGridFunctionSet() [1/2]

IBTK::CartGridFunctionSet::CartGridFunctionSet

(

std::string

object_name = ""

)

~CartGridFunctionSet()

virtual IBTK::CartGridFunctionSet::~CartGridFunctionSet ( )

virtualdefault

CartGridFunctionSet() [2/2]

IBTK::CartGridFunctionSet::CartGridFunctionSet ( const CartGridFunctionSet &  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

addFunction()

void IBTK::CartGridFunctionSet::addFunction

(

SAMRAI::tbox::Pointer< CartGridFunction >

fcn

)

isTimeDependent()

bool IBTK::CartGridFunctionSet::isTimeDependent ( ) const

overridevirtual

Implements IBTK::CartGridFunction.

setDataOnPatchHierarchy()

void IBTK::CartGridFunctionSet::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  )

overridevirtual

Reimplemented from IBTK::CartGridFunction.

setDataOnPatchLevel()

void IBTK::CartGridFunctionSet::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  )

overridevirtual

Reimplemented from IBTK::CartGridFunction.

setDataOnPatch()

void IBTK::CartGridFunctionSet::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)  )

overridevirtual

Implements IBTK::CartGridFunction.

operator=()

CartGridFunctionSet& IBTK::CartGridFunctionSet::operator= ( const CartGridFunctionSet &  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_fcns

std::vector<SAMRAI::tbox::Pointer<CartGridFunction> > IBTK::CartGridFunctionSet::d_fcns

protected

d_object_name

std::string IBTK::CartGridFunction::d_object_name

protectedinherited

---

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

• ibtk/include/ibtk/CartGridFunctionSet.h