orderedPhasePair Class Reference
Inheritance diagram for orderedPhasePair:
[legend]
Collaboration diagram for orderedPhasePair:
[legend]

Public Member Functions

 orderedPhasePair (const phaseModel &from, const phaseModel &to)
 Construct from two phases and gravity. More...
 
virtual ~orderedPhasePair ()=default
 Destructor. More...
 
virtual const phaseModelfrom () const
 Dispersed phase. More...
 
virtual const phaseModelto () const
 Continuous phase. More...
 
virtual word name () const
 Pair name. More...
 
 orderedPhasePair (const phaseModel &dispersed, const phaseModel &continuous)
 Construct from two phases and gravity. More...
 
virtual ~orderedPhasePair ()
 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...
 
virtual tmp< volScalarFieldE () const
 Aspect ratio. More...
 
 orderedPhasePair (const phaseModel &dispersed, const phaseModel &continuous, const dimensionedVector &g, const scalarTable &sigmaTable, const dictTable &aspectRatioTable)
 Construct from two phases, gravity, surface tension and aspect. More...
 
virtual ~orderedPhasePair ()
 Destructor. More...
 
virtual const phaseModeldispersed () const
 Dispersed phase. More...
 
virtual const phaseModelcontinuous () const
 Continuous phase. More...
 
virtual word name () const
 Pair name. More...
 
virtual tmp< volScalarFieldE () const
 Aspect ratio. More...
 
- Public Member Functions inherited from phasePair
 phasePair (const phaseModel &phase1, const phaseModel &phase2, const bool ordered=false)
 Construct from two phases. More...
 
virtual ~phasePair ()=default
 Destructor. 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...
 
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...
 
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...
 
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...
 
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

- Public Types inherited from phasePair
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...
 
- Static Public Member Functions inherited from Pair< word >
static int compare (const Pair< word > &a, const Pair< word > &b)
 Compare Pairs. More...
 

Detailed Description

Constructor & Destructor Documentation

◆ orderedPhasePair() [1/3]

orderedPhasePair ( const phaseModel from,
const phaseModel to 
)

Construct from two phases and gravity.

Definition at line 33 of file orderedPhasePair.C.

◆ ~orderedPhasePair() [1/3]

~orderedPhasePair ( )
virtualdefault

Destructor.

Definition at line 50 of file orderedPhasePair.C.

◆ orderedPhasePair() [2/3]

orderedPhasePair ( const phaseModel dispersed,
const phaseModel continuous 
)

Construct from two phases and gravity.

◆ ~orderedPhasePair() [2/3]

virtual ~orderedPhasePair ( )
virtual

Destructor.

◆ orderedPhasePair() [3/3]

orderedPhasePair ( const phaseModel dispersed,
const phaseModel continuous,
const dimensionedVector g,
const scalarTable sigmaTable,
const dictTable aspectRatioTable 
)

Construct from two phases, gravity, surface tension and aspect.

ratio tables

Definition at line 35 of file orderedPhasePair.C.

References HashTable< T, Key, Hash >::found(), and Foam::New().

Here is the call graph for this function:

◆ ~orderedPhasePair() [3/3]

virtual ~orderedPhasePair ( )
virtual

Destructor.

Member Function Documentation

◆ from()

const Foam::phaseModel & from ( ) const
virtual

Dispersed phase.

Reimplemented from phasePair.

Definition at line 44 of file orderedPhasePair.C.

References phasePair::phase1().

Here is the call graph for this function:

◆ to()

const Foam::phaseModel & to ( ) const
virtual

Continuous phase.

Reimplemented from phasePair.

Definition at line 50 of file orderedPhasePair.C.

References phase2.

◆ name() [1/3]

Foam::word name ( ) const
virtual

Pair name.

Reimplemented from phasePair.

Definition at line 56 of file orderedPhasePair.C.

◆ dispersed() [1/2]

const Foam::phaseModel & dispersed ( ) const
virtual

Dispersed phase.

Reimplemented from phasePair.

Definition at line 56 of file orderedPhasePair.C.

References phase1.

◆ continuous() [1/2]

const Foam::phaseModel & continuous ( ) const
virtual

Continuous phase.

Reimplemented from phasePair.

Definition at line 62 of file orderedPhasePair.C.

References phase2.

◆ name() [2/3]

virtual word name ( ) const
virtual

Pair name.

Reimplemented from phasePair.

◆ otherName()

Foam::word otherName ( ) const
virtual

Other pair name.

Reimplemented from phasePair.

Definition at line 76 of file orderedPhasePair.C.

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

Here is the call graph for this function:

◆ E() [1/2]

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

Aspect ratio.

Reimplemented from phasePair.

Definition at line 86 of file orderedPhasePair.C.

References phaseSystem::E(), phaseModel::fluid(), and phase1.

Here is the call graph for this function:

◆ dispersed() [2/2]

virtual const phaseModel& dispersed ( ) const
virtual

Dispersed phase.

Reimplemented from phasePair.

◆ continuous() [2/2]

virtual const phaseModel& continuous ( ) const
virtual

Continuous phase.

Reimplemented from phasePair.

◆ name() [3/3]

virtual word name ( ) const
virtual

Pair name.

Reimplemented from phasePair.

◆ E() [2/2]

virtual tmp<volScalarField> E ( ) const
virtual

Aspect ratio.

Reimplemented from phasePair.


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