orderedPhasePair Class Reference
Inheritance diagram for orderedPhasePair:
Collaboration diagram for orderedPhasePair:

Public Member Functions

 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 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 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
 
const phaseModelphase2 () const
 
const
uniformDimensionedVectorField
g () 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...
 
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 ()
 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 Type &f, const Type &s)
 Construct from components. More...
 
 Pair (const FixedList< Type, 2 > &fl)
 Construct from FixedList. More...
 
 Pair (Istream &is)
 Construct from Istream. More...
 
const Type & first () const
 Return first. More...
 
Type & first ()
 Return first. More...
 
const Type & second () const
 Return second. More...
 
Type & second ()
 Return second. More...
 
const Type & other (const Type &a) const
 Return other. More...
 
- Public Member Functions inherited from FixedList< Type, 2 >
 FixedList ()
 Null constructor. More...
 
 FixedList (const Typev[Size])
 Construct from C-array. More...
 
 FixedList (const Type &)
 Construct from value. More...
 
 FixedList (const UList< Type > &)
 Construct from UList. More...
 
 FixedList (const SLList< Type > &)
 Construct from SLList. More...
 
 FixedList (const FixedList< Type, Size > &)
 Copy constructor. More...
 
 FixedList (Istream &)
 Construct from Istream. More...
 
autoPtr< FixedList< Type, 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 Type * cdata () const
 Return a const pointer to the first data element,. More...
 
Type * data ()
 Return a pointer to the first data element,. More...
 
Type & first ()
 Return the first element of the list. More...
 
const Type & first () const
 Return first element of the list. More...
 
Type & last ()
 Return the last element of the list. More...
 
const Type & last () 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< Type, 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...
 
Type & operator[] (const label)
 Return element of FixedList. More...
 
const Type & operator[] (const label) const
 Return element of constant FixedList. More...
 
void operator= (const Typev[Size])
 Assignment from array operator. Takes linear time. More...
 
void operator= (const UList< Type > &)
 Assignment from UList operator. Takes linear time. More...
 
void operator= (const SLList< Type > &)
 Assignment from SLList operator. Takes linear time. More...
 
void operator= (const Type &)
 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< Type, Size > &)
 Swap two FixedLists of the same type in constant time. More...
 
bool operator== (const FixedList< Type, Size > &) const
 Equality operation on FixedLists of the same type. More...
 
bool operator!= (const FixedList< Type, Size > &) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const FixedList< Type, Size > &) const
 Compare two FixedLists lexicographically. Takes linear time. More...
 
bool operator> (const FixedList< Type, Size > &) const
 Compare two FixedLists lexicographically. Takes linear time. More...
 
bool operator<= (const FixedList< Type, Size > &) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const FixedList< Type, Size > &) const
 Return true if !(a < b). Takes linear time. More...
 

Additional Inherited Members

- Public Types inherited from phasePair
typedef HashTable< dictionary,
phasePairKey,
phasePairKey::hash
dictTable
 Dictionary hash table. More...
 
typedef HashTable< scalar,
phasePairKey,
phasePairKey::hash
scalarTable
 Scalar hash table. More...
 
typedef HashTable< dictionary,
phasePairKey,
phasePairKey::hash
dictTable
 Dictionary hash table. More...
 
typedef HashTable< scalar,
phasePairKey,
phasePairKey::hash
scalarTable
 Scalar hash table. More...
 
- Public Types inherited from FixedList< Type, 2 >
typedef Type value_type
 Type of values the FixedList contains. More...
 
typedef Type & reference
 Type that can be used for storing into. More...
 
typedef const Type & const_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 Type * iterator
 Random access iterator for traversing FixedList. More...
 
typedef const Type * const_iterator
 Random access iterator for traversing FixedList. More...
 
typedef Type * reverse_iterator
 Reverse iterator for reverse traversal of FixedList. More...
 
typedef const Type * const_reverse_iterator
 Reverse iterator for reverse traversal of constant FixedList. More...
 
- Static Public Member Functions inherited from Pair< word >
static int compare (const Pair< Type > &a, const Pair< Type > &b)
 Compare Pairs. More...
 
- Static Public Member Functions inherited from FixedList< Type, 2 >
static const FixedList< Type,
Size > & 
null ()
 Return a null FixedList. More...
 

Detailed Description

Constructor & Destructor Documentation

orderedPhasePair ( const phaseModel dispersed,
const phaseModel continuous 
)

Construct from two phases and gravity.

virtual ~orderedPhasePair ( )
virtual

Destructor.

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

virtual ~orderedPhasePair ( )
virtual

Destructor.

Member Function Documentation

virtual const phaseModel& dispersed ( ) const
virtual

Dispersed phase.

Reimplemented from phasePair.

virtual const phaseModel& continuous ( ) const
virtual

Continuous phase.

Reimplemented from phasePair.

virtual word name ( ) const
virtual

Pair name.

Reimplemented from phasePair.

virtual tmp<volScalarField> E ( ) const
virtual

Aspect ratio.

Reimplemented from phasePair.

virtual const phaseModel& dispersed ( ) const
virtual

Dispersed phase.

Reimplemented from phasePair.

virtual const phaseModel& continuous ( ) const
virtual

Continuous phase.

Reimplemented from phasePair.

virtual word name ( ) const
virtual

Pair name.

Reimplemented from phasePair.

virtual tmp<volScalarField> E ( ) const
virtual

Aspect ratio.

Reimplemented from phasePair.


The documentation for this class was generated from the following file:
  • applications/solvers/multiphase/reactingEulerFoam/phaseSystems/phasePair/orderedPhasePair/orderedPhasePair.H