EBHelmholtzLarsenEBBCFactory Class Reference

Class for making Larsen boundary conditions. More...

#include <CD_EBHelmholtzLarsenEBBCFactory.H>

Inheritance diagram for EBHelmholtzLarsenEBBCFactory:

Collaboration diagram for EBHelmholtzLarsenEBBCFactory:

Public Member Functions
	EBHelmholtzLarsenEBBCFactory ()=delete
	Disallowed weak constructor.
	EBHelmholtzLarsenEBBCFactory (const int a_order, const int a_weight, const RefCountedPtr< RtSpecies > &a_species, const Real a_r1, const Real a_r2, const Real a_source)
	Constructor. Source term is set to zero. More...
	EBHelmholtzLarsenEBBCFactory (const EBHelmholtzLarsenEBBCFactory &a_other)=delete
	No copy construction.
	EBHelmholtzLarsenEBBCFactory (const EBHelmholtzLarsenEBBCFactory &&a_other)=delete
	No move construction.
virtual	~EBHelmholtzLarsenEBBCFactory ()
	Default constructor.
EBHelmholtzLarsenEBBCFactory &	operator= (const EBHelmholtzLarsenEBBCFactory &a_other)=delete
	No copy assignment.
EBHelmholtzLarsenEBBCFactory &	operator= (const EBHelmholtzLarsenEBBCFactory &&a_other)=delete
	No move assignment.
Public Member Functions inherited from EBHelmholtzRobinEBBCFactory
	EBHelmholtzRobinEBBCFactory ()
	Constructor.
	EBHelmholtzRobinEBBCFactory (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. More...
	EBHelmholtzRobinEBBCFactory (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. More...
virtual	~EBHelmholtzRobinEBBCFactory ()
	Destructor (does nothing).
void	setOrder (const int a_order)
	Set BC order. More...
void	setWeight (const int a_weight)
	Set equation weights for least squares reconstruction. More...
void	setCoefficients (const Real a_A, const Real a_B, const Real a_C)
	Set constant coefficients. More...
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. More...
virtual void	setDomainDropOrder (const int a_domainSize)
	Drop BC order if domain size is equal or below this.
RefCountedPtr< EBHelmholtzEBBC >	create () override
	Factory method. More...
Public Member Functions inherited from EBHelmholtzEBBCFactory
	EBHelmholtzEBBCFactory ()
	Constructor.
virtual	~EBHelmholtzEBBCFactory ()
	Destructor.
	EBHelmholtzEBBCFactory (const EBHelmholtzEBBCFactory &a_other)=delete
	Disallowed – don't see why you would need it.
EBHelmholtzEBBCFactory &	operator= (const EBHelmholtzEBBCFactory &a_other)=delete
	Disallowed - don't see why you would need it.

Protected Member Functions
void	setRobinCoefficients ()
	Set Robin coefficients.

Protected Attributes
RefCountedPtr< RtSpecies >	m_species
	Radiative transfer species.
Real	m_r1
	"First reflection coefficient"
Real	m_r2
	"Second reflection coefficient"
Real	m_source
	Source term.
Protected Attributes inherited from EBHelmholtzRobinEBBCFactory
bool	m_useConstant
bool	m_useFunction
	Use function for BC value.
int	m_order
	(Attempted) stencil order
int	m_weight
	Weight for least squares gradient 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.

Detailed Description

Class for making Larsen boundary conditions.

Constructor & Destructor Documentation

EBHelmholtzLarsenEBBCFactory()

EBHelmholtzLarsenEBBCFactory::EBHelmholtzLarsenEBBCFactory	(	const int	a_order,
		const int	a_weight,
		const RefCountedPtr< RtSpecies > &	a_species,
		const Real	a_r1,
		const Real	a_r2,
		const Real	a_source
	)

Constructor. Source term is set to zero.

Parameters

[in]	a_order	Stencil order
[in]	a_weight	Equation weights (in least squares)
[in]	a_species	Radiative transfer species
[in]	a_r1	"First reflection coefficient"
[in]	a_r2	"Second reflection coefficient"
[in]	a_source	"Source term

Larsen coefficients (in Robin format) are set based on kappa and reflection coefficients.

---

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

• Source/RadiativeTransfer/CD_EBHelmholtzLarsenEBBCFactory.H
• Source/RadiativeTransfer/CD_EBHelmholtzLarsenEBBCFactory.cpp