Class StokesBcCoefStrategy is a subclass of the abstract base class IBTK::ExtendedRobinBcCoefStrategy to allow for specialization needed to treat physical boundary conditions for coupled Stokes solvers.

#include <ibamr/StokesBcCoefStrategy.h>

Inheritance diagram for IBAMR::StokesBcCoefStrategy:

[legend]

Public Member Functions
	StokesBcCoefStrategy ()=default
	Empty default constructor. More...

	~StokesBcCoefStrategy ()=default
	Empty destructor. More...

virtual void	setStokesSpecifications (const StokesSpecifications *problem_coefs)
	Set the StokesSpecifications object used by this boundary condition specification object. More...

virtual void	setTargetVelocityPatchDataIndex (int u_target_data_idx)
	Set the target velocity data index to use when setting physical boundary conditions and the time at which it is defined. More...

virtual void	clearTargetVelocityPatchDataIndex ()
	Clear the target velocity data index used when setting physical boundary conditions. More...

virtual void	setTargetPressurePatchDataIndex (int u_target_data_idx)
	Set the target pressure data index to use when setting physical boundary conditions and the time at which it is defined. More...

virtual void	clearTargetPressurePatchDataIndex ()
	Clear the target pressure data index used when setting physical boundary conditions. More...

virtual void	setTractionBcType (TractionBcType bc_type)
	Set the type of traction boundary conditions. Supported options are: TRACTION_BOUNDARY_CONDITIONS and PSEUDO_TRACTION_BOUNDARY_CONDITIONS. More...

virtual TractionBcType	getTractionBcType () const
	Get the type of traction boundary conditions. More...

Protected Attributes
const StokesSpecifications *	d_problem_coefs

int	d_u_target_data_idx = IBTK::invalid_index

int	d_p_target_data_idx = IBTK::invalid_index

TractionBcType	d_traction_bc_type = TRACTION

Private Member Functions
	StokesBcCoefStrategy (const StokesBcCoefStrategy &from)=delete
	Copy constructor. More...

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

Extended SAMRAI::solv::RobinBcCoefStrategy interface.
int	d_target_data_idx = IBTK::invalid_index

bool	d_homogeneous_bc = false

virtual void	setTargetPatchDataIndex (int target_data_idx)
	Set the target data index. More...

virtual void	clearTargetPatchDataIndex ()
	Clear the target data index. More...

virtual void	setHomogeneousBc (bool homogeneous_bc)
	Set whether the class is filling homogeneous or inhomogeneous boundary conditions. More...

Constructor & Destructor Documentation

◆ StokesBcCoefStrategy() [1/2]

IBAMR::StokesBcCoefStrategy::StokesBcCoefStrategy ( )

default

◆ ~StokesBcCoefStrategy()

IBAMR::StokesBcCoefStrategy::~StokesBcCoefStrategy ( )

default

◆ StokesBcCoefStrategy() [2/2]

