Class RobinPhysBdryPatchStrategy is an abstract strategy class that extends the SAMRAI::xfer::RefinePatchStrategy interface to provide routines specific for setting Robin boundary conditions at physical boundaries. This class also provides default implementations of some methods defined in SAMRAI::xfer::RefinePatchStrategy that are generally not needed for filling ghost cell values at physical boundaries.

#include <ibtk/RobinPhysBdryPatchStrategy.h>

Inheritance diagram for IBTK::RobinPhysBdryPatchStrategy:

[legend]

Public Member Functions
	RobinPhysBdryPatchStrategy ()=default
	Default constructor. More...

	~RobinPhysBdryPatchStrategy ()=default
	Destructor. More...

void	setPatchDataIndex (int patch_data_index)
	Reset the patch data index operated upon by this class. More...

void	setPatchDataIndices (const std::set< int > &patch_data_indices)
	Reset the patch data indices operated upon by this class. More...

void	setPatchDataIndices (const SAMRAI::hier::ComponentSelector &patch_data_indices)
	Reset the patch data indices operated upon by this class. More...

void	setPhysicalBcCoef (SAMRAI::solv::RobinBcCoefStrategy< NDIM > *bc_coef)
	Reset the Robin boundary condition specification object employed by this class to set physical boundary conditions. More...

void	setPhysicalBcCoefs (const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > &bc_coefs)
	Reset the Robin boundary condition specification object employed by this class to set physical boundary conditions. More...

void	setHomogeneousBc (bool homogeneous_bc)
	Set whether boundary filling should employ homogeneous boundary conditions. More...

bool	getHomogeneousBc () const

virtual void	setPhysicalBoundaryConditions (hier::Patch< DIM > &patch, const double fill_time, const hier::IntVector< DIM > &ghost_width_to_fill)=0

virtual hier::IntVector< DIM >	getRefineOpStencilWidth () const=0

virtual void	preprocessRefine (hier::Patch< DIM > &fine, const hier::Patch< DIM > &coarse, const hier::Box< DIM > &fine_box, const hier::IntVector< DIM > &ratio)=0

virtual void	postprocessRefine (hier::Patch< DIM > &fine, const hier::Patch< DIM > &coarse, const hier::Box< DIM > &fine_box, const hier::IntVector< DIM > &ratio)=0

virtual void	preprocessRefineBoxes (hier::Patch< DIM > &fine, const hier::Patch< DIM > &coarse, const hier::BoxList< DIM > &fine_boxes, const hier::IntVector< DIM > &ratio)

virtual void	postprocessRefineBoxes (hier::Patch< DIM > &fine, const hier::Patch< DIM > &coarse, const hier::BoxList< DIM > &fine_boxes, const hier::IntVector< DIM > &ratio)

Partial implementation of SAMRAI::xfer::RefinePatchStrategy
interface.
std::set< int >	d_patch_data_indices

std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * >	d_bc_coefs

bool	d_homogeneous_bc = false

void	preprocessRefine (SAMRAI::hier::Patch< NDIM > &fine, const SAMRAI::hier::Patch< NDIM > &coarse, const SAMRAI::hier::Box< NDIM > &fine_box, const SAMRAI::hier::IntVector< NDIM > &ratio) override

void	postprocessRefine (SAMRAI::hier::Patch< NDIM > &fine, const SAMRAI::hier::Patch< NDIM > &coarse, const SAMRAI::hier::Box< NDIM > &fine_box, const SAMRAI::hier::IntVector< NDIM > &ratio) override

virtual void	accumulateFromPhysicalBoundaryData (SAMRAI::hier::Patch< NDIM > &patch, double fill_time, const SAMRAI::hier::IntVector< NDIM > &ghost_width_to_fill)

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

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

Constructor & Destructor Documentation

◆ RobinPhysBdryPatchStrategy() [1/2]

IBTK::RobinPhysBdryPatchStrategy::RobinPhysBdryPatchStrategy ( )

default

◆ ~RobinPhysBdryPatchStrategy()

