EBHelmholtzNeumannEBBCFactory Class Reference

Factory class which generates EBHelmholtzNeumannEBBC. More...

#include <CD_EBHelmholtzNeumannEBBCFactory.H>

Inheritance diagram for EBHelmholtzNeumannEBBCFactory:

Collaboration diagram for EBHelmholtzNeumannEBBCFactory:

Public Member Functions
	EBHelmholtzNeumannEBBCFactory ()
	Constructor.
	EBHelmholtzNeumannEBBCFactory (const Real a_DphiDn)
	Full constructor which sets dphi/dn on the EB.
	EBHelmholtzNeumannEBBCFactory (const std::function< Real(const RealVect &a_pos)> &a_DphiDn)
	Full constructor which sets dphi/dn on the EB.
virtual	~EBHelmholtzNeumannEBBCFactory ()
	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.
RefCountedPtr< EBHelmholtzEBBC >	create () override
	Factory method.
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 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.

Detailed Description

Factory class which generates EBHelmholtzNeumannEBBC.

Constructor & Destructor Documentation

EBHelmholtzNeumannEBBCFactory() [1/2]

EBHelmholtzNeumannEBBCFactory::EBHelmholtzNeumannEBBCFactory

(

const Real

a_DphiDn

)

Full constructor which sets dphi/dn on the EB.

Parameters

[in]

a_DphiDn

Description

EBHelmholtzNeumannEBBCFactory() [2/2]

EBHelmholtzNeumannEBBCFactory::EBHelmholtzNeumannEBBCFactory

(

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

a_DphiDn

)

Full constructor which sets dphi/dn on the EB.

Parameters

[in]

a_DphiDn

Description

Member Function Documentation

create()

RefCountedPtr< EBHelmholtzEBBC > EBHelmholtzNeumannEBBCFactory::create ( )

overridevirtual

Factory method.

Returns

Return value

Implements EBHelmholtzEBBCFactory.

setBxDphiDn() [1/2]

void EBHelmholtzNeumannEBBCFactory::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 EBHelmholtzNeumannEBBCFactory::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 EBHelmholtzNeumannEBBCFactory::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 EBHelmholtzNeumannEBBCFactory::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_EBHelmholtzNeumannEBBCFactory.H
• Source/Elliptic/CD_EBHelmholtzNeumannEBBCFactory.cpp