Base class for passing Robin MF boundary conditions into MFHelmholtzOp. More...

#include <CD_MFHelmholtzRobinEBBC.H>

Inheritance diagram for MFHelmholtzRobinEBBC:

[legend]

Collaboration diagram for MFHelmholtzRobinEBBC:

[legend]

Public Member Functions
	MFHelmholtzRobinEBBC (const int a_phase, const RefCountedPtr< MFHelmholtzJumpBC > &a_jumpBC)
	Full constructor. Must subsequently set the order and weight for stencils.

virtual	~MFHelmholtzRobinEBBC ()
	Destructor.

void	setOrder (const int a_order)
	Set BC order.

void	setWeight (const int a_weight)
	Set equation weights for least squares reconstruction.

virtual void	setDomainDropOrder (const int a_domainSize)
	Drop BC order if domain size is equal or below this.

void	setCoefficients (const Real a_A, const Real a_B, const Real a_C)
	Set constant coefficients.

void	setCoefficients (const std::function< Real(const RealVect &a_pos)> &a_A, const std::function< Real(const RealVect &a_pos)> &a_B, const std::function< Real(const RealVect &a_pos)> &a_C)
	Set variable coefficients.

Public Member Functions inherited from MFHelmholtzEBBC
	MFHelmholtzEBBC ()=delete
	Disallowed weak constructor. Factory must call the other version.

	MFHelmholtzEBBC (const MFHelmholtzEBBC &a_other)=delete
	Disallowed copy constructor. Factory must call the other version.

	MFHelmholtzEBBC (const int a_phase, const RefCountedPtr< MFHelmholtzJumpBC > &a_jumpBC)
	Full constructor.

virtual	~MFHelmholtzEBBC ()
	Default constructor.

virtual void	applyEBFlux (VoFIterator &a_vofit, EBCellFAB &a_Lphi, const EBCellFAB &a_phi, const BaseIVFAB< Real > &a_Bcoef, const DataIndex &a_dit, const Real &a_beta, const bool &a_homogeneousPhysBC) const override
	Apply the EB flux. This is the version that is called by EBHelmholtzOp.

Public Member Functions inherited from EBHelmholtzEBBC
	EBHelmholtzEBBC ()
	Default constructor.

virtual	~EBHelmholtzEBBC ()
	Destructor.

	EBHelmholtzEBBC (const EBHelmholtzEBBC &a_other)=delete
	Disallowed – don't see why you would need it.

EBHelmholtzEBBC &	operator= (const EBHelmholtzEBBC &a_other)=delete
	Disallowed - don't see why you would need it.

void	define (const Location::Cell a_dataLocation, const EBLevelGrid &a_eblg, const AmrMask &a_validCells, const RealVect &a_probLo, const Real &a_dx, const int a_ghostCF)
	Define function that is called by EBHelmholtzOp.

const LayoutData< BaseIVFAB< VoFStencil > > &	getGradPhiStencils () const
	Get the stencil for computing the finite-volume approximation to kappa*Div(F).

Protected Member Functions
virtual void	defineSinglePhase () override
	User define function.

virtual void	applyEBFluxSinglePhase (VoFIterator &a_singlePhaseVofs, EBCellFAB &a_Lphi, const EBCellFAB &a_phi, const BaseIVFAB< Real > &a_Bcoef, const DataIndex &a_dit, const Real &a_beta, const bool &a_homogeneousPhysBC) const override
	Apply flux single phase.

VoFStencil	getInterpolationStencil (const VolIndex &a_vof, const DataIndex &a_dit, const VofUtils::Neighborhood a_neighborhood, const int a_order) const
	Get a least-squares based interpolation stencil.

Protected Member Functions inherited from MFHelmholtzEBBC
void	define () override final
	User define function.

void	defineMultiPhase ()
	Define stuff for multi-phase.

void	applyEBFluxMultiPhase (VoFIterator &a_multiPhaseVofs, EBCellFAB &a_Lphi, const EBCellFAB &a_phi, const BaseIVFAB< Real > &a_Bcoef, const DataIndex &a_dit, const Real &a_beta, const bool &a_homogeneousPhysBC) const
	Apply flux in multiphase cells.

virtual bool	getLeastSquaresBoundaryGradStencil (std::pair< Real, VoFStencil > &a_stencil, const VolIndex &a_vof, const VofUtils::Neighborhood a_neighborhood, const DataIndex &a_dit, const int a_order, const int a_weight) const
	Get stencil with specified order.

Protected Member Functions inherited from EBHelmholtzEBBC
bool	isStencilValidCF (const VoFStencil &a_stencil, const DataIndex &a_dit) const
	Check if stencil is valid.

RealVect	getBoundaryPosition (const VolIndex &a_vof, const DataIndex &a_dit) const
	Returns physical position at the boundary.

Real	applyStencil (const VoFStencil &a_stencil, const EBCellFAB &a_phi) const
	Apply stencil to data holder and return result.

Protected Attributes
bool	m_useConstant

bool	m_useFunction
	Use function for BC value.

int	m_order
	Stencil order.

int	m_weight
	Stencil weight.

int	m_domainDropOrder
	Special flag for dropping stencil order when domains become coarser than this.

Real	m_constantA
	Constant A-coefficient.

Real	m_constantB
	Constant B-coefficient.

Real	m_constantC
	Constant C-coefficient.

