EBHelmholtzNeumannEBBC Class Reference

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

#include <CD_EBHelmholtzNeumannEBBC.H>

Inheritance diagram for EBHelmholtzNeumannEBBC:

Collaboration diagram for EBHelmholtzNeumannEBBC:

Public Member Functions
	EBHelmholtzNeumannEBBC ()
	Default constructor.
virtual	~EBHelmholtzNeumannEBBC ()
	Destructor.
void	setDphiDn (const Real a_DphiDn)
	Set value of dphi/dn on the EB. More...
void	setDphiDn (const std::function< Real(const RealVect &a_pos)> &a_DphiDn)
	Set spatially dependent value of dphi/dn on the EB. More...
void	setBxDphiDn (const Real a_BxDphiDn)
	Set the value of B*dphi/dn on the EB. More...
void	setBxDphiDn (const std::function< Real(const RealVect &a_pos)> &a_BxDphiDn)
	Set the spatially dependent value of B*dphi/dn on the EB. More...
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. More...
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 RealVect &a_probLo, const Real &a_dx, const int a_ghostCF)
	Define function that is called by EBHelmholtzOp. More...
const LayoutData< BaseIVFAB< VoFStencil > > &	getGradPhiStencils () const
	Get the stencil for computing the finite-volume approximation to kappa*Div(F). More...

Protected Member Functions
virtual void	define () override
	User define function.
Protected Member Functions inherited from EBHelmholtzEBBC
bool	isStencilValidCF (const VoFStencil &a_stencil, const DataIndex &a_dit) const
	Check if stencil is valid. More...
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 EB.
std::function< Real(const RealVect &a_pos)>	m_functionDphiDn
	Value on the EB.
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.
LayoutData< BaseIVFAB< VoFStencil > >	m_gradPhiStencils
	Stencils for computing the flux on a single level. This is a single-level object.

Additional Inherited Members
Static Protected Attributes inherited from EBHelmholtzEBBC
constexpr static int	m_comp = 0
	Component that everything is defined for. Always have m_comp = 0.
constexpr static int	m_nComp = 1
	Number of components. Always have m_nComp = 1.

Detailed Description

Base class for passing Neumann EB boundary conditions into EBHelmholtzOp.

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

applyEBFlux()

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

setBxDphiDn() [1/2]

void EBHelmholtzNeumannEBBC::setBxDphiDn

(

const Real

a_BxDphiDn

)

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

Parameters

[in]

a_BxDphiDn

Value of B*dphi/dn.

Note

A positive values gives a flux INTO the domain.

setBxDphiDn() [2/2]

void EBHelmholtzNeumannEBBC::setBxDphiDn

(

const std::function< Real(const RealVect &a_pos)> &

a_BxDphiDn

)

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

Parameters

[in]

a_BxDphiDn

Value of B*dphi/dn.

Note

A positive values gives a flux INTO the domain.

setDphiDn() [1/2]

void EBHelmholtzNeumannEBBC::setDphiDn

(

const Real

a_DphiDn

)

Set value of dphi/dn on the EB.

Parameters

[in]

a_DphiDn

Value of dphi/dn.

Note

A positive values gives a flux INTO the domain.

setDphiDn() [2/2]

void EBHelmholtzNeumannEBBC::setDphiDn

(

const std::function< Real(const RealVect &a_pos)> &

a_DphiDn

)

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

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_EBHelmholtzNeumannEBBC.H
• Source/Elliptic/CD_EBHelmholtzNeumannEBBC.cpp