IBAMR  IBAMR version 0.19.
Public Member Functions | List of all members
SAMRAI::appu::BoundaryUtilityStrategy Class Reference

Class BoundaryUtilityStrategy is an abstract base class that declares an interface that allows application code to read problem-specific boundary data when using the SAMRAI boundary utilities. Currently, there are two virtual member functions defined.
One allows users to read problem-specific DIRICHLET boundary values from an input database; the other does the same for NEUMANN boundary values. More virtual functions may be added in the future as additional boundary conditions are supported. More...

#include <BoundaryUtilityStrategy.h>

Public Member Functions

 BoundaryUtilityStrategy ()
 
virtual ~BoundaryUtilityStrategy ()
 
virtual void readDirichletBoundaryDataEntry (tbox::Pointer< tbox::Database > db, std::string &db_name, int bdry_location_index)
 
virtual void readNeumannBoundaryDataEntry (tbox::Pointer< tbox::Database > db, std::string &db_name, int bdry_location_index)
 

Detailed Description

See the include file BoundaryDefines.h for integer constant definitions that apply for the various boundary types, locations, and boundary conditions.

See also
appu::CartesianBoundaryUtilities2
appu::CartesianBoundaryUtilities3

Constructor & Destructor Documentation

◆ BoundaryUtilityStrategy()

SAMRAI::appu::BoundaryUtilityStrategy::BoundaryUtilityStrategy ( )

The default constructor for BoundaryUtilityStrategy does nothing interesting.

◆ ~BoundaryUtilityStrategy()

virtual SAMRAI::appu::BoundaryUtilityStrategy::~BoundaryUtilityStrategy ( )
virtual

The destructor for BoundaryUtilityStrategy does nothing interesting.

Member Function Documentation

◆ readDirichletBoundaryDataEntry()

virtual void SAMRAI::appu::BoundaryUtilityStrategy::readDirichletBoundaryDataEntry ( tbox::Pointer< tbox::Database db,
std::string &  db_name,
int  bdry_location_index 
)
inlinevirtual

Read DIRICHLET boundary state values for an edge (in 2d) or a face (in 3d) from a given database. This virtual function is given a blank implementation here to avoid the need for users to do the same if they do not need this functionality.

Parameters
dbInput database from which to read boundary values.
db_nameName of input database (e.g., for error reporting).
bdry_location_indexInteger index for location of edge (in 2d) or face (in 3d) boundary.

◆ readNeumannBoundaryDataEntry()

virtual void SAMRAI::appu::BoundaryUtilityStrategy::readNeumannBoundaryDataEntry ( tbox::Pointer< tbox::Database db,
std::string &  db_name,
int  bdry_location_index 
)
inlinevirtual

Read NEUMANN boundary state values for an edge (in 2d) or a face (in 3d) from a given database. This virtual function is given a blank implementation here to avoid the need for users to do the same if they do not need this functionality.

Parameters
dbInput database from which to read boundary values.
db_nameName of input database (e.g., for error reporting).
bdry_location_indexInteger index for location of edge (in 2d) or face (in 3d) boundary.

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