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 Types inherited from FixedList< word, 2 >
typedef word	value_type
	The value type the FixedList contains. More...

typedef word *	pointer
	The pointer type for non-const access to value_type items. More...

typedef const word *	const_pointer
	The pointer type for const access to value_type items. More...

typedef word &	reference
	The type used for storing into value_type objects. More...

typedef const word &	const_reference
	The type used for reading from constant value_type objects. More...

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

typedef const word *	const_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< iterator >	reverse_iterator
	Reverse iterator (non-const access) More...

typedef std::reverse_iterator< const_iterator >	const_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...

void	front ()=delete
	The front() accessor (from FixedList) has no purpose. More...

void	back ()=delete
	The back() accessor (from FixedList) has no purpose. More...

const word &	first () const noexcept
	Access the first element. More...

word &	first () noexcept
	Access the first element. More...

const word &	second () const noexcept
	Access the second element. More...

word &	second () noexcept
	Access the second element. More...

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

bool	is_sorted () const
	True if first() is less-than-equal second() More...

void	flip ()
	Flip the Pair in-place. More...

void	sort ()
	Sort so that first() is less-than second() More...

bool	sorted () const
	Deprecated(2023-07) Use is_sorted() method. More...

Public Member Functions inherited from FixedList< word, 2 >
void	writeEntry (const word &keyword, Ostream &os) const
	Write the list as a dictionary entry with keyword. More...

	FixedList ()=default
	Default construct. More...

	FixedList (const word &val)
	Construct and initialize all entries to given value. More...

	FixedList (const Foam::zero)
	Construct and initialize all entries to zero. More...

	FixedList (const FixedList< word, N > &list)
	Copy construct. More...

	FixedList (FixedList< word, N > &&list)
	Move construct by using move assignment for the individual list elements. More...

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

	FixedList (const UList< word > &list)
	Construct from UList. Runtime size check. More...

	FixedList (const FixedList< word, AnyNum > &list, const FixedList< label, N > &indices)
	Copy construct from a subset of the input. No size check. More...

	FixedList (const UList< word > &list, const FixedList< label, N > &indices)
	Copy construct from a subset of the input. No size check. More...

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

	FixedList (const word list[N])
	Deprecated: copy construct from C-array. More...

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

const word *	cdata () const noexcept
	Return pointer to the underlying array serving as data storage. More...

word *	data () 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...

word &	get () noexcept
	Element access using compile-time indexing. More...

const word &	get () const noexcept
	Element access using compile-time indexing. More...

word &	front () noexcept
	Access first element of the list, position [0]. More...

const word &	front () const noexcept
	Access first element of the list, position [0]. More...

word &	back () noexcept
	Access last element of the list, position [N-1]. More...

const word &	back () const noexcept
	Access last element of the list, position [N-1]. More...

label	fcIndex (const label i) const noexcept
	Return the forward circular index, i.e. next index which returns to the first at the end of the list. More...

const word &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list) More...

word &	fcValue (const label i)
	Return forward circular value (ie, next value in the list) More...

label	rcIndex (const label i) const noexcept
	Return the reverse circular index, i.e. previous index which returns to the last at the beginning of the list. More...

const word &	rcValue (const label i) const
	Return reverse circular value (ie, previous value in the list) More...

word &	rcValue (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...

bool	contains (const word &val) const
	True if the value is contained in the list. More...

bool	contains (const word &val, label pos, label len=-1) const
	Is the value contained in the list? More...

label	find (const word &val) const
	Find index of the first occurrence of the value. More...

label	find (const word &val, label pos, label len=-1) const
	Find index of the first occurrence of the value. More...

label	rfind (const word &val, label pos=-1) const
	Find index of the last occurrence of the value. More...

void	resize (const label n)
	Dummy function, to make FixedList consistent with List Any resizing is ignored (Fatal with bad sizing in full debug). More...

void	resize_fill (const label n, const word &val)
	Set val for all elements. Any resizing is ignored (Fatal with bad sizing in full debug). More...

void	resize_nocopy (const label n)
	Dummy function, to make FixedList consistent with List Any resizing is ignored (Fatal with bad sizing in full debug). More...

void	setSize (const label n)
	Dummy function, to make FixedList consistent with List. More...

void	fill (const word &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< word, N > &list)
	Transfer by swapping using a move assignment for the content of the individual list elements. More...

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

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

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

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

void	operator= (const word &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< word, N > &list)
	Copy assignment. More...

void	operator= (FixedList< word, N > &&list)
	Move assignment. More...

void	operator= (const word list[N])
	Deprecated: assignment from C-array. More...

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

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

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

const_iterator	end () const noexcept
	Return const_iterator to end traversing the constant 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...

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

void	swap (FixedList< word, N > &other)
	Swap lists by swapping the content of the individual list elements. More...

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

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

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

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

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

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

Istream &	readList (Istream &is)
	Read from Istream, discarding contents of existing List. More...

Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen. More...

word &	first () noexcept
	Access first element of the list, position [0] - front() More...

const word &	first () const noexcept
	Access first element of the list, position [0] - front() More...

word &	last () noexcept
	Access last element of the list, position [N-1] - back() More...

const word &	last () const noexcept
	Access last element of the list, position [N-1] - back() More...

bool	found (const word &val, label pos=0) const
	Same as contains() 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...

Static Public Member Functions inherited from FixedList< word, 2 >
static const FixedList< word, 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 ()
	Number of contiguous bytes for the list data, runtime FatalError if type is not contiguous. More...

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< word, 2 >
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 61 of file phasePairKey.H.

Member Typedef Documentation

◆ hash [1/3]

using hash = phasePairKey::hasher

Alternative name for functor.

Definition at line 156 of file phasePairKey.H.

◆ hash [2/3]

using hash = phasePairKey::hasher

Alternative name for functor.

Definition at line 156 of file phasePairKey.H.

◆ hash [3/3]

using hash = phasePairKey::hasher

Alternative name for functor.

Definition at line 156 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 27 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 104 of file phasePairKey.H.

Here is the caller graph for this function:

◆ ordered() [2/3]

bool ordered ( ) const

inlinenoexcept

Return the ordered flag.

Definition at line 104 of file phasePairKey.H.

◆ ordered() [3/3]

bool ordered ( ) const

inlinenoexcept

Return the ordered flag.

Definition at line 104 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

Classes

Public Types

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ hash [1/3]

◆ hash [2/3]

◆ hash [3/3]

Constructor & Destructor Documentation

◆ phasePairKey() [1/6]

◆ phasePairKey() [2/6]

◆ ~phasePairKey() [1/3]

◆ phasePairKey() [3/6]

◆ phasePairKey() [4/6]

◆ ~phasePairKey() [2/3]

◆ phasePairKey() [5/6]

◆ phasePairKey() [6/6]

◆ ~phasePairKey() [3/3]

Member Function Documentation

◆ ordered() [1/3]

◆ ordered() [2/3]

◆ ordered() [3/3]

Friends And Related Function Documentation

◆ operator== [1/3]

◆ operator!= [1/3]

◆ operator>> [1/3]

◆ operator<< [1/3]

◆ operator== [2/3]

◆ operator!= [2/3]

◆ operator>> [2/3]

◆ operator<< [2/3]

◆ operator== [3/3]

◆ operator!= [3/3]

◆ operator>> [3/3]

◆ operator<< [3/3]