Base class for passing Robin EB boundary conditions into EBHelmholtzOp. More...

#include <CD_EBHelmholtzRobinEBBC.H>

Inheritance diagram for EBHelmholtzRobinEBBC:

Collaboration diagram for EBHelmholtzRobinEBBC:

Public Member Functions
	EBHelmholtzRobinEBBC ()
	Default constructor. Must subsequently set coefficients.

	EBHelmholtzRobinEBBC (const int a_order, const int a_weight, const Real a_A, const Real a_B, const Real a_C)
	Full constructor which sets constant coefficients.

	EBHelmholtzRobinEBBC (const int a_order, const int a_weight, 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)
	Full constructor which sets variable coefficients.

virtual	~EBHelmholtzRobinEBBC ()
	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.

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	define () override
	User define function.

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 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
	Use constant for BC.

bool	m_useFunction
	Use function for BC value.

int	m_order
	Stencil order.

int	m_weight
	Stencil weight (for weighting equations in least squares reconstruction)

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 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 EB boundary conditions into EBHelmholtzOp.

Robin bcs are in the form A*phi + B*dphi/dn = C. We impose dphi/dn = (C - A*phi)/B where phi is extrapolated to the EB to first order.

Note: The B-coefficient is not the same as in the Helmholtz equation...; In our notation, n points into the computational domain.

Constructor & Destructor Documentation

◆ EBHelmholtzRobinEBBC() [1/2]

EBHelmholtzRobinEBBC::EBHelmholtzRobinEBBC	(	const int	a_order,
		const int	a_weight,
		const Real	a_A,
		const Real	a_B,
		const Real	a_C
	)

Full constructor which sets constant coefficients.

Parameters

[in]	a_order	Stencil order. Must be > 0
[in]	a_weight	Equation weights. Must be >=0
[in]	a_A	Robin A-coefficient
[in]	a_B	Robin B-coefficient
[in]	a_C	Robin C-coefficient

◆ EBHelmholtzRobinEBBC() [2/2]

EBHelmholtzRobinEBBC::EBHelmholtzRobinEBBC	(	const int	a_order,
		const int	a_weight,
		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
	)

Full constructor which sets variable coefficients.

Parameters

[in]	a_order	Stencil order. Must be > 0
[in]	a_weight	Equation weights. Must be >=0
[in]	a_A	Robin A-coefficient
[in]	a_B	Robin B-coefficient
[in]	a_C	Robin C-coefficient

Member Function Documentation

◆ applyEBFlux()

void EBHelmholtzRobinEBBC::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.

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.

◆ define()

void EBHelmholtzRobinEBBC::define ( )

overrideprotectedvirtual

User define function.

Implements EBHelmholtzEBBC.

◆ getInterpolationStencil()

VoFStencil EBHelmholtzRobinEBBC::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.

Returns: Interpolation stencil

◆ setCoefficients() [1/2]

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

Set constant coefficients.

Parameters

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

◆ setCoefficients() [2/2]

void EBHelmholtzRobinEBBC::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	Spatially dependent A-coefficient
[in]	a_B	Spatially dependent B-coefficient
[in]	a_C	Spatially dependent C-coefficient

◆ setDomainDropOrder()

void EBHelmholtzRobinEBBC::setDomainDropOrder ( const int a_domainSize )

virtual

Drop BC order if domain size is equal or below this.

Parameters

[in] a_domainSize Description

◆ setOrder()

void EBHelmholtzRobinEBBC::setOrder ( const int a_order )

Set BC order.

Parameters

[in] a_order Order

◆ setWeight()

void EBHelmholtzRobinEBBC::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_EBHelmholtzRobinEBBC.H
Source/Elliptic/CD_EBHelmholtzRobinEBBC.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EBHelmholtzRobinEBBC() [1/2]

◆ EBHelmholtzRobinEBBC() [2/2]

Member Function Documentation

◆ applyEBFlux()

◆ define()

◆ getInterpolationStencil()

◆ setCoefficients() [1/2]

◆ setCoefficients() [2/2]

◆ setDomainDropOrder()

◆ setOrder()

◆ setWeight()