std::function< Real(const RealVect &a_pos)>	m_functionA
	Function-based A-coefficient.

std::function< Real(const RealVect &a_pos)>	m_functionB
	Function-based B-coefficient.

std::function< Real(const RealVect &a_pos)>	m_functionC
	Function-based C-coefficient.

Protected Attributes inherited from MFHelmholtzEBBC
RefCountedPtr< MFHelmholtzJumpBC >	m_jumpBC
	Jump bc object.

int	m_phase
	Phase.

LayoutData< BaseIVFAB< Real > >	m_boundaryWeights
	Weights for matching cells.

Protected Attributes inherited from EBHelmholtzEBBC
Location::Cell	m_dataLocation
	Data centering.

int	m_ghostCF
	Number of ghost cells that were filled across CF interface.

Real	m_dx
	Grid resolution.

RealVect	m_probLo
	Lower-left corner of computational domain.

EBLevelGrid	m_eblg
	Level grid.

RefCountedPtr< LevelData< BaseFab< bool > > >	m_validCells
	Valid grid cells.

LayoutData< BaseIVFAB< VoFStencil > >	m_gradPhiStencils
	Stencils for computing the flux on a single level. This is a single-level object.

Additional Inherited Members
Public Types inherited from EBHelmholtzEBBC
using	AmrMask = RefCountedPtr< LevelData< BaseFab< bool > > >
	Alias to cut down on typing.

Static Protected Attributes inherited from EBHelmholtzEBBC
static constexpr int	m_comp = 0
	Component that everything is defined for. Always have m_comp = 0.

static constexpr int	m_nComp = 1
	Number of components. Always have m_nComp = 1.

Detailed Description

Base class for passing Robin MF boundary conditions into MFHelmholtzOp.

Note: MFHelmholtzRobinEBBC ignores the a_order and a_weight argument passed into MFHelmholtzEBBC. It computes the interpolation of phi onto the boundary using a first order accurate stencil (with range 1).

Member Function Documentation

◆ applyEBFluxSinglePhase()

void MFHelmholtzRobinEBBC::applyEBFluxSinglePhase	(	VoFIterator &	a_singlePhaseVofs,
		EBCellFAB &	a_Lphi,
		const EBCellFAB &	a_phi,
		const BaseIVFAB< Real > &	a_Bcoef,
		const DataIndex &	a_dit,
		const Real &	a_beta,
		const bool &	a_homogeneousPhysBC
	)		const

overrideprotectedvirtual

Apply flux single phase.

Parameters

[in,out]	a_singlePhaseVofs	Iterator for single-phase cut-cells
[in,out]	a_Lphi	Operator kappa*L(phi)
[in]	a_phi	Phi, cell-centered.
[in]	a_Bcoef	EB-centered B-coefficient
[in]	a_dit	Data index
[in]	a_beta	Beta. Passed in from operator.
[in]	a_homogeneousPhysBC	Homogeneous BC or not.

Implements MFHelmholtzEBBC.

◆ defineSinglePhase()

void MFHelmholtzRobinEBBC::defineSinglePhase ( )

overrideprotectedvirtual

User define function.

Implements MFHelmholtzEBBC.

◆ getInterpolationStencil()

VoFStencil MFHelmholtzRobinEBBC::getInterpolationStencil	(	const VolIndex &	a_vof,
		const DataIndex &	a_dit,
		const VofUtils::Neighborhood	a_neighborhood,
		const int	a_order
	)		const

protected

Get a least-squares based interpolation stencil.

Parameters

[in]	a_vof	Grid cell
[in]	a_dit	Data index.
[in]	a_neighborhood	Vof neighborhood (either quadrant-based or radius)
[in]	a_order	Stencil order

Note: This extrapolates from cell-centers to the EB using a first order expression.

◆ setCoefficients() [1/2]

void MFHelmholtzRobinEBBC::setCoefficients	(	const Real	a_A,
		const Real	a_B,
		const Real	a_C
	)

Set constant coefficients.

Parameters

[in]	a_A	A-coefficient
[in]	a_B	B-coefficient
[in]	a_C	C-coefficient

◆ setCoefficients() [2/2]

void MFHelmholtzRobinEBBC::setCoefficients	(	const std::function< Real(const RealVect &a_pos)> &	a_A,
		const std::function< Real(const RealVect &a_pos)> &	a_B,
		const std::function< Real(const RealVect &a_pos)> &	a_C
	)

Set variable coefficients.

Parameters

[in]	a_A	A-coefficient
[in]	a_B	B-coefficient
[in]	a_C	C-coefficient

◆ setOrder()

void MFHelmholtzRobinEBBC::setOrder ( const int a_order )

Set BC order.

Parameters

[in] a_order Order

◆ setWeight()

void MFHelmholtzRobinEBBC::setWeight ( const int a_weight )

Set equation weights for least squares reconstruction.

Parameters

[in] a_weight Weights

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

Source/Elliptic/CD_MFHelmholtzRobinEBBC.H
Source/Elliptic/CD_MFHelmholtzRobinEBBC.cpp
Source/Elliptic/CD_MFHelmholtzRobinEBBCFactory.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ applyEBFluxSinglePhase()

◆ defineSinglePhase()

◆ getInterpolationStencil()

◆ setCoefficients() [1/2]

◆ setCoefficients() [2/2]

◆ setOrder()

◆ setWeight()