chombo-discharge
Public Member Functions | Protected Attributes | List of all members
EBHelmholtzNeumannEBBCFactory Class Reference

Factory class which generates EBHelmholtzNeumannEBBC. More...

#include <CD_EBHelmholtzNeumannEBBCFactory.H>

Inheritance diagram for EBHelmholtzNeumannEBBCFactory:
Inheritance graph
[legend]
Collaboration diagram for EBHelmholtzNeumannEBBCFactory:
Collaboration graph
[legend]

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. More...
 
void setDphiDn (const std::function< Real(const RealVect &a_pos)> &a_DphiDn)
 Set spatially dependent value of dphi/dn on the EB. More...
 
void setBxDphiDn (const Real a_BxDphiDn)
 Set the value of B*dphi/dn on the EB. More...
 
void setBxDphiDn (const std::function< Real(const RealVect &a_pos)> &a_BxDphiDn)
 Set the spatially dependent value of B*dphi/dn on the EB. More...
 
RefCountedPtr< EBHelmholtzEBBCcreate () 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.
 
EBHelmholtzEBBCFactoryoperator= (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.

Member Function Documentation

◆ setBxDphiDn() [1/2]

void EBHelmholtzNeumannEBBCFactory::setBxDphiDn ( const Real  a_BxDphiDn)

Set the value of B*dphi/dn on the EB.

Parameters
[in]a_BxDphiDnValue 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_BxDphiDnValue 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_DphiDnValue 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_DphiDnValue of dphi/dn.
Note
A positive values gives a flux INTO the domain.

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