phasePairKey Class Reference

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

Inheritance diagram for phasePairKey:

Collaboration diagram for phasePairKey:

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 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 word &	second () const noexcept
	Return second element, which is also the last element. More...
word &	second () noexcept
	Return second element, which is also the last element. More...
const word &	other (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 phasePairKey &a, const phasePairKey &b)
	Test for equality. More...
bool	operator!= (const phasePairKey &a, const phasePairKey &b)
	Test for inequality. More...
Istream &	operator>> (Istream &is, phasePairKey &key)
	Read from Istream. More...
Ostream &	operator<< (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...
Istream &	operator>> (Istream &is, phasePairKey &key)
	Read from Istream. More...
Ostream &	operator<< (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...
Istream &	operator>> (Istream &is, phasePairKey &key)
	Read from Istream. More...
Ostream &	operator<< (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...

Detailed Description

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

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

Source files

• phasePairKey.H
• phasePairKey.C

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

Source files

• phasePairKey.H
• phasePairKey.C

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

Source files

• phasePairKey.H
• phasePairKey.C

Definition at line 65 of file phasePairKey.H.

Member Typedef Documentation

hash [1/3]

using hash = phasePairKey::hasher

Alternative name for functor.

Definition at line 138 of file phasePairKey.H.

hash [2/3]

using hash = phasePairKey::hasher

Alternative name for functor.

Definition at line 138 of file phasePairKey.H.

hash [3/3]

using hash = phasePairKey::hasher

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 34 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]

bool ordered ( ) const

inlinenoexcept

Return the ordered flag.

Definition at line 98 of file phasePairKey.H.

Referenced by phaseForces::execute(), OneResistanceHeatTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), TwoResistanceHeatTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::heatTransfer(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::InterfaceCompositionPhaseChangePhaseSystem(), PopulationBalancePhaseSystem< BasePhaseSystem >::massTransfer(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::massTransfer(), Foam::operator==(), phaseForces::phaseForces(), PopulationBalancePhaseSystem< BasePhaseSystem >::PopulationBalancePhaseSystem(), and ThermalPhaseChangePhaseSystem< BasePhaseSystem >::ThermalPhaseChangePhaseSystem().

Here is the caller graph for this function:

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:

• src/phaseSystemModels/multiphaseInter/phasesSystem/phasePair/phasePairKey.H
• src/phaseSystemModels/multiphaseInter/phasesSystem/phasePair/phasePairKey.C