Inheritance diagram for phaseModel:

Collaboration diagram for phaseModel:

Classes
class	iNew
	Return a pointer to a new phase created on freestore. More...

Public Member Functions
	ClassName ("phaseModel")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, phaseModel, phaseSystem,(const phaseSystem &fluid, const word &phaseName, const bool referencePhase, const label index),(fluid, phaseName, referencePhase, index))

	phaseModel (const phaseSystem &fluid, const word &phaseName, const bool referencePhase, const label index)

autoPtr< phaseModel >	clone () const
	Return clone. More...

virtual	~phaseModel ()
	Destructor. More...

const word &	name () const
	Return the name of this phase. More...

const word &	keyword () const
	Return the name of the phase for use as the keyword in PtrDictionary. More...

label	index () const
	Return the index of the phase. More...

const phaseSystem &	fluid () const
	Return the system to which this phase belongs. More...

const dimensionedScalar &	residualAlpha () const
	Return the residual phase-fraction for given phase. More...

scalar	alphaMax () const
	Return the maximum phase-fraction (e.g. packing limit) More...

tmp< volScalarField >	d () const
	Return the Sauter-mean diameter. More...

const diameterModel &	diameter () const
	Return a reference to the diameterModel of the phase. More...

diameterModel &	diameter ()
	Return a reference to the diameterModel of the phase. More...

virtual void	correct ()
	Correct the phase properties. More...

virtual void	correctContinuityError (const volScalarField &source)
	Correct the continuity error. More...

virtual void	correctKinematics ()
	Correct the kinematics. More...

virtual void	correctThermo ()
	Correct the thermodynamics. More...

virtual void	correctReactions ()
	Correct the reactions. More...

virtual void	correctSpecies ()
	Correct the species concentrations. More...

virtual void	predictMomentumTransport ()
	Predict the momentumTransport. More...

virtual void	predictThermophysicalTransport ()
	Predict the energy transport. More...

virtual void	correctMomentumTransport ()
	Correct the momentumTransport. More...

virtual void	correctThermophysicalTransport ()
	Correct the energy transport. More...

virtual void	correctUf ()
	Correct the face velocity for moving meshes. More...

void	correctInflowOutflow (surfaceScalarField &alphaPhi) const
	Ensure that the flux at inflow/outflow BCs is preserved. More...

virtual bool	read ()
	Read phase properties dictionary. More...

virtual bool	incompressible () const =0
	Return true if the phase is incompressible otherwise false. More...

virtual bool	isochoric () const =0
	Return true if the phase is constant density otherwise false. More...

virtual const autoPtr< volScalarField > &	divU () const =0
	Return the phase dilatation rate (d(alpha)/dt + div(alpha*phi)) More...

virtual void	divU (tmp< volScalarField > divU)=0
	Set the phase dilatation rate (d(alpha)/dt + div(alpha*phi)) More...

virtual const rhoThermo &	thermo () const =0
	Return the thermophysical model. More...

virtual rhoThermo &	thermo ()=0
	Access the thermophysical model. More...

virtual const rhoFluidThermo &	fluidThermo () const =0
	Return the thermophysical model. More...

virtual rhoFluidThermo &	fluidThermo ()=0
	Access the thermophysical model. More...

virtual const volScalarField &	rho () const =0
	Return the density field. More...

virtual volScalarField &	rho ()=0
	Access the density field. More...

virtual bool	isothermal () const =0
	Return whether the phase is isothermal. More...

virtual tmp< fvScalarMatrix >	heEqn ()=0
	Return the enthalpy equation. More...

virtual bool	pure () const =0
	Return whether the phase is pure (i.e., not multi-component) More...

virtual tmp< fvScalarMatrix >	YiEqn (volScalarField &Yi)=0
	Return the species fraction equation. More...

virtual const PtrList< volScalarField > &	Y () const =0
	Return the species mass fractions. More...

virtual const volScalarField &	Y (const label speciei) const =0
	Return a species mass fraction by index. More...

virtual const volScalarField &	Y (const word &name) const =0
	Return a species mass fraction by name. More...

virtual PtrList< volScalarField > &	YRef ()=0
	Access the species mass fractions. More...

virtual bool	solveSpecie (const label speciei) const =0
	Should the given specie be solved for? I.e., is it active and. More...

virtual tmp< volScalarField::Internal >	R (const label) const =0
	Return the consumption rate for a specie. More...

virtual tmp< fvScalarMatrix >	R (volScalarField &Yi) const =0
	Return consumption rate matrix for a specie. More...

virtual bool	stationary () const =0
	Return whether the phase is stationary. More...

virtual tmp< fvVectorMatrix >	UEqn ()=0
	Return the momentum equation. More...

virtual tmp< fvVectorMatrix >	UfEqn ()=0
	Return the momentum equation for the face-based algorithm. More...

virtual tmp< volVectorField >	U () const =0
	Return the velocity. More...

virtual volVectorField &	URef ()=0
	Access the velocity. More...

virtual const volVectorField &	URef () const =0
	Access the velocity. More...

virtual tmp< surfaceScalarField >	phi () const =0
	Return the volumetric flux. More...

virtual surfaceScalarField &	phiRef ()=0
	Access the volumetric flux. More...

virtual const surfaceScalarField &	phiRef () const =0
	Access the volumetric flux. More...

virtual const autoPtr< surfaceVectorField > &	Uf () const =0
	Return the face velocity. More...

virtual surfaceVectorField &	UfRef ()=0
	Access the face velocity. More...

virtual const surfaceVectorField &	UfRef () const =0
	Access the face velocity. More...

virtual tmp< surfaceScalarField >	alphaPhi () const =0
	Return the volumetric flux of the phase. More...

virtual surfaceScalarField &	alphaPhiRef ()=0
	Access the volumetric flux of the phase. More...

virtual const surfaceScalarField &	alphaPhiRef () const =0
	Access the volumetric flux of the phase. More...

virtual tmp< surfaceScalarField >	alphaRhoPhi () const =0
	Return the mass flux of the phase. More...

virtual surfaceScalarField &	alphaRhoPhiRef ()=0
	Access the mass flux of the phase. More...

virtual const surfaceScalarField &	alphaRhoPhiRef () const =0
	Access the mass flux of the phase. More...

virtual tmp< fvVectorMatrix >	UgradU () const =0
	Return the velocity transport matrix. More...

virtual tmp< fvVectorMatrix >	DUDt () const =0
	Return the substantive acceleration matrix. More...

virtual tmp< volScalarField >	continuityError () const =0
	Return the continuity error. More...

virtual tmp< volScalarField >	K () const =0
	Return the phase kinetic energy. More...

virtual tmp< scalarField >	kappaEff (const label patchi) const =0
	Effective thermal turbulent conductivity. More...

virtual tmp< volScalarField >	k () const =0
	Return the turbulent kinetic energy. More...

virtual tmp< surfaceScalarField >	pPrimef () const =0
	Return the face-phase-pressure'. More...

Public Member Functions inherited from GeometricField< Type, GeoMesh, PrimitiveField >
	TypeName ("GeometricField")
	Runtime type information. More...

	GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const word &patchFieldType=Patch::calculatedType())
	Constructor given IOobject, mesh, dimensions and patch field type. More...

	GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
	Constructor given IOobject, mesh, dimensions and patch field types. More...

	GeometricField (const IOobject &, const Mesh &, const dimensioned< Type > &, const word &patchFieldType=Patch::calculatedType())
	Constructor given IOobject, mesh, dimensioned<Type> More...

	GeometricField (const IOobject &, const Mesh &, const dimensioned< Type > &, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
	Constructor given IOobject, mesh, dimensioned<Type> More...

	GeometricField (const IOobject &, const Internal &, const PtrList< Patch > &, const HashPtrTable< Source > &=HashPtrTable< Source >())
	Constructor from components. More...

	GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const PrimitiveField< Type > &, const PtrList< Patch > &, const HashPtrTable< Source > &=HashPtrTable< Source >())
	Constructor from components. More...

	GeometricField (const IOobject &, const Mesh &)
	Construct and read given IOobject. More...

	GeometricField (const IOobject &, const Mesh &, const dictionary &)
	Construct from dictionary. More...

	GeometricField (const GeometricField< Type, GeoMesh, PrimitiveField > &)
	Copy constructor. More...

