EBHelmholtzNeumannDomainBCFactory Class Reference

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

#include <CD_EBHelmholtzNeumannDomainBCFactory.H>

Inheritance diagram for EBHelmholtzNeumannDomainBCFactory:

Collaboration diagram for EBHelmholtzNeumannDomainBCFactory:

Public Member Functions
	EBHelmholtzNeumannDomainBCFactory ()
	Constructor.
	EBHelmholtzNeumannDomainBCFactory (const Real a_DphiDn)
	Constructor.
	EBHelmholtzNeumannDomainBCFactory (const std::function< Real(const RealVect &a_pos)> &a_DphiDn)
	Full constructor.
virtual	~EBHelmholtzNeumannDomainBCFactory ()
	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 RefCountedPtr< EBHelmholtzDomainBC >	create () const override
	Factory method.
Public Member Functions inherited from EBHelmholtzDomainBCFactory
	EBHelmholtzDomainBCFactory ()
	Constructor.
virtual	~EBHelmholtzDomainBCFactory ()
	Destructor.
	EBHelmholtzDomainBCFactory (const EBHelmholtzDomainBCFactory &a_other)=delete
	Disallowed – don't see why you would need it.
EBHelmholtzDomainBCFactory &	operator= (const EBHelmholtzDomainBCFactory &a_other)=delete
	Disallowed - don't see why you would need it.

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
	Constant values on domain sides.
std::function< Real(const RealVect &a_pos)>	m_functionDphiDn
	Spatially dependent value on the domain sides.

Detailed Description

Class for passing Neumann boundary domain boundary conditions into EBHelmholtzOp.

Constructor & Destructor Documentation

EBHelmholtzNeumannDomainBCFactory() [1/2]

EBHelmholtzNeumannDomainBCFactory::EBHelmholtzNeumannDomainBCFactory

(

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.

EBHelmholtzNeumannDomainBCFactory() [2/2]

EBHelmholtzNeumannDomainBCFactory::EBHelmholtzNeumannDomainBCFactory

(

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

a_DphiDn

)

Full constructor.

Parameters

[in]

a_DphiDn

Spatially dependent value of dphi/dn on all domain sides.

Note

A positive values gives a flux INTO the domain.

Member Function Documentation

create()

RefCountedPtr< EBHelmholtzDomainBC > EBHelmholtzNeumannDomainBCFactory::create ( ) const

overridevirtual

Factory method.

Returns

Return value

Implements EBHelmholtzDomainBCFactory.

setBxDphiDn() [1/2]

void EBHelmholtzNeumannDomainBCFactory::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 EBHelmholtzNeumannDomainBCFactory::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 EBHelmholtzNeumannDomainBCFactory::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 EBHelmholtzNeumannDomainBCFactory::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_EBHelmholtzNeumannDomainBCFactory.H
• Source/Elliptic/CD_EBHelmholtzNeumannDomainBCFactory.cpp