phasePairKey Class Reference

An ordered or unorder pair of phase names. Typically specified as follows. More...

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

Classes

struct  hasher
 Hashing functor for phasePairKey. More...
 

Public Types

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< T, N >
typedef T value_type
 The value type the FixedList contains. More...
 
typedef Tpointer
 The pointer type for non-const access to value_type items. More...
 
typedef const Tconst_pointer
 The pointer type for const access to value_type items. More...
 
typedef Treference
 The type used for storing into value_type objects. More...
 
typedef const Tconst_reference
 The type used for reading from constant value_type objects. More...
 
typedef Titerator
 Random access iterator for traversing FixedList. More...
 
typedef const Tconst_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< iteratorreverse_iterator
 Reverse iterator (non-const access) More...
 
typedef std::reverse_iterator< const_iteratorconst_reverse_iterator
 Reverse iterator (const access) More...
 

Public Member Functions

 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...
 
- Public Member Functions inherited from FixedList< T, N >
 FixedList ()=default
 Default construct. More...
 
 FixedList (const T &val)
 Construct and initialize all entries to given value. More...
 
 FixedList (const Foam::zero)
 Construct and initialize all entries to zero. More...
 
 FixedList (const T list[N])
 Copy construct from C-array (deprecated) More...
 
 FixedList (const FixedList< T, N > &list)
 Copy construct. More...
 
 FixedList (FixedList< T, N > &&list)
 
 FixedList (std::initializer_list< T > list)
 Construct from an initializer list. Runtime size check. More...
 
 FixedList (const UList< T > &list)
 Construct from UList. Runtime size check. More...
 
template<unsigned AnyNum>
 FixedList (const FixedList< T, AnyNum > &list, const FixedList< label, N > &indices)
 Copy construct from a subset of the input. No size check. More...
 
 FixedList (const UList< T > &list, const FixedList< label, N > &indices)
 Copy construct from a subset of the input. No size check. More...
 
 FixedList (const SLList< T > &list)
 Construct from SLList. Runtime size check. More...
 
 FixedList (Istream &is)
 Construct from Istream. More...
 
autoPtr< FixedList< T, N > > clone () const
 Clone. More...
 
const Tcdata () const noexcept
 Return pointer to the underlying array serving as data storage. More...
 
Tdata () 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...
 
Tfirst () noexcept
 The first element of the list, position [0]. More...
 
const Tfirst () const noexcept
 The first element of the list, position [0]. More...
 
Tlast () noexcept
 The last element of the list, position [N-1]. More...
 
const Tlast () const noexcept
 The last element of the list, position [N-1]. More...
 
label fcIndex (const label i) const
 
const TfcValue (const label i) const
 Return forward circular value (ie, next value in the list) More...
 
TfcValue (const label i)
 Return forward circular value (ie, next value in the list) More...
 
label rcIndex (const label i) const
 
const TrcValue (const label i) const
 Return reverse circular value (ie, previous value in the list) More...
 
TrcValue (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...
 
label find (const T &val, label pos=0) const
 Find index of the first occurrence of the value. More...
 
label rfind (const T &val, label pos=-1) const
 Find index of the last occurrence of the value. More...
 
bool found (const T &val, label pos=0) const
 True if the value if found in the list. More...
 
void resize (const label n)
 Dummy function, to make FixedList consistent with List. More...
 
void resize_nocopy (const label n)
 Dummy function, to make FixedList consistent with List. More...
 
void setSize (const label n)
 Dummy function, to make FixedList consistent with List. More...
 
void fill (const T &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< T, N > &list)
 
Toperator[] (const label i)
 Return element of FixedList. More...
 
const Toperator[] (const label i) const
 Return element of constant FixedList. More...
 
void operator= (const T list[N])
 Assignment to array operator. Takes linear time. More...
 
void operator= (const UList< T > &list)
 Assignment to UList operator. Takes linear time. More...
 
void operator= (const SLList< T > &list)
 Assignment to SLList operator. Takes linear time. More...
 
void operator= (std::initializer_list< T > list)
 Assignment to an initializer list. Takes linear time. More...
 
void operator= (const T &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< T, N > &list)
 Copy assignment. More...
 
void operator= (FixedList< T, N > &&list)
 Move assignment. More...
 
iterator begin () noexcept
 Return an iterator to begin traversing the FixedList. More...
 
iterator end () noexcept
 Return an iterator to end traversing the 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...
 
const_iterator begin () const noexcept
 Return const_iterator to begin traversing the constant FixedList. More...
 
const_iterator end () 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...
 
reverse_iterator rend ()
 Return reverse_iterator to end reverse traversing the 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...
 
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing FixedList. More...
 
const_reverse_iterator rend () const
 Return const_reverse_iterator to end reverse traversing FixedList. More...
 
void swap (FixedList< T, N > &other)
 Swap lists by swapping the content of the individual list elements. More...
 
bool operator== (const FixedList< T, N > &list) const
 Equality operation on FixedLists of the same type. More...
 
bool operator!= (const FixedList< T, N > &list) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const FixedList< T, N > &list) const
 Compare two FixedLists lexicographically. Takes linear time. More...
 
bool operator> (const FixedList< T, N > &list) const
 Compare two FixedLists lexicographically. Takes linear time. More...
 
bool operator<= (const FixedList< T, N > &list) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const FixedList< T, N > &list) const
 Return true if !(a < b). Takes linear time. More...
 
IstreamreadList (Istream &is)
 Read from Istream, discarding contents of existing List. More...
 
void writeEntry (const word &keyword, Ostream &os) const
 Write the list as a dictionary entry with keyword. More...
 
