phasePair Class Reference

Description for mass transfer between a pair of phases. The direction of the mass transfer is from the phase 'from' to the phasse 'to'. More...

Inheritance diagram for phasePair:

Collaboration diagram for phasePair:

Classes
class	const_iterator

Public Types
typedef HashTable< dictionary, phasePairKey, phasePairKey::hash >	dictTable
typedef HashTable< scalar, phasePairKey, phasePairKey::hash >	scalarTable
typedef HashTable< dictionary, phasePairKey, phasePairKey::hash >	dictTable
typedef HashTable< scalar, phasePairKey, phasePairKey::hash >	scalarTable
Public Types inherited from phasePairKey
using	hash = phasePairKey::hasher
using	hash = phasePairKey::hasher
using	hash = phasePairKey::hasher

Public Member Functions
	phasePair (const phaseModel &phase1, const phaseModel &phase2, const bool ordered=false)
virtual	~phasePair ()=default
virtual const phaseModel &	from () const
virtual const phaseModel &	to () const
virtual word	name () const
const phaseModel &	phase1 () const
const phaseModel &	phase2 () const
	phasePair (const phaseModel &phase1, const phaseModel &phase2, const bool ordered=false)
virtual	~phasePair ()
virtual const phaseModel &	dispersed () const
virtual const phaseModel &	continuous () const
virtual word	name () const
virtual word	otherName () const
tmp< volScalarField >	rho () const
tmp< volScalarField >	magUr () const
tmp< volVectorField >	Ur () const
tmp< volScalarField >	Re () const
tmp< volScalarField >	Pr () const
tmp< volScalarField >	Eo () const
tmp< volScalarField >	EoH1 () const
tmp< volScalarField >	EoH2 () const
tmp< volScalarField >	sigma () const
tmp< volScalarField >	Mo () const
tmp< volScalarField >	Ta () const
virtual tmp< volScalarField >	E () const
const phaseModel &	phase1 () const
const phaseModel &	phase2 () const
bool	contains (const phaseModel &phase) const
const phaseModel &	otherPhase (const phaseModel &phase) const
label	index (const phaseModel &phase) const
const uniformDimensionedVectorField &	g () const
const_iterator	cbegin () const
const_iterator	cend () const
const_iterator	begin () const
const_iterator	end () const
	phasePair (const phaseModel &phase1, const phaseModel &phase2, const dimensionedVector &g, const scalarTable &sigmaTable, const bool ordered=false)
virtual	~phasePair ()
virtual const phaseModel &	dispersed () const
virtual const phaseModel &	continuous () const
virtual word	name () const
tmp< volScalarField >	rho () const
tmp< volScalarField >	magUr () const
tmp< volVectorField >	Ur () const
tmp< volScalarField >	Re () const
tmp< volScalarField >	Pr () const
tmp< volScalarField >	Eo () const
tmp< volScalarField >	EoH1 () const
tmp< volScalarField >	EoH2 () const
tmp< volScalarField >	Mo () const
tmp< volScalarField >	Ta () const
virtual tmp< volScalarField >	E () const
const phaseModel &	phase1 () const
const phaseModel &	phase2 () const
const dimensionedVector &	g () const
const dimensionedScalar &	sigma () const
Public Member Functions inherited from phasePairKey
	phasePairKey ()=default
	phasePairKey (const word &name1, const word &name2, const bool ordered=false)
virtual	~phasePairKey ()=default
bool	ordered () const noexcept
	phasePairKey ()=default
	phasePairKey (const word &name1, const word &name2, const bool ordered=false)
virtual	~phasePairKey ()=default
bool	ordered () const noexcept
	phasePairKey ()=default
	phasePairKey (const word &name1, const word &name2, const bool ordered=false)
virtual	~phasePairKey ()=default
bool	ordered () const noexcept
Public Member Functions inherited from Pair< word >
	Pair ()=default
	Pair (const T &f, const T &s)
	Pair (T &&f, T &&s)
	Pair (const std::pair< T, T > &vals)
	Pair (std::pair< T, T > &&vals)
	Pair (const FixedList< T, 2 > &list)
	Pair (const T &f, const T &s, const bool doSort)
	Pair (const FixedList< T, 2 > &list, const bool doSort)
	Pair (Istream &is)
const T &	second () const noexcept
T &	second () noexcept
const T &	other (const T &a) const
bool	sorted () const
void	flip ()
void	sort ()

