Inheritance diagram for phasePair:

Collaboration diagram for phasePair:

Classes
class	const_iterator
	STL const_iterator. More...

Public Types
typedef HashTable< dictionary, phasePairKey, phasePairKey::hash >	dictTable
	Dictionary hash table. More...

typedef HashTable< scalar, phasePairKey, phasePairKey::hash >	scalarTable
	Scalar hash table. More...

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

Public Member Functions
	phasePair (const phaseModel &phase1, const phaseModel &phase2, const bool ordered=false)
	Construct from two phases and gravity. More...

virtual	~phasePair ()
	Destructor. More...

virtual const phaseModel &	dispersed () const
	Dispersed phase. More...

virtual const phaseModel &	continuous () const
	Continuous phase. More...

virtual word	name () const
	Pair name. More...

virtual word	otherName () const
	Other pair name. More...

tmp< volScalarField >	rho () const
	Average density. More...

tmp< volScalarField >	magUr () const
	Relative velocity magnitude. More...

tmp< volVectorField >	Ur () const
	Relative velocity. More...

tmp< volScalarField >	Re () const
	Reynolds number. More...

tmp< volScalarField >	Pr () const
	Prandtl number. More...

tmp< volScalarField >	Eo () const
	Eotvos number. More...

tmp< volScalarField >	EoH1 () const
	Eotvos number based on hydraulic diameter type 1. More...

tmp< volScalarField >	EoH2 () const
	Eotvos number based on hydraulic diameter type 2. More...

tmp< volScalarField >	sigma () const
	Surface tension coefficient. More...

tmp< volScalarField >	Mo () const
	Morton Number. More...

tmp< volScalarField >	Ta () const
	Takahashi Number. More...

virtual tmp< volScalarField >	E () const
	Aspect ratio. More...

const phaseModel &	phase1 () const
	Return phase 1. More...

const phaseModel &	phase2 () const
	Return phase 2. More...

bool	contains (const phaseModel &phase) const
	Return true if this phasePair contains the given phase. More...

const phaseModel &	otherPhase (const phaseModel &phase) const
	Return the other phase relative to the given phase. More...

label	index (const phaseModel &phase) const
	Return the index of the given phase. Generates a FatalError if. More...

const uniformDimensionedVectorField &	g () const
	Return gravitation acceleration. More...

const fvMesh &	mesh () const
	Return the mesh. More...

const_iterator	cbegin () const
	const_iterator set to the beginning of the pair More...

const_iterator	cend () const
	const_iterator set to beyond the end of the pair More...

const_iterator	begin () const
	const_iterator set to the beginning of the pair More...

const_iterator	end () const
	const_iterator set to beyond the end of the pair More...

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

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

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, Size > &	null ()
	Return a null FixedList. More...

Detailed Description

Source files

Definition at line 49 of file phasePair.H.

Member Typedef Documentation

◆ dictTable

typedef HashTable<dictionary, phasePairKey, phasePairKey::hash> dictTable

Dictionary hash table.

Definition at line 59 of file phasePair.H.

◆ scalarTable

typedef HashTable<scalar, phasePairKey, phasePairKey::hash> scalarTable

Scalar hash table.

Definition at line 63 of file phasePair.H.

Constructor & Destructor Documentation

◆ phasePair()

phasePair	(	const phaseModel &	phase1,
		const phaseModel &	phase2,
		const bool	ordered = `false`
	)

Construct from two phases and gravity.

◆ ~phasePair()

virtual ~phasePair ( )

virtual

Destructor.

Member Function Documentation

◆ dispersed()

virtual const phaseModel& dispersed ( ) const

virtual

Dispersed phase.

Reimplemented in orderedPhasePair.

◆ continuous()

virtual const phaseModel& continuous ( ) const

virtual

Continuous phase.

Reimplemented in orderedPhasePair.

◆ name()

virtual word name ( ) const

virtual

Pair name.

Reimplemented in orderedPhasePair.

◆ otherName()

virtual word otherName ( ) const

virtual

Other pair name.

Reimplemented in orderedPhasePair.

◆ rho()

tmp<volScalarField> rho ( ) const

Average density.

◆ magUr()

tmp<volScalarField> magUr ( ) const

Relative velocity magnitude.

◆ Ur()

tmp<volVectorField> Ur ( ) const