IBAMR::StokesBcCoefStrategy::StokesBcCoefStrategy ( const StokesBcCoefStrategy & 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

◆ setStokesSpecifications()

virtual void IBAMR::StokesBcCoefStrategy::setStokesSpecifications ( const StokesSpecifications * problem_coefs )

virtual

Parameters

problem_coefs Problem coefficients

Reimplemented in IBAMR::INSCollocatedVelocityBcCoef, IBAMR::INSStaggeredVelocityBcCoef, IBAMR::INSVCStaggeredVelocityBcCoef, IBAMR::INSVCStaggeredPressureBcCoef, and IBAMR::INSStaggeredPressureBcCoef.

◆ setTargetVelocityPatchDataIndex()

virtual void IBAMR::StokesBcCoefStrategy::setTargetVelocityPatchDataIndex ( int u_target_data_idx )

virtual

Reimplemented in IBAMR::INSCollocatedVelocityBcCoef, IBAMR::INSStaggeredVelocityBcCoef, IBAMR::INSVCStaggeredVelocityBcCoef, IBAMR::INSVCStaggeredPressureBcCoef, and IBAMR::INSStaggeredPressureBcCoef.

◆ clearTargetVelocityPatchDataIndex()

virtual void IBAMR::StokesBcCoefStrategy::clearTargetVelocityPatchDataIndex ( )

virtual

Reimplemented in IBAMR::INSCollocatedVelocityBcCoef, IBAMR::INSStaggeredVelocityBcCoef, IBAMR::INSVCStaggeredVelocityBcCoef, IBAMR::INSVCStaggeredPressureBcCoef, and IBAMR::INSStaggeredPressureBcCoef.

◆ setTargetPressurePatchDataIndex()

virtual void IBAMR::StokesBcCoefStrategy::setTargetPressurePatchDataIndex ( int u_target_data_idx )

virtual

Reimplemented in IBAMR::INSCollocatedVelocityBcCoef, IBAMR::INSStaggeredVelocityBcCoef, IBAMR::INSVCStaggeredVelocityBcCoef, IBAMR::INSVCStaggeredPressureBcCoef, and IBAMR::INSStaggeredPressureBcCoef.

◆ clearTargetPressurePatchDataIndex()

virtual void IBAMR::StokesBcCoefStrategy::clearTargetPressurePatchDataIndex ( )

virtual

Reimplemented in IBAMR::INSCollocatedVelocityBcCoef, IBAMR::INSStaggeredVelocityBcCoef, IBAMR::INSVCStaggeredVelocityBcCoef, IBAMR::INSVCStaggeredPressureBcCoef, and IBAMR::INSStaggeredPressureBcCoef.

◆ setTractionBcType()

virtual void IBAMR::StokesBcCoefStrategy::setTractionBcType ( TractionBcType bc_type )

virtual

The default is TRACTION_BOUNDARY_CONDITIONS.

◆ getTractionBcType()

virtual TractionBcType IBAMR::StokesBcCoefStrategy::getTractionBcType ( ) const

virtual

◆ operator=()

StokesBcCoefStrategy& IBAMR::StokesBcCoefStrategy::operator= ( const StokesBcCoefStrategy & 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.

◆ setTargetPatchDataIndex()

virtual void IBTK::ExtendedRobinBcCoefStrategy::setTargetPatchDataIndex ( int target_data_idx )

virtualinherited

Reimplemented in IBAMR::INSCollocatedVelocityBcCoef, IBAMR::INSStaggeredVelocityBcCoef, IBAMR::INSVCStaggeredVelocityBcCoef, IBAMR::INSVCStaggeredPressureBcCoef, IBAMR::INSStaggeredPressureBcCoef, IBAMR::INSIntermediateVelocityBcCoef, and IBAMR::INSProjectionBcCoef.

◆ clearTargetPatchDataIndex()

virtual void IBTK::ExtendedRobinBcCoefStrategy::clearTargetPatchDataIndex ( )

virtualinherited

Reimplemented in IBAMR::INSCollocatedVelocityBcCoef, IBAMR::INSStaggeredVelocityBcCoef, IBAMR::INSVCStaggeredVelocityBcCoef, IBAMR::INSVCStaggeredPressureBcCoef, IBAMR::INSStaggeredPressureBcCoef, IBAMR::INSIntermediateVelocityBcCoef, and IBAMR::INSProjectionBcCoef.

◆ setHomogeneousBc()

virtual void IBTK::ExtendedRobinBcCoefStrategy::setHomogeneousBc ( bool homogeneous_bc )

virtualinherited

Reimplemented in IBAMR::INSCollocatedVelocityBcCoef, IBAMR::INSStaggeredVelocityBcCoef, IBAMR::INSVCStaggeredVelocityBcCoef, IBAMR::INSVCStaggeredPressureBcCoef, IBAMR::INSStaggeredPressureBcCoef, IBAMR::INSIntermediateVelocityBcCoef, and IBAMR::INSProjectionBcCoef.

◆ setBcCoefs()

virtual void SAMRAI::solv::RobinBcCoefStrategy< DIM >::setBcCoefs	(	tbox::Pointer< pdat::ArrayData< DIM, double > > &	acoef_data,
		tbox::Pointer< pdat::ArrayData< DIM, double > > &	bcoef_data,
		tbox::Pointer< pdat::ArrayData< DIM, double > > &	gcoef_data,
		const tbox::Pointer< hier::Variable< DIM > > &	variable,
		const hier::Patch< DIM > &	patch,
		const hier::BoundaryBox< DIM > &	bdry_box,
		const double	fill_time = `0.0`
	)		const

pure virtualinherited

This class specifies the Robin boundary condition coefficients at discrete locations on the patch boundary. Though these locations are defined by boundary box object, they do not necessarily coincide with the centers of the cells referred to by those boxes. These locations typically coincide with the nodes or face centers which do lie on the patch boundary. Accordingly, you use this function to provide the boundary coefficients at those locations by filling an array at indices corresponding to those locations.

When setting the values of the boundary condition coefficients it is useful to note that for any cell (i,j,k), the indices of the sides, edges and nodes are easily determined. The index on the lower side of the cell is the same as the index of the cell, whereas the index on the upper side of the cell has the next higher value. In 2D, the cell and its surrounding nodes and faces has the following indices:

*
*       (i,j+1)----(i,j+1)---(i+1,j+1)
*          |                     |
*          |                     |
*          |                     |
*          |                     |
*        (i,j)      (i,j)     (i+1,j)
*          |                     |
*          |                     |
*          |                     |
*          |                     |
*        (i,j)------(i,j)-----(i+1,j)
*
*

Once this is understood, translation between the index in the boundary box index space to the index of things on the boundary is simple.

The boundary condition coefficients should be placed in the pdat::ArrayData<DIM> objects, acoef_data and gcoef_data (see argument list), which are dimensioned to contain the indices of the points alligned with variable and lying on the the boundary defined by bdry_box.

This function is only used with type-1 boundary boxes, such as faces in 3D. Other types of boundaries do not have a well-defined surface normal.

The parameter variable is passed through to tell the implementation of this function what variable to set the coefficients for. You may wish to ignore it if your implementation is intended for a specific variable.

Parameters

acoef_data	boundary coefficient data. The array will have been defined to include index range for corresponding to the boundary box `bdry_box` and appropriate for the alignment of the given variable. If this is a null pointer, then the calling function is not interested in a, and you can disregard it.
bcoef_data	boundary coefficient data. This array is exactly like `acoef_data`, except that it is to be filled with the b coefficient.
gcoef_data	boundary coefficient data. This array is exactly like `acoef_data`, except that it is to be filled with the g coefficient.
variable	variable to set the coefficients for. If implemented for multiple variables, this parameter can be used to determine which variable's coefficients are being sought.
patch	patch requiring bc coefficients
bdry_box	boundary box showing where on the boundary the coefficient data is needed.
fill_time	solution time corresponding to filling, for use when coefficients are time-dependent.

◆ numberOfExtensionsFillable()

virtual hier::IntVector<DIM> SAMRAI::solv::RobinBcCoefStrategy< DIM >::numberOfExtensionsFillable ( ) const

pure virtualinherited

Member Data Documentation

◆ d_problem_coefs

const StokesSpecifications* IBAMR::StokesBcCoefStrategy::d_problem_coefs

protected

◆ d_u_target_data_idx

int IBAMR::StokesBcCoefStrategy::d_u_target_data_idx = IBTK::invalid_index

protected

Patch data indices.

◆ d_p_target_data_idx

int IBAMR::StokesBcCoefStrategy::d_p_target_data_idx = IBTK::invalid_index

protected

◆ d_traction_bc_type

TractionBcType IBAMR::StokesBcCoefStrategy::d_traction_bc_type = TRACTION

protected

◆ d_target_data_idx

int IBTK::ExtendedRobinBcCoefStrategy::d_target_data_idx = IBTK::invalid_index

protectedinherited

◆ d_homogeneous_bc

bool IBTK::ExtendedRobinBcCoefStrategy::d_homogeneous_bc = false

protectedinherited

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

include/ibamr/StokesBcCoefStrategy.h

Public Member Functions

Protected Attributes

Private Member Functions

Extended SAMRAI::solv::RobinBcCoefStrategy interface.

Constructor & Destructor Documentation

◆ StokesBcCoefStrategy() [1/2]

◆ ~StokesBcCoefStrategy()

◆ StokesBcCoefStrategy() [2/2]

Member Function Documentation

◆ setStokesSpecifications()

◆ setTargetVelocityPatchDataIndex()

◆ clearTargetVelocityPatchDataIndex()

◆ setTargetPressurePatchDataIndex()

◆ clearTargetPressurePatchDataIndex()

◆ setTractionBcType()

◆ getTractionBcType()

◆ operator=()

◆ setTargetPatchDataIndex()

◆ clearTargetPatchDataIndex()

◆ setHomogeneousBc()

◆ setBcCoefs()

◆ numberOfExtensionsFillable()

Member Data Documentation

◆ d_problem_coefs

◆ d_u_target_data_idx

◆ d_p_target_data_idx

◆ d_traction_bc_type

◆ d_target_data_idx

◆ d_homogeneous_bc