EBHelmholtzElectrostaticDomainBC Class Reference

Class for passing electrostatic domain boundary conditions into EBHelmholtzOp. More...

#include <CD_EBHelmholtzElectrostaticDomainBC.H>

Inheritance diagram for EBHelmholtzElectrostaticDomainBC:

Collaboration diagram for EBHelmholtzElectrostaticDomainBC:

Public Member Functions
	EBHelmholtzElectrostaticDomainBC ()=delete
	Not allowed, use the full constructor.
	EBHelmholtzElectrostaticDomainBC (const ElectrostaticDomainBc &a_electrostaticBCs)
	Full constructor.
	EBHelmholtzElectrostaticDomainBC (const EBHelmholtzElectrostaticDomainBC &a_other)=delete
	Disallowed – don't see why you would need it.
	EBHelmholtzElectrostaticDomainBC (const EBHelmholtzElectrostaticDomainBC &&a_other)=delete
	Disallowed – don't see why you would need it.
	~EBHelmholtzElectrostaticDomainBC ()
	Destructor.
EBHelmholtzElectrostaticDomainBC &	operator= (const EBHelmholtzElectrostaticDomainBC &a_other)=delete
	Disallowed - don't see why you would need it.
EBHelmholtzElectrostaticDomainBC &	operator= (const EBHelmholtzElectrostaticDomainBC &&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) override final
	Define function.
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 final
	Get face flux. This is for regular cells.
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 final
	Get face flux. This is for irregular cells.
Real	getDiagWeight (const int a_dir, const Side::LoHiSide a_side) const override
	Routes getDiagWeight to the per-face BC sub-object.
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.

Protected Attributes
ElectrostaticDomainBc	m_electrostaticBCs
	Electrostatic domain boundary conditions.
std::map< ElectrostaticDomainBc::DomainSide, std::shared_ptr< EBHelmholtzDomainBC > >	m_bcObjects
	BC objects on each 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

Class for passing electrostatic domain boundary conditions into EBHelmholtzOp.

This class is a wrapper for Dirichlet/Neumann boundary conditions where the values/functions are passed in through ElectrostaticDomainBc. This class will simply instantiate one such BC object for each edge/face in the computational domain, and call the appropriate BC function when EBHelmholtzOp asks for it.

Note

For this class to operate correctly with time-dependent boundary conditions, the user must ensure that the time dependence is captured by reference. FieldSolverGMG already does this, by taking the user's boundary condition function and replacing the time-argument by a reference to FieldSolver::m_time.

Constructor & Destructor Documentation

EBHelmholtzElectrostaticDomainBC() [1/3]

EBHelmholtzElectrostaticDomainBC::EBHelmholtzElectrostaticDomainBC

(

const ElectrostaticDomainBc &

a_electrostaticBCs

)

Full constructor.

Parameters

[in]

a_electrostaticBCs

Electrostatic domain boundary condition functions (in time and space)

EBHelmholtzElectrostaticDomainBC() [2/3]

EBHelmholtzElectrostaticDomainBC::EBHelmholtzElectrostaticDomainBC ( const EBHelmholtzElectrostaticDomainBC &  a_other )

delete

Disallowed – don't see why you would need it.

Parameters

[in]

a_other

Other operator

EBHelmholtzElectrostaticDomainBC() [3/3]

EBHelmholtzElectrostaticDomainBC::EBHelmholtzElectrostaticDomainBC ( const EBHelmholtzElectrostaticDomainBC &&  a_other )

delete

Disallowed – don't see why you would need it.

Parameters

[in]

a_other

Other operator

Member Function Documentation

define()

void EBHelmholtzElectrostaticDomainBC::define ( const Location::Cell  a_dataLocation, const EBLevelGrid &  a_eblg, const RealVect &  a_probLo, const Real  a_dx  )

finaloverridevirtual

Define function.

Parameters

[in]	a_dataLocation	Data location (either Location::Cell::Center or Location::Cell::Centroid).
[in]	a_eblg	Level grids
[in]	a_probLo	Lower-left corner of computational domain
[in]	a_dx	Grid resolution

Note

This overrides EBHelmholtzDomainBC because EBHelmholtzElectrostaticDomainBC is just a wrapper class for Dirichlet/Neumann, and those objects need defining.

Reimplemented from EBHelmholtzDomainBC.

getDiagWeight()

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

overridevirtual

Routes getDiagWeight to the per-face BC sub-object.

Parameters

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

Returns

Diagonal weight multiplier for the face.

Implements EBHelmholtzDomainBC.

getFaceFlux() [1/2]

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

finaloverridevirtual

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 EBHelmholtzElectrostaticDomainBC::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

finaloverridevirtual

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.

operator=() [1/2]

EBHelmholtzElectrostaticDomainBC & EBHelmholtzElectrostaticDomainBC::operator= ( const EBHelmholtzElectrostaticDomainBC &&  a_other )

delete

Disallowed - don't see why you would need it.

Parameters

[in]

a_other

Other operator

operator=() [2/2]

EBHelmholtzElectrostaticDomainBC & EBHelmholtzElectrostaticDomainBC::operator= ( const EBHelmholtzElectrostaticDomainBC &  a_other )

delete

Disallowed - don't see why you would need it.

Parameters

[in]

a_other

Other operator

Member Data Documentation

m_bcObjects

std::map<ElectrostaticDomainBc::DomainSide, std::shared_ptr<EBHelmholtzDomainBC> > EBHelmholtzElectrostaticDomainBC::m_bcObjects

protected

BC objects on each domain side.

These are instantiated in the constructor where we construct Neumann/Dirichlet on each domain side.

---

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

• Source/Electrostatics/CD_EBHelmholtzElectrostaticDomainBC.H
• Source/Electrostatics/CD_EBHelmholtzElectrostaticDomainBC.cpp