Relative velocity.

◆ Re()

tmp<volScalarField> Re ( ) const

Reynolds number.

◆ Pr()

tmp<volScalarField> Pr ( ) const

Prandtl number.

◆ Eo()

tmp<volScalarField> Eo ( ) const

Eotvos number.

◆ EoH1()

tmp<volScalarField> EoH1 ( ) const

Eotvos number based on hydraulic diameter type 1.

◆ EoH2()

tmp<volScalarField> EoH2 ( ) const

Eotvos number based on hydraulic diameter type 2.

◆ sigma()

tmp<volScalarField> sigma ( ) const

Surface tension coefficient.

◆ Mo()

tmp<volScalarField> Mo ( ) const

Morton Number.

◆ Ta()

tmp<volScalarField> Ta ( ) const

Takahashi Number.

◆ E()

virtual tmp<volScalarField> E ( ) const

virtual

Aspect ratio.

Reimplemented in orderedPhasePair.

◆ phase1()

const Foam::phaseModel & phase1 ( ) const

inline

Return phase 1.

Definition at line 28 of file phasePairI.H.

Referenced by populationBalanceModel::isVelocityGroupPair().

Here is the caller graph for this function:

◆ phase2()

const Foam::phaseModel & phase2 ( ) const

inline

Return phase 2.

Definition at line 34 of file phasePairI.H.

Referenced by populationBalanceModel::isVelocityGroupPair().

Here is the caller graph for this function:

◆ contains()

bool contains ( const phaseModel & phase ) const

inline

Return true if this phasePair contains the given phase.

Definition at line 40 of file phasePairI.H.

References phasePair::otherPhase().

Here is the call graph for this function:

◆ otherPhase()

const Foam::phaseModel & otherPhase ( const phaseModel & phase ) const

inline

Return the other phase relative to the given phase.

Generates a FatalError if this phasePair does not contain the given phase

Definition at line 47 of file phasePairI.H.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and phaseModel::name().

Referenced by phasePair::contains().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ index()

Foam::label index ( const phaseModel & phase ) const

inline

Return the index of the given phase. Generates a FatalError if.

this phasePair does not contain the given phase

Definition at line 70 of file phasePairI.H.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and phaseModel::name().

Referenced by phasePair::mesh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ g()

const Foam::uniformDimensionedVectorField & g ( ) const

inline

Return gravitation acceleration.

Definition at line 91 of file phasePairI.H.

◆ mesh()

const Foam::fvMesh & mesh ( ) const

inline

Return the mesh.

Definition at line 97 of file phasePairI.H.

References phasePair::index(), and DimensionedField< Type, GeoMesh >::mesh().

Here is the call graph for this function:

◆ cbegin()

Foam::phasePair::const_iterator cbegin ( ) const

inline

const_iterator set to the beginning of the pair

Definition at line 198 of file phasePairI.H.

◆ cend()

Foam::phasePair::const_iterator cend ( ) const

inline

const_iterator set to beyond the end of the pair

Definition at line 204 of file phasePairI.H.

◆ begin()

Foam::phasePair::const_iterator begin ( ) const

inline

const_iterator set to the beginning of the pair

Definition at line 210 of file phasePairI.H.

◆ end()

Foam::phasePair::const_iterator end ( ) const

inline

const_iterator set to beyond the end of the pair

Definition at line 216 of file phasePairI.H.

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

applications/solvers/multiphase/multiphaseEulerFoam/phaseSystems/phasePair/phasePair/phasePair.H
applications/solvers/multiphase/multiphaseEulerFoam/phaseSystems/phasePair/phasePair/phasePairI.H

Classes

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ dictTable

◆ scalarTable

Constructor & Destructor Documentation

◆ phasePair()

◆ ~phasePair()

Member Function Documentation

◆ dispersed()

◆ continuous()

◆ name()

◆ otherName()

◆ rho()

◆ magUr()

◆ Ur()

◆ Re()

◆ Pr()

◆ Eo()

◆ EoH1()

◆ EoH2()

◆ sigma()

◆ Mo()

◆ Ta()

◆ E()

◆ phase1()

◆ phase2()

◆ contains()

◆ otherPhase()

◆ index()

◆ g()

◆ mesh()

◆ cbegin()

◆ cend()

◆ begin()

◆ end()