Public Types | Public Member Functions | List of all members
phasePair Class Reference
Inheritance diagram for phasePair:
Inheritance graph
[legend]
Collaboration diagram for phasePair:
Collaboration graph
[legend]

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 FixedList< word, 2 >
typedef word value_type
 Type of values the FixedList contains. More...
 
typedef wordreference
 Type that can be used for storing into. More...
 
typedef const wordconst_reference
 Type that can be used for storing into. More...
 
typedef label difference_type
 The type that can represent the difference between any two. More...
 
typedef label size_type
 The type that can represent the size of a FixedList. More...
 
typedef worditerator
 Random access iterator for traversing FixedList. More...
 
typedef const wordconst_iterator
 Random access iterator for traversing FixedList. More...
 
typedef wordreverse_iterator
 Reverse iterator for reverse traversal of FixedList. More...
 
typedef const wordconst_reverse_iterator
 Reverse iterator for reverse traversal of constant FixedList. More...
 

Public Member Functions

 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...
 
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
 
const phaseModelphase2 () const
 
const uniformDimensionedVectorFieldg () const
 
 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 ()
 Construct null. More...
 
 phasePairKey (const word &name1, const word &name2, const bool ordered=false)
 Construct from names and the ordering flag. More...
 
virtual ~phasePairKey ()
 
bool ordered () const
 Return the ordered flag. More...
 
 phasePairKey ()
 Construct null. More...
 
 phasePairKey (const word &name1, const word &name2, const bool ordered)
 Construct from names and the ordering flag. More...
 
virtual ~phasePairKey ()
 
- Public Member Functions inherited from Pair< word >
 Pair ()
 Null constructor. More...
 
 Pair (const word &f, const word &s)
 Construct from components. More...
 
 Pair (const FixedList< word, 2 > &fl)
 Construct from FixedList. More...
 
 Pair (Istream &is)
 Construct from Istream. More...
 
const wordfirst () const
 Return first. More...
 
wordfirst ()
 Return first. More...
 
const wordsecond () const
 Return second. More...
 
wordsecond ()
 Return second. More...
 
const wordother (const word &a) const
 Return other. More...
 
- Public Member Functions inherited from FixedList< word, 2 >
 FixedList ()
 Null constructor. More...
 
 FixedList (const word v[Size])
 Construct from C-array. More...
 
 FixedList (const word &)
 Construct from value. More...
 
 FixedList (const UList< word > &)
 Construct from UList. More...
 
 FixedList (const SLList< word > &)
 Construct from SLList. More...
 
 FixedList (const FixedList< word, Size > &)
 Copy constructor. More...
 
 FixedList (Istream &)
 Construct from Istream. More...
 
autoPtr< FixedList< word, Size > > clone () const
 Clone. More...
 
label fcIndex (const label i) const
 Return the forward circular index, i.e. the next index. More...
 
label rcIndex (const label i) const
 Return the reverse circular index, i.e. the previous index. More...
 
const wordcdata () const
 Return a const pointer to the first data element,. More...
 
worddata ()
 Return a pointer to the first data element,. More...
 
wordfirst ()
 Return the first element of the list. More...
 
const wordfirst () const
 Return first element of the list. More...
 
wordlast ()
 Return the last element of the list. More...
 
const wordlast () const
 Return the last element of the list. More...
 
void checkStart (const label start) const
 Check start is within valid range (0 ... size-1). More...
 
void checkSize (const label size) const
 Check size is within valid range (0 ... size). More...
 
void checkIndex (const label i) const
 Check index i is within valid range (0 ... size-1). More...
 
void resize (const label)
 Dummy resize function. More...
 
void setSize (const label)
 Dummy setSize function. More...
 
void transfer (const FixedList< word, Size > &)
 Copy (not transfer) the argument contents. More...
 
void writeEntry (Ostream &) const
 Write the FixedList as a dictionary entry. More...
 
void writeEntry (const word &keyword, Ostream &) const
 Write the FixedList as a dictionary entry with keyword. More...
 
wordoperator[] (const label)
 Return element of FixedList. More...
 
const wordoperator[] (const label) const
 Return element of constant FixedList. More...
 
void operator= (const word v[Size])
 Assignment from array operator. Takes linear time. More...
 
void operator= (const UList< word > &)
 Assignment from UList operator. Takes linear time. More...
 
void operator= (const SLList< word > &)
 Assignment from SLList operator. Takes linear time. More...
 
void operator= (const word &)
 Assignment of all entries to the given value. More...
 
iterator begin ()
 Return an iterator to begin traversing the FixedList. More...
 
const_iterator begin () const
 Return const_iterator to begin traversing the constant FixedList. More...
 
iterator end ()
 Return an iterator to end traversing the FixedList. More...
 
const_iterator end () const
 Return const_iterator to end traversing the constant FixedList. More...
 
const_iterator cbegin () const
 Return const_iterator to begin traversing the constant FixedList. More...
 
const_iterator cend () const
 Return const_iterator to end traversing the constant FixedList. More...
 
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the FixedList. More...
 
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing FixedList. More...
 
reverse_iterator rend ()
 Return reverse_iterator to end reverse traversing the FixedList. More...
 
