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]

Data Structures
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
	TypeName ("GeometricField")
	Runtime type information. More...

	GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const word &patchFieldType=PatchField< Type >::calculatedType())
	Constructor given IOobject, mesh, dimensions and patch type. More...

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

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

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

	GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const Field< Type > &, const PtrList< PatchField< Type > > &)
	Constructor from components. More...

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

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

	GeometricField (const GeometricField< Type, PatchField, GeoMesh > &)
	Construct as copy. More...

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

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

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

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

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

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

	GeometricField (const IOobject &, const GeometricField< Type, PatchField, GeoMesh > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
	Construct as copy resetting IO parameters and boundary types. More...

virtual	~GeometricField ()
	Destructor. More...

DimensionedInternalField &	dimensionedInternalField ()
	Return dimensioned internal field. More...

const DimensionedInternalField &	dimensionedInternalField () const
	Return dimensioned internal field. More...

InternalField &	internalField ()
	Return internal field. More...

const InternalField &	internalField () const
	Return internal field. More...

GeometricBoundaryField &	boundaryField ()
	Return reference to GeometricBoundaryField. More...

const GeometricBoundaryField &	boundaryField () const
	Return reference to GeometricBoundaryField for const 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< Type, PatchField, GeoMesh > &	oldTime () const
	Return old time field. More...

GeometricField< Type, PatchField, GeoMesh > &	oldTime ()
	Return non-const old time field. More...

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

const GeometricField< Type, PatchField, GeoMesh > &	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, PatchField, GeoMesh > >	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, PatchField, GeoMesh > >	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 ()

void	replace (const direction, const GeometricField< cmptType, PatchField, GeoMesh > &)

void	replace (const direction, const dimensioned< cmptType > &)

void	max (const dimensioned< Type > &)

void	min (const dimensioned< Type > &)

void	max (const GeometricField< Type, PatchField, GeoMesh > &, const dimensioned< Type > &)

void	min (const GeometricField< Type, PatchField, GeoMesh > &, const dimensioned< Type > &)

void	scale (const GeometricField< Type, PatchField, GeoMesh > &, const GeometricField< Type, PatchField, GeoMesh > &)

void	scale (const GeometricField< Type, PatchField, GeoMesh > &, const dimensioned< Type > &)

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, 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)

Private Attributes
word	name_

dictionary	phaseDict_

autoPtr< viscosityModel >	nuModel_

dimensionedScalar	rho_

Additional Inherited Members
Public Types inherited from GeometricField
typedef GeoMesh::Mesh	Mesh

typedef GeoMesh::BoundaryMesh	BoundaryMesh

typedef DimensionedField< Type, GeoMesh >	DimensionedInternalField

typedef Field< Type >	InternalField

typedef PatchField< Type >	PatchFieldType

typedef Field< Type >::cmptType	cmptType

Static Public Member Functions inherited from GeometricField
static const GeometricField< Type, PatchField, GeoMesh > &	null ()
	Return a null geometric field. 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 52 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 109 of file phase.H.

References phase::name_.

Referenced by phase::keyword().

Here is the caller graph for this function:

◆ keyword()

const word& keyword ( ) const

inline

Definition at line 114 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 120 of file phase.H.

References phase::nuModel_.

◆ nu() [1/2]

tmp<volScalarField> nu ( ) const

inline

Return the kinematic laminar viscosity.

Definition at line 126 of file phase.H.

References phase::nuModel_.

◆ nu() [2/2]

tmp<scalarField> nu ( const label patchi ) const

inline

Return the laminar viscosity for patch.

Definition at line 132 of file phase.H.

References phase::nuModel_, and patchi.

◆ rho()

const dimensionedScalar& rho ( ) const

inline

Return const-access to phase1 density.

Definition at line 138 of file phase.H.

References phase::rho_.

◆ correct()

void correct ( )

Correct the phase properties.

◆ read()

bool read ( const dictionary & phaseDict )

Read base transportProperties dictionary.

Field Documentation

◆ name_

word name_

private

Definition at line 58 of file phase.H.

Referenced by phase::name().

◆ phaseDict_

dictionary phaseDict_

private

Definition at line 59 of file phase.H.

◆ nuModel_

autoPtr<viscosityModel> nuModel_

private

Definition at line 60 of file phase.H.

Referenced by phase::nu(), and phase::nuModel().

◆ rho_

dimensionedScalar rho_

private

Definition at line 61 of file phase.H.

Referenced by phase::rho().

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

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

Data Structures

Public Member Functions

Private Attributes

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()

Field Documentation

◆ name_

◆ phaseDict_

◆ nuModel_

◆ rho_