Factory class for making saturation charge jump boundary condition objects in multifluid Helmholtz context. More...

Inheritance diagram for MFHelmholtzSaturationChargeJumpBCFactory:

Collaboration diagram for MFHelmholtzSaturationChargeJumpBCFactory:

Public Types
using	BcoefPtr = RefCountedPtr< LevelData< MFBaseIVFAB > >
	Alias to cut down on typing.

using	AmrMask = RefCountedPtr< LevelData< BaseFab< bool > > >
	Alias to cut down on typing.

Public Types inherited from MFHelmholtzJumpBCFactory
using	BcoefPtr = RefCountedPtr< LevelData< MFBaseIVFAB > >
	Alias to cut down on typing.

using	AmrMask = RefCountedPtr< LevelData< BaseFab< bool > > >
	Alias to cut down on typing.

Public Member Functions
	MFHelmholtzSaturationChargeJumpBCFactory (const phase::which_phase a_phase)
	Full constructor.

virtual	~MFHelmholtzSaturationChargeJumpBCFactory ()
	Default constructor.

virtual RefCountedPtr< MFHelmholtzJumpBC >	create (const Location::Cell a_dataLocation, const MFLevelGrid &a_mflg, const BcoefPtr &a_Bcoef, const AmrMask &a_validCells, const Real a_dx, const int a_order, const int a_weight, const int a_radius, const int a_ghostCF, const IntVect a_ghostPhi) override
	Factory method for creating MFHelmholtzSaturationChargeJumpBC objects.

Public Member Functions inherited from MFHelmholtzJumpBCFactory
	MFHelmholtzJumpBCFactory ()
	Weak constructor.

virtual	~MFHelmholtzJumpBCFactory ()
	Default constructor.

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)
	Drop to a first-order approximation if the cut-cell is a coarsened cell.

Protected Attributes
phase::which_phase	m_phase
	Which phase the saturation BC is applied on.

Protected Attributes inherited from MFHelmholtzJumpBCFactory
int	m_domainDropOrder
	Special flag for dropping stencil order when domains become coarser than this.

bool	m_dropOrder
	Special flag for signalling MFHelmholtzJumpBC that it should drop the stencil order to 1 if the cut-cell is a coarsened cell.

Detailed Description

Factory class for making saturation charge jump boundary condition objects in multifluid Helmholtz context.

Constructor & Destructor Documentation

MFHelmholtzSaturationChargeJumpBCFactory::MFHelmholtzSaturationChargeJumpBCFactory ( const phase::which_phase a_phase )

Full constructor.

Parameters

[in] a_phase Which phase the saturation charge BC is applied on.

RefCountedPtr< MFHelmholtzJumpBC > MFHelmholtzSaturationChargeJumpBCFactory::create	(	const Location::Cell	a_dataLocation,
		const MFLevelGrid &	a_mflg,
		const BcoefPtr &	a_Bcoef,
		const AmrMask &	a_validCells,
		const Real	a_dx,
		const int	a_order,
		const int	a_weight,
		const int	a_radius,
		const int	a_ghostCF,
		const IntVect	a_ghostPhi
	)

overridevirtual

Factory method for creating MFHelmholtzSaturationChargeJumpBC objects.

Parameters

[in]	a_dataLocation	Data centering
[in]	a_mflg	Grids
[in]	a_Bcoef	Helmholtz B-coefficient
[in]	a_validCells	Valid grid cells (might be null pointer)
[in]	a_dx	Grid resolution
[in]	a_order	Stencil approximation order
[in]	a_weight	Weighting factor for least squares
[in]	a_radius	Stencil radius
[in]	a_ghostCF	Number of grid cells that were filled across the CF.
[in]	a_ghostPhi	Number of ghost cells in phi

Returns: Returns an MFHelmholtzJumpBC for encapsulating boundary conditions on multiphase cells.

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