Inheritance diagram for phasePairKey:

Collaboration diagram for phasePairKey:

Classes
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 word &f, const word &s)
	Construct from components. More...

	Pair (const FixedList< word, 2 > &fl)
	Construct from FixedList. More...

	Pair (Istream &is)
	Construct from Istream. More...

const word &	first () const
	Return first. More...

word &	first ()
	Return first. More...

const word &	second () const
	Return second. More...

word &	second ()
	Return second. More...

const word &	other (const word &a) const
	Return other. More...

Public Member Functions inherited from FixedList< word, 2 >
	FixedList ()
	Null constructor. More...

	FixedList (const word &)
	Construct from value. More...

	FixedList (const word v[Size])
	Construct from C-array. More...

	FixedList (InputIterator first, InputIterator last)
	Construct given start and end iterators. More...

	FixedList (std::initializer_list< word >)
	Construct from an initializer list. More...

	FixedList (const UList< word > &)
	Construct from UList. More...

	FixedList (const SLList< word > &)
	Construct from SLList. More...

	FixedList (Istream &)
	Construct from Istream. More...

autoPtr< FixedList< word, Size > >	clone () const
	Clone. More...

label	fcIndex (const label i) const
	Return the forward circular index, i.e. the next index. More...

label	rcIndex (const label i) const
	Return the reverse circular index, i.e. the previous index. More...

const word *	cdata () const
	Return a const pointer to the first data element,. More...

word *	data ()
	Return a pointer to the first data element,. More...

word &	first ()
	Return the first element of the list. More...

const word &	first () const
	Return first element of the list. More...

word &	last ()
	Return the last element of the list. More...

const word &	last () const
	Return the last element of the list. More...

void	checkStart (const label start) const
	Check start is within valid range (0 ... size-1) More...

void	checkSize (const label size) const
	Check size is within valid range (0 ... size) More...

void	checkIndex (const label i) const
	Check index i is within valid range (0 ... size-1) More...

void	resize (const label)
	Dummy resize function. More...

void	setSize (const label)
	Dummy setSize function. More...

void	transfer (const FixedList< word, Size > &)
	Copy (not transfer) the argument contents. More...

word &	operator[] (const label)
	Return element of FixedList. More...

const word &	operator[] (const label) const
	Return element of constant FixedList. More...

void	operator= (const word v[Size])
	Assignment to array operator. Takes linear time. More...

void	operator= (const UList< word > &)
	Assignment to UList operator. Takes linear time. More...

void	operator= (const SLList< word > &)
	Assignment to SLList operator. Takes linear time. More...

void	operator= (std::initializer_list< word >)
	Assignment to an initializer list. Takes linear time. More...

void	operator= (const word &)
	Assignment of all entries to the given value. More...

iterator	begin ()
	Return an iterator to begin traversing the FixedList. More...

const_iterator	begin () const
	Return const_iterator to begin traversing the constant FixedList. More...

iterator	end ()
	Return an iterator to end traversing the FixedList. More...

const_iterator	end () const
	Return const_iterator to end traversing the constant FixedList. More...

const_iterator	cbegin () const
	Return const_iterator to begin traversing the constant FixedList. More...

const_iterator	cend () const
	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...

label	size () const
	Return the number of elements in the FixedList. More...

label	max_size () const
	Return size of the largest possible FixedList. More...

bool	empty () const
	Return true if the FixedList is empty (ie, size() is zero) More...

void	swap (FixedList< word, Size > &)
	Swap two FixedLists of the same type in constant time. More...

bool	operator== (const FixedList< word, Size > &) const
	Equality operation on FixedLists of the same type. More...

bool	operator!= (const FixedList< word, Size > &) const
	The opposite of the equality operation. Takes linear time. More...

bool	operator< (const FixedList< word, Size > &) const
	Compare two FixedLists lexicographically. Takes linear time. More...

bool	operator> (const FixedList< word, Size > &) const
	Compare two FixedLists lexicographically. Takes linear time. More...

bool	operator<= (const FixedList< word, Size > &) const
	Return true if !(a > b). Takes linear time. More...

bool	operator>= (const FixedList< word, Size > &) const
	Return true if !(a < b). Takes linear time. 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
Public Types inherited from FixedList< word, 2 >
typedef word	value_type
	Type of values the FixedList contains. More...

typedef word &	reference
	Type that can be used for storing into. More...

typedef const word &	const_reference
	Type that can be used for storing into. More...

typedef label	difference_type
	The type that can represent the difference between any two. More...

typedef label	size_type
	The type that can represent the size of a FixedList. More...

typedef word *	iterator
	Random access iterator for traversing FixedList. More...

typedef const word *	const_iterator
	Random access iterator for traversing FixedList. More...

typedef word *	reverse_iterator
	Reverse iterator for reverse traversal of FixedList. More...

typedef const word *	const_reverse_iterator
	Reverse iterator for reverse traversal of constant FixedList. 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, Size > &	null ()
	Return a null FixedList. More...

Detailed Description

Source files

phasePairKey.H

Source files

phasePairKey.H

Definition at line 57 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.

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

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

Classes

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ phasePairKey() [1/4]

◆ phasePairKey() [2/4]

◆ ~phasePairKey() [1/2]

◆ phasePairKey() [3/4]

◆ phasePairKey() [4/4]

◆ ~phasePairKey() [2/2]

Member Function Documentation

◆ ordered()

Friends And Related Function Documentation

◆ operator== [1/2]

◆ operator!= [1/2]

◆ operator>> [1/2]

◆ operator<< [1/2]

◆ operator== [2/2]

◆ operator!= [2/2]

◆ operator>> [2/2]

◆ operator<< [2/2]