Additional Inherited Members
Static Public Member Functions inherited from Pair< word >
static int	compare (const Pair< T > &a, const Pair< T > &b)

Detailed Description

Description for mass transfer between a pair of phases. The direction of the mass transfer is from the phase 'from' to the phasse 'to'.

Source files

• phasePair.H
• phasePair.C

Source files

• phasePair.H
• phasePair.C

Source files

• phasePair.H
• phasePair.C

Definition at line 49 of file phasePair.H.

Member Typedef Documentation

dictTable [1/2]

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

Definition at line 57 of file phasePair.H.

scalarTable [1/2]

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

Definition at line 61 of file phasePair.H.

dictTable [2/2]

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

Definition at line 56 of file phasePair.H.

scalarTable [2/2]

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

Definition at line 60 of file phasePair.H.

Constructor & Destructor Documentation

phasePair() [1/3]

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

Definition at line 28 of file phasePair.C.

~phasePair() [1/3]

~phasePair ( )

virtualdefault

Definition at line 59 of file phasePair.C.

phasePair() [2/3]

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

~phasePair() [2/3]

virtual ~phasePair ( )

virtual

phasePair() [3/3]

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

Definition at line 41 of file phasePair.C.

~phasePair() [3/3]

virtual ~phasePair ( )

virtual

Member Function Documentation

from()

const Foam::phaseModel & from ( ) const

virtual

Reimplemented in orderedPhasePair.

Definition at line 42 of file phasePair.C.

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

Referenced by interfaceHeatResistance< Thermo, OtherThermo >::Kexp(), kineticGasEvaporation< Thermo, OtherThermo >::Kexp(), and interfaceOxideRate< Thermo, OtherThermo >::Kexp().

Here is the call graph for this function:

Here is the caller graph for this function:

to()

const Foam::phaseModel & to ( ) const

virtual

Reimplemented in orderedPhasePair.

Definition at line 52 of file phasePair.C.

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

Referenced by interfaceHeatResistance< Thermo, OtherThermo >::Kexp(), kineticGasEvaporation< Thermo, OtherThermo >::Kexp(), and interfaceOxideRate< Thermo, OtherThermo >::Kexp().

Here is the call graph for this function:

Here is the caller graph for this function:

name() [1/3]

Foam::word name ( ) const

virtual

Reimplemented in orderedPhasePair, orderedPhasePair, and orderedPhasePair.

Definition at line 62 of file phasePair.C.