IBTK::RobinPhysBdryPatchStrategy::~RobinPhysBdryPatchStrategy ( )

default

◆ RobinPhysBdryPatchStrategy() [2/2]

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

◆ setPatchDataIndex()

void IBTK::RobinPhysBdryPatchStrategy::setPatchDataIndex ( int patch_data_index )

◆ setPatchDataIndices() [1/2]

void IBTK::RobinPhysBdryPatchStrategy::setPatchDataIndices ( const std::set< int > & patch_data_indices )

◆ setPatchDataIndices() [2/2]

void IBTK::RobinPhysBdryPatchStrategy::setPatchDataIndices ( const SAMRAI::hier::ComponentSelector & patch_data_indices )

◆ setPhysicalBcCoef()

void IBTK::RobinPhysBdryPatchStrategy::setPhysicalBcCoef ( SAMRAI::solv::RobinBcCoefStrategy< NDIM > * bc_coef )

Note: bc_coef cannot be nullptr.

◆ setPhysicalBcCoefs()

void IBTK::RobinPhysBdryPatchStrategy::setPhysicalBcCoefs ( const std::vector< SAMRAI::solv::RobinBcCoefStrategy< NDIM > * > & bc_coefs )

Note: None of the elements of bc_coefs can be nullptr.

◆ setHomogeneousBc()

void IBTK::RobinPhysBdryPatchStrategy::setHomogeneousBc ( bool homogeneous_bc )

Note: By default, inhomogeneous boundary conditions are assumed.

◆ getHomogeneousBc()

bool IBTK::RobinPhysBdryPatchStrategy::getHomogeneousBc ( ) const

Returns: Whether boundary filling employs homogeneous boundary conditions.

◆ preprocessRefine() [1/2]

void IBTK::RobinPhysBdryPatchStrategy::preprocessRefine	(	SAMRAI::hier::Patch< NDIM > &	fine,
		const SAMRAI::hier::Patch< NDIM > &	coarse,
		const SAMRAI::hier::Box< NDIM > &	fine_box,
		const SAMRAI::hier::IntVector< NDIM > &	ratio
	)

override

Function to perform user-defined preprocess data refine operations. This member function is called before standard refine operations (expressed using concrete subclasses of the SAMRAI::xfer::RefineOperator base class). The preprocess function must refine data from the scratch components of the coarse patch into the scratch components of the fine patch on the specified fine box region. Recall that the scratch components are specified in calls to the registerRefine() function in the SAMRAI::xfer::RefineAlgorithm class.

The default implementation does nothing. This behavior can be overridden by subclasses.

Parameters

fine	Fine patch containing destination data.
coarse	Coarse patch containing source data.
fine_box	Box region on fine patch into which data is refined.
ratio	Integer vector containing ratio relating index space between coarse and fine patches.

◆ postprocessRefine() [1/2]

void IBTK::RobinPhysBdryPatchStrategy::postprocessRefine	(	SAMRAI::hier::Patch< NDIM > &	fine,
		const SAMRAI::hier::Patch< NDIM > &	coarse,
		const SAMRAI::hier::Box< NDIM > &	fine_box,
		const SAMRAI::hier::IntVector< NDIM > &	ratio
	)

override

Function to perform user-defined postprocess data refine operations. This member function is called after standard refine operations (expressed using concrete subclasses of the SAMRAI::xfer::RefineOperator base class). The postprocess function must refine data from the scratch components of the coarse patch into the scratch components of the fine patch on the specified fine box region. Recall that the scratch components are specified in calls to the registerRefine() function in the SAMRAI::xfer::RefineAlgorithm class.

The implementation does nothing. This behavior can be overridden by subclasses.

Parameters

fine	Fine patch containing destination data.
coarse	Coarse patch containing source data.
fine_box	Box region on fine patch into which data is refined.
ratio	Integer vector containing ratio relating index space between coarse and fine patches.

◆ accumulateFromPhysicalBoundaryData()

