Public Member Functions | |
| orderedPhasePair (const multiphaseInter::phaseModel &from, const multiphaseInter::phaseModel &to) | |
| Construct from two phases and gravity. More... | |
| virtual | ~orderedPhasePair ()=default |
| Destructor. More... | |
| virtual const multiphaseInter::phaseModel & | from () const |
| Dispersed phase. More... | |
| virtual const multiphaseInter::phaseModel & | to () 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 phaseModel & | dispersed () const |
| Dispersed phase. More... | |
| virtual const phaseModel & | continuous () const |
| Continuous phase. More... | |
| virtual word | name () const |
| Pair name. More... | |
| virtual word | otherName () const |
| Other pair name. More... | |
| virtual tmp< volScalarField > | E () 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 phaseModel & | dispersed () const |
| Dispersed phase. More... | |
| virtual const phaseModel & | continuous () const |
| Continuous phase. More... | |
| virtual word | name () const |
| Pair name. More... | |
| virtual tmp< volScalarField > | E () const |
| Aspect ratio. More... | |
 Public Member Functions inherited from phasePair | |
| phasePair (const multiphaseInter::phaseModel &phase1, const multiphaseInter::phaseModel &phase2, const bool ordered=false) | |
| Construct from two phases. More... | |
| virtual | ~phasePair ()=default |
| Destructor. More... | |
| const multiphaseInter::phaseModel & | phase1 () const |
| const multiphaseInter::phaseModel & | phase2 () const |
| phasePair (const phaseModel &phase1, const phaseModel &phase2, const bool ordered=false) | |
| Construct from two phases and gravity. More... | |
| virtual | ~phasePair () |
| Destructor. More... | |
| tmp< volScalarField > | rho () const |
| Average density. More... | |
| tmp< volScalarField > | magUr () const |
| Relative velocity magnitude. More... | |
| tmp< volVectorField > | Ur () const |
| Relative velocity. More... | |
| tmp< volScalarField > | Re () const |
| Reynolds number. More... | |
| tmp< volScalarField > | Pr () const |
| Prandtl number. More... | |
| tmp< volScalarField > | Eo () const |
| Eotvos number. More... | |
| tmp< volScalarField > | EoH1 () const |
| Eotvos number based on hydraulic diameter type 1. More... | |
| tmp< volScalarField > | EoH2 () const |
| Eotvos number based on hydraulic diameter type 2. More... | |
| tmp< volScalarField > | sigma () const |
| Surface tension coefficient. More... | |
| tmp< volScalarField > | Mo () const |
| Morton Number. More... | |
| tmp< volScalarField > | Ta () const |
| Takahashi Number. More... | |
| const phaseModel & | phase1 () const |
| Return phase 1. More... | |
| const phaseModel & | phase2 () const |
| Return phase 2. More... | |
| bool | contains (const phaseModel &phase) const |
| Return true if this phasePair contains the given phase. More... | |
| const phaseModel & | otherPhase (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 uniformDimensionedVectorField & | g () 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< volScalarField > | rho () const |
| Average density. More... | |
| tmp< volScalarField > | magUr () const |
| Relative velocity magnitude. More... | |
| tmp< volVectorField > | Ur () const |
| Relative velocity. More... | |
| tmp< volScalarField > | Re () const |
| Reynolds number. More... | |
| tmp< volScalarField > | Pr () const |
| Prandtl number. More... | |
| tmp< volScalarField > | Eo () const |
| Eotvos number. More... | |
| tmp< volScalarField > | EoH1 () const |
| Eotvos number based on hydraulic diameter type 1. More... | |
| tmp< volScalarField > | EoH2 () const |
| Eotvos number based on hydraulic diameter type 2. More... | |
| tmp< volScalarField > | Mo () const |
| Morton Number. More... | |
| tmp< volScalarField > | Ta () const |
| Takahashi Number. More... | |
| const phaseModel & | phase1 () const |
| const phaseModel & | phase2 () const |
| const dimensionedVector & | g () const |
| const dimensionedScalar & | sigma () 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... | |
| void | front ()=delete |
| The front() accessor (from FixedList) has no purpose. More... | |
| void | back ()=delete |
| The back() accessor (from FixedList) has no purpose. More... | |
| const word & | first () const noexcept |
| Access the first element. More... | |
| word & | first () noexcept |
| Access the first element. More... | |
| const word & | second () const noexcept |
| Access the second element. More... | |
| word & | second () noexcept |
| Access the second element. More... | |
| const word & | other (const word &a) const |
| Return other element. More... | |
| bool | is_sorted () const |
| True if first() is less-than-equal second() More... | |
| void | flip () |
| Flip the Pair in-place. More... | |
| void | sort () |
| Sort so that first() is less-than second() More... | |
| bool | sorted () const |
| Deprecated(2023-07) Use is_sorted() method. More... | |
| Public Member Functions inherited from FixedList< word, 2 > | |
| void | writeEntry (const word &keyword, Ostream &os) const |
| Write the list as a dictionary entry with keyword. More... | |
| FixedList ()=default | |
| Default construct. More... | |
| FixedList (const word &val) | |
| Construct and initialize all entries to given value. More... | |
| FixedList (const Foam::zero) | |
| Construct and initialize all entries to zero. More... | |
| FixedList (const FixedList< word, N > &list) | |
| Copy construct. More... | |
| FixedList (FixedList< word, N > &&list) | |
| Move construct by using move assignment for the individual list elements. More... | |
| FixedList (std::initializer_list< word > list) | |
| Construct from an initializer list. Runtime size check. More... | |
| FixedList (const UList< word > &list) | |
| Construct from UList. Runtime size check. More... | |
| FixedList (const FixedList< word, AnyNum > &list, const FixedList< label, N > &indices) | |
| Copy construct from a subset of the input. No size check. More... | |
| FixedList (const UList< word > &list, const FixedList< label, N > &indices) | |
| Copy construct from a subset of the input. No size check. More... | |
| FixedList (Istream &is) | |
| Construct from Istream. More... | |
| FixedList (const word list[N]) | |
| Deprecated: copy construct from C-array. More... | |
| autoPtr< FixedList< word, N > > | clone () const |
| Clone. More... | |
| const word * | cdata () const noexcept |
| Return pointer to the underlying array serving as data storage. More... | |
| word * | data () noexcept |
| Return pointer to the underlying array serving as data storage. More... | |
| const char * | cdata_bytes () const noexcept |
| Return pointer to the underlying array serving as data storage,. More... | |
| char * | data_bytes () noexcept |
| Return pointer to the underlying array serving as data storage,. More... | |
| word & | get () noexcept |
| Element access using compile-time indexing. More... | |
| const word & | get () const noexcept |
| Element access using compile-time indexing. More... | |
| word & | front () noexcept |
| Access first element of the list, position [0]. More... | |
| const word & | front () const noexcept |
| Access first element of the list, position [0]. More... | |
| word & | back () noexcept |
| Access last element of the list, position [N-1]. More... | |
| const word & | back () const noexcept |
| Access last element of the list, position [N-1]. More... | |
| label | fcIndex (const label i) const noexcept |
| Return the forward circular index, i.e. next index which returns to the first at the end of the list. More... | |
| const word & | fcValue (const label i) const |
| Return forward circular value (ie, next value in the list) More... | |
| word & | fcValue (const label i) |
| Return forward circular value (ie, next value in the list) More... | |
| label | rcIndex (const label i) const noexcept |
| Return the reverse circular index, i.e. previous index which returns to the last at the beginning of the list. More... | |
| const word & | rcValue (const label i) const |
| Return reverse circular value (ie, previous value in the list) More... | |
| word & | rcValue (const label i) |
| Return reverse circular value (ie, previous value in the list) More... | |
| void | checkStart (const label start) const |
| Check start is within valid range [0,size) More... | |
| void | checkSize (const label size) const |
| Check size is identical to template parameter N. More... | |
| void | checkIndex (const label i) const |
| Check index is within valid range [0,N) More... | |
| bool | uniform () const |
| True if all entries have identical values, and list is non-empty. More... | |
| bool | contains (const word &val) const |
| True if the value is contained in the list. More... | |
| bool | contains (const word &val, label pos, label len=-1) const |
| Is the value contained in the list? More... | |
| label | find (const word &val) const |
| Find index of the first occurrence of the value. More... | |
| label | find (const word &val, label pos, label len=-1) const |
| Find index of the first occurrence of the value. More... | |
| label | rfind (const word &val, label pos=-1) const |
| Find index of the last occurrence of the value. More... | |
| void | resize (const label n) |
| Dummy function, to make FixedList consistent with List Any resizing is ignored (Fatal with bad sizing in full debug). More... | |
| void | resize_fill (const label n, const word &val) |
| Set val for all elements. Any resizing is ignored (Fatal with bad sizing in full debug). More... | |
| void | resize_nocopy (const label n) |
| Dummy function, to make FixedList consistent with List Any resizing is ignored (Fatal with bad sizing in full debug). More... | |
| void | setSize (const label n) |
| Dummy function, to make FixedList consistent with List. More... | |
| void | fill (const word &val) |
| Assign all entries to the given value. More... | |
| void | fill (const Foam::zero) |
| Assign all entries to zero. More... | |
| void | moveFirst (const label i) |
| Move element to the first position. More... | |
| void | moveLast (const label i) |
| Move element to the last position. More... | |
| void | swapFirst (const label i) |
| Swap element with the first element. More... | |
| void | swapLast (const label i) |
| Swap element with the last element. More... | |
| void | transfer (FixedList< word, N > &list) |
| Transfer by swapping using a move assignment for the content of the individual list elements. More... | |
| word & | operator[] (const label i) |
| Return element of FixedList. More... | |
| const word & | operator[] (const label i) const |
| Return element of constant FixedList. More... | |
| void | operator= (const UList< word > &list) |
| Assignment to UList operator. Takes linear time. More... | |
| void | operator= (std::initializer_list< word > list) |
| Assignment to an initializer list. Takes linear time. More... | |
| void | operator= (const word &val) |
| Assign all entries to the given value. fill() More... | |
| void | operator= (const Foam::zero) |
| Assign all entries to zero. fill() More... | |
| void | operator= (const FixedList< word, N > &list) |
| Copy assignment. More... | |
| void | operator= (FixedList< word, N > &&list) |
| Move assignment. More... | |
| void | operator= (const word list[N]) |
| Deprecated: assignment from C-array. More... | |
| iterator | begin () noexcept |
| Return an iterator to begin traversing the FixedList. More... | |
| const_iterator | begin () const noexcept |
| Return const_iterator to begin traversing the constant FixedList. More... | |
| iterator | end () noexcept |
| Return an iterator to end traversing the FixedList. More... | |
| const_iterator | end () const noexcept |
| Return const_iterator to end traversing the constant FixedList. More... | |
| const_iterator | cbegin () const noexcept |
| Return const_iterator to begin traversing the constant FixedList. More... | |
| const_iterator | cend () const noexcept |
| 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... | |
| void | swap (FixedList< word, N > &other) |
| Swap lists by swapping the content of the individual list elements. More... | |
| bool | operator== (const FixedList< word, N > &list) const |
| Equality operation on FixedLists of the same type. More... | |
| bool | operator!= (const FixedList< word, N > &list) const |
| The opposite of the equality operation. Takes linear time. More... | |
| bool | operator< (const FixedList< word, N > &list) const |
| Compare two FixedLists lexicographically. Takes linear time. More... | |
| bool | operator> (const FixedList< word, N > &list) const |
| Compare two FixedLists lexicographically. Takes linear time. More... | |
| bool | operator<= (const FixedList< word, N > &list) const |
| Return true if !(a > b). Takes linear time. More... | |
| bool | operator>= (const FixedList< word, N > &list) const |
| Return true if !(a < b). Takes linear time. More... | |
| Istream & | readList (Istream &is) |
| Read from Istream, discarding contents of existing List. More... | |
| Ostream & | writeList (Ostream &os, const label shortLen=0) const |
| Write List, with line-breaks in ASCII when length exceeds shortLen. More... | |
| word & | first () noexcept |
| Access first element of the list, position [0] - front() More... | |
| const word & | first () const noexcept |
| Access first element of the list, position [0] - front() More... | |
| word & | last () noexcept |
| Access last element of the list, position [N-1] - back() More... | |
| const word & | last () const noexcept |
| Access last element of the list, position [N-1] - back() More... | |
| bool | found (const word &val, label pos=0) const |
| Same as contains() 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 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 Types inherited from FixedList< word, 2 > | |
| typedef word | value_type |
| The value type the FixedList contains. More... | |
| typedef word * | pointer |
| The pointer type for non-const access to value_type items. More... | |
| typedef const word * | const_pointer |
| The pointer type for const access to value_type items. More... | |
| typedef word & | reference |
| The type used for storing into value_type objects. More... | |
| typedef const word & | const_reference |
| The type used for reading from constant value_type objects. More... | |
| typedef word * | iterator |
| Random access iterator for traversing FixedList. More... | |
| typedef const word * | const_iterator |
| Random access iterator for traversing FixedList. More... | |
| typedef label | size_type |
| The type to represent the size of a FixedList. More... | |
| typedef label | difference_type |
| The difference between iterator objects. More... | |
| typedef std::reverse_iterator< iterator > | reverse_iterator |
| Reverse iterator (non-const access) More... | |
| typedef std::reverse_iterator< const_iterator > | const_reverse_iterator |
| Reverse iterator (const access) More... | |
| 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, N > & | null () |
| Return a null FixedList. More... | |
| static std::streamsize | size_bytes () noexcept |
| Number of contiguous bytes for the list data,. More... | |
| static std::streamsize | byteSize () |
| Number of contiguous bytes for the list data, runtime FatalError if type is not contiguous. More... | |
| static constexpr bool | empty () noexcept |
| Always false since zero-sized FixedList is compile-time disabled. More... | |
| static constexpr label | size () noexcept |
| Return the number of elements in the FixedList. More... | |
| static constexpr unsigned | max_size () noexcept |
| The dimensioned size (template parameter N) of the FixedList. More... | |
| Protected Member Functions inherited from FixedList< word, 2 > | |
| void | writeEntry (Ostream &os) const |
| Write the FixedList with its compound type. More... | |
| orderedPhasePair | ( | const multiphaseInter::phaseModel & | from, |
| const multiphaseInter::phaseModel & | to | ||
| ) |
Construct from two phases and gravity.
Definition at line 26 of file orderedPhasePair.C.
|
virtualdefault |
Destructor.
Definition at line 43 of file orderedPhasePair.C.
| orderedPhasePair | ( | const phaseModel & | dispersed, |
| const phaseModel & | continuous | ||
| ) |
Construct from two phases and gravity.
Definition at line 27 of file orderedPhasePair.C.
|
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
Definition at line 28 of file orderedPhasePair.C.
References HashTable< T, Key, Hash >::found(), and Foam::New().
|
virtual |
Destructor.
|
virtual |
Dispersed phase.
Reimplemented from phasePair.
Definition at line 37 of file orderedPhasePair.C.
References phasePair::phase1().
|
virtual |
Continuous phase.
Reimplemented from phasePair.
Definition at line 43 of file orderedPhasePair.C.
References phase2.
|
virtual |
|
virtual |
Dispersed phase.
Reimplemented from phasePair.
Definition at line 49 of file orderedPhasePair.C.
References phase1.
|
virtual |
Continuous phase.
Reimplemented from phasePair.
Definition at line 55 of file orderedPhasePair.C.
References phase2.
|
virtual |
Other pair name.
Reimplemented from phasePair.
Definition at line 69 of file orderedPhasePair.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and word::null.
|
virtual |
Aspect ratio.
Reimplemented from phasePair.
Definition at line 79 of file orderedPhasePair.C.
References phaseSystem::E(), phaseModel::fluid(), and phase1.
|
virtual |
Dispersed phase.
Reimplemented from phasePair.
|
virtual |
Continuous phase.
Reimplemented from phasePair.
|
virtual |
Aspect ratio.
Reimplemented from phasePair.
1.8.14 