FreeFOAM The Cross-Platform CFD Toolkit
multiphaseMixture::interfacePair Class Reference

#include <applications/solvers/multiphase/multiphaseInterFoam/multiphaseMixture/multiphaseMixture.H>


Detailed Description

Definition at line 68 of file multiphaseMixture.H.

+ Inheritance diagram for multiphaseMixture::interfacePair:
+ Collaboration diagram for multiphaseMixture::interfacePair:

List of all members.

Classes

class  hash

Public Member Functions

 interfacePair ()
 interfacePair (const word &alpha1Name, const word &alpha2Name)
 interfacePair (const phase &alpha1, const phase &alpha2)
- Public Member Functions inherited from Pair< word >
 Pair ()
 Null constructor.
 Pair (const word &f, const word &s)
 Construct from components.
 Pair (Istream &is)
 Construct from Istream.
const wordfirst () const
 Return first.
wordfirst ()
 Return first.
const wordsecond () const
 Return second.
wordsecond ()
 Return second.
Pair< wordreversePair () const
 Return reverse pair.
const wordother (const word &a) const
 Return other.
- Public Member Functions inherited from FixedList< word, 2 >
 FixedList ()
 Null constructor.
 FixedList (const wordv[Size])
 Construct from components.
 FixedList (const word &)
 Construct from value.
 FixedList (const UList< word > &)
 Construct from UList.
 FixedList (const SLList< word > &)
 Construct from SLList.
 FixedList (const FixedList< word, Size > &)
 Copy constructor.
 FixedList (Istream &)
 Construct from Istream.
autoPtr< FixedList< word, Size > > clone () const
 Clone.
label fcIndex (const label i) const
 Return the forward circular index, i.e. the next index.
label rcIndex (const label i) const
 Return the reverse circular index, i.e. the previous index.
const wordcdata () const
 Return a const pointer to the first data element,.
worddata ()
 Return a pointer to the first data element,.
void checkStart (const label start) const
 Check start is within valid range (0 ... size-1).
void checkSize (const label size) const
 Check size is within valid range (0 ... size).
void checkIndex (const label i) const
 Check index i is within valid range (0 ... size-1).
void resize (const label)
 Dummy resize function.
void setSize (const label)
 Dummy setSize function.
void transfer (const FixedList< word, Size > &)
 Copy (not transfer) the argument contents.
void writeEntry (Ostream &) const
 Write the FixedList as a dictionary entry.
void writeEntry (const word &keyword, Ostream &) const
 Write the FixedList as a dictionary entry with keyword.
wordoperator[] (const label)
 Return element of FixedList.
const wordoperator[] (const label) const
 Return element of constant FixedList.
void operator= (const wordv[Size])
 Assignment from array operator. Takes linear time.
void operator= (const UList< word > &)
 Assignment from UList operator. Takes linear time.
void operator= (const SLList< word > &)
 Assignment from SLList operator. Takes linear time.
void operator= (const word &)
 Assignment of all entries to the given value.
iterator begin ()
 Return an iterator to begin traversing the FixedList.
const_iterator begin () const
 Return const_iterator to begin traversing the constant FixedList.
iterator end ()
 Return an iterator to end traversing the FixedList.
const_iterator end () const
 Return const_iterator to end traversing the constant FixedList.
const_iterator cbegin () const
 Return const_iterator to begin traversing the constant FixedList.
const_iterator cend () const
 Return const_iterator to end traversing the constant FixedList.
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the FixedList.
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing FixedList.
reverse_iterator rend ()
 Return reverse_iterator to end reverse traversing the FixedList.
const_reverse_iterator rend () const
 Return const_reverse_iterator to end reverse traversing FixedList.
const_reverse_iterator crbegin () const
 Return const_reverse_iterator to begin reverse traversing FixedList.
const_reverse_iterator crend () const
 Return const_reverse_iterator to end reverse traversing FixedList.
label size () const
 Return the number of elements in the FixedList.
label max_size () const
 Return size of the largest possible FixedList.
bool empty () const
 Return true if the FixedList is empty (ie, size() is zero).
void swap (FixedList< word, Size > &)
 Swap two FixedLists of the same type in constant time.
bool operator== (const FixedList< word, Size > &) const
 Equality operation on FixedLists of the same type.
bool operator!= (const FixedList< word, Size > &) const
 The opposite of the equality operation. Takes linear time.
bool operator< (const FixedList< word, Size > &) const
 Compare two FixedLists lexicographically. Takes linear time.
bool operator> (const FixedList< word, Size > &) const
 Compare two FixedLists lexicographically. Takes linear time.
bool operator<= (const FixedList< word, Size > &) const
 Return true if !(a > b). Takes linear time.
bool operator>= (const FixedList< word, Size > &) const
 Return true if !(a < b). Takes linear time.

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
- Static Public Member Functions inherited from FixedList< word, 2 >
static const FixedList< word,
Size > & 
null ()
 Return a null FixedList.

Constructor & Destructor Documentation

interfacePair ( )
inline

Definition at line 92 of file multiphaseMixture.H.

interfacePair ( const word alpha1Name,
const word alpha2Name 
)
inline

Definition at line 95 of file multiphaseMixture.H.

interfacePair ( const phase alpha1,
const phase alpha2 
)
inline

Definition at line 100 of file multiphaseMixture.H.


Friends And Related Function Documentation

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

Definition at line 109 of file multiphaseMixture.H.

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

Definition at line 122 of file multiphaseMixture.H.


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