Referenced by phaseChange::addToDriftRate(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::InterfaceCompositionPhaseChangePhaseSystem(), MomentumTransferPhaseSystem< BasePhaseSystem >::MomentumTransferPhaseSystem(), phaseChange::phaseChange(), PopulationBalancePhaseSystem< BasePhaseSystem >::PopulationBalancePhaseSystem(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::ThermalPhaseChangePhaseSystem(), and TwoResistanceHeatTransferPhaseSystem< BasePhaseSystem >::TwoResistanceHeatTransferPhaseSystem().

Here is the caller graph for this function:

phase1() [1/3]

const Foam::phaseModel & phase1 ( ) const

inline

Definition at line 23 of file phasePairI.H.

Referenced by MassTransferPhaseSystem< BasePhaseSystem >::alphaTransfer(), turbulentDispersionModel::continuousTurbulence(), TwoResistanceHeatTransferPhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), PopulationBalancePhaseSystem< BasePhaseSystem >::dmdts(), PhaseTransferPhaseSystem< BasePhaseSystem >::dmdts(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::dmdts(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::dmdts(), orderedPhasePair::from(), OneResistanceHeatTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), TwoResistanceHeatTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::heatTransfer(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::InterfaceCompositionPhaseChangePhaseSystem(), PopulationBalancePhaseSystem< BasePhaseSystem >::massTransfer(), PhaseTransferPhaseSystem< BasePhaseSystem >::massTransfer(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::massTransfer(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::massTransfer(), interfaceCompositionModel::New(), phaseForces::nonDragForce(), NonRandomTwoLiquid< Thermo, OtherThermo >::NonRandomTwoLiquid(), MomentumTransferPhaseSystem< BasePhaseSystem >::partialElimination(), MomentumTransferPhaseSystem< BasePhaseSystem >::partialEliminationf(), MomentumTransferPhaseSystem< BasePhaseSystem >::phiFfs(), MomentumTransferPhaseSystem< BasePhaseSystem >::phiFs(), constantSurfaceTensionCoefficient::sigma(), TwoResistanceHeatTransferPhaseSystem< BasePhaseSystem >::TwoResistanceHeatTransferPhaseSystem(), and MassTransferPhaseSystem< BasePhaseSystem >::volTransfer().

Here is the caller graph for this function:

phase2() [1/3]

const Foam::phaseModel & phase2 ( ) const

inline

Definition at line 29 of file phasePairI.H.

Referenced by MassTransferPhaseSystem< BasePhaseSystem >::alphaTransfer(), TwoResistanceHeatTransferPhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), PopulationBalancePhaseSystem< BasePhaseSystem >::dmdts(), PhaseTransferPhaseSystem< BasePhaseSystem >::dmdts(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::dmdts(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::dmdts(), OneResistanceHeatTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), TwoResistanceHeatTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::heatTransfer(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::InterfaceCompositionPhaseChangePhaseSystem(), PopulationBalancePhaseSystem< BasePhaseSystem >::massTransfer(), PhaseTransferPhaseSystem< BasePhaseSystem >::massTransfer(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::massTransfer(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::massTransfer(), interfaceCompositionModel::New(), MomentumTransferPhaseSystem< BasePhaseSystem >::partialElimination(), MomentumTransferPhaseSystem< BasePhaseSystem >::partialEliminationf(), MomentumTransferPhaseSystem< BasePhaseSystem >::phiFfs(), MomentumTransferPhaseSystem< BasePhaseSystem >::phiFs(), TwoResistanceHeatTransferPhaseSystem< BasePhaseSystem >::TwoResistanceHeatTransferPhaseSystem(), and MassTransferPhaseSystem< BasePhaseSystem >::volTransfer().

Here is the caller graph for this function:

dispersed() [1/2]

const Foam::phaseModel & dispersed ( ) const

virtual

Reimplemented in orderedPhasePair, and orderedPhasePair.

Definition at line 65 of file phasePair.C.

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

Referenced by wallLubricationModel::F(), linear::limiter(), sine::limiter(), and cosine::limiter().

Here is the call graph for this function:

Here is the caller graph for this function:

continuous() [1/2]

const Foam::phaseModel & continuous ( ) const

virtual

Reimplemented in orderedPhasePair, and orderedPhasePair.

Definition at line 75 of file phasePair.C.

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

Referenced by turbulentDispersionModel::continuousTurbulence(), liftModel::Fi(), and virtualMassModel::Ki().

Here is the call graph for this function:

Here is the caller graph for this function:

name() [2/3]

virtual word name ( ) const

virtual

Reimplemented in orderedPhasePair, orderedPhasePair, and orderedPhasePair.

otherName()

Foam::word otherName ( ) const

virtual

Reimplemented in orderedPhasePair.

Definition at line 93 of file phasePair.C.

rho() [1/2]

Foam::tmp< Foam::volScalarField > rho

(

)

const

Definition at line 101 of file phasePair.C.

References phase1, phase2, and phaseModel::rho().

Here is the call graph for this function:

magUr() [1/2]

Foam::tmp< Foam::volScalarField > magUr

(

)

const

Definition at line 107 of file phasePair.C.

References Foam::mag(), phase1, phase2, and U.

Here is the call graph for this function:

Ur() [1/2]

Foam::tmp< Foam::volVectorField > Ur

(

)

const

Definition at line 113 of file phasePair.C.

Referenced by liftModel::Fi().

Here is the caller graph for this function:

Re() [1/2]

Foam::tmp< Foam::volScalarField > Re

(

)

const

Definition at line 119 of file phasePair.C.

Pr() [1/2]

Foam::tmp< Foam::volScalarField > Pr

(

)

const

Definition at line 125 of file phasePair.C.

Eo() [1/2]

Foam::tmp< Foam::volScalarField > Eo

(

)

const

Definition at line 135 of file phasePair.C.

EoH1() [1/2]

Foam::tmp< Foam::volScalarField > EoH1

(

)

const

Definition at line 141 of file phasePair.C.

References Foam::cbrt(), and Foam::pow().

Here is the call graph for this function:

EoH2() [1/2]

Foam::tmp< Foam::volScalarField > EoH2

(

)

const

Definition at line 152 of file phasePair.C.

References Foam::cbrt().

Here is the call graph for this function:

sigma() [1/2]

const Foam::dimensionedScalar & sigma ( ) const

inline

Definition at line 163 of file phasePair.C.

References phaseModel::fluid(), phaseSystem::lookupSubModel(), phase1, phase2, and sigma().

Here is the call graph for this function:

Mo() [1/2]

Foam::tmp< Foam::volScalarField > Mo

(

)

const

Definition at line 173 of file phasePair.C.

References g, Foam::mag(), nu, Foam::pow3(), rho, and sigma().

Here is the call graph for this function:

Ta() [1/2]

Foam::tmp< Foam::volScalarField > Ta

(

)

const

Definition at line 187 of file phasePair.C.

References Foam::pow(), and Foam::Re().

Here is the call graph for this function:

E() [1/2]

Foam::tmp< Foam::volScalarField > E ( ) const

virtual

Reimplemented in orderedPhasePair, and orderedPhasePair.

Definition at line 193 of file phasePair.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and phase1.

Here is the call graph for this function:

phase1() [2/3]

const phaseModel& phase1 ( ) const

inline

phase2() [2/3]

const phaseModel& phase2 ( ) const

inline

contains()

bool contains ( const phaseModel &  phase ) const

inline

Definition at line 35 of file phasePairI.H.

Referenced by phaseChange::addToDriftRate(), phaseChange::correct(), phaseForces::execute(), phaseSystem::generatePairsAndSubModels(), and phaseForces::phaseForces().

Here is the caller graph for this function:

otherPhase()

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

inline

Definition at line 42 of file phasePairI.H.

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

Referenced by phaseForces::execute().

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

Definition at line 65 of file phasePairI.H.

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

Referenced by phaseSystem::generatePairsAndSubModels(), and InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::InterfaceCompositionPhaseChangePhaseSystem().

Here is the call graph for this function:

Here is the caller graph for this function:

g() [1/2]

const Foam::dimensionedVector & g ( ) const

inline

Definition at line 86 of file phasePairI.H.

cbegin()

Foam::phasePair::const_iterator cbegin ( ) const

inline

Definition at line 187 of file phasePairI.H.

cend()

Foam::phasePair::const_iterator cend ( ) const

inline

Definition at line 193 of file phasePairI.H.

begin()

Foam::phasePair::const_iterator begin ( ) const

inline

Definition at line 199 of file phasePairI.H.

end()

Foam::phasePair::const_iterator end ( ) const

inline

Definition at line 205 of file phasePairI.H.

dispersed() [2/2]

virtual const phaseModel& dispersed ( ) const

virtual

Reimplemented in orderedPhasePair, and orderedPhasePair.

continuous() [2/2]

virtual const phaseModel& continuous ( ) const

virtual

Reimplemented in orderedPhasePair, and orderedPhasePair.

name() [3/3]

virtual word name ( ) const

virtual

Reimplemented in orderedPhasePair, orderedPhasePair, and orderedPhasePair.

rho() [2/2]

tmp<volScalarField> rho

(

)

const

magUr() [2/2]

tmp<volScalarField> magUr

(

)

const

Ur() [2/2]

tmp<volVectorField> Ur

(

)

const

Re() [2/2]

tmp<volScalarField> Re

(

)

const

Pr() [2/2]

tmp<volScalarField> Pr

(

)

const

Eo() [2/2]

tmp<volScalarField> Eo

(

)

const

EoH1() [2/2]

tmp<volScalarField> EoH1

(

)

const

EoH2() [2/2]

tmp<volScalarField> EoH2

(

)

const

Mo() [2/2]

tmp<volScalarField> Mo

(

)

const

Ta() [2/2]

tmp<volScalarField> Ta

(

)

const

E() [2/2]

virtual tmp<volScalarField> E ( ) const

virtual

Reimplemented in orderedPhasePair, and orderedPhasePair.

phase1() [3/3]

const phaseModel& phase1 ( ) const

inline

phase2() [3/3]

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:

• src/phaseSystemModels/multiphaseInter/phasesSystem/phasePair/phasePair.H
• src/phaseSystemModels/multiphaseInter/phasesSystem/phasePair/phasePair.C
• src/phaseSystemModels/multiphaseInter/phasesSystem/phasePair/phasePairI.H