phasePair Class Reference

Description for mass transfer between a pair of phases. The direction of the mass transfer is from the phase 'from' to the phasse 'to'. More...

Inheritance diagram for phasePair:
[legend]
Collaboration diagram for phasePair:
[legend]

Classes

class  const_iterator
 STL const_iterator. More...
 

Public Types

typedef HashTable< dictionary, phasePairKey, phasePairKey::hashdictTable
 Dictionary hash table. More...
 
typedef HashTable< scalar, phasePairKey, phasePairKey::hashscalarTable
 Scalar hash table. More...
 
typedef HashTable< dictionary, phasePairKey, phasePairKey::hashdictTable
 Dictionary hash table. More...
 
typedef HashTable< scalar, phasePairKey, phasePairKey::hashscalarTable
 Scalar hash table. More...
 
- Public Types inherited from phasePairKey
using hash = phasePairKey::hasher
 Alternative name for functor. More...
 
using hash = phasePairKey::hasher
 Alternative name for functor. More...
 
using hash = phasePairKey::hasher
 Alternative name for functor. More...
 

Public Member Functions

 phasePair (const phaseModel &phase1, const phaseModel &phase2, const bool ordered=false)
 Construct from two phases. More...
 
virtual ~phasePair ()=default
 Destructor. More...
 
virtual const phaseModelfrom () const
 From phase. More...
 
virtual const phaseModelto () const
 To phase. More...
 
virtual word name () const
 Pair name. More...
 
const phaseModelphase1 () const
 
const phaseModelphase2 () const
 
 phasePair (const phaseModel &phase1, const phaseModel &phase2, const bool ordered=false)
 Construct from two phases and gravity. More...
 
virtual ~phasePair ()
 Destructor. More...
 
virtual const phaseModeldispersed () const
 Dispersed phase. More...
 
virtual const phaseModelcontinuous () const
 Continuous phase. More...
 
virtual word name () const
 Pair name. More...
 
virtual word otherName () const
 Other pair name. More...
 
tmp< volScalarFieldrho () const
 Average density. More...
 
tmp< volScalarFieldmagUr () const
 Relative velocity magnitude. More...
 
tmp< volVectorFieldUr () const
 Relative velocity. More...
 
tmp< volScalarFieldRe () const
 Reynolds number. More...
 
tmp< volScalarFieldPr () const
 Prandtl number. More...
 
tmp< volScalarFieldEo () const
 Eotvos number. More...
 
tmp< volScalarFieldEoH1 () const
 Eotvos number based on hydraulic diameter type 1. More...
 
tmp< volScalarFieldEoH2 () const
 Eotvos number based on hydraulic diameter type 2. More...
 
tmp< volScalarFieldsigma () const
 Surface tension coefficient. More...
 
tmp< volScalarFieldMo () const
 Morton Number. More...
 
tmp< volScalarFieldTa () const
 Takahashi Number. More...
 
virtual tmp< volScalarFieldE () const
 Aspect ratio. More...
 
const phaseModelphase1 () const
 Return phase 1. More...
 
const phaseModelphase2 () const
 Return phase 2. More...
 
bool contains (const phaseModel &phase) const
 Return true if this phasePair contains the given phase. More...
 
const phaseModelotherPhase (const phaseModel &phase) const
 Return the other phase relative to the given phase. More...
 
label index (const phaseModel &phase) const
 Return the index of the given phase. Generates a FatalError if. More...
 
const uniformDimensionedVectorFieldg () const
 Return gravitation acceleration. More...
 
const_iterator cbegin () const
 const_iterator set to the beginning of the pair More...
 
const_iterator cend () const
 const_iterator set to beyond the end of the pair More...
 
const_iterator begin () const
 const_iterator set to the beginning of the pair More...
 
const_iterator end () const
 const_iterator set to beyond the end of the pair More...
 
 phasePair (const phaseModel &phase1, const phaseModel &phase2, const dimensionedVector &g, const scalarTable &sigmaTable, const bool ordered=false)
 Construct from two phases, gravity and surface tension table. More...
 
