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:

[legend]

Collaboration diagram for phase:

[legend]

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

Public Member Functions
	phase (const word &name, const dictionary &phaseDict, const volVectorField &U, const surfaceScalarField &phi)
	Construct from components. More...

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

const word &	name () const

const word &	keyword () const

const viscosityModel &	nuModel () const
	Return const-access to phase1 viscosityModel. More...

tmp< volScalarField >	nu () const
	Return the kinematic laminar viscosity. More...

tmp< scalarField >	nu (const label patchi) const
	Return the laminar viscosity for patch. More...

const dimensionedScalar &	rho () const
	Return const-access to phase1 density. More...

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

bool	read (const dictionary &phaseDict)
	Read base transportProperties dictionary. More...

Public Member Functions inherited from GeometricField< scalar, fvPatchField, volMesh >
	TypeName ("GeometricField")
	Runtime type information. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const word &patchFieldType=fvPatchField< scalar >::calculatedType())
	Construct given IOobject, mesh, dimensions and patch type. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
	Construct given IOobject, mesh, dimensions and patch types. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dimensioned< scalar > &dt, const word &patchFieldType=fvPatchField< scalar >::calculatedType())
	Construct given IOobject, mesh, dimensioned<Type> and patch type. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dimensioned< scalar > &dt, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
	Construct given IOobject, mesh, dimensioned<Type> and patch types. More...

	GeometricField (const IOobject &io, const Internal &diField, const PtrList< fvPatchField< scalar >> &ptfl)
	Copy construct from components. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const Field< scalar > &iField, const word &patchFieldType=fvPatchField< scalar >::calculatedType())
	Copy construct from internal field, with specified patch type. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, Field< scalar > &&iField, const word &patchFieldType=fvPatchField< scalar >::calculatedType())
	Move construct from internal field, with specified patch type. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const Field< scalar > &iField, const PtrList< fvPatchField< scalar >> &ptfl)
	Copy construct from components. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const bool readOldTime=true)
	Construct and read given IOobject. More...

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

	GeometricField (const GeometricField< scalar, fvPatchField, volMesh > &gf)
	Copy construct. More...

	GeometricField (const tmp< GeometricField< scalar, fvPatchField, volMesh >> &tgf)
	Construct from tmp<GeometricField> deleting argument. More...

	GeometricField (const IOobject &io, const GeometricField< scalar, fvPatchField, volMesh > &gf)
	Construct as copy resetting IO parameters. More...

	GeometricField (const IOobject &io, const tmp< GeometricField< scalar, fvPatchField, volMesh >> &tgf)
	Construct as copy of tmp<GeometricField> resetting IO parameters. More...

	GeometricField (const word &newName, const GeometricField< scalar, fvPatchField, volMesh > &gf)
	Copy construct with a new name. More...

	GeometricField (const word &newName, const tmp< GeometricField< scalar, fvPatchField, volMesh >> &tgf)
	Construct with a new name from tmp<GeometricField> More...

	GeometricField (const IOobject &io, const GeometricField< scalar, fvPatchField, volMesh > &gf, const word &patchFieldType)
	Construct as copy resetting IO parameters and patch type. More...

	GeometricField (const IOobject &io, const GeometricField< scalar, fvPatchField, volMesh > &gf, const labelList &patchIDs, const word &patchFieldType)

	GeometricField (const IOobject &io, const GeometricField< scalar, fvPatchField, volMesh > &gf, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
	Construct as copy resetting IO parameters and boundary types. More...

	GeometricField (const IOobject &io, const tmp< GeometricField< scalar, fvPatchField, volMesh >> &tgf, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
	Construct as copy resetting IO parameters and boundary types. More...

tmp< GeometricField< scalar, fvPatchField, volMesh > >	clone () const
	Clone. More...

virtual	~GeometricField ()
	Destructor. More...

Internal &	ref (const bool updateAccessTime=true)
	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

Internal::FieldType &	primitiveFieldRef (const bool updateAccessTime=true)
	Return a reference to the internal field. More...

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

Boundary &	boundaryFieldRef (const bool updateAccessTime=true)
	Return a reference to the boundary field. More...

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

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

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

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

void	storeOldTime () const
	Store the old-time field. More...

label	nOldTimes () const
	Return the number of old time fields stored. More...

const GeometricField< scalar, fvPatchField, volMesh > &	oldTime () const
	Return old time field. More...

GeometricField< scalar, fvPatchField, volMesh > &	oldTime ()
	Return non-const old time field. More...

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

const GeometricField< scalar, fvPatchField, volMesh > &	prevIter () const
	Return previous iteration field. More...

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

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

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

tmp< GeometricField< scalar, faPatchField, areaMesh > >	component (const direction) const

tmp< GeometricField< scalar, faPatchField, areaMesh > >	component (const direction) const

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

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

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

tmp< GeometricField< scalar, fvPatchField, volMesh > >	T () const
	Return transpose (only if it is a tensor field) More...

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

void	relax ()
	Relax field (for steady-state solution). 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 ()
	Negate the field inplace. More...

void	replace (const direction d, const GeometricField< cmptType, fvPatchField, volMesh > &gcf)
	Replace specified field component with content from another field. More...

void	replace (const direction d, const dimensioned< cmptType > &ds)
	Replace specified field component with specified value. More...

void	replace (const direction, const GeometricField< scalar, faPatchField, areaMesh > &gsf)

void	replace (const direction, const GeometricField< scalar, faPatchField, areaMesh > &sf)

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

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

void	min (const dimensioned< scalar > &dt)
	Use the minimum of the field and specified value. More...

void	max (const dimensioned< scalar > &dt)
	Use the maximum of the field and specified value. More...

void	clip (const dimensioned< MinMax< scalar >> &range)
	Clip the field to be bounded within the specified range. More...

void	clip (const dimensioned< scalar > &minVal, const dimensioned< scalar > &maxVal)
	Clip the field to be bounded within the specified range. More...

void	maxMin (const dimensioned< scalar > &minVal, const dimensioned< scalar > &maxVal)
	Deprecated(2019-01) identical to clip() More...

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

void	operator= (const GeometricField< scalar, fvPatchField, volMesh > &)

void	operator= (const tmp< GeometricField< scalar, fvPatchField, volMesh >> &)

void	operator= (const dimensioned< scalar > &)

void	operator== (const tmp< GeometricField< scalar, fvPatchField, volMesh >> &)

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

void	operator+= (const GeometricField< scalar, fvPatchField, volMesh > &)

void	operator+= (const tmp< GeometricField< scalar, fvPatchField, volMesh >> &)

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

void	operator-= (const GeometricField< scalar, fvPatchField, volMesh > &)

void	operator-= (const tmp< GeometricField< scalar, fvPatchField, volMesh >> &)

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

void	operator*= (const GeometricField< scalar, fvPatchField, volMesh > &)

void	operator*= (const tmp< GeometricField< scalar, fvPatchField, volMesh >> &)

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

void	operator/= (const GeometricField< scalar, fvPatchField, volMesh > &)

void	operator/= (const tmp< GeometricField< scalar, fvPatchField, volMesh >> &)

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

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

typedef volMesh ::BoundaryMesh	BoundaryMesh

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

typedef fvPatchField< scalar >	Patch

typedef Field< scalar >::cmptType	cmptType

Static Public Member Functions inherited from GeometricField< scalar, fvPatchField, volMesh >
static const GeometricField< scalar, fvPatchField, volMesh > &	null ()
	Return a null geometric field. More...

static tmp< GeometricField< scalar, fvPatchField, volMesh > >	New (const word &name, const Mesh &mesh, const dimensionSet &ds, const word &patchFieldType=fvPatchField< scalar >::calculatedType())
	Return tmp field from name, mesh, dimensions and patch type. More...

static tmp< GeometricField< scalar, fvPatchField, volMesh > >	New (const word &name, const Mesh &mesh, const dimensionSet &ds, const Field< scalar > &iField, const word &patchFieldType=fvPatchField< scalar >::calculatedType())

static tmp< GeometricField< scalar, fvPatchField, volMesh > >	New (const word &name, const Mesh &mesh, const dimensionSet &ds, Field< scalar > &&iField, const word &patchFieldType=fvPatchField< scalar >::calculatedType())

static tmp< GeometricField< scalar, fvPatchField, volMesh > >	New (const word &name, const Mesh &mesh, const dimensioned< scalar > &dt, const word &patchFieldType=fvPatchField< scalar >::calculatedType())

static tmp< GeometricField< scalar, fvPatchField, volMesh > >	New (const word &name, const Mesh &mesh, const dimensioned< scalar > &dt, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())

static tmp< GeometricField< scalar, fvPatchField, volMesh > >	New (const word &newName, const tmp< GeometricField< scalar, fvPatchField, volMesh >> &tgf)
	Return renamed tmp field. More...

static tmp< GeometricField< scalar, fvPatchField, volMesh > >	New (const word &newName, const tmp< GeometricField< scalar, fvPatchField, volMesh >> &tgf, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
	Rename tmp field and reset patch field types and return. More...

Detailed Description

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

Source files

Definition at line 54 of file phase.H.

Constructor & Destructor Documentation

◆ phase()

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

Construct from components.

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

Here is the caller graph for this function:

Member Function Documentation

◆ clone()

autoPtr<phase> clone ( ) const

Return clone.

◆ name()

const word& name ( ) const

inline

Definition at line 111 of file phase.H.

Here is the caller graph for this function:

◆ keyword()

const word& keyword ( ) const

inline

Definition at line 116 of file phase.H.

References phase::name().

Here is the call graph for this function:

◆ nuModel()

const viscosityModel& nuModel ( ) const

inline

Return const-access to phase1 viscosityModel.

Definition at line 122 of file phase.H.

◆ nu() [1/2]

tmp<volScalarField> nu ( ) const

inline

Return the kinematic laminar viscosity.

Definition at line 128 of file phase.H.

◆ nu() [2/2]

tmp<scalarField> nu ( const label patchi ) const

inline

Return the laminar viscosity for patch.

Definition at line 134 of file phase.H.

◆ rho()

const dimensionedScalar& rho ( ) const

inline

Return const-access to phase1 density.

Definition at line 140 of file phase.H.

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

Here is the caller graph for this function:

◆ correct()

void correct ( )

Correct the phase properties.

Referenced by phaseSystem::correct().

Here is the caller graph for this function:

◆ read()

bool read ( const dictionary & phaseDict )

Read base transportProperties dictionary.

Referenced by phaseSystem::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

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ phase()

Member Function Documentation

◆ clone()

◆ name()

◆ keyword()

◆ nuModel()

◆ nu() [1/2]

◆ nu() [2/2]

◆ rho()

◆ correct()

◆ read()