IBAMR
An adaptive and distributed-memory parallel implementation of the immersed boundary (IB) method
Public Member Functions | List of all members
IBTK::CartGridFunction Class Referenceabstract

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:
Inheritance graph
[legend]

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

Detailed Description

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

Member Function Documentation

◆ 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

◆ 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 IBTK::CartGridFunctionSet, and IBAMR::CFINSForcing.


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