virtual ~phasePair ()
 Destructor. More...
 
virtual const phaseModeldispersed () const
 Dispersed phase. More...
 
virtual const phaseModelcontinuous () const
 Continuous phase. More...
 
virtual word name () const
 Pair name. More...
 
tmp< volScalarFieldrho () const
 Average density. More...
 
tmp< volScalarFieldmagUr () const
 Relative velocity magnitude. More...
 
tmp< volVectorFieldUr () const
 Relative velocity. More...
 
tmp< volScalarFieldRe () const
 Reynolds number. More...
 
tmp< volScalarFieldPr () const
 Prandtl number. More...
 
tmp< volScalarFieldEo () const
 Eotvos number. More...
 
tmp< volScalarFieldEoH1 () const
 Eotvos number based on hydraulic diameter type 1. More...
 
tmp< volScalarFieldEoH2 () const
 Eotvos number based on hydraulic diameter type 2. More...
 
tmp< volScalarFieldMo () const
 Morton Number. More...
 
tmp< volScalarFieldTa () const
 Takahashi Number. More...
 
virtual tmp< volScalarFieldE () const
 Aspect ratio. More...
 
const phaseModelphase1 () const
 
const phaseModelphase2 () const
 
const dimensionedVectorg () const
 
const dimensionedScalarsigma () const
 
- Public Member Functions inherited from phasePairKey
 phasePairKey ()=default
 Default construct. More...
 
 phasePairKey (const word &name1, const word &name2, const bool ordered=false)
 Construct from names and (optional) ordering flag. More...
 
virtual ~phasePairKey ()=default
 Destructor. More...
 
bool ordered () const noexcept
 Return the ordered flag. More...
 
 phasePairKey ()=default
 Default construct. More...
 
 phasePairKey (const word &name1, const word &name2, const bool ordered=false)
 Construct from names and (optional) ordering flag. More...
 
virtual ~phasePairKey ()=default
 Destructor. More...
 
bool ordered () const noexcept
 Return the ordered flag. More...
 
 phasePairKey ()=default
 Default construct. More...
 
 phasePairKey (const word &name1, const word &name2, const bool ordered=false)
 Construct from names and (optional) ordering flag. More...
 
virtual ~phasePairKey ()=default
 Destructor. More...
 
bool ordered () const noexcept
 Return the ordered flag. More...
 
- Public Member Functions inherited from Pair< word >
 Pair ()=default
 Default construct. More...
 
 Pair (const word &f, const word &s)
 Copy construct from components. More...
 
 Pair (word &&f, word &&s)
 Move construct from components. More...
 
 Pair (const std::pair< word, word > &vals)
 Copy construct from std::pair. More...
 
 Pair (std::pair< word, word > &&vals)
 Move construct from std::pair. More...
 
 Pair (const FixedList< word, 2 > &list)
 Copy construct FixedList of two items. More...
 
 Pair (const word &f, const word &s, const bool doSort)
 Copy construct, optionally sorted with first less-than second. More...
 
 Pair (const FixedList< word, 2 > &list, const bool doSort)
 Copy construct, optionally sorted with first less-than second. More...
 
 Pair (Istream &is)
 Construct from Istream. More...
 
const wordsecond () const noexcept
 Return second element, which is also the last element. More...
 
wordsecond () noexcept
 Return second element, which is also the last element. More...
 
const wordother (const word &a) const
 Return other element. More...
 
bool sorted () const
 True if first() is less-than second() More...
 
void flip ()
 Flip the Pair in-place. More...
 
void sort ()
 Sort so that first() is less-than second() More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Pair< word >
static int compare (const Pair< word > &a, const Pair< word > &b)
 Compare Pairs. More...
 

Detailed Description

Description for mass transfer between a pair of phases. The direction of the mass transfer is from the phase 'from' to the phasse 'to'.