OstreamwriteList (Ostream &os, const label shortLen=0) const
 Write List, with line-breaks in ASCII when length exceeds shortLen. More...
 

Friends

bool operator== (const phasePairKey &a, const phasePairKey &b)
 Test for equality. More...
 
bool operator!= (const phasePairKey &a, const phasePairKey &b)
 Test for inequality. More...
 
Istreamoperator>> (Istream &is, phasePairKey &key)
 Read from Istream. More...
 
Ostreamoperator<< (Ostream &os, const phasePairKey &key)
 Write to Ostream. More...
 
bool operator== (const phasePairKey &a, const phasePairKey &b)
 Test for equality. More...
 
bool operator!= (const phasePairKey &a, const phasePairKey &b)
 Test for inequality. More...
 
Istreamoperator>> (Istream &is, phasePairKey &key)
 Read from Istream. More...
 
Ostreamoperator<< (Ostream &os, const phasePairKey &key)
 Write to Ostream. More...
 
bool operator== (const phasePairKey &a, const phasePairKey &b)
 Test for equality. More...
 
bool operator!= (const phasePairKey &a, const phasePairKey &b)
 Test for inequality. More...
 
Istreamoperator>> (Istream &is, phasePairKey &key)
 Read from Istream. More...
 
Ostreamoperator<< (Ostream &os, const phasePairKey &key)
 Write to Ostream. 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< T, N >
static const FixedList< T, 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 ()
 
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< T, N >
void writeEntry (Ostream &os) const
 Write the FixedList with its compound type. More...
 

Detailed Description

An ordered or unorder pair of phase names. Typically specified as follows.

   (phase1 and phase2)  // unordered
   (phase1 to  phase2)  // ordered
Source files

   (phase1 and phase2)  // unordered
   (phase1 in  phase2)  // ordered
Source files

   (phase1 and phase2)  // unordered
   (phase1 in  phase2)  // ordered
Source files

Definition at line 65 of file phasePairKey.H.

Member Typedef Documentation

◆ hash [1/3]

Alternative name for functor.

Definition at line 138 of file phasePairKey.H.

◆ hash [2/3]

Alternative name for functor.

Definition at line 138 of file phasePairKey.H.

◆ hash [3/3]

Alternative name for functor.

Definition at line 138 of file phasePairKey.H.

Constructor & Destructor Documentation

◆ phasePairKey() [1/6]

phasePairKey ( )
default

Default construct.

◆ phasePairKey() [2/6]

phasePairKey ( const word name1,
const word name2,
const bool  ordered = false 
)

Construct from names and (optional) ordering flag.

Definition at line 33 of file phasePairKey.C.

◆ ~phasePairKey() [1/3]

virtual ~phasePairKey ( )
virtualdefault

Destructor.

◆ phasePairKey() [3/6]

phasePairKey ( )
default

Default construct.

◆ phasePairKey() [4/6]

phasePairKey ( const word name1,
const word name2,
const bool  ordered = false 
)

Construct from names and (optional) ordering flag.

◆ ~phasePairKey() [2/3]

virtual ~phasePairKey ( )
virtualdefault

Destructor.

◆ phasePairKey() [5/6]

phasePairKey ( )
default

Default construct.

◆ phasePairKey() [6/6]

phasePairKey ( const word name1,
const word name2,
const bool  ordered = false 
)

Construct from names and (optional) ordering flag.

◆ ~phasePairKey() [3/3]

virtual ~phasePairKey ( )
virtualdefault

Destructor.

Member Function Documentation

◆ ordered() [1/3]

◆ ordered() [2/3]

bool ordered ( ) const
inlinenoexcept

Return the ordered flag.

Definition at line 98 of file phasePairKey.H.

◆ ordered() [3/3]

bool ordered ( ) const
inlinenoexcept

Return the ordered flag.

Definition at line 98 of file phasePairKey.H.

Friends And Related Function Documentation

◆ operator== [1/3]

bool operator== ( const phasePairKey a,
const phasePairKey b 
)
friend

Test for equality.

Referenced by phasePair::const_iterator::operator!=().

◆ operator!= [1/3]

bool operator!= ( const phasePairKey a,
const phasePairKey b 
)
friend

Test for inequality.

◆ operator>> [1/3]

Istream & operator>> ( Istream is,
phasePairKey key 
)
friend

Read from Istream.

◆ operator<< [1/3]

Ostream & operator<< ( Ostream os,
const phasePairKey key 
)
friend

Write to Ostream.

◆ operator== [2/3]

bool operator== ( const phasePairKey a,
const phasePairKey b 
)
friend

Test for equality.

◆ operator!= [2/3]

bool operator!= ( const phasePairKey a,
const phasePairKey b 
)
friend

Test for inequality.

◆ operator>> [2/3]

Istream & operator>> ( Istream is,
phasePairKey key 
)
friend

Read from Istream.

◆ operator<< [2/3]

Ostream & operator<< ( Ostream os,
const phasePairKey key 
)
friend

Write to Ostream.

◆ operator== [3/3]

bool operator== ( const phasePairKey a,
const phasePairKey b 
)
friend

Test for equality.

◆ operator!= [3/3]

bool operator!= ( const phasePairKey a,
const phasePairKey b 
)
friend

Test for inequality.

◆ operator>> [3/3]

Istream & operator>> ( Istream is,
phasePairKey key 
)
friend

Read from Istream.

◆ operator<< [3/3]

Ostream & operator<< ( Ostream os,
const phasePairKey key 
)
friend

Write to Ostream.


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