virtual void IBTK::RobinPhysBdryPatchStrategy::accumulateFromPhysicalBoundaryData	(	SAMRAI::hier::Patch< NDIM > &	patch,
		double	fill_time,
		const SAMRAI::hier::IntVector< NDIM > &	ghost_width_to_fill
	)

virtual

Function to accumulate data near physical boundaries from values set in the ghost cell region using the adjoint of the operator used to extrapolate the ghost cell values. This function can be used to construct the adjoint of linear operators that use ghost cell data.

Note: A default implementation is provided that emits an error message.

Parameters

patch	Patch on which to fill boundary data.
fill_time	Double simulation time for boundary filling.
ghost_width_to_fill	Integer vector describing maximum ghost width to fill over all registered scratch components.

Reimplemented in IBTK::CartCellRobinPhysBdryOp, and IBTK::CartSideRobinPhysBdryOp.

◆ operator=()

RobinPhysBdryPatchStrategy& IBTK::RobinPhysBdryPatchStrategy::operator= ( const RobinPhysBdryPatchStrategy & 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.

◆ setPhysicalBoundaryConditions()

virtual void SAMRAI::xfer::RefinePatchStrategy< DIM >::setPhysicalBoundaryConditions	(	hier::Patch< DIM > &	patch,
		const double	fill_time,
		const hier::IntVector< DIM > &	ghost_width_to_fill
	)

pure virtualinherited

Pure virtual function to set data associated with the given list of patch data indices at patch boundaries that intersect the physical domain boundary. The specific boundary conditions are determined by the user. The patch data components set in this routine correspond to the "scratch" components specified in calls to the registerRefine() function in the RefineAlgorithm<DIM> class.

Parameters

patch	hier::Patch on which to fill boundary data.
fill_time	Double simulation time for boundary filling.
ghost_width_to_fill	Integer vector describing maximum ghost width to fill over all registered scratch components.

◆ getRefineOpStencilWidth()

virtual hier::IntVector<DIM> SAMRAI::xfer::RefinePatchStrategy< DIM >::getRefineOpStencilWidth ( ) const

pure virtualinherited

Pure virtual function to return maximum stencil width needed over user-defined data interpolation operations. This is needed to determine the correct interpolation data dependencies.

◆ preprocessRefine() [2/2]

virtual void SAMRAI::xfer::RefinePatchStrategy< DIM >::preprocessRefine	(	hier::Patch< DIM > &	fine,
		const hier::Patch< DIM > &	coarse,
		const hier::Box< DIM > &	fine_box,
		const hier::IntVector< DIM > &	ratio
	)

pure virtualinherited

Pure virtual function to perform user-defined preprocess data refine operations. This member function is called before standard refine operations (expressed using concrete subclasses of the RefineOperator<DIM> base class). The preprocess function must refine data from the scratch components of the coarse patch into the scratch components of the fine patch on the specified fine box region. Recall that the scratch components are specified in calls to the registerRefine() function in the RefineAlgorithm<DIM> class.

Parameters

fine	Fine patch containing destination data.
coarse	Coarse patch containing source data.
fine_box	hier::Box region on fine patch into which data is refined.
ratio	Integer vector containing ratio relating index space between coarse and fine patches.

◆ postprocessRefine() [2/2]

virtual void SAMRAI::xfer::RefinePatchStrategy< DIM >::postprocessRefine	(	hier::Patch< DIM > &	fine,
		const hier::Patch< DIM > &	coarse,
		const hier::Box< DIM > &	fine_box,
		const hier::IntVector< DIM > &	ratio
	)

pure virtualinherited

Pure virtual function to perform user-defined postprocess data refine operations. This member function is called after standard refine operations (expressed using concrete subclasses of the RefineOperator<DIM> base class). The postprocess function must refine data from the scratch components of the coarse patch into the scratch components of the fine patch on the specified fine box region. Recall that the scratch components are specified in calls to the registerRefine() function in the RefineAlgorithm<DIM> class.

Parameters

fine	Fine patch containing destination data.
coarse	Coarse patch containing source data.
fine_box	hier::Box region on fine patch into which data is refined.
ratio	Integer vector containing ratio relating index space between coarse and fine patches.

◆ preprocessRefineBoxes()

virtual void SAMRAI::xfer::RefinePatchStrategy< DIM >::preprocessRefineBoxes	(	hier::Patch< DIM > &	fine,
		const hier::Patch< DIM > &	coarse,
		const hier::BoxList< DIM > &	fine_boxes,
		const hier::IntVector< DIM > &	ratio
	)

virtualinherited

Virtual function to perform user-defined refine operations. This member function is called before standard refining operations (expressed using concrete subclasses of the RefineOperator<DIM> base class). The preprocess function must refine data from the scratch components of the coarse patch into the scratch components of the fine patch on the specified fine box regions.

Typically, only the pure virtual members of this class are implemented in user-defined subclasses of this base class. This version of the preprocess function operates on an entire box list. By default, this version simply loops over the box list and calls the single-box version, which is a pure virtual function.

Parameters

fine	Fine patch containing destination data.
coarse	Coarse patch containing source data.
fine_boxes	tbox::List of box regions on fine patch into which data is refined.
ratio	Integer vector containing ratio relating index space between coarse and fine patches.

◆ postprocessRefineBoxes()

virtual void SAMRAI::xfer::RefinePatchStrategy< DIM >::postprocessRefineBoxes	(	hier::Patch< DIM > &	fine,
		const hier::Patch< DIM > &	coarse,
		const hier::BoxList< DIM > &	fine_boxes,
		const hier::IntVector< DIM > &	ratio
	)

virtualinherited

Virtual function to perform user-defined refine operations. This member function is called after standard refining operations (expressed using concrete subclasses of the RefineOperator<DIM> base class). The postprocess function must refine data from the scratch components of the coarse patch into the scratch components of the fine patch on the specified fine box regions.

Typically, only the pure virtual members of this class are implemented in user-defined subclasses of this base class. This version of the postprocess function operates on an entire box list. By default, this version simply loops over the box list and calls the single-box version, which is a pure virtual function.

Parameters

fine	Fine patch containing destination data.
coarse	Coarse patch containing source data.
fine_boxes	tbox::List of box regions on fine patch into which data is refined.
ratio	Integer vector containing ratio relating index space between coarse and fine patches.

Member Data Documentation

◆ d_patch_data_indices

std::set<int> IBTK::RobinPhysBdryPatchStrategy::d_patch_data_indices

protected

◆ d_bc_coefs

std::vector<SAMRAI::solv::RobinBcCoefStrategy<NDIM>*> IBTK::RobinPhysBdryPatchStrategy::d_bc_coefs

protected

◆ d_homogeneous_bc

bool IBTK::RobinPhysBdryPatchStrategy::d_homogeneous_bc = false

protected

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

ibtk/include/ibtk/RobinPhysBdryPatchStrategy.h

Public Member Functions

Partial implementation of SAMRAI::xfer::RefinePatchStrategy

Constructor & Destructor Documentation

◆ RobinPhysBdryPatchStrategy() [1/2]

◆ ~RobinPhysBdryPatchStrategy()

◆ RobinPhysBdryPatchStrategy() [2/2]

Member Function Documentation

◆ setPatchDataIndex()

◆ setPatchDataIndices() [1/2]

◆ setPatchDataIndices() [2/2]

◆ setPhysicalBcCoef()

◆ setPhysicalBcCoefs()

◆ setHomogeneousBc()

◆ getHomogeneousBc()

◆ preprocessRefine() [1/2]

◆ postprocessRefine() [1/2]

◆ accumulateFromPhysicalBoundaryData()

◆ operator=()

◆ setPhysicalBoundaryConditions()

◆ getRefineOpStencilWidth()

◆ preprocessRefine() [2/2]

◆ postprocessRefine() [2/2]

◆ preprocessRefineBoxes()

◆ postprocessRefineBoxes()

Member Data Documentation

◆ d_patch_data_indices

◆ d_bc_coefs

◆ d_homogeneous_bc