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

#include <CD_MFHelmholtzNeumannEBBC.H>

Inheritance diagram for MFHelmholtzNeumannEBBC:

[legend]

Collaboration diagram for MFHelmholtzNeumannEBBC:

[legend]

Public Member Functions
	MFHelmholtzNeumannEBBC (const int a_phase, const RefCountedPtr< MFHelmholtzJumpBC > &a_jumpBC)
	Full constructor.

virtual	~MFHelmholtzNeumannEBBC ()
	Destructor.

void	setDphiDn (const Real a_DphiDn)
	Set value of dphi/dn on the MF.

void	setDphiDn (const std::function< Real(const RealVect &a_pos)> &a_DphiDn)
	Set spatially dependent value of dphi/dn on the MF.

void	setBxDphiDn (const Real a_BxDphiDn)
	Set the value of B*dphi/dn on the MF.

void	setBxDphiDn (const std::function< Real(const RealVect &a_pos)> &a_BxDphiDn)
	Set the spatially dependent value of B*dphi/dn on the MF.

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.

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_multByBco
	Multiply by b-coefficient or not.

bool	m_useConstant
	Use constant for BC.

bool	m_useFunction
	Use function for BC value.

Real	m_constantDphiDn
	Value on MF.

std::function< Real(const RealVect &a_pos)>	m_functionDphiDn
	Value on the MF.

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 Neumann MF boundary conditions into MFHelmholtzOp.

This allows the user to specify dphi/dn on the boundary or B*dphi/dn, either using a constant value or with a function.

Member Function Documentation

◆ applyEBFluxSinglePhase()

void MFHelmholtzNeumannEBBC::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 MFHelmholtzNeumannEBBC::defineSinglePhase ( )

overrideprotectedvirtual

User define function.

Implements MFHelmholtzEBBC.

◆ setBxDphiDn() [1/2]

void MFHelmholtzNeumannEBBC::setBxDphiDn ( const Real a_BxDphiDn )

Set the value of B*dphi/dn on the MF.

Parameters

[in] a_BxDphiDn Value of B*dphi/dn.

Note: A positive values gives a flux INTO the domain.

◆ setBxDphiDn() [2/2]

void MFHelmholtzNeumannEBBC::setBxDphiDn ( const std::function< Real(const RealVect &a_pos)> & a_BxDphiDn )

Set the spatially dependent value of B*dphi/dn on the MF.

Parameters

[in] a_BxDphiDn Value of B*dphi/dn.

Note: A positive values gives a flux INTO the domain.

◆ setDphiDn() [1/2]

void MFHelmholtzNeumannEBBC::setDphiDn ( const Real a_DphiDn )

Set value of dphi/dn on the MF.

Parameters

[in] a_DphiDn Value of dphi/dn.

Note: A positive values gives a flux INTO the domain.

◆ setDphiDn() [2/2]

void MFHelmholtzNeumannEBBC::setDphiDn ( const std::function< Real(const RealVect &a_pos)> & a_DphiDn )

Set spatially dependent value of dphi/dn on the MF.

Parameters

[in] a_DphiDn Value of dphi/dn.

Note: A positive values gives a flux INTO the domain.

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

Source/Elliptic/CD_MFHelmholtzNeumannEBBC.H
Source/Elliptic/CD_MFHelmholtzNeumannEBBC.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ applyEBFluxSinglePhase()

◆ defineSinglePhase()

◆ setBxDphiDn() [1/2]

◆ setBxDphiDn() [2/2]

◆ setDphiDn() [1/2]

◆ setDphiDn() [2/2]