IBTK::StaggeredPhysicalBoundaryHelper Class Reference

Class StaggeredPhysicalBoundaryHelper provides helper functions to handle physical boundary conditions for a staggered grid discretizations.

#include <ibtk/StaggeredPhysicalBoundaryHelper.h>

Inheritance diagram for IBTK::StaggeredPhysicalBoundaryHelper:

Public Member Functions
	StaggeredPhysicalBoundaryHelper ()=default
	Default constructor. More...
virtual	~StaggeredPhysicalBoundaryHelper ()=default
	Destructor. More...
void	copyDataAtDirichletBoundaries (int u_out_data_idx, int u_in_data_idx, int coarsest_ln=invalid_level_number, int finest_ln=invalid_level_number) const
	Copy data to u_data_out_idx from u_data_in_idx at Dirichlet boundaries over the specified range of levels in the patch hierarchy. More...
void	copyDataAtDirichletBoundaries (SAMRAI::tbox::Pointer< SAMRAI::pdat::SideData< NDIM, double > > u_out_data, SAMRAI::tbox::Pointer< SAMRAI::pdat::SideData< NDIM, double > > u_in_data, SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM > > patch) const
	Copy data to u_data_out_idx from u_data_in_idx at Dirichlet boundaries on a single patch. More...
void	setupMaskingFunction (int mask_data_idx, int coarsest_ln=invalid_level_number, int finest_ln=invalid_level_number) const
	Setup a masking function over the specified range of levels in the patch hierarchy. More...
void	setupMaskingFunction (SAMRAI::tbox::Pointer< SAMRAI::pdat::SideData< NDIM, int > > u_data, SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM > > patch) const
	Setup a masking function on a single patch. More...
bool	patchTouchesDirichletBoundary (SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM > > patch) const
	Return a boolean value indicating whether a patch has Dirichlet boundaries. More...
bool	patchTouchesDirichletBoundaryAxis (SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM > > patch, const unsigned int axis) const
	Return a boolean value indicating whether a patch has Dirichlet boundaries in the specified coordinate axis. More...
void	cacheBcCoefData (const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &u_bc_coefs, double fill_time, SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > > hierarchy)
	Cache boundary coefficient data. More...
virtual void	clearBcCoefData ()
	Clear cached boundary coefficient data. More...

Static Protected Member Functions
static void	setupBcCoefBoxes (SAMRAI::hier::Box< NDIM > &bc_coef_box, SAMRAI::hier::BoundaryBox< NDIM > &trimmed_bdry_box, const SAMRAI::hier::BoundaryBox< NDIM > &bdry_box, SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM > > patch)
	Setup boundary boxes used for setting boundary condition coefficients. More...

Protected Attributes
SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > >	d_hierarchy
std::vector< std::map< int, SAMRAI::tbox::Array< SAMRAI::hier::BoundaryBox< NDIM > > > >	d_physical_codim1_boxes
std::vector< std::map< int, std::vector< SAMRAI::tbox::Pointer< SAMRAI::pdat::ArrayData< NDIM, bool > > > > >	d_dirichlet_bdry_locs

Private Member Functions
	StaggeredPhysicalBoundaryHelper (const StaggeredPhysicalBoundaryHelper &from)=delete
	Copy constructor. More...
StaggeredPhysicalBoundaryHelper &	operator= (const StaggeredPhysicalBoundaryHelper &that)=delete
	Assignment operator. More...

Constructor & Destructor Documentation

StaggeredPhysicalBoundaryHelper() [1/2]

IBTK::StaggeredPhysicalBoundaryHelper::StaggeredPhysicalBoundaryHelper ( )

default

~StaggeredPhysicalBoundaryHelper()

virtual IBTK::StaggeredPhysicalBoundaryHelper::~StaggeredPhysicalBoundaryHelper ( )

virtualdefault

StaggeredPhysicalBoundaryHelper() [2/2]

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

copyDataAtDirichletBoundaries() [1/2]

void IBTK::StaggeredPhysicalBoundaryHelper::copyDataAtDirichletBoundaries	(	int	u_out_data_idx,
		int	u_in_data_idx,
		int	coarsest_ln = invalid_level_number,
		int	finest_ln = invalid_level_number
	)		const

copyDataAtDirichletBoundaries() [2/2]

void IBTK::StaggeredPhysicalBoundaryHelper::copyDataAtDirichletBoundaries	(	SAMRAI::tbox::Pointer< SAMRAI::pdat::SideData< NDIM, double > >	u_out_data,
		SAMRAI::tbox::Pointer< SAMRAI::pdat::SideData< NDIM, double > >	u_in_data,
		SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM > >	patch
	)		const

setupMaskingFunction() [1/2]

void IBTK::StaggeredPhysicalBoundaryHelper::setupMaskingFunction	(	int	mask_data_idx,
		int	coarsest_ln = invalid_level_number,
		int	finest_ln = invalid_level_number
	)		const

setupMaskingFunction() [2/2]

void IBTK::StaggeredPhysicalBoundaryHelper::setupMaskingFunction	(	SAMRAI::tbox::Pointer< SAMRAI::pdat::SideData< NDIM, int > >	u_data,
		SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM > >	patch
	)		const

patchTouchesDirichletBoundary()

bool IBTK::StaggeredPhysicalBoundaryHelper::patchTouchesDirichletBoundary

(

SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM > >

patch

)

const

patchTouchesDirichletBoundaryAxis()

bool IBTK::StaggeredPhysicalBoundaryHelper::patchTouchesDirichletBoundaryAxis	(	SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM > >	patch,
		const unsigned int	axis
	)		const

cacheBcCoefData()

void IBTK::StaggeredPhysicalBoundaryHelper::cacheBcCoefData	(	const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &	u_bc_coefs,
		double	fill_time,
		SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > >	hierarchy
	)

clearBcCoefData()

virtual void IBTK::StaggeredPhysicalBoundaryHelper::clearBcCoefData ( )

virtual

setupBcCoefBoxes()

static void IBTK::StaggeredPhysicalBoundaryHelper::setupBcCoefBoxes ( SAMRAI::hier::Box< NDIM > &  bc_coef_box, SAMRAI::hier::BoundaryBox< NDIM > &  trimmed_bdry_box, const SAMRAI::hier::BoundaryBox< NDIM > &  bdry_box, SAMRAI::tbox::Pointer< SAMRAI::hier::Patch< NDIM > >  patch  )

staticprotected

operator=()

StaggeredPhysicalBoundaryHelper& IBTK::StaggeredPhysicalBoundaryHelper::operator= ( const StaggeredPhysicalBoundaryHelper &  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_hierarchy

SAMRAI::tbox::Pointer<SAMRAI::hier::PatchHierarchy<NDIM> > IBTK::StaggeredPhysicalBoundaryHelper::d_hierarchy

protected

Cached hierarchy-related information.

d_physical_codim1_boxes

std::vector<std::map<int, SAMRAI::tbox::Array<SAMRAI::hier::BoundaryBox<NDIM> > > > IBTK::StaggeredPhysicalBoundaryHelper::d_physical_codim1_boxes

protected

d_dirichlet_bdry_locs

std::vector<std::map<int, std::vector<SAMRAI::tbox::Pointer<SAMRAI::pdat::ArrayData<NDIM, bool> > > > > IBTK::StaggeredPhysicalBoundaryHelper::d_dirichlet_bdry_locs

protected

---

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

• ibtk/include/ibtk/StaggeredPhysicalBoundaryHelper.h