Boundary condition class for passing Neumann domain boundary conditions into EBHelmholtzOp. More...

#include <CD_EBHelmholtzNeumannDomainBC.H>

Inheritance diagram for EBHelmholtzNeumannDomainBC:

Collaboration diagram for EBHelmholtzNeumannDomainBC:

Public Member Functions
	EBHelmholtzNeumannDomainBC ()
	Constructor. Must subsequently call setDphiDn or setBxDphiDn.

	EBHelmholtzNeumannDomainBC (const Real a_DphiDn)
	Constructor.

	EBHelmholtzNeumannDomainBC (const std::function< Real(const RealVect &a_pos)> &a_DphiDn)
	Full constructor.

virtual	~EBHelmholtzNeumannDomainBC ()
	Destructor.

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

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

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

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

virtual void	getFaceFlux (BaseFab< Real > &a_faceFlux, const BaseFab< Real > &a_phi, const BaseFab< Real > &a_Bcoef, const int &a_dir, const Side::LoHiSide &a_side, const DataIndex &a_dit, const bool a_useHomogeneous) const override
	Get face flux. This is for regular cells.

virtual Real	getFaceFlux (const VolIndex &a_vof, const EBCellFAB &a_phi, const EBFaceFAB &a_Bcoef, const int &a_dir, const Side::LoHiSide &a_side, const DataIndex &a_dit, const bool a_useHomogeneous) const override
	Get face flux. This is for irregular cells.

Real	getDiagWeight (const int a_dir, const Side::LoHiSide a_side) const override
	Returns 0.0: a Neumann BC prescribes the flux independently of phi, contributing nothing to the diagonal.

Public Member Functions inherited from EBHelmholtzDomainBC
	EBHelmholtzDomainBC ()
	Constructor.

virtual	~EBHelmholtzDomainBC ()
	Destructor.

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

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

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

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

virtual void	define (const Location::Cell a_dataLocation, const EBLevelGrid &a_eblg, const RealVect &a_probLo, const Real a_dx)
	Define function.

Protected Attributes
bool	m_multByBco
	Hook for multiplying 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 the domain side.

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

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

Real	m_dx
	Grid resolution.

RealVect	m_probLo
	Lower-left corner of computational domain.

EBLevelGrid	m_eblg
	Level grid.

Additional Inherited Members
Protected Member Functions inherited from EBHelmholtzDomainBC
RealVect	getBoundaryPosition (const IntVect &a_iv, const int &a_dir, const Side::LoHiSide &a_side) const
	Returns the cell-centered position at the boundary.

Static Protected Member Functions inherited from EBHelmholtzDomainBC
static void	multiplyByBcoef (BaseFab< Real > &a_flux, const BaseFab< Real > &a_bco, const int a_dir, const Side::LoHiSide a_side)
	Utility function which multiplies the flux (or actually, dphi/dn) by the B-coefficient. This is used by the implementation classes when they compute the regular flux at the domain edges/faces.

Static Protected Attributes inherited from EBHelmholtzDomainBC
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

Boundary condition class for passing Neumann domain boundary conditions into EBHelmholtzOp.

This class can set either dphi/dn or B*dphi/dn on the boundary.

Constructor & Destructor Documentation

◆ EBHelmholtzNeumannDomainBC() [1/2]

EBHelmholtzNeumannDomainBC::EBHelmholtzNeumannDomainBC ( const Real a_DphiDn )

Constructor.

Parameters

[in] a_DphiDn Constant value of dphi/dn on all domain sides.

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

◆ EBHelmholtzNeumannDomainBC() [2/2]

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

Full constructor.

Parameters

[in] a_DphiDn Spatially varying value of dphi/dn on all domain sides.

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

Member Function Documentation

◆ getDiagWeight()

Real EBHelmholtzNeumannDomainBC::getDiagWeight	(	const int	a_dir,
		const Side::LoHiSide	a_side
	)		const

overridevirtual

Returns 0.0: a Neumann BC prescribes the flux independently of phi, contributing nothing to the diagonal.

Parameters

[in]	a_dir	Coordinate direction.
[in]	a_side	High or low side.

Returns: 0.0

Implements EBHelmholtzDomainBC.

◆ getFaceFlux() [1/2]

void EBHelmholtzNeumannDomainBC::getFaceFlux	(	BaseFab< Real > &	a_faceFlux,
		const BaseFab< Real > &	a_phi,
		const BaseFab< Real > &	a_Bcoef,
		const int &	a_dir,
		const Side::LoHiSide &	a_side,
		const DataIndex &	a_dit,
		const bool	a_useHomogeneous
	)		const

overridevirtual

Get face flux. This is for regular cells.

Parameters

[in,out]	a_faceFlux	Face-centered flux.
[in]	a_phi	Cell-centered data
[in]	a_Bcoef	Face-centered B-coefficient
[in]	a_dir	Coordinate direction
[in]	a_side	High or low side
[in]	a_dit	Data index
[in]	a_useHomogeneous	Homogeneous physical BCs or not.

Note: a_faceFlux is defined in the first strip of interior cells on the (dir,side) edge of the domain.

Implements EBHelmholtzDomainBC.

◆ getFaceFlux() [2/2]

Real EBHelmholtzNeumannDomainBC::getFaceFlux	(	const VolIndex &	a_vof,
		const EBCellFAB &	a_phi,
		const EBFaceFAB &	a_Bcoef,
		const int &	a_dir,
		const Side::LoHiSide &	a_side,
		const DataIndex &	a_dit,
		const bool	a_useHomogeneous
	)		const

overridevirtual

Get face flux. This is for irregular cells.

Parameters

[in]	a_vof	Grid cell
[in]	a_phi	Cell-centered data
[in]	a_Bcoef	Face-centered B-coefficient
[in]	a_dir	Coordinate direction
[in]	a_side	High or low side
[in]	a_dit	Data index
[in]	a_useHomogeneous	Homogeneous physical BCs or not.

Returns: Face flux

Implements EBHelmholtzDomainBC.

◆ setBxDphiDn() [1/2]

void EBHelmholtzNeumannDomainBC::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 EBHelmholtzNeumannDomainBC::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 EBHelmholtzNeumannDomainBC::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 EBHelmholtzNeumannDomainBC::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_EBHelmholtzNeumannDomainBC.H
Source/Elliptic/CD_EBHelmholtzNeumannDomainBC.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EBHelmholtzNeumannDomainBC() [1/2]

◆ EBHelmholtzNeumannDomainBC() [2/2]

Member Function Documentation

◆ getDiagWeight()

◆ getFaceFlux() [1/2]

◆ getFaceFlux() [2/2]

◆ setBxDphiDn() [1/2]

◆ setBxDphiDn() [2/2]

◆ setDphiDn() [1/2]

◆ setDphiDn() [2/2]