multiphaseSystem::interfacePair Class Reference

Name pair for the interface. More...

Inheritance diagram for multiphaseSystem::interfacePair:
[legend]
Collaboration diagram for multiphaseSystem::interfacePair:
[legend]

Public Types

using hash = Pair< word >::hasher
 
using symmHash = Pair< word >::symmHasher
 

Public Member Functions

 interfacePair ()=default
 
 interfacePair (const word &alpha1Name, const word &alpha2Name)
 
 interfacePair (const phaseModel &alpha1, const phaseModel &alpha2)
 
- 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...
 

Friends

bool operator== (const interfacePair &a, const interfacePair &b)
 
bool operator!= (const interfacePair &a, const interfacePair &b)
 

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...
 

Detailed Description

Name pair for the interface.

Definition at line 73 of file multiphaseSystem.H.

Member Typedef Documentation

◆ hash

using hash = Pair<word>::hasher

Definition at line 80 of file multiphaseSystem.H.

◆ symmHash

using symmHash = Pair<word>::symmHasher

Definition at line 83 of file multiphaseSystem.H.

Constructor & Destructor Documentation

◆ interfacePair() [1/3]

interfacePair ( )
default

◆ interfacePair() [2/3]

interfacePair ( const word alpha1Name,
const word alpha2Name 
)
inline

Definition at line 90 of file multiphaseSystem.H.

◆ interfacePair() [3/3]

interfacePair ( const phaseModel alpha1,
const phaseModel alpha2 
)
inline

Definition at line 95 of file multiphaseSystem.H.

Friends And Related Function Documentation

◆ operator==

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

Definition at line 104 of file multiphaseSystem.H.

◆ operator!=

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

Definition at line 113 of file multiphaseSystem.H.


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