template<template< class > class PrimitiveField2>
	GeometricField (const GeometricField< Type, GeoMesh, PrimitiveField2 > &)
	Copy constructor. More...

	GeometricField (GeometricField< Type, GeoMesh, PrimitiveField > &&)
	Move constructor. More...

	GeometricField (const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &)
	Construct as copy of tmp. More...

template<template< class > class PrimitiveField2>
	GeometricField (const IOobject &, const GeometricField< Type, GeoMesh, PrimitiveField2 > &)
	Construct as copy resetting IO parameters. More...

	GeometricField (const IOobject &, const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &)
	Construct as copy of tmp resetting IO parameters. More...

template<template< class > class PrimitiveField2>
	GeometricField (const word &newName, const GeometricField< Type, GeoMesh, PrimitiveField2 > &)
	Construct as copy resetting name. More...

	GeometricField (const word &newName, const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &)
	Construct as copy of tmp resetting name. More...

template<template< class > class PrimitiveField2>
	GeometricField (const IOobject &, const GeometricField< Type, GeoMesh, PrimitiveField2 > &, const word &patchFieldType)
	Construct as copy resetting IO parameters and patch field type. More...

	GeometricField (const IOobject &, const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &, const word &patchFieldType)
	Construct as copy of tmp resetting IO parameters. More...

template<template< class > class PrimitiveField2>
	GeometricField (const IOobject &, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &, const word &patchFieldType)
	Constructor from internal field and patch field type. More...

	GeometricField (const IOobject &, const tmp< Internal > &, const word &patchFieldType)
	Constructor from temporary internal field and patch field type. More...

