Class for making boundary conditions on the EB in a multifluid context. More...

#include <CD_MFHelmholtzEBBC.H>

Inheritance diagram for MFHelmholtzEBBC:

[legend]

Collaboration diagram for MFHelmholtzEBBC:

Public Member Functions
	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
void	define () override final
	User define function.

void	defineMultiPhase ()
	Define stuff for multi-phase.

virtual void	defineSinglePhase ()=0
	Define stuff for multi-phase.

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 =0
	Apply flux single 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
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

Class for making boundary conditions on the EB in a multifluid context.

This class is almost like EBHelmholtzEBBC, except that it enforces matching on multiphase cells. The user can inherit from this layer if he needs additional BCs in a multiphase context.

Constructor & Destructor Documentation

◆ MFHelmholtzEBBC()

MFHelmholtzEBBC::MFHelmholtzEBBC	(	const int	a_phase,
		const RefCountedPtr< MFHelmholtzJumpBC > &	a_jumpBC
	)

Full constructor.

Parameters

[in]	a_phase	Description
[in,out]	a_jumpBC	Description

Member Function Documentation

◆ applyEBFlux()

void MFHelmholtzEBBC::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

overridevirtual

Apply the EB flux. This is the version that is called by EBHelmholtzOp.

Users get a new interface to the subset of cells that are not multi-phase cells.

Parameters

[in,out]	a_vofit	Iterator for cut-cells
[in]	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 EBHelmholtzEBBC.

◆ applyEBFluxMultiPhase()

void MFHelmholtzEBBC::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

protected

Apply flux in multiphase cells.

Parameters

[in,out]	a_multiPhaseVofs	Iterator for multi-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.

◆ applyEBFluxSinglePhase()

virtual void MFHelmholtzEBBC::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

protectedpure virtual

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.

Implemented in MFHelmholtzElectrostaticEBBC, MFHelmholtzDirichletEBBC, MFHelmholtzNeumannEBBC, and MFHelmholtzRobinEBBC.

◆ define()

void MFHelmholtzEBBC::define ( )

finaloverrideprotectedvirtual

User define function.

Implements EBHelmholtzEBBC.

◆ defineSinglePhase()

virtual void MFHelmholtzEBBC::defineSinglePhase ( )

protectedpure virtual

Define stuff for multi-phase.

Implemented in MFHelmholtzElectrostaticEBBC, MFHelmholtzDirichletEBBC, MFHelmholtzNeumannEBBC, and MFHelmholtzRobinEBBC.

◆ getLeastSquaresBoundaryGradStencil()

bool MFHelmholtzEBBC::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

protectedvirtual

Get stencil with specified order.

Parameters

[out]	a_stencil	Weight and stencil
[out]	a_vof	Grid cell
[out]	a_neighborhood	Neighborhood specifier
[in]	a_dit	Data index
[in]	a_order	Attempted order for stencil. This is also the stencil radius.
[in]	a_weight	Weighting factor for weighted least squares

Returns: If this returns true, a_stencil contains a valid stencil and weight.

Note: Stencils are computed using weighted least squares with squared inverse distance weighting.

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

Source/Elliptic/CD_MFHelmholtzEBBC.H
Source/Elliptic/CD_MFHelmholtzEBBC.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MFHelmholtzEBBC()

Member Function Documentation

◆ applyEBFlux()

◆ applyEBFluxMultiPhase()

◆ applyEBFluxSinglePhase()

◆ define()

◆ defineSinglePhase()

◆ getLeastSquaresBoundaryGradStencil()