phase Class Reference

Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture for interface-capturing multi-phase simulations. More...

Inheritance diagram for phase:

Collaboration diagram for phase:

Classes
class	iNew

Public Member Functions
	phase (const word &name, const dictionary &phaseDict, const volVectorField &U, const surfaceScalarField &phi)
autoPtr< phase >	clone () const
const word &	name () const
const word &	keyword () const
const viscosityModel &	nuModel () const
tmp< volScalarField >	nu () const
tmp< scalarField >	nu (const label patchi) const
const dimensionedScalar &	rho () const
void	correct ()
bool	read (const dictionary &phaseDict)
Public Member Functions inherited from GeometricField
	TypeName ("GeometricField")
	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const word &patchFieldType=PatchField< Type >::calculatedType())
	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
	GeometricField (const IOobject &io, const Mesh &mesh, const dimensioned< Type > &dt, const word &patchFieldType=PatchField< Type >::calculatedType())
	GeometricField (const IOobject &io, const Mesh &mesh, const dimensioned< Type > &dt, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
	GeometricField (const IOobject &io, const Internal &diField, const PtrList< PatchField< Type >> &ptfl)
	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const Field< Type > &iField, const word &patchFieldType=PatchField< Type >::calculatedType())
	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, Field< Type > &&iField, const word &patchFieldType=PatchField< Type >::calculatedType())
	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const Field< Type > &iField, const PtrList< PatchField< Type >> &ptfl)
	GeometricField (const IOobject &io, const Mesh &mesh, const bool readOldTime=true)
	GeometricField (const IOobject &io, const Mesh &mesh, const dictionary &dict)
	GeometricField (const GeometricField< Type, PatchField, GeoMesh > &gf)
	GeometricField (const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf)
	GeometricField (const IOobject &io, const GeometricField< Type, PatchField, GeoMesh > &gf)
	GeometricField (const IOobject &io, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf)
	GeometricField (const word &newName, const GeometricField< Type, PatchField, GeoMesh > &gf)
	GeometricField (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf)
	GeometricField (const IOobject &io, const GeometricField< Type, PatchField, GeoMesh > &gf, const word &patchFieldType)
	GeometricField (const IOobject &io, const GeometricField< Type, PatchField, GeoMesh > &gf, const labelList &patchIDs, const word &patchFieldType)
	GeometricField (const IOobject &io, const GeometricField< Type, PatchField, GeoMesh > &gf, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
	GeometricField (const IOobject &io, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
tmp< GeometricField< Type, PatchField, GeoMesh > >	clone () const
virtual	~GeometricField ()
Internal &	ref (const bool updateAccessTime=true)
const Internal &	internalField () const
const Internal &	v () const
Internal::FieldType &	primitiveFieldRef (const bool updateAccessTime=true)
const Internal::FieldType &	primitiveField () const
Boundary &	boundaryFieldRef (const bool updateAccessTime=true)
const Boundary &	boundaryField () const
label	timeIndex () const
label &	timeIndex ()
void	storeOldTimes () const
void	storeOldTime () const
label	nOldTimes () const
const GeometricField< Type, PatchField, GeoMesh > &	oldTime () const
GeometricField< Type, PatchField, GeoMesh > &	oldTime ()
void	storePrevIter () const
const GeometricField< Type, PatchField, GeoMesh > &	prevIter () const
void	correctBoundaryConditions ()
bool	needReference () const
tmp< GeometricField< cmptType, PatchField, GeoMesh > >	component (const direction) const
bool	writeData (Ostream &) const
tmp< GeometricField< Type, PatchField, GeoMesh > >	T () const
void	relax (const scalar alpha)
void	relax ()
word	select (bool final) const
void	writeMinMax (Ostream &os) const
void	negate ()
void	replace (const direction d, const GeometricField< cmptType, PatchField, GeoMesh > &gcf)
void	replace (const direction d, const dimensioned< cmptType > &ds)
void	min (const dimensioned< Type > &dt)
void	max (const dimensioned< Type > &dt)
void	clip (const dimensioned< MinMax< Type >> &range)
void	clip (const dimensioned< Type > &minVal, const dimensioned< Type > &maxVal)
void	maxMin (const dimensioned< Type > &minVal, const dimensioned< Type > &maxVal)
const Internal &	operator() () const
void	operator= (const GeometricField< Type, PatchField, GeoMesh > &)
void	operator= (const tmp< GeometricField< Type, PatchField, GeoMesh >> &)
void	operator= (const dimensioned< Type > &)
void	operator== (const tmp< GeometricField< Type, PatchField, GeoMesh >> &)
void	operator== (const dimensioned< Type > &)
void	operator+= (const GeometricField< Type, PatchField, GeoMesh > &)
void	operator+= (const tmp< GeometricField< Type, PatchField, GeoMesh >> &)
void	operator-= (const GeometricField< Type, PatchField, GeoMesh > &)
void	operator-= (const tmp< GeometricField< Type, PatchField, GeoMesh >> &)
void	operator*= (const GeometricField< scalar, PatchField, GeoMesh > &)
void	operator*= (const tmp< GeometricField< scalar, PatchField, GeoMesh >> &)
void	operator/= (const GeometricField< scalar, PatchField, GeoMesh > &)
void	operator/= (const tmp< GeometricField< scalar, PatchField, GeoMesh >> &)
void	operator+= (const dimensioned< Type > &)
void	operator-= (const dimensioned< Type > &)
void	operator*= (const dimensioned< scalar > &)
void	operator/= (const dimensioned< scalar > &)
tmp< GeometricField< scalar, faPatchField, areaMesh > >	component (const direction) const
void	replace (const direction, const GeometricField< scalar, faPatchField, areaMesh > &gsf)
tmp< GeometricField< scalar, faPatchField, areaMesh > >	component (const direction) const
void	replace (const direction, const GeometricField< scalar, faPatchField, areaMesh > &sf)
tmp< GeometricField< scalar, fvPatchField, volMesh > >	component (const direction) const
void	replace (const direction, const GeometricField< scalar, fvPatchField, volMesh > &gsf)
tmp< GeometricField< scalar, fvPatchField, volMesh > >	component (const direction) const
void	replace (const direction, const GeometricField< scalar, fvPatchField, volMesh > &sf)

Additional Inherited Members
Public Types inherited from GeometricField
typedef GeoMesh::Mesh	Mesh
typedef GeoMesh::BoundaryMesh	BoundaryMesh
typedef DimensionedField< Type, GeoMesh >	Internal
typedef PatchField< Type >	Patch
typedef Field< Type >::cmptType	cmptType
Static Public Member Functions inherited from GeometricField
static const GeometricField< Type, PatchField, GeoMesh > &	null ()
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &name, const Mesh &mesh, const dimensionSet &ds, const word &patchFieldType=PatchField< Type >::calculatedType())
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &name, const Mesh &mesh, const dimensionSet &ds, const Field< Type > &iField, const word &patchFieldType=PatchField< Type >::calculatedType())
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &name, const Mesh &mesh, const dimensionSet &ds, Field< Type > &&iField, const word &patchFieldType=PatchField< Type >::calculatedType())
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &name, const Mesh &mesh, const dimensioned< Type > &dt, const word &patchFieldType=PatchField< Type >::calculatedType())
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &name, const Mesh &mesh, const dimensioned< Type > &dt, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf)
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())