template<template< class > class PrimitiveField2>
	GeometricField (const IOobject &, const GeometricField< Type, GeoMesh, PrimitiveField2 > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
	Construct as copy resetting IO parameters and patch field types. More...

	GeometricField (const IOobject &, const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
	Construct as copy of tmp resetting IO parameters. More...

template<template< class > class PrimitiveField2>
	GeometricField (const IOobject &, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
	Construct from IOobject, internal field and patch field types. More...

	GeometricField (const IOobject &, const tmp< Internal > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
	Construct from IOobject, tmp internal field and patch field types. More...

tmp< GeometricField< Type, GeoMesh, PrimitiveField > >	clone () const
	Clone. More...

tmp< GeometricField< Type, GeoMesh, PrimitiveField > >	cloneUnSliced () const
	Clone un-sliced. More...

virtual	~GeometricField ()
	Destructor. More...

Internal &	internalFieldRef ()
	Return a reference to the dimensioned internal field. More...

const Internal &	internalField () const
	Return a const-reference to the dimensioned internal field. More...

const Internal &	v () const
	Return a const-reference to the dimensioned internal field. More...

Internal::FieldType &	primitiveFieldRef ()
	Return a reference to the primitive field. More...

const Internal::FieldType &	primitiveField () const
	Return a const-reference to the primitive field. More...

Boundary &	boundaryFieldRef ()
	Return a reference to the boundary field. More...

Boundary &	boundaryFieldRefNoStoreOldTimes ()
	Return a reference to the boundary field without storing old times. More...

const Boundary &	boundaryField () const
	Return const-reference to the boundary field. More...

Sources &	sourcesRef ()
	Return a reference to the sources. More...

const Sources &	sources () const
	Return const-reference to the sources. More...

void	storePrevIter () const
	Store the field as the previous iteration value. More...

void	clearPrevIter ()
	Delete the previous iteration field. More...

const GeometricField< Type, GeoMesh, Field > &	prevIter () const
	Return previous iteration field. More...

	USING_OLD_TIME_FIELD (GeometricField)
	Use old-time methods from the base class. More...

void	correctBoundaryConditions ()
	Correct boundary field. More...

template<template< class > class PrimitiveField2>
void	reset (const GeometricField< Type, GeoMesh, PrimitiveField2 > &)
	Reset the field contents to the given field. More...

void	reset (const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &)
	Reset the field contents to the given tmp-field. More...

template<template< class > class PrimitiveField2>
void	reset (const tmp< GeometricField< Type, GeoMesh, PrimitiveField2 >> &)
	Reset the field contents to the given tmp-field. More...

bool	needReference () const
	Does the field need a reference level for solution. More...

tmp< GeometricField< cmptType, GeoMesh, Field > >	component (const direction) const
	Return a component of the field. More...

bool	writeData (Ostream &) const
	WriteData member function required by regIOobject. More...

tmp< GeometricField< Type, GeoMesh, Field > >	T () const
	Return transpose (only if it is a tensor field) More...

void	relax (const scalar alpha)
	Relax field (for steady-state solution). More...

scalar	relaxationFactor () const
	Return the field relaxation factor read from fvSolution. More...

void	relax ()
	Relax current field with respect to the cached previous iteration. More...

template<template< class > class PrimitiveField2>
void	relax (const tmp< GeometricField< Type, GeoMesh, PrimitiveField2 >> &, const scalar alpha)
	Relax given field with respect to the current field. More...

template<template< class > class PrimitiveField2>
void	relax (const tmp< GeometricField< Type, GeoMesh, PrimitiveField2 >> &)
	Relax given field with respect to the current field. More...

word	select (bool final) const
	Select the final iteration parameters if `final' is true. More...

void	writeMinMax (Ostream &os) const
	Helper function to write the min and max to an Ostream. More...

void	negate ()

template<template< class > class PrimitiveField2>
void	replace (const direction, const GeometricField< cmptType, GeoMesh, PrimitiveField2 > &)
	Replace a component field of the field. More...

template<template< class > class PrimitiveField2>
void	replace (const direction, const tmp< GeometricField< cmptType, GeoMesh, PrimitiveField2 >> &)
	Replace a component field of the field. More...

void	replace (const direction, const dimensioned< cmptType > &)
	Replace a component field of the field. More...

void	max (const dimensioned< Type > &)

void	min (const dimensioned< Type > &)

void	maxMin (const dimensioned< Type > &minDt, const dimensioned< Type > &maxDt)

const Internal &	operator() () const
	Return a const-reference to the dimensioned internal field. More...

void	operator= (const GeometricField< Type, GeoMesh, PrimitiveField > &)

void	operator= (GeometricField< Type, GeoMesh, PrimitiveField > &&)

template<template< class > class PrimitiveField2>
void	operator= (const GeometricField< Type, GeoMesh, PrimitiveField2 > &)

void	operator= (const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &)

template<template< class > class PrimitiveField2>
void	operator= (const tmp< GeometricField< Type, GeoMesh, PrimitiveField2 >> &)

void	operator= (const dimensioned< Type > &)

void	operator= (const zero &)

template<template< class > class PrimitiveField2>
void	operator== (const GeometricField< Type, GeoMesh, PrimitiveField2 > &)

void	operator== (const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &)

template<template< class > class PrimitiveField2>
void	operator== (const tmp< GeometricField< Type, GeoMesh, PrimitiveField2 >> &)

void	operator== (const dimensioned< Type > &)

void	operator== (const zero &)

template<template< class > class PrimitiveField2>
void	operator+= (const GeometricField< Type, GeoMesh, PrimitiveField2 > &)

template<template< class > class PrimitiveField2>
void	operator+= (const tmp< GeometricField< Type, GeoMesh, PrimitiveField2 >> &)

void	operator+= (const dimensioned< Type > &)

template<template< class > class PrimitiveField2>
void	operator-= (const GeometricField< Type, GeoMesh, PrimitiveField2 > &)

template<template< class > class PrimitiveField2>
void	operator-= (const tmp< GeometricField< Type, GeoMesh, PrimitiveField2 >> &)

void	operator-= (const dimensioned< Type > &)

template<template< class > class PrimitiveField2>
void	operator*= (const GeometricField< scalar, GeoMesh, PrimitiveField2 > &)

template<template< class > class PrimitiveField2>
void	operator*= (const tmp< GeometricField< scalar, GeoMesh, PrimitiveField2 >> &)

void	operator*= (const dimensioned< scalar > &)

template<template< class > class PrimitiveField2>
void	operator/= (const GeometricField< scalar, GeoMesh, PrimitiveField2 > &)

template<template< class > class PrimitiveField2>
void	operator/= (const tmp< GeometricField< scalar, GeoMesh, PrimitiveField2 >> &)

void	operator/= (const dimensioned< scalar > &)

tmp< VolField< scalar > >	component (const direction) const

void	replace (const direction, const GeometricField< scalar, volMesh, PrimitiveField > &sf)

Foam::tmp< Foam::GeometricField< Foam::scalar, Foam::volMesh > >	component (const direction) const

void	replace (const direction, const GeometricField< scalar, volMesh, PrimitiveField > &gsf)

template<template< class > class PrimitiveField2>
Foam::tmp< Foam::GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &newName, const GeometricField< Type, GeoMesh, PrimitiveField2 > &gf, const word &patchFieldType)

template<template< class > class PrimitiveField2>
Foam::tmp< Foam::GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &newName, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &df, const word &patchFieldType)

template<template< class > class PrimitiveField2>
Foam::tmp< Foam::GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &newName, const GeometricField< Type, GeoMesh, PrimitiveField2 > &gf, const wordList &patchFieldTypes, const wordList &actualPatchTypes, const HashTable< word > &fieldSourceTypes)

template<template< class > class PrimitiveField2>
Foam::tmp< Foam::GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &newName, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &df, const wordList &patchFieldTypes, const wordList &actualPatchTypes, const HashTable< word > &fieldSourceTypes)

template<template< class > class PrimitiveField2>
void	replace (const direction d, const GeometricField< typename GeometricField< Type, GeoMesh, PrimitiveField >::cmptType, GeoMesh, PrimitiveField2 > &gcf)

template<template< class > class PrimitiveField2>
void	replace (const direction d, const tmp< GeometricField< typename GeometricField< Type, GeoMesh, PrimitiveField >::cmptType, GeoMesh, PrimitiveField2 > > &gcf)

Public Member Functions inherited from DimensionedField< Type, GeoMesh, PrimitiveField >
	TypeName ("DimensionedField")
	Runtime type information. More...

	DimensionedField (const IOobject &, const Mesh &mesh, const dimensionSet &, const PrimitiveField< Type > &)
	Construct from components. More...

	DimensionedField (const IOobject &, const Mesh &mesh, const dimensionSet &, const bool checkIOFlags=true)
	Construct from components. More...

	DimensionedField (const IOobject &, const Mesh &mesh, const dimensioned< Type > &, const bool checkIOFlags=true)
	Construct from components. More...

	DimensionedField (const IOobject &, const Mesh &mesh, const word &fieldDictEntry="value")
	Construct from Istream. More...

	DimensionedField (const IOobject &, const Mesh &mesh, const dictionary &fieldDict, const word &fieldDictEntry="value")
	Construct from dictionary. More...

	DimensionedField (const DimensionedField< Type, GeoMesh, PrimitiveField > &)
	Copy constructor. More...

	DimensionedField (DimensionedField< Type, GeoMesh, PrimitiveField > &&)
	Move constructor. More...

template<template< class > class PrimitiveField2>
	DimensionedField (const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)
	Copy constructor. More...

template<template< class > class PrimitiveField2>
	DimensionedField (DimensionedField< Type, GeoMesh, PrimitiveField2 > &, const bool reuse)
	Copy constructor or reuse as specified. More...

	DimensionedField (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField >> &)
	Copy constructor of tmp<DimensionedField> deleting argument. More...

template<template< class > class PrimitiveField2>
	DimensionedField (const IOobject &, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &, const bool checkIOFlags=true)
	Copy constructor resetting IO parameters. More...

template<template< class > class PrimitiveField2>
	DimensionedField (const IOobject &, DimensionedField< Type, GeoMesh, PrimitiveField2 > &, const bool reuse, const bool checkIOFlags=true)
	Copy constructor resetting IO parameters and reuse as specified. More...

	DimensionedField (const IOobject &, const tmp< DimensionedField< Type, GeoMesh, PrimitiveField >> &, const bool checkIOFlags=true)
	Copy constructor from tmp resetting IO parameters. More...

template<template< class > class PrimitiveField2>
	DimensionedField (const word &newName, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)
	Copy constructor resetting name. More...

template<template< class > class PrimitiveField2>
	DimensionedField (const word &newName, DimensionedField< Type, GeoMesh, PrimitiveField2 > &, const bool reuse)
	Copy constructor resetting name and reuse as specified. More...

	DimensionedField (const word &newName, const tmp< DimensionedField< Type, GeoMesh, PrimitiveField >> &)
	Copy constructor from tmp resetting name. More...

tmp< DimensionedField< Type, GeoMesh, PrimitiveField > >	clone () const
	Clone. More...

virtual	~DimensionedField ()
	Destructor. More...

void	readField (const dictionary &fieldDict, const word &fieldDictEntry="value")

const Mesh &	mesh () const
	Return mesh. More...

const dimensionSet &	dimensions () const
	Return dimensions. More...

dimensionSet &	dimensions ()
	Return non-const access to dimensions. More...

PrimitiveField< Type > &	primitiveFieldRef ()
	Return a reference to the internal field. More...

const PrimitiveField< Type > &	primitiveField () const
	Return a const-reference to the primitive field. More...

	USING_OLD_TIME_FIELD (DimensionedField)
	Use old-time methods from the base class. More...

tmp< DimensionedField< cmptType, GeoMesh, Field > >	component (const direction) const
	Return a component field of the field. More...

template<template< class > class PrimitiveField2>
void	replace (const direction, const DimensionedField< cmptType, GeoMesh, PrimitiveField2 > &)
	Replace a component field of the field. More...

template<template< class > class PrimitiveField2>
void	replace (const direction, const tmp< DimensionedField< cmptType, GeoMesh, PrimitiveField2 >> &)
	Replace a component field of the field. More...

tmp< DimensionedField< Type, GeoMesh, Field > >	T () const
	Return the field transpose (only defined for second rank tensors) More...

dimensioned< Type >	average () const
	Calculate and return arithmetic average. More...

template<template< class > class PrimitiveField2>
dimensioned< Type >	weightedAverage (const DimensionedField< scalar, GeoMesh, PrimitiveField2 > &) const
	Calculate and return weighted average. More...

template<template< class > class PrimitiveField2>
dimensioned< Type >	weightedAverage (const tmp< DimensionedField< scalar, GeoMesh, PrimitiveField2 >> &) const
	Calculate and return weighted average. More...

template<template< class > class PrimitiveField2>
void	reset (const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)
	Reset the field values to the given field. More...

void	reset (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField >> &)
	Reset the field values to the given tmp-field. More...

template<template< class > class PrimitiveField2>
void	reset (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField2 >> &)
	Reset the field values to the given tmp-field. More...

bool	writeData (Ostream &, const word &fieldDictEntry) const

void	operator= (const DimensionedField< Type, GeoMesh, PrimitiveField > &)

void	operator= (DimensionedField< Type, GeoMesh, PrimitiveField > &&)

void	operator= (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField >> &)

template<template< class > class PrimitiveField2>
void	operator= (const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)

template<template< class > class PrimitiveField2>
void	operator= (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField2 >> &)

void	operator= (const dimensioned< Type > &)

void	operator= (const zero &)

template<template< class > class PrimitiveField2>
void	operator== (const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)

template<template< class > class PrimitiveField2>
void	operator== (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField2 >> &)

void	operator== (const dimensioned< Type > &)

void	operator== (const zero &)

template<template< class > class PrimitiveField2>
void	operator+= (const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)

template<template< class > class PrimitiveField2>
void	operator+= (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField2 >> &)

void	operator+= (const dimensioned< Type > &)

template<template< class > class PrimitiveField2>
void	operator-= (const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)

template<template< class > class PrimitiveField2>
void	operator-= (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField2 >> &)

void	operator-= (const dimensioned< Type > &)

template<template< class > class PrimitiveField2>
void	operator*= (const DimensionedField< scalar, GeoMesh, PrimitiveField2 > &)

template<template< class > class PrimitiveField2>
void	operator*= (const tmp< DimensionedField< scalar, GeoMesh, PrimitiveField2 >> &)

void	operator*= (const dimensioned< scalar > &)

template<template< class > class PrimitiveField2>
void	operator/= (const DimensionedField< scalar, GeoMesh, PrimitiveField2 > &)

template<template< class > class PrimitiveField2>
void	operator/= (const tmp< DimensionedField< scalar, GeoMesh, PrimitiveField2 >> &)

void	operator/= (const dimensioned< scalar > &)

template<template< class > class PrimitiveField2>
Foam::tmp< Foam::DimensionedField< Type, GeoMesh, PrimitiveField > >	New (const word &newName, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &df)

template<template< class > class PrimitiveField2>
void	replace (const direction d, const DimensionedField< typename DimensionedField< Type, GeoMesh, PrimitiveField >::cmptType, GeoMesh, PrimitiveField2 > &df)

template<template< class > class PrimitiveField2>
void	replace (const direction d, const tmp< DimensionedField< typename DimensionedField< Type, GeoMesh, PrimitiveField >::cmptType, GeoMesh, PrimitiveField2 > > &tdf)

Public Member Functions inherited from regIOobject
	TypeName ("regIOobject")
	Runtime type information. More...

	regIOobject (const IOobject &, const bool isTime=false)
	Construct from IOobject. Optional flag for if IOobject is the. More...

	regIOobject (const regIOobject &)
	Copy constructor. More...

	regIOobject (regIOobject &&)
	Move constructor. More...

	regIOobject (const regIOobject &, bool registerCopy)
	Copy constructor, transferring registry registration to copy. More...

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy constructor with new name, transferring registry registration. More...

	regIOobject (const IOobject &, const regIOobject &)
	Copy constructor with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

virtual bool	global () const
	Return true if object is global, i.e. same for all processors. More...

virtual bool	globalFile () const
	Return true if object is global, i.e. same for all processors. More...

const fileName &	caseName () const

fileName	path () const
	Return complete path. More...

fileName	objectPath () const
	Return complete path + object name. More...

fileName	filePath () const
	Return complete path + object name if the file exists. More...

bool	checkIn ()
	Add object to registry. More...

bool	checkOut ()
	Remove object from registry. More...

void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED) More...

bool	registered () const
	Is this object registered with the registry? More...

bool	ownedByRegistry () const
	Is this object owned by the registry? More...

void	store ()
	Transfer ownership of this object to its registry. More...

void	release ()
	Release ownership of this object from its registry. More...

label	eventNo () const
	Event number at last update. More...

label &	eventNo ()
	Event number at last update. More...

bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object. More...

bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

void	setUpToDate ()
	Set up to date (obviously) More...

virtual void	rename (const word &newName)
	Rename. More...

bool	headerOk ()
	Read and check header info. More...

Istream &	readStream (const word &, const bool read=true)
	Return Istream and check object type against that given. More...

void	close ()
	Close Istream. More...

virtual bool	readData (Istream &)
	Virtual readData function. More...

const labelList &	watchIndices () const
	Return file-monitoring handles. More...

labelList &	watchIndices ()
	Return file-monitoring handles. More...

virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) More...

virtual bool	dependenciesModified () const
	Return true if the object's dependencies have been modified. More...

virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...

virtual bool	writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
	Write using given format, version and compression. More...

virtual bool	write (const bool write=true) const
	Write using setting from DB. More...

void	operator= (const IOobject &)=delete
	Assign to IOobject. More...

void	operator= (const regIOobject &)=delete
	Disallow default assignment. More...

const fileName &	caseName (const bool global) const

fileName	path (const bool global) const
	Return complete path including the processor sub-directory. More...

fileName	objectPath (const bool global) const
	Return complete path + object name including the processor. More...

fileName	filePath (const bool global) const
	Return complete path + object name if the file exists. More...

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Runtime type information. More...

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, registry, io options. More...

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, local, registry, io options. More...

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const objectRegistry &registry)
	Construct from copy resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Construct from copy resetting name. More...

	IOobject (const IOobject &io)=default
	Copy constructor. More...

autoPtr< IOobject >	clone () const
	Clone. More...

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...

virtual	~IOobject ()
	Destructor. More...

const Time &	time () const
	Return time. More...

const objectRegistry &	db () const
	Return the local objectRegistry. More...

const word &	name () const
	Return name. More...

const word &	headerClassName () const
	Return name of the class name read from header. More...

word &	headerClassName ()
	Return name of the class name read from header. More...

string &	note ()
	Return non-constant access to the optional note. More...

const string &	note () const
	Return the optional note. More...

bool &	registerObject ()
	Register object created from this IOobject with registry if true. More...

bool	registerObject () const
	Register object created from this IOobject with registry if true. More...

readOption	readOpt () const

readOption &	readOpt ()

writeOption	writeOpt () const

writeOption &	writeOpt ()

word	group () const
	Return group (extension part of name) More...

word	member () const
	Return member (name without the extension) More...

const fileName &	rootPath () const

const fileName &	caseName (const bool global) const

fileName &	instance () const
	Return the instance directory, constant, system, <time> etc. More...

void	updateInstance () const
	If the instance is a time directory update to the current time. More...

void	updateTimeInstance () const
	Update instance to the current time. More...

const fileName &	local () const

fileName	path (const bool global) const
	Return complete path including the processor sub-directory. More...

fileName	objectPath (const bool global) const
	Return complete path + object name including the processor. More...

fileName	relativePath () const
	Return the path relative to the case directory. More...

fileName	relativeObjectPath () const
	Return complete relativePath + object name. More...

fileName	filePath (const bool global) const
	Return complete path + object name if the file exists. More...

bool	readHeader (Istream &)
	Read header. More...

bool	headerOk ()
	Read header of local object without type-checking. More...

template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. More...

bool	writeHeader (Ostream &) const
	Write header. More...

bool	writeHeader (Ostream &, const word &objectType) const
	Write header. Allow override of type. More...

bool	good () const

bool	bad () const

InfoProxy< IOobject >	info () const
	Return info proxy. More...

void	operator= (const IOobject &)

template<class Name >
Foam::word	groupName (Name name, const word &group)

Public Member Functions inherited from OldTimeField< DimensionedField< Type, GeoMesh, PrimitiveField > >
	OldTimeField (const label timeIndex)
	Construct from a time index. More...

	OldTimeField (const OldTimeField< DimensionedField< Type, GeoMesh, PrimitiveField > > &otf)
	Copy construct. More...

	OldTimeField (OldTimeField< DimensionedField< Type, GeoMesh, PrimitiveField > > &&otf)
	Move construct. More...

	~OldTimeField ()
	Destructor. More...

label	timeIndex () const
	Return the time index of the field. More...

label &	timeIndex ()
	Return a non-const reference to the time index of the field. More...

bool	isOldTime () const
	Return whether or not this is an old-time field. More...

bool	hasStoredOldTimes () const
	Return whether old-time fields have been stored yet. More...

void	storeOldTimes () const
	Store the old-time fields. More...

void	clearOldTimes ()
	Clear old-time fields. More...

void	nullOldestTime ()
	Set the oldest field pointer to nullObjectPtr. This removes the. More...

label	nOldTimes (const bool includeNull=true) const
	Return the number of old-time fields stored. More...

const Field0Type &	oldTime () const
	Return the old-time field. More...

const Field0Type &	oldTime (const label n) const
	Return the n-th old-time field. More...

Field0Type &	oldTimeRef ()
	Return a non-const reference to the old-time field. More...

Field0Type &	oldTimeRef (const label n)
	Return a non-const reference to the n-th old time field. More...

void	operator= (const OldTimeField< DimensionedField< Type, GeoMesh, PrimitiveField > > &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from OldTimeField< GeometricField< Type, GeoMesh, PrimitiveField > >
	OldTimeField (const label timeIndex)
	Construct from a time index. More...

	OldTimeField (const OldTimeField< GeometricField< Type, GeoMesh, PrimitiveField > > &otf)
	Copy construct. More...

	OldTimeField (OldTimeField< GeometricField< Type, GeoMesh, PrimitiveField > > &&otf)
	Move construct. More...

	~OldTimeField ()
	Destructor. More...

label	timeIndex () const
	Return the time index of the field. More...

label &	timeIndex ()
	Return a non-const reference to the time index of the field. More...

bool	isOldTime () const
	Return whether or not this is an old-time field. More...

bool	hasStoredOldTimes () const
	Return whether old-time fields have been stored yet. More...

void	storeOldTimes () const
	Store the old-time fields. More...

void	clearOldTimes ()
	Clear old-time fields. More...

void	nullOldestTime ()
	Set the oldest field pointer to nullObjectPtr. This removes the. More...

label	nOldTimes (const bool includeNull=true) const
	Return the number of old-time fields stored. More...

const Field0Type &	oldTime () const
	Return the old-time field. More...

const Field0Type &	oldTime (const label n) const
	Return the n-th old-time field. More...

Field0Type &	oldTimeRef ()
	Return a non-const reference to the old-time field. More...

Field0Type &	oldTimeRef (const label n)
	Return a non-const reference to the n-th old time field. More...

void	operator= (const OldTimeField< GeometricField< Type, GeoMesh, PrimitiveField > > &)=delete
	Disallow default bitwise assignment. More...

Static Public Member Functions
static autoPtr< phaseModel >	New (const phaseSystem &fluid, const word &phaseName, const bool referencePhase, const label index)

Static Public Member Functions inherited from GeometricField< Type, GeoMesh, PrimitiveField >
static const GeometricField< Type, GeoMesh, PrimitiveField > &	null ()
	Return a null geometric field. More...

static tmp< GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &name, const Internal &, const PtrList< Patch > &, const HashPtrTable< Source > &=HashPtrTable< Source >())
	Return a temporary field constructed from name,. More...

static tmp< GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &name, const Mesh &, const dimensionSet &, const word &patchFieldType=Patch::calculatedType())
	Return a temporary field constructed from name, mesh, dimensionSet. More...

static tmp< GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &name, const Mesh &, const dimensioned< Type > &, const word &patchFieldType=Patch::calculatedType())
	Return a temporary field constructed from mesh, dimensioned<Type> More...

static tmp< GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &name, const Mesh &, const dimensioned< Type > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
	Return a temporary field constructed from mesh, dimensioned<Type> More...

static tmp< GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &newName, const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &)
	Rename temporary field and return. More...

template<template< class > class PrimitiveField2>
static tmp< GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &newName, const GeometricField< Type, GeoMesh, PrimitiveField2 > &, const word &patchFieldType)
	Rename field, reset patch field type and return. More...

static tmp< GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &newName, const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &, const word &patchFieldType)
	Rename temporary field, reset patch field type and return. More...

template<template< class > class PrimitiveField2>
static tmp< GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &name, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &, const word &patchFieldType)
	Return a temporary field constructed from name,. More...

static tmp< GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &name, const tmp< Internal > &, const word &patchFieldType)
	Return a temporary field constructed from name,. More...

template<template< class > class PrimitiveField2>
static tmp< GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &newName, const GeometricField< Type, GeoMesh, PrimitiveField2 > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
	Rename and reset patch fields types of field and return. More...

static tmp< GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &newName, const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
	Rename and reset patch fields types of temporary field and return. More...

template<template< class > class PrimitiveField2>
static tmp< GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &newName, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
	Return a temporary field constructed from IOobject,. More...

static tmp< GeometricField< Type, GeoMesh, PrimitiveField > >	New (const word &newName, const tmp< Internal > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
	Return a temporary field constructed from IOobject,. More...

Static Public Member Functions inherited from DimensionedField< Type, GeoMesh, PrimitiveField >
static const DimensionedField< Type, GeoMesh, PrimitiveField > &	null ()
	Return a null DimensionedField. More...

static tmp< DimensionedField< Type, GeoMesh, PrimitiveField > >	New (const word &name, const Mesh &mesh, const dimensionSet &, const PrimitiveField< Type > &)
	Return a temporary field constructed from name, mesh,. More...

static tmp< DimensionedField< Type, GeoMesh, PrimitiveField > >	New (const word &name, const Mesh &mesh, const dimensionSet &)
	Return a temporary field constructed from name, mesh. More...

static tmp< DimensionedField< Type, GeoMesh, PrimitiveField > >	New (const word &name, const Mesh &mesh, const dimensioned< Type > &)
	Return a temporary field constructed from name, mesh. More...

template<template< class > class PrimitiveField2>
static tmp< DimensionedField< Type, GeoMesh, PrimitiveField > >	New (const word &newName, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)
	Return a temporary field constructed from name and a field. More...

static tmp< DimensionedField< Type, GeoMesh, PrimitiveField > >	New (const word &newName, const tmp< DimensionedField< Type, GeoMesh, PrimitiveField >> &)
	Return renamed temporary field. More...

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *)
	Transfer ownership of the given object pointer to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &)
	Transfer ownership of the given object pointer to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class Name >
static word	groupName (Name name, const word &group)

static word	group (const word &name)
	Return group (extension part of name) More...

static word	member (const word &name)
	Return member (name without the extension) More...

template<class Stream >
static Stream &	writeBanner (Stream &os, bool noHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

template<class Stream >
static Stream &	writeDivider (Stream &os)
	Write the standard file section divider. More...

template<class Stream >
static Stream &	writeEndDivider (Stream &os)
	Write the standard end file divider. More...

Additional Inherited Members
Public Types inherited from GeometricField< Type, GeoMesh, PrimitiveField >
typedef GeoMesh::Mesh	Mesh
	Type of mesh on which this GeometricField is instantiated. More...

typedef DimensionedField< Type, GeoMesh, PrimitiveField >	Internal
	Type of the internal field from which this GeometricField is derived. More...

typedef DimensionedField< Type, GeoMesh, PrimitiveField >	Base
	Type of the field from which this GeometricField is derived. More...

typedef GeoMesh::template PatchField< Type >	Patch
	Type of the patch field of which the Boundary is composed. More...

typedef GeometricBoundaryField< Type, GeoMesh, PrimitiveField >	Boundary
	Type of the boundary field. More...

typedef GeoMesh::template FieldSource< Type >	Source
	Type of the field source of which the Sources is composed. More...

typedef GeometricFieldSources< Type, GeoMesh, PrimitiveField >	Sources
	Type of the field sources. More...

typedef Field< Type >::cmptType	cmptType
	Component type of the elements of the field. More...

Public Types inherited from DimensionedField< Type, GeoMesh, PrimitiveField >
typedef GeoMesh::Mesh	Mesh
	Type of mesh on which this DimensionedField is instantiated. More...

typedef PrimitiveField< Type >	FieldType
	Type of the field from which this DimensionedField is derived. More...

typedef PrimitiveField< Type >	Base
	Type of the field from which this DimensionedField is derived. More...

typedef PrimitiveField< Type >::cmptType	cmptType
	Component type of the elements of the field. More...

Public Types inherited from IOobject
enum	objectState { GOOD , BAD }
	Enumeration defining the valid states of an IOobject. More...

enum	readOption { MUST_READ , MUST_READ_IF_MODIFIED , READ_IF_PRESENT , NO_READ }
	Enumeration defining the read options. More...

enum	writeOption { AUTO_WRITE = 0 , NO_WRITE = 1 }
	Enumeration defining the write options. More...

enum	fileCheckTypes { timeStamp , timeStampMaster , inotify , inotifyMaster }
	Enumeration defining the file checking options. More...

Static Public Attributes inherited from regIOobject
static float	fileModificationSkew

Static Public Attributes inherited from IOobject
static constexpr const char *	foamFile = "FoamFile"
	Keyword for the FoamFile header sub-dictionary. More...

static const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames

static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
	Read header, check readOpt flags and read data if necessary. More...

Protected Member Functions inherited from IOobject
template<class Type >
bool	typeHeaderOk (const bool checkType)
	Read header using typeGlobalFile to find file. More...

Protected Member Functions inherited from OldTimeField< DimensionedField< Type, GeoMesh, PrimitiveField > >
bool	readOldTimeIfPresent ()
	Read old-time field from file if it is present. More...

void	copyOldTimes (const IOobject &io, const OtherOldTime< OtherPrimitiveField > &)
	Copy the old-times from the given field. More...

void	copyOldTimes (const word &newName, const OtherOldTime< OtherPrimitiveField > &)
	Copy the old-times from the given field. More...

Protected Member Functions inherited from OldTimeField< GeometricField< Type, GeoMesh, PrimitiveField > >
bool	readOldTimeIfPresent ()
	Read old-time field from file if it is present. More...

void	copyOldTimes (const IOobject &io, const OtherOldTime< OtherPrimitiveField > &)
	Copy the old-times from the given field. More...

void	copyOldTimes (const word &newName, const OtherOldTime< OtherPrimitiveField > &)
	Copy the old-times from the given field. More...

Detailed Description

Source files

Definition at line 54 of file phaseModel.H.

Constructor & Destructor Documentation

◆ phaseModel()

phaseModel	(	const phaseSystem &	fluid,
		const word &	phaseName,
		const bool	referencePhase,
		const label	index
	)

Definition at line 41 of file phaseModel.C.

References phaseModel::fluid(), diameterModel::New(), and dictionary::subDict().

Here is the call graph for this function:

◆ ~phaseModel()

~phaseModel ( )

virtual

Destructor.

Definition at line 139 of file phaseModel.C.

Member Function Documentation

◆ ClassName()

ClassName ( "phaseModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		phaseModel	,
		phaseSystem	,
		(const phaseSystem &fluid, const word &phaseName, const bool referencePhase, const label index)	,
		(fluid, phaseName, referencePhase, index)
	)

◆ clone()

Foam::autoPtr< Foam::phaseModel > clone ( ) const

Return clone.

Definition at line 130 of file phaseModel.C.

References NotImplemented.

◆ New()

Foam::autoPtr< Foam::phaseModel > New	(	const phaseSystem &	fluid,
		const word &	phaseName,
		const bool	referencePhase,
		const label	index
	)

static

Definition at line 31 of file phaseModelNew.C.

References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, phaseModel::fluid(), phaseModel::index(), Foam::Info, dictionary::lookup(), and dictionary::subDict().

Referenced by phaseModel::iNew::operator()().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ name()

const Foam::word & name ( ) const

Return the name of this phase.

Definition at line 145 of file phaseModel.C.

Referenced by Luo::addToCoalescenceRate(), phaseSystem::correctContinuityError(), momentumTransferSystem::dragCorrs(), sizeGroup::fieldIo(), fractal::fractal(), heatTransferSystem::heatTransfer(), populationBalanceSystem::heatTransfer(), heatTransferSystem::heatTransferSystem(), heatTransferSystem::Hs(), phaseInterface::index(), momentumTransferSystem::invADVfs(), momentumTransferSystem::invADVs(), SidedInterfacialModel< ModelType >::modelInThe(), populationBalanceSystem::momentumTransfer(), diameterModel::New(), sizeGroup::iNew::operator()(), phaseInterface::otherPhase(), phaseForces::phaseForces(), reactionDrivenPhaseChange::reactionDrivenPhaseChange(), blendingMethod::readParameters(), sizeGroup::sizeGroup(), phaseSystem::solve(), multiphaseEuler::thermophysicalPredictor(), populationBalanceSetSizeDistribution::write(), and SidedInterfacialModel< blendedDiffusiveMassTransferModel >::writeData().

Here is the caller graph for this function:

◆ keyword()

const Foam::word & keyword ( ) const

Return the name of the phase for use as the keyword in PtrDictionary.

Definition at line 151 of file phaseModel.C.

◆ index()

Foam::label index ( ) const

Return the index of the phase.

Definition at line 157 of file phaseModel.C.

Referenced by momentumTransferSystem::alphaDByAf(), BlendedInterfacialModel< ModelType >::BlendedInterfacialModel(), mixtureKEpsilon< BasicMomentumTransportModel >::correct(), phaseSystem::correctContinuityError(), phaseSystem::correctPhi(), momentumTransferSystem::ddtCorrs(), momentumTransferSystem::dragCorrs(), populationBalanceModel::expansionSp(), phaseInterface::getPhase1(), phaseInterface::getPhase2(), momentumTransferSystem::invADVfs(), momentumTransferSystem::invADVs(), mixtureKEpsilon< BasicMomentumTransportModel >::mixtureKEpsilon(), phaseModel::New(), populationBalanceModel::solve(), and phaseSystem::solve().

Here is the caller graph for this function:

◆ fluid()

const Foam::phaseSystem & fluid ( ) const

Return the system to which this phase belongs.

Definition at line 163 of file phaseModel.C.

Referenced by continuousGasKEpsilon< BasicMomentumTransportModel >::correctNut(), IATEsource::fluid(), AttouFerschneider::K(), continuousGasKEqn< BasicMomentumTransportModel >::liquidTurbulence(), continuousGasKEpsilon< BasicMomentumTransportModel >::liquidTurbulence(), phaseModel::New(), phaseModel::phaseModel(), and continuousGasKEpsilon< BasicMomentumTransportModel >::rhoEff().

Here is the caller graph for this function:

◆ residualAlpha()

const Foam::dimensionedScalar & residualAlpha ( ) const

Return the residual phase-fraction for given phase.

Used to stabilise the phase momentum as the phase-fraction -> 0

Definition at line 169 of file phaseModel.C.

Referenced by oneResistanceHeatTransfer::addSup(), LehrMilliesMewesCoalescence::addToCoalescenceRate(), Ergun::CdRe(), fractal::correct(), populationBalanceModel::correct(), momentumTransferSystem::ddtCorrs(), momentumTransferSystem::dragCorrs(), phaseForces::execute(), momentumTransferSystem::invADVfs(), momentumTransferSystem::invADVs(), and populationBalanceModel::solve().

Here is the caller graph for this function:

◆ alphaMax()

Foam::scalar alphaMax ( ) const

Return the maximum phase-fraction (e.g. packing limit)

Definition at line 175 of file phaseModel.C.

Referenced by phaseSystem::solve().

Here is the caller graph for this function:

◆ d()

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

Return the Sauter-mean diameter.

Definition at line 181 of file phaseModel.C.

Referenced by LaheyKEpsilon< BasicMomentumTransportModel >::bubbleG(), mixtureKEpsilon< BasicMomentumTransportModel >::bubbleG(), populationBalanceModel::correct(), NicenoKEqn< BasicMomentumTransportModel >::correctNut(), SmagorinskyZhang< BasicMomentumTransportModel >::correctNut(), continuousGasKEpsilon< BasicMomentumTransportModel >::correctNut(), LaheyKEpsilon< BasicMomentumTransportModel >::correctNut(), cosine::limiter(), linear::limiter(), and sine::limiter().

Here is the caller graph for this function:

◆ diameter() [1/2]

const Foam::diameterModel & diameter ( ) const

Return a reference to the diameterModel of the phase.

Definition at line 187 of file phaseModel.C.

Referenced by phaseSurfaceArrheniusReactionRate::preEvaluate().

Here is the caller graph for this function:

◆ diameter() [2/2]

Foam::diameterModel & diameter ( )

Return a reference to the diameterModel of the phase.

Definition at line 193 of file phaseModel.C.

◆ correct()

void correct ( )

virtual

Correct the phase properties.

Definition at line 199 of file phaseModel.C.

◆ correctContinuityError()

void correctContinuityError ( const volScalarField & source )

virtual

Correct the continuity error.

Definition at line 205 of file phaseModel.C.

Referenced by phaseSystem::correctContinuityError().

Here is the caller graph for this function:

◆ correctKinematics()

void correctKinematics ( )

virtual

Correct the kinematics.

Definition at line 209 of file phaseModel.C.

◆ correctThermo()

void correctThermo ( )

virtual

Correct the thermodynamics.

Definition at line 213 of file phaseModel.C.

◆ correctReactions()

void correctReactions ( )

virtual

Correct the reactions.

Definition at line 217 of file phaseModel.C.

◆ correctSpecies()

void correctSpecies ( )

virtual

Correct the species concentrations.

Definition at line 221 of file phaseModel.C.

◆ predictMomentumTransport()

void predictMomentumTransport ( )

virtual

Predict the momentumTransport.

Definition at line 225 of file phaseModel.C.

◆ predictThermophysicalTransport()

void predictThermophysicalTransport ( )

virtual

Predict the energy transport.

Definition at line 229 of file phaseModel.C.

◆ correctMomentumTransport()

void correctMomentumTransport ( )

virtual

Correct the momentumTransport.

Definition at line 233 of file phaseModel.C.

◆ correctThermophysicalTransport()

void correctThermophysicalTransport ( )

virtual

Correct the energy transport.

Definition at line 237 of file phaseModel.C.

◆ correctUf()

void correctUf ( )

virtual

Correct the face velocity for moving meshes.

Definition at line 241 of file phaseModel.C.

◆ correctInflowOutflow()

void correctInflowOutflow ( surfaceScalarField & alphaPhi ) const

Ensure that the flux at inflow/outflow BCs is preserved.

Definition at line 251 of file phaseModel.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::boundaryFieldRef(), fvsPatchField< Type >::coupled(), forAll, and patchi.

Referenced by phaseSystem::solve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

bool read ( )

virtual

Read phase properties dictionary.

Reimplemented from regIOobject.

Definition at line 245 of file phaseModel.C.

◆ incompressible()

virtual bool incompressible ( ) const

pure virtual

Return true if the phase is incompressible otherwise false.

◆ isochoric()

virtual bool isochoric ( ) const

pure virtual

Return true if the phase is constant density otherwise false.

◆ divU() [1/2]

virtual const autoPtr<volScalarField>& divU ( ) const

pure virtual

Return the phase dilatation rate (d(alpha)/dt + div(alpha*phi))

Referenced by phaseSystem::solve().

Here is the caller graph for this function:

◆ divU() [2/2]

virtual void divU ( tmp< volScalarField > divU )

pure virtual

Set the phase dilatation rate (d(alpha)/dt + div(alpha*phi))

◆ thermo() [1/2]

virtual const rhoThermo& thermo ( ) const

pure virtual

Return the thermophysical model.

Referenced by oneResistanceHeatTransfer::addSup(), twoResistanceHeatTransfer::addSup(), Cole::fDeparture(), multiphaseExternalTemperatureFvPatchScalarField::getKappa(), multiphaseCoupledTemperatureFvPatchScalarField::getNbr(), multiphaseCoupledTemperatureFvPatchScalarField::getThis(), heatTransferSystem::heatTransfer(), populationBalanceSystem::heatTransfer(), KochFriedlanderSintering::tau(), and multiphaseEuler::thermophysicalPredictor().

Here is the caller graph for this function:

◆ thermo() [2/2]

virtual rhoThermo& thermo ( )

pure virtual

Access the thermophysical model.

◆ fluidThermo() [1/2]

virtual const rhoFluidThermo& fluidThermo ( ) const

pure virtual

Return the thermophysical model.

Referenced by phaseSystem::correctPhi().

Here is the caller graph for this function:

◆ fluidThermo() [2/2]

virtual rhoFluidThermo& fluidThermo ( )

pure virtual

Access the thermophysical model.

◆ rho() [1/2]

virtual const volScalarField& rho ( ) const

pure virtual

Return the density field.

Referenced by ballisticCollisions::addToCoalescenceRate(), Luo::addToCoalescenceRate(), massDiffusionLimitedPhaseChange::correct(), fractal::correct(), phaseSystem::correctContinuityError(), continuousGasKEpsilon< BasicMomentumTransportModel >::correctNut(), phaseSystem::correctPhi(), mixtureKEpsilon< BasicMomentumTransportModel >::Ct2(), KocamustafaogullariIshiiDepartureDiameter::dDeparture(), momentumTransferSystem::ddtCorrs(), KocamustafaogullariIshiiDepartureFrequency::fDeparture(), Cole::fDeparture(), KocamustafaogullariIshiiNucleationSite::nucleationSiteDensity(), LiaoCoalescence::precompute(), continuousGasKEpsilon< BasicMomentumTransportModel >::rhoEff(), mixtureKEpsilon< BasicMomentumTransportModel >::rhogEff(), Laakkonen::setBreakupRate(), populationBalanceModel::solve(), and phaseSystem::solve().

Here is the caller graph for this function:

◆ rho() [2/2]

virtual volScalarField& rho ( )

pure virtual

Access the density field.

◆ isothermal()

virtual bool isothermal ( ) const

pure virtual

Return whether the phase is isothermal.

Referenced by phaseSystem::phaseSystem().

Here is the caller graph for this function:

◆ heEqn()

virtual tmp<fvScalarMatrix> heEqn ( )

pure virtual

Return the enthalpy equation.

◆ pure()

virtual bool pure ( ) const

pure virtual

Return whether the phase is pure (i.e., not multi-component)

Referenced by phaseSystem::phaseSystem().

Here is the caller graph for this function:

◆ YiEqn()

virtual tmp<fvScalarMatrix> YiEqn ( volScalarField & Yi )

pure virtual

Return the species fraction equation.

◆ Y() [1/3]

virtual const PtrList<volScalarField>& Y ( ) const

pure virtual

Return the species mass fractions.

Referenced by populationBalanceSystem::specieTransfer().

Here is the caller graph for this function:

◆ Y() [2/3]

virtual const volScalarField& Y ( const label speciei ) const

pure virtual

Return a species mass fraction by index.

◆ Y() [3/3]

virtual const volScalarField& Y ( const word & name ) const

pure virtual

Return a species mass fraction by name.

◆ YRef()

virtual PtrList<volScalarField>& YRef ( )

pure virtual

Access the species mass fractions.

◆ solveSpecie()

virtual bool solveSpecie ( const label speciei ) const

pure virtual

Should the given specie be solved for? I.e., is it active and.

not the default specie?

◆ R() [1/2]

virtual tmp<volScalarField::Internal> R ( const label ) const

pure virtual

Return the consumption rate for a specie.

◆ R() [2/2]

virtual tmp<fvScalarMatrix> R ( volScalarField & Yi ) const

pure virtual

Return consumption rate matrix for a specie.

◆ stationary()

virtual bool stationary ( ) const

pure virtual

Return whether the phase is stationary.

Referenced by Foam::correctFixedFluxBCs(), phaseSystem::phaseSystem(), and phaseSystem::solve().

Here is the caller graph for this function:

◆ UEqn()

virtual tmp<fvVectorMatrix> UEqn ( )

pure virtual

Return the momentum equation.

◆ UfEqn()

virtual tmp<fvVectorMatrix> UfEqn ( )

pure virtual

Return the momentum equation for the face-based algorithm.

◆ U()

virtual tmp<volVectorField> U ( ) const

pure virtual

Return the velocity.

Referenced by LehrMilliesMewesCoalescence::addToCoalescenceRate(), kineticTheoryModel::correct(), populationBalanceModel::correct(), phaseSystem::correctBoundaryFlux(), phaseSystem::correctPhi(), momentumTransferSystem::ddtCorrs(), phaseForces::execute(), momentumTransferSystem::invADVfs(), phaseSystem::K(), populationBalanceSystem::momentumTransfer(), JohnsonJacksonSchaeffer::nu(), Schaeffer::nu(), and phaseSystem::solve().

Here is the caller graph for this function:

◆ URef() [1/2]

virtual volVectorField& URef ( )

pure virtual

Access the velocity.

Referenced by phaseSystem::correctPhi().

Here is the caller graph for this function:

◆ URef() [2/2]

virtual const volVectorField& URef ( ) const

pure virtual

Access the velocity.

◆ phi()

virtual tmp<surfaceScalarField> phi ( ) const

pure virtual

Return the volumetric flux.

Referenced by Foam::correctFixedFluxBCs(), momentumTransferSystem::ddtCorrs(), momentumTransferSystem::dragCorrs(), momentumTransferSystem::invADVfs(), and phaseSystem::solve().

Here is the caller graph for this function:

◆ phiRef() [1/2]

virtual surfaceScalarField& phiRef ( )

pure virtual

Access the volumetric flux.

Referenced by phaseSystem::correctBoundaryFlux(), and phaseSystem::correctPhi().

Here is the caller graph for this function:

◆ phiRef() [2/2]

virtual const surfaceScalarField& phiRef ( ) const

pure virtual

Access the volumetric flux.

◆ Uf()

virtual const autoPtr<surfaceVectorField>& Uf ( ) const

pure virtual

Return the face velocity.

Required for moving mesh cases

Referenced by momentumTransferSystem::ddtCorrs().

Here is the caller graph for this function:

◆ UfRef() [1/2]

virtual surfaceVectorField& UfRef ( )

pure virtual

Access the face velocity.

Required for moving mesh cases

Referenced by phaseSystem::correctPhi().

Here is the caller graph for this function:

◆ UfRef() [2/2]

virtual const surfaceVectorField& UfRef ( ) const

pure virtual

Access the face velocity.

Required for moving mesh cases

◆ alphaPhi()

virtual tmp<surfaceScalarField> alphaPhi ( ) const

pure virtual

Return the volumetric flux of the phase.

Referenced by fractal::correct(), populationBalanceModel::solve(), and phaseSystem::solve().

Here is the caller graph for this function:

◆ alphaPhiRef() [1/2]

virtual surfaceScalarField& alphaPhiRef ( )

pure virtual

Access the volumetric flux of the phase.

Referenced by phaseSystem::solve().

Here is the caller graph for this function:

◆ alphaPhiRef() [2/2]

virtual const surfaceScalarField& alphaPhiRef ( ) const

pure virtual

Access the volumetric flux of the phase.

◆ alphaRhoPhi()

virtual tmp<surfaceScalarField> alphaRhoPhi ( ) const

pure virtual

Return the mass flux of the phase.

◆ alphaRhoPhiRef() [1/2]

virtual surfaceScalarField& alphaRhoPhiRef ( )

pure virtual

Access the mass flux of the phase.

Referenced by phaseSystem::solve().

Here is the caller graph for this function:

◆ alphaRhoPhiRef() [2/2]

virtual const surfaceScalarField& alphaRhoPhiRef ( ) const

pure virtual

Access the mass flux of the phase.

◆ UgradU()

virtual tmp<fvVectorMatrix> UgradU ( ) const

pure virtual

Return the velocity transport matrix.

Referenced by momentumTransferSystem::invADVfs().

Here is the caller graph for this function:

◆ DUDt()

virtual tmp<fvVectorMatrix> DUDt ( ) const

pure virtual

Return the substantive acceleration matrix.

Referenced by phaseForces::execute(), and momentumTransferSystem::invADVs().

Here is the caller graph for this function:

◆ continuityError()

virtual tmp<volScalarField> continuityError ( ) const

pure virtual

Return the continuity error.

◆ K()

virtual tmp<volScalarField> K ( ) const

pure virtual

Return the phase kinetic energy.

◆ kappaEff()

virtual tmp<scalarField> kappaEff ( const label patchi ) const

pure virtual

Effective thermal turbulent conductivity.

of mixture for patch [W/m/K]

Referenced by multiphaseExternalTemperatureFvPatchScalarField::getKappa(), multiphaseCoupledTemperatureFvPatchScalarField::getNbr(), and multiphaseCoupledTemperatureFvPatchScalarField::getThis().

Here is the caller graph for this function:

◆ k()

virtual tmp<volScalarField> k ( ) const

pure virtual

Return the turbulent kinetic energy.

◆ pPrimef()

virtual tmp<surfaceScalarField> pPrimef ( ) const

pure virtual

Return the face-phase-pressure'.

(derivative of phase-pressure w.r.t. phase-fraction)

Referenced by momentumTransferSystem::alphaDByAf(), momentumTransferSystem::Ffs(), and momentumTransferSystem::Fs().

Here is the caller graph for this function:

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

applications/modules/multiphaseEuler/phaseSystem/phaseModel/phaseModel.H
applications/modules/multiphaseEuler/phaseSystem/phaseModel/phaseModel.C
applications/modules/multiphaseEuler/phaseSystem/phaseModel/phaseModelNew.C

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ phaseModel()

◆ ~phaseModel()

Member Function Documentation

◆ ClassName()

◆ declareRunTimeSelectionTable()

◆ clone()

◆ New()

◆ name()

◆ keyword()

◆ index()

◆ fluid()

◆ residualAlpha()

◆ alphaMax()

◆ d()

◆ diameter() [1/2]

◆ diameter() [2/2]

◆ correct()

◆ correctContinuityError()

◆ correctKinematics()

◆ correctThermo()

◆ correctReactions()

◆ correctSpecies()

◆ predictMomentumTransport()

◆ predictThermophysicalTransport()

◆ correctMomentumTransport()

◆ correctThermophysicalTransport()

◆ correctUf()

◆ correctInflowOutflow()

◆ read()

◆ incompressible()

◆ isochoric()

◆ divU() [1/2]

◆ divU() [2/2]

◆ thermo() [1/2]

◆ thermo() [2/2]

◆ fluidThermo() [1/2]

◆ fluidThermo() [2/2]

◆ rho() [1/2]

◆ rho() [2/2]

◆ isothermal()

◆ heEqn()

◆ pure()

◆ YiEqn()

◆ Y() [1/3]

◆ Y() [2/3]

◆ Y() [3/3]

◆ YRef()

◆ solveSpecie()

◆ R() [1/2]

◆ R() [2/2]

◆ stationary()

◆ UEqn()

◆ UfEqn()

◆ U()

◆ URef() [1/2]

◆ URef() [2/2]

◆ phi()

◆ phiRef() [1/2]

◆ phiRef() [2/2]

◆ Uf()

◆ UfRef() [1/2]

◆ UfRef() [2/2]

◆ alphaPhi()

◆ alphaPhiRef() [1/2]

◆ alphaPhiRef() [2/2]

◆ alphaRhoPhi()

◆ alphaRhoPhiRef() [1/2]

◆ alphaRhoPhiRef() [2/2]

◆ UgradU()

◆ DUDt()

◆ continuityError()

◆ K()

◆ kappaEff()

◆ k()