Inheritance diagram for phasePair:

Collaboration diagram for phasePair:

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

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

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

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

const phaseModel &	phase2 () const

const uniformDimensionedVectorField &	g () const

	phasePair (const phaseModel &phase1, const phaseModel &phase2, const dimensionedVector &g, const scalarTable &sigmaTable, const bool ordered=false)
	Construct from two phases, gravity and surface tension table. 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...

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 >	Mo () const
	Morton Number. More...

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

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

const phaseModel &	phase1 () const

const phaseModel &	phase2 () const

const dimensionedVector &	g () const

const dimensionedScalar &	sigma () const

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

	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 (const FixedList< word, Size > &)
	Copy constructor. 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...

void	writeEntry (Ostream &) const
	Write the FixedList as a dictionary entry. More...

void	writeEntry (const word &keyword, Ostream &) const
	Write the FixedList as a dictionary entry with keyword. 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 [1/2]

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

Dictionary hash table.

Definition at line 59 of file phasePair.H.

◆ scalarTable [1/2]

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

Scalar hash table.

Definition at line 63 of file phasePair.H.

◆ dictTable [2/2]

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

Dictionary hash table.

Definition at line 58 of file phasePair.H.

◆ scalarTable [2/2]

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

Scalar hash table.

Definition at line 62 of file phasePair.H.

Constructor & Destructor Documentation

◆ phasePair() [1/2]

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

Construct from two phases and gravity.

◆ ~phasePair() [1/2]

virtual ~phasePair ( )

virtual

Destructor.

◆ phasePair() [2/2]

phasePair	(	const phaseModel &	phase1,
		const phaseModel &	phase2,
		const dimensionedVector &	g,
		const scalarTable &	sigmaTable,
		const bool	ordered = `false`
	)

Construct from two phases, gravity and surface tension table.

◆ ~phasePair() [2/2]

virtual ~phasePair ( )

virtual

Destructor.

Member Function Documentation

◆ dispersed() [1/2]

virtual const phaseModel& dispersed ( ) const

virtual

Dispersed phase.

Reimplemented in orderedPhasePair, and orderedPhasePair.

◆ continuous() [1/2]

virtual const phaseModel& continuous ( ) const

virtual

Continuous phase.

Reimplemented in orderedPhasePair, and orderedPhasePair.

◆ name() [1/2]

virtual word name ( ) const

virtual

Pair name.

Reimplemented in orderedPhasePair, and orderedPhasePair.

◆ rho() [1/2]

tmp<volScalarField> rho ( ) const

Average density.

◆ magUr() [1/2]

tmp<volScalarField> magUr ( ) const

Relative velocity magnitude.

◆ Ur() [1/2]

tmp<volVectorField> Ur ( ) const

Relative velocity.

◆ Re() [1/2]

tmp<volScalarField> Re ( ) const

Reynolds number.

◆ Pr() [1/2]

tmp<volScalarField> Pr ( ) const

Prandtl number.

◆ Eo() [1/2]

tmp<volScalarField> Eo ( ) const

Eotvos number.

◆ EoH1() [1/2]

tmp<volScalarField> EoH1 ( ) const

Eotvos number based on hydraulic diameter type 1.

◆ EoH2() [1/2]

tmp<volScalarField> EoH2 ( ) const

Eotvos number based on hydraulic diameter type 2.

◆ sigma() [1/2]

const Foam::dimensionedScalar & sigma ( ) const

inline

Surface tension coefficient.

Definition at line 46 of file phasePairI.H.

◆ Mo() [1/2]

tmp<volScalarField> Mo ( ) const

Morton Number.

◆ Ta() [1/2]

tmp<volScalarField> Ta ( ) const

Takahashi Number.

◆ E() [1/2]

virtual tmp<volScalarField> E ( ) const

virtual

Aspect ratio.

Reimplemented in orderedPhasePair, and orderedPhasePair.

◆ phase1() [1/2]

const Foam::phaseModel & phase1 ( ) const

