phasePairKey Class Reference

Inheritance diagram for phasePairKey:

Collaboration diagram for phasePairKey:

Data Structures
class	hash

Public Member Functions
	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...

Private Attributes
bool	ordered_
	Flag to indicate whether ordering is important. More...

Friends
bool	operator== (const phasePairKey &a, const phasePairKey &b)
	Test if keys are equal. More...
bool	operator!= (const phasePairKey &a, const phasePairKey &b)
	Test if keys are unequal. More...
Istream &	operator>> (Istream &is, phasePairKey &key)
	Read from stdin. More...
Ostream &	operator<< (Ostream &os, const phasePairKey &key)
	Write to stdout. More...
bool	operator== (const phasePairKey &a, const phasePairKey &b)
	Test if keys are equal. More...
bool	operator!= (const phasePairKey &a, const phasePairKey &b)
	Test if keys are unequal. More...
Istream &	operator>> (Istream &is, phasePairKey &key)
	Read from stdin. More...
Ostream &	operator<< (Ostream &os, const phasePairKey &key)
	Write to stdout. More...

Additional Inherited Members
Static Public Member Functions inherited from Pair< word >
static int	compare (const Pair< Type > &a, const Pair< Type > &b)
	Compare Pairs. More...

Detailed Description

Source files

• phasePairKey.H

Source files

• phasePairKey.H

Definition at line 46 of file phasePairKey.H.

Constructor & Destructor Documentation

phasePairKey() [1/4]

phasePairKey

(

)

Construct null.

phasePairKey() [2/4]

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

Construct from names and the ordering flag.

~phasePairKey() [1/2]

virtual ~phasePairKey ( )

virtual

phasePairKey() [3/4]

phasePairKey

(

)

Construct null.

phasePairKey() [4/4]

phasePairKey	(	const word &	name1,
		const word &	name2,
		const bool	ordered
	)

Construct from names and the ordering flag.

~phasePairKey() [2/2]

virtual ~phasePairKey ( )

virtual

Member Function Documentation

ordered()

bool ordered

(

)

const

Return the ordered flag.

Friends And Related Function Documentation

operator== [1/2]

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

friend

Test if keys are equal.

operator!= [1/2]

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

friend

Test if keys are unequal.

operator>> [1/2]

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

friend

Read from stdin.

operator<< [1/2]

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

friend

Write to stdout.

operator== [2/2]

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

friend

Test if keys are equal.

operator!= [2/2]

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

friend

Test if keys are unequal.

operator>> [2/2]

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

friend

Read from stdin.

operator<< [2/2]

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

friend

Write to stdout.

Field Documentation

ordered_

bool ordered_

private

Flag to indicate whether ordering is important.

Definition at line 76 of file phasePairKey.H.

---

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

• applications/solvers/multiphase/reactingEulerFoam/phaseSystems/phasePair/phasePairKey/phasePairKey.H