MFHelmholtzDirichletEBBCFactory Class Reference

Class for making Dirichlet boundary conditions on the EB in a multifluid context. More...

#include <CD_MFHelmholtzDirichletEBBCFactory.H>

Inheritance diagram for MFHelmholtzDirichletEBBCFactory:

Collaboration diagram for MFHelmholtzDirichletEBBCFactory:

Public Member Functions
	MFHelmholtzDirichletEBBCFactory ()=delete
	Weak constructor. Must subsequently set order, weight, and value.
	MFHelmholtzDirichletEBBCFactory (const int a_order, const int a_weight, const Real a_value)
	Full constructor which sets order and value on EB.
	MFHelmholtzDirichletEBBCFactory (const int a_order, const int a_weight, const std::function< Real(const RealVect &a_pos)> &a_value)
	Full constructor which sets order and spatially varying value on EBs.
	~MFHelmholtzDirichletEBBCFactory ()
	Default constructor.
virtual void	setValue (const Real a_value)
	Set the value on the EB.
virtual void	setValue (const std::function< Real(const RealVect &a_pos)> &a_value)
	Set the spatially varying value on the EB.
virtual void	setDomainDropOrder (const int a_domainSize)
	Drop BC order if domain size is equal or below this.
virtual void	setCoarseGridDropOrder (const bool a_dropOrder)
	Signal that it should drop the stencil order if the cell is a coarsened cell.
RefCountedPtr< EBHelmholtzEBBC >	create (const int a_iphase, const RefCountedPtr< MFHelmholtzJumpBC > &a_jumpBC) const override
	Factory method.
Public Member Functions inherited from MFHelmholtzEBBCFactory
	MFHelmholtzEBBCFactory ()
	Weak constructor. Must subsequently set order, weight, and value.
virtual	~MFHelmholtzEBBCFactory ()
	Default constructor.

Protected Attributes
bool	m_useConstant
	Use constant for BC.
bool	m_useFunction
	Use function for BC value.
Real	m_constantValue
	Value on EB.
int	m_order
	Stencil order.
int	m_weight
	Stencil weight (for weighted least squares)
int	m_domainDropOrder
	Special flag for dropping stencil order when domains become coarser than this.
bool	m_dropOrder
	Special flag for dropping stencil order if the cell is a coarsened cell.
std::function< Real(const RealVect &a_pos)>	m_functionValue
	Value on the EB.

Detailed Description

Class for making Dirichlet boundary conditions on the EB in a multifluid context.

Constructor & Destructor Documentation

MFHelmholtzDirichletEBBCFactory() [1/2]

MFHelmholtzDirichletEBBCFactory::MFHelmholtzDirichletEBBCFactory	(	const int	a_order,
		const int	a_weight,
		const Real	a_value
	)

Full constructor which sets order and value on EB.

Parameters

[in]	a_order	Approximation order
[in]	a_weight	Weighting factor for stencils
[in]	a_value	Constant value on EB

Note

The order is also the attempted radius of the stencil.

MFHelmholtzDirichletEBBCFactory() [2/2]

MFHelmholtzDirichletEBBCFactory::MFHelmholtzDirichletEBBCFactory	(	const int	a_order,
		const int	a_weight,
		const std::function< Real(const RealVect &a_pos)> &	a_value
	)

Full constructor which sets order and spatially varying value on EBs.

Parameters

[in]	a_order	Approximation order
[in]	a_value	Spatially varying value on EBs
[in]	a_weight	Description

Member Function Documentation

create()

RefCountedPtr< EBHelmholtzEBBC > MFHelmholtzDirichletEBBCFactory::create ( const int  a_iphase, const RefCountedPtr< MFHelmholtzJumpBC > &  a_jumpBC  ) const

overridevirtual

Factory method.

Parameters

[in]

a_jumpBC

Jump bc object.

Returns

Return value

Parameters

[in]

a_iphase

Description

Implements MFHelmholtzEBBCFactory.

setCoarseGridDropOrder()

void MFHelmholtzDirichletEBBCFactory::setCoarseGridDropOrder ( const bool  a_dropOrder )

virtual

Signal that it should drop the stencil order if the cell is a coarsened cell.

Parameters

[in]

a_dropOrder

setDomainDropOrder()

void MFHelmholtzDirichletEBBCFactory::setDomainDropOrder ( const int  a_domainSize )

virtual

Drop BC order if domain size is equal or below this.

Parameters

[in]

a_domainSize

Description

setValue() [1/2]

void MFHelmholtzDirichletEBBCFactory::setValue ( const Real  a_value )

virtual

Set the value on the EB.

Parameters

[in]

a_value

Constant value on EB

setValue() [2/2]

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

virtual

Set the spatially varying value on the EB.

Parameters

[in]

a_value

Spatially dependent value on EB

---

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

• Source/Elliptic/CD_MFHelmholtzDirichletEBBCFactory.H
• Source/Elliptic/CD_MFHelmholtzDirichletEBBCFactory.cpp