twoPhases Class Referenceabstract

Interface to two phases. More...

Inheritance diagram for twoPhases:

Public Member Functions

 TypeName ("twoPhases")
 Runtime type information. More...
 
 twoPhases ()
 Default construct. More...
 
virtual ~twoPhases ()
 Destructor. More...
 
const fvMeshmesh () const
 Access the mesh. More...
 
bool index (const word &name) const
 Return the index associated with a given phase name. More...
 
virtual const volScalarFieldalpha1 () const =0
 Return the volume-fraction of phase 1. More...
 
virtual const volScalarFieldalpha2 () const =0
 Return the volume-fraction of phase 2. More...
 
const volScalarFieldalpha (const bool index) const
 Return the volume-fraction of a given phase. More...
 

Detailed Description

Interface to two phases.

Source files

Definition at line 48 of file twoPhases.H.

Constructor & Destructor Documentation

◆ twoPhases()

twoPhases ( )
inline

Default construct.

Definition at line 59 of file twoPhases.H.

◆ ~twoPhases()

virtual ~twoPhases ( )
inlinevirtual

Destructor.

Definition at line 64 of file twoPhases.H.

Member Function Documentation

◆ TypeName()

TypeName ( "twoPhases"  )

Runtime type information.

◆ mesh()

const fvMesh& mesh ( ) const
inline

Access the mesh.

Definition at line 71 of file twoPhases.H.

References twoPhases::alpha1(), and DimensionedField< Type, GeoMesh >::mesh().

Referenced by compressibleTwoPhaseVoFMixture::compressibleTwoPhaseVoFMixture().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ index()

bool index ( const word name) const
inline

Return the index associated with a given phase name.

Definition at line 77 of file twoPhases.H.

References twoPhases::alpha1(), twoPhases::alpha2(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, IOobject::group(), Foam::constant::atomic::group, and Foam::name().

Referenced by twoPhases::alpha(), compressibleTwoPhases::rho(), incompressibleTwoPhases::rho(), and compressibleTwoPhases::thermo().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ alpha1()

virtual const volScalarField& alpha1 ( ) const
pure virtual

Return the volume-fraction of phase 1.

Implemented in twoPhaseMixture, and phaseInterface.

Referenced by twoPhases::alpha(), twoPhases::index(), and twoPhases::mesh().

Here is the caller graph for this function:

◆ alpha2()

virtual const volScalarField& alpha2 ( ) const
pure virtual

Return the volume-fraction of phase 2.

Implemented in twoPhaseMixture, and phaseInterface.

Referenced by twoPhases::alpha(), and twoPhases::index().

Here is the caller graph for this function:

◆ alpha()

const volScalarField& alpha ( const bool  index) const
inline

Return the volume-fraction of a given phase.

Definition at line 103 of file twoPhases.H.

References twoPhases::alpha1(), twoPhases::alpha2(), and twoPhases::index().

Referenced by cavitationModel::alphal(), and cavitationModel::alphav().

Here is the call graph for this function:
Here is the caller graph for this function:

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