inline

Definition at line 28 of file phasePairI.H.

◆ phase2() [1/2]

const Foam::phaseModel & phase2 ( ) const

inline

Definition at line 34 of file phasePairI.H.

◆ g() [1/2]

const Foam::dimensionedVector & g ( ) const

inline

Definition at line 40 of file phasePairI.H.

◆ dispersed() [2/2]

virtual const phaseModel& dispersed ( ) const

virtual

Dispersed phase.

Reimplemented in orderedPhasePair, and orderedPhasePair.

◆ continuous() [2/2]

virtual const phaseModel& continuous ( ) const

virtual

Continuous phase.

Reimplemented in orderedPhasePair, and orderedPhasePair.

◆ name() [2/2]

virtual word name ( ) const

virtual

Pair name.

Reimplemented in orderedPhasePair, and orderedPhasePair.

◆ rho() [2/2]

tmp<volScalarField> rho ( ) const

Average density.

◆ magUr() [2/2]

tmp<volScalarField> magUr ( ) const

Relative velocity magnitude.

◆ Ur() [2/2]

tmp<volVectorField> Ur ( ) const

Relative velocity.

◆ Re() [2/2]

tmp<volScalarField> Re ( ) const

Reynolds number.

◆ Pr() [2/2]

tmp<volScalarField> Pr ( ) const

Prandtl number.

◆ Eo() [2/2]

tmp<volScalarField> Eo ( ) const

Eotvos number.

◆ EoH1() [2/2]

tmp<volScalarField> EoH1 ( ) const

Eotvos number based on hydraulic diameter type 1.

◆ EoH2() [2/2]

tmp<volScalarField> EoH2 ( ) const

Eotvos number based on hydraulic diameter type 2.

◆ Mo() [2/2]

tmp<volScalarField> Mo ( ) const

Morton Number.

◆ Ta() [2/2]

tmp<volScalarField> Ta ( ) const

Takahashi Number.

◆ E() [2/2]

virtual tmp<volScalarField> E ( ) const

virtual

Aspect ratio.

Reimplemented in orderedPhasePair, and orderedPhasePair.

◆ phase1() [2/2]

const phaseModel& phase1 ( ) const

inline

◆ phase2() [2/2]

const phaseModel& phase2 ( ) const

inline

◆ g() [2/2]

const dimensionedVector& g ( ) const

inline

◆ sigma() [2/2]

const dimensionedScalar& sigma ( ) const

inline

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

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

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ dictTable [1/2]

◆ scalarTable [1/2]

◆ dictTable [2/2]

◆ scalarTable [2/2]

Constructor & Destructor Documentation

◆ phasePair() [1/2]

◆ ~phasePair() [1/2]

◆ phasePair() [2/2]

◆ ~phasePair() [2/2]

Member Function Documentation

◆ dispersed() [1/2]

◆ continuous() [1/2]

◆ name() [1/2]

◆ rho() [1/2]

◆ magUr() [1/2]

◆ Ur() [1/2]

◆ Re() [1/2]

◆ Pr() [1/2]

◆ Eo() [1/2]

◆ EoH1() [1/2]

◆ EoH2() [1/2]

◆ sigma() [1/2]

◆ Mo() [1/2]

◆ Ta() [1/2]

◆ E() [1/2]

◆ phase1() [1/2]

◆ phase2() [1/2]

◆ g() [1/2]

◆ dispersed() [2/2]

◆ continuous() [2/2]

◆ name() [2/2]

◆ rho() [2/2]

◆ magUr() [2/2]

◆ Ur() [2/2]

◆ Re() [2/2]

◆ Pr() [2/2]

◆ Eo() [2/2]

◆ EoH1() [2/2]

◆ EoH2() [2/2]

◆ Mo() [2/2]

◆ Ta() [2/2]

◆ E() [2/2]

◆ phase1() [2/2]

◆ phase2() [2/2]

◆ g() [2/2]

◆ sigma() [2/2]