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

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

#include <CD_MFHelmholtzSaturationChargeJumpBCFactory.H>

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

Public Types

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

Public Member Functions

 MFHelmholtzSaturationChargeJumpBCFactory (const phase::which_phase a_phase)
 Full constructor. More...
 
virtual ~MFHelmholtzSaturationChargeJumpBCFactory ()
 Default constructor.
 
virtual RefCountedPtr< MFHelmholtzJumpBCcreate (const Location::Cell a_dataLocation, const MFLevelGrid &a_mflg, const BcoefPtr &a_Bcoef, 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. More...
 
- 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.
 

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.
 

Detailed Description

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

Constructor & Destructor Documentation

◆ MFHelmholtzSaturationChargeJumpBCFactory()

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

Full constructor.

Parameters
[in]a_phaseWhich phase the saturation charge BC is applied on.

Member Function Documentation

◆ create()

RefCountedPtr< MFHelmholtzJumpBC > MFHelmholtzSaturationChargeJumpBCFactory::create ( const Location::Cell  a_dataLocation,
const MFLevelGrid a_mflg,
const BcoefPtr a_Bcoef,
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_dataLocationData centering
[in]a_mflgGrids
[in]a_BcoefHelmholtz B-coefficient
[in]a_dxGrid resolution
[in]a_orderStencil approximation order
[in]a_weightWeighting factor for least squares
[in]a_radiusStencil radius
[in]a_ghostCFNumber of grid cells that were filled across the CF.
[in]a_ghostPhiNumber of ghost cells in phi
Returns
Returns an MFHelmholtzJumpBC for encapsulating boundary conditions on multiphase cells.

Reimplemented from MFHelmholtzJumpBCFactory.


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