Source files

Source files

Source files

Definition at line 53 of file phasePair.H.

Member Typedef Documentation

◆ dictTable [1/2]

Dictionary hash table.

Definition at line 61 of file phasePair.H.

◆ scalarTable [1/2]

Scalar hash table.

Definition at line 65 of file phasePair.H.

◆ dictTable [2/2]

Dictionary hash table.

Definition at line 60 of file phasePair.H.

◆ scalarTable [2/2]

Scalar hash table.

Definition at line 64 of file phasePair.H.

Constructor & Destructor Documentation

◆ phasePair() [1/3]

phasePair ( const phaseModel phase1,
const phaseModel phase2,
const bool  ordered = false 
)

Construct from two phases.

Definition at line 35 of file phasePair.C.

◆ ~phasePair() [1/3]

~phasePair ( )
virtualdefault

Destructor.

Definition at line 66 of file phasePair.C.

◆ phasePair() [2/3]

phasePair ( const phaseModel phase1,
const phaseModel phase2,
const bool  ordered = false 
)

Construct from two phases and gravity.

◆ ~phasePair() [2/3]

virtual ~phasePair ( )
virtual

Destructor.

◆ phasePair() [3/3]

phasePair ( const phaseModel phase1,
const phaseModel phase2,
const dimensionedVector g,
const scalarTable sigmaTable,
const bool  ordered = false 
)

Construct from two phases, gravity and surface tension table.

Definition at line 48 of file phasePair.C.

◆ ~phasePair() [3/3]

virtual ~phasePair ( )
virtual

Destructor.

Member Function Documentation

◆ from()

const Foam::phaseModel & from ( ) const
virtual

From phase.

Reimplemented in orderedPhasePair.

Definition at line 49 of file phasePair.C.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Referenced by interfaceHeatResistance< Thermo, OtherThermo >::Kexp(), kineticGasEvaporation< Thermo, OtherThermo >::Kexp(), and interfaceOxideRate< Thermo, OtherThermo >::Kexp().

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

◆ to()

const Foam::phaseModel & to ( ) const
virtual

To phase.

Reimplemented in orderedPhasePair.

Definition at line 59 of file phasePair.C.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Referenced by interfaceHeatResistance< Thermo, OtherThermo >::Kexp(), kineticGasEvaporation< Thermo, OtherThermo >::Kexp(), and interfaceOxideRate< Thermo, OtherThermo >::Kexp().

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

◆ name() [1/3]

◆ phase1() [1/3]

const Foam::phaseModel & phase1 ( ) const
inline

Definition at line 30 of file phasePairI.H.