Detailed Description

Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture for interface-capturing multi-phase simulations.

Source files

• phase.H
• phase.C

Definition at line 50 of file phase.H.

Constructor & Destructor Documentation

phase()

phase	(	const word &	name,
		const dictionary &	phaseDict,
		const volVectorField &	U,
		const surfaceScalarField &	phi
	)

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

Here is the caller graph for this function:

Member Function Documentation

clone()

autoPtr<phase> clone

(

)

const

name()

const word& name ( ) const

inline

Definition at line 107 of file phase.H.

Referenced by phaseSystem::addField(), alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField::calcAlphat(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), phaseSystem::fillFields(), phaseSystem::generatePairsAndSubModels(), OneResistanceHeatTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), TwoResistanceHeatTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), phasePair::index(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::InterfaceCompositionPhaseChangePhaseSystem(), phase::keyword(), PopulationBalancePhaseSystem< BasePhaseSystem >::massTransfer(), PhaseTransferPhaseSystem< BasePhaseSystem >::massTransfer(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::massTransfer(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::massTransfer(), MomentumTransferPhaseSystem< BasePhaseSystem >::momentumTransfer(), MomentumTransferPhaseSystem< BasePhaseSystem >::momentumTransferf(), diameterModel::New(), phasePair::otherPhase(), and fixedMultiPhaseHeatFluxFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

keyword()

const word& keyword ( ) const

inline

Definition at line 112 of file phase.H.

References phase::name().

Here is the call graph for this function:

nuModel()

const viscosityModel& nuModel ( ) const

inline

Definition at line 118 of file phase.H.

nu() [1/2]

tmp<volScalarField> nu ( ) const

inline

Definition at line 124 of file phase.H.

nu() [2/2]

tmp<scalarField> nu ( const label  patchi ) const

inline

Definition at line 130 of file phase.H.

rho()

const dimensionedScalar& rho ( ) const

inline

Definition at line 136 of file phase.H.

Referenced by constantDrift::addToDriftRate(), constantNucleation::addToNucleationRate(), wallBoiling::addToNucleationRate(), multiphaseSystem::Cvm(), MomentumTransferPhaseSystem< BasePhaseSystem >::ddtCorrByAs(), IATEsource::Eo(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::massTransfer(), IATEsource::Mo(), wallBoiling::R(), populationBalanceModel::solve(), and multiphaseSystem::Svm().

Here is the caller graph for this function:

correct()

void correct

(

)

Referenced by multiphaseSystem::solve().

Here is the caller graph for this function:

read()

bool read

(

const dictionary &

phaseDict

)

Referenced by multiphaseSystem::read().

Here is the caller graph for this function:

---

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

• applications/solvers/multiphase/multiphaseInterFoam/multiphaseMixture/phase/phase.H