const_reverse_iterator rend () const
 Return const_reverse_iterator to end reverse traversing FixedList. More...
 
const_reverse_iterator crbegin () const
 Return const_reverse_iterator to begin reverse traversing FixedList. More...
 
const_reverse_iterator crend () const
 Return const_reverse_iterator to end reverse traversing FixedList. More...
 
label size () const
 Return the number of elements in the FixedList. More...
 
label max_size () const
 Return size of the largest possible FixedList. More...
 
bool empty () const
 Return true if the FixedList is empty (ie, size() is zero). More...
 
void swap (FixedList< word, Size > &)
 Swap two FixedLists of the same type in constant time. More...
 
bool operator== (const FixedList< word, Size > &) const
 Equality operation on FixedLists of the same type. More...
 
bool operator!= (const FixedList< word, Size > &) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const FixedList< word, Size > &) const
 Compare two FixedLists lexicographically. Takes linear time. More...
 
bool operator> (const FixedList< word, Size > &) const
 Compare two FixedLists lexicographically. Takes linear time. More...
 
bool operator<= (const FixedList< word, Size > &) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const FixedList< word, Size > &) const
 Return true if !(a < b). Takes linear time. 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...
 
- Static Public Member Functions inherited from FixedList< word, 2 >
static const FixedList< word, Size > & null ()
 Return a null FixedList. More...
 

Detailed Description

Source files

Source files

Definition at line 49 of file phasePair.H.

Member Typedef Documentation

Dictionary hash table.

Definition at line 59 of file phasePair.H.

Scalar hash table.

Definition at line 63 of file phasePair.H.

Dictionary hash table.

Definition at line 58 of file phasePair.H.

Scalar hash table.

Definition at line 62 of file phasePair.H.

Constructor & Destructor Documentation

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

Construct from two phases and gravity.

virtual ~phasePair ( )
virtual

Destructor.

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.

virtual ~phasePair ( )
virtual

Destructor.

Member Function Documentation

virtual const phaseModel& dispersed ( ) const
virtual

Dispersed phase.

Reimplemented in orderedPhasePair, and orderedPhasePair.

virtual const phaseModel& continuous ( ) const
virtual

Continuous phase.

Reimplemented in orderedPhasePair, and orderedPhasePair.

virtual word name ( ) const
virtual

Pair name.

Reimplemented in orderedPhasePair, and orderedPhasePair.

tmp<volScalarField> rho ( ) const

Average density.

tmp<volScalarField> magUr ( ) const

Relative velocity magnitude.

tmp<volVectorField> Ur ( ) const

Relative velocity.

tmp<volScalarField> Re ( ) const

Reynolds number.

tmp<volScalarField> Pr ( ) const

Prandtl number.

tmp<volScalarField> Eo ( ) const

Eotvos number.

tmp<volScalarField> EoH1 ( ) const

Eotvos number based on hydraulic diameter type 1.

tmp<volScalarField> EoH2 ( ) const

Eotvos number based on hydraulic diameter type 2.

const Foam::dimensionedScalar & sigma ( ) const
inline

Surface tension coefficient.

Definition at line 46 of file phasePairI.H.

tmp<volScalarField> Mo ( ) const

Morton Number.

tmp<volScalarField> Ta ( ) const

Takahashi Number.

virtual tmp<volScalarField> E ( ) const
virtual

Aspect ratio.

Reimplemented in orderedPhasePair, and orderedPhasePair.

const Foam::phaseModel & phase1 ( ) const
inline

Definition at line 28 of file phasePairI.H.

const Foam::phaseModel & phase2 ( ) const
inline

Definition at line 34 of file phasePairI.H.

const Foam::dimensionedVector & g ( ) const
inline

Definition at line 40 of file phasePairI.H.

virtual const phaseModel& dispersed ( ) const
virtual

Dispersed phase.

Reimplemented in orderedPhasePair, and orderedPhasePair.

virtual const phaseModel& continuous ( ) const
virtual

Continuous phase.

Reimplemented in orderedPhasePair, and orderedPhasePair.

virtual word name ( ) const
virtual

Pair name.

Reimplemented in orderedPhasePair, and orderedPhasePair.

tmp<volScalarField> rho ( ) const

Average density.

tmp<volScalarField> magUr ( ) const

Relative velocity magnitude.

tmp<volVectorField> Ur ( ) const

Relative velocity.

tmp<volScalarField> Re ( ) const

Reynolds number.

tmp<volScalarField> Pr ( ) const

Prandtl number.

tmp<volScalarField> Eo ( ) const

Eotvos number.

tmp<volScalarField> EoH1 ( ) const

Eotvos number based on hydraulic diameter type 1.

tmp<volScalarField> EoH2 ( ) const

Eotvos number based on hydraulic diameter type 2.

tmp<volScalarField> Mo ( ) const

Morton Number.

tmp<volScalarField> Ta ( ) const

Takahashi Number.

virtual tmp<volScalarField> E ( ) const
virtual

Aspect ratio.

Reimplemented in orderedPhasePair, and orderedPhasePair.

const phaseModel& phase1 ( ) const
inline
const phaseModel& phase2 ( ) const
inline
const dimensionedVector& g ( ) const
inline
const dimensionedScalar& sigma ( ) const
inline

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