Referenced by MassTransferPhaseSystem< BasePhaseSystem >::alphaTransfer(), turbulentDispersionModel::continuousTurbulence(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), PopulationBalancePhaseSystem< BasePhaseSystem >::dmdts(), PhaseTransferPhaseSystem< BasePhaseSystem >::dmdts(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::dmdts(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::dmdts(), orderedPhasePair::from(), OneResistanceHeatTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), TwoResistanceHeatTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::heatTransfer(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::InterfaceCompositionPhaseChangePhaseSystem(), PopulationBalancePhaseSystem< BasePhaseSystem >::massTransfer(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::massTransfer(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::massTransfer(), interfaceCompositionModel::New(), phaseForces::nonDragForce(), NonRandomTwoLiquid< Thermo, OtherThermo >::NonRandomTwoLiquid(), MomentumTransferPhaseSystem< BasePhaseSystem >::partialElimination(), MomentumTransferPhaseSystem< BasePhaseSystem >::partialEliminationf(), constantSurfaceTensionCoefficient::sigma(), TwoResistanceHeatTransferPhaseSystem< BasePhaseSystem >::TwoResistanceHeatTransferPhaseSystem(), and MassTransferPhaseSystem< BasePhaseSystem >::volTransfer().

Here is the caller graph for this function:

◆ phase2() [1/3]

◆ dispersed() [1/2]

const Foam::phaseModel & dispersed ( ) const
virtual

Dispersed phase.

Reimplemented in orderedPhasePair, and orderedPhasePair.

Definition at line 72 of file phasePair.C.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Referenced by wallLubricationModel::F(), linear::limiter(), sine::limiter(), and cosine::limiter().

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

◆ continuous() [1/2]

const Foam::phaseModel & continuous ( ) const
virtual

Continuous phase.

Reimplemented in orderedPhasePair, and orderedPhasePair.

Definition at line 82 of file phasePair.C.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Referenced by turbulentDispersionModel::continuousTurbulence(), liftModel::Fi(), and virtualMassModel::Ki().

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

◆ name() [2/3]

virtual word name ( ) const
virtual

Pair name.

Reimplemented in orderedPhasePair, orderedPhasePair, and orderedPhasePair.

◆ otherName()

Foam::word otherName ( ) const
virtual

Other pair name.

Reimplemented in orderedPhasePair.

Definition at line 100 of file phasePair.C.

◆ rho() [1/2]

Foam::tmp< Foam::volScalarField > rho ( ) const

Average density.

Definition at line 108 of file phasePair.C.

References phase1, phase2, and phaseModel::rho().

Here is the call graph for this function:

◆ magUr() [1/2]

Foam::tmp< Foam::volScalarField > magUr ( ) const

Relative velocity magnitude.

Definition at line 114 of file phasePair.C.

References Foam::mag(), phase1, phase2, and U.

Here is the call graph for this function:

◆ Ur() [1/2]

Relative velocity.

Definition at line 120 of file phasePair.C.

Referenced by liftModel::Fi().

Here is the caller graph for this function:

◆ Re() [1/2]

Reynolds number.

Definition at line 126 of file phasePair.C.

◆ Pr() [1/2]

Prandtl number.

Definition at line 132 of file phasePair.C.

◆ Eo() [1/2]

Eotvos number.

Definition at line 142 of file phasePair.C.

◆ EoH1() [1/2]

Foam::tmp< Foam::volScalarField > EoH1 ( ) const

Eotvos number based on hydraulic diameter type 1.

Definition at line 148 of file phasePair.C.

References Foam::cbrt(), and Foam::pow().

Here is the call graph for this function:

◆ EoH2() [1/2]

Foam::tmp< Foam::volScalarField > EoH2 ( ) const

Eotvos number based on hydraulic diameter type 2.

Definition at line 159 of file phasePair.C.

References Foam::cbrt().

Here is the call graph for this function:

◆ sigma() [1/2]

const Foam::dimensionedScalar & sigma ( ) const
inline

Surface tension coefficient.

Definition at line 170 of file phasePair.C.

References phaseModel::fluid(), phaseSystem::lookupSubModel(), phase1, phase2, and sigma().

Here is the call graph for this function:

◆ Mo() [1/2]

Morton Number.

Definition at line 180 of file phasePair.C.

References g, Foam::mag(), nu, Foam::pow3(), rho, and sigma().

Here is the call graph for this function:

◆ Ta() [1/2]

Takahashi Number.

Definition at line 194 of file phasePair.C.

References Foam::pow(), and Foam::Re().

Here is the call graph for this function:

◆ E() [1/2]

Foam::tmp< Foam::volScalarField > E ( ) const
virtual

Aspect ratio.

Reimplemented in orderedPhasePair, and orderedPhasePair.

Definition at line 200 of file phasePair.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and phase1.

Here is the call graph for this function:

◆ phase1() [2/3]

const phaseModel& phase1 ( ) const
inline

Return phase 1.

◆ phase2() [2/3]

const phaseModel& phase2 ( ) const
inline

Return phase 2.

◆ contains()

bool contains ( const phaseModel phase) const
inline

Return true if this phasePair contains the given phase.

Definition at line 42 of file phasePairI.H.

Referenced by phaseChange::addToDriftRate(), phaseChange::correct(), phaseForces::execute(), phaseSystem::generatePairsAndSubModels(), and phaseForces::phaseForces().

Here is the caller graph for this function:

◆ otherPhase()

const Foam::phaseModel & otherPhase ( const phaseModel phase) const
inline

Return the other phase relative to the given phase.

Generates a FatalError if this phasePair does not contain the given phase

Definition at line 49 of file phasePairI.H.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and phase::name().

Referenced by phaseForces::execute().

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

◆ index()

Foam::label index ( const phaseModel phase) const
inline

Return the index of the given phase. Generates a FatalError if.

this phasePair does not contain the given phase

Definition at line 72 of file phasePairI.H.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and phase::name().

Referenced by phaseSystem::generatePairsAndSubModels(), and InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::InterfaceCompositionPhaseChangePhaseSystem().

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

◆ g() [1/2]

const Foam::dimensionedVector & g ( ) const
inline

Return gravitation acceleration.

Definition at line 93 of file phasePairI.H.

◆ cbegin()

Foam::phasePair::const_iterator cbegin ( ) const
inline

const_iterator set to the beginning of the pair

Definition at line 194 of file phasePairI.H.

◆ cend()

Foam::phasePair::const_iterator cend ( ) const
inline

const_iterator set to beyond the end of the pair

Definition at line 200 of file phasePairI.H.

◆ begin()

Foam::phasePair::const_iterator begin ( ) const
inline

const_iterator set to the beginning of the pair

Definition at line 206 of file phasePairI.H.

◆ end()

Foam::phasePair::const_iterator end ( ) const
inline

const_iterator set to beyond the end of the pair

Definition at line 212 of file phasePairI.H.

◆ dispersed() [2/2]

virtual const phaseModel& dispersed ( ) const
virtual

Dispersed phase.

Reimplemented in orderedPhasePair, and orderedPhasePair.

◆ continuous() [2/2]

virtual const phaseModel& continuous ( ) const
virtual

Continuous phase.

Reimplemented in orderedPhasePair, and orderedPhasePair.

◆ name() [3/3]

virtual word name ( ) const
virtual

Pair name.

Reimplemented in orderedPhasePair, orderedPhasePair, and orderedPhasePair.

◆ rho() [2/2]

tmp<volScalarField> rho ( ) const

Average density.

◆ magUr() [2/2]

tmp<volScalarField> magUr ( ) const

Relative velocity magnitude.

◆ Ur() [2/2]

tmp<volVectorField> Ur ( ) const

Relative velocity.

◆ Re() [2/2]

tmp<volScalarField> Re ( ) const

Reynolds number.

◆ Pr() [2/2]

tmp<volScalarField> Pr ( ) const

Prandtl number.

◆ Eo() [2/2]

tmp<volScalarField> Eo ( ) const

Eotvos number.

◆ EoH1() [2/2]

tmp<volScalarField> EoH1 ( ) const

Eotvos number based on hydraulic diameter type 1.

◆ EoH2() [2/2]

tmp<volScalarField> EoH2 ( ) const

Eotvos number based on hydraulic diameter type 2.

◆ Mo() [2/2]

tmp<volScalarField> Mo ( ) const

Morton Number.

◆ Ta() [2/2]

tmp<volScalarField> Ta ( ) const

Takahashi Number.

◆ E() [2/2]

virtual tmp<volScalarField> E ( ) const
virtual

Aspect ratio.

Reimplemented in orderedPhasePair, and orderedPhasePair.

◆ phase1() [3/3]

const phaseModel& phase1 ( ) const
inline

◆ phase2() [3/3]

const phaseModel& phase2 ( ) const
inline

◆ g() [2/2]

const dimensionedVector& g ( ) const
inline

◆ sigma() [2/2]

const dimensionedScalar& sigma ( ) const
inline

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