chombo-discharge
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
MFHelmholtzDirichletDomainBCFactory Class Reference

Factory class for passing Dirichlet domain boundary conditions into MFHelmholtzOp. More...

#include <CD_MFHelmholtzDirichletDomainBCFactory.H>

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

Public Member Functions

 MFHelmholtzDirichletDomainBCFactory ()
 Constructor.
 
 MFHelmholtzDirichletDomainBCFactory (const Real a_value)
 Constructor.
 
 MFHelmholtzDirichletDomainBCFactory (const std::function< Real(const RealVect &a_pos)> &a_value)
 Full constructor.
 
virtual ~MFHelmholtzDirichletDomainBCFactory ()
 Destructor.
 
void setValue (const Real a_value)
 Set the constant value on the domain side.
 
void setValue (const std::function< Real(const RealVect &a_pos)> &a_value)
 Set the spatially dependent value on the domain side.
 
virtual RefCountedPtr< EBHelmholtzDomainBCcreate (const int a_iphase) const override
 Factory method.
 
- Public Member Functions inherited from MFHelmholtzDomainBCFactory
 MFHelmholtzDomainBCFactory ()
 Constructor.
 
virtual ~MFHelmholtzDomainBCFactory ()
 Destructor.
 
 MFHelmholtzDomainBCFactory (const MFHelmholtzDomainBCFactory &a_other)=delete
 Disallowed – don't see why you would need it.
 
MFHelmholtzDomainBCFactoryoperator= (const MFHelmholtzDomainBCFactory &a_other)=delete
 Disallowed - don't see why you would need it.
 

Protected Attributes

bool m_useConstant
 Use constant for BC.
 
bool m_useFunction
 Use function for BC value.
 
Real m_constantValue
 Value on EB.
 
std::function< Real(const RealVect &a_pos)> m_functionValue
 Value on the EB.
 

Detailed Description

Factory class for passing Dirichlet domain boundary conditions into MFHelmholtzOp.

Constructor & Destructor Documentation

◆ MFHelmholtzDirichletDomainBCFactory() [1/2]

MFHelmholtzDirichletDomainBCFactory::MFHelmholtzDirichletDomainBCFactory ( const Real  a_value)

Constructor.

Parameters
[in]a_valueConstant value on domain side

◆ MFHelmholtzDirichletDomainBCFactory() [2/2]

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

Full constructor.

Parameters
[in]a_valueSpatially dependent value on domain side

Member Function Documentation

◆ create()

RefCountedPtr< EBHelmholtzDomainBC > MFHelmholtzDirichletDomainBCFactory::create ( const int  a_iphase) const
overridevirtual

Factory method.

Implements MFHelmholtzDomainBCFactory.

◆ setValue() [1/2]

void MFHelmholtzDirichletDomainBCFactory::setValue ( const Real  a_value)

Set the constant value on the domain side.

Parameters
[in]a_valueConstant value on all domain sides.

◆ setValue() [2/2]

void MFHelmholtzDirichletDomainBCFactory::setValue ( const std::function< Real(const RealVect &a_pos)> &  a_value)

Set the spatially dependent value on the domain side.

Parameters
[in]a_valueSpatially dependent value on all domain sides.

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