phaseModel 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 phaseModel:

Collaboration diagram for phaseModel:

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

Public Member Functions
	phaseModel (const word &phaseName, const dictionary &phaseDict, const fvMesh &mesh)
autoPtr< phaseModel >	clone () const
	Return clone. More...
virtual	~phaseModel ()
	Destructor. More...
const word &	name () const
const word &	keyword () const
tmp< volScalarField >	d () const
const dimensionedScalar &	nu () const
	Return the laminar viscosity. More...
const dimensionedScalar &	kappa () const
const dimensionedScalar &	Cp () const
const dimensionedScalar &	rho () const
const volVectorField &	U () const
volVectorField &	U ()
const volVectorField &	DDtU () const
volVectorField &	DDtU ()
const surfaceScalarField &	phi () const
surfaceScalarField &	phi ()
const surfaceScalarField &	alphaPhi () const
surfaceScalarField &	alphaPhi ()
void	correctInflowOutflow (surfaceScalarField &alphaPhi) const
	Ensure that the flux at inflow/outflow BCs is preserved. More...
void	correct ()
	Correct the phase properties. More...
bool	read (const dictionary &phaseDict)
	Read base transportProperties dictionary. More...
	ClassName ("phaseModel")
	Runtime type information. More...
	declareRunTimeSelectionTable (autoPtr, phaseModel, phaseSystem,(const phaseSystem &fluid, const word &phaseName, const label index),(fluid, phaseName, index))
	phaseModel (const phaseSystem &fluid, const word &phaseName, 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 autoPtr< diameterModel > &	dPtr () const
	Return const-reference to diameterModel of the phase. More...
virtual void	correct ()
	Correct the phase properties. More...
virtual void	correctKinematics ()
	Correct the kinematics. More...
virtual void	correctThermo ()
	Correct the thermodynamics. More...
virtual void	correctTurbulence ()
	Correct the turbulence. More...
virtual void	correctEnergyTransport ()
	Correct the energy transport. 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	compressible () const =0
	Return true if the phase is compressible otherwise false. More...
virtual tmp< 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 bool	isothermal () const =0
	Return whether the phase is isothermal. More...
virtual tmp< fvScalarMatrix >	heEqn ()=0
	Return the enthalpy equation. More...
virtual const rhoThermo &	thermo () const =0
	Return the thermophysical model. More...
virtual rhoThermo &	thermoRef ()=0
	Access the thermophysical model. More...
virtual tmp< volScalarField >	rho () const =0
	Return the density field. 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 word &name) const =0
	Return a species mass fraction by name. More...
virtual PtrList< volScalarField > &	YRef ()=0
	Access the species mass fractions. More...
virtual const UPtrList< volScalarField > &	YActive () const =0
	Return the active species mass fractions. More...
virtual UPtrList< volScalarField > &	YActiveRef ()=0
	Access the active species mass fractions. 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 tmp< surfaceScalarField >	phi () const =0
	Return the volumetric flux. More...
virtual surfaceScalarField &	phiRef ()=0
	Access the volumetric flux. 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 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 tmp< volVectorField >	DUDt () const =0
	Return the substantive acceleration. More...
virtual tmp< surfaceScalarField >	DUDtf () const =0
	Return the substantive acceleration on the faces. More...
virtual tmp< volScalarField >	continuityError () const =0
	Return the continuity error. More...
virtual tmp< volScalarField >	continuityErrorFlow () const =0
	Return the continuity error due to the flow field. More...
virtual tmp< volScalarField >	continuityErrorSources () const =0
	Return the continuity error due to any sources. More...
virtual tmp< volScalarField >	K () const =0
	Return the phase kinetic energy. More...
virtual tmp< volScalarField >	mu () const =0
	Return the laminar dynamic viscosity. More...
virtual tmp< scalarField >	mu (const label patchi) const =0
	Return the laminar dynamic viscosity on a patch. More...
virtual tmp< volScalarField >	nu () const =0
	Return the laminar kinematic viscosity. More...
virtual tmp< scalarField >	nu (const label patchi) const =0
	Return the laminar kinematic viscosity on a patch. More...
virtual tmp< volScalarField >	alpha () const =0
	Thermal diffusivity for enthalpy of mixture [kg/m/s]. More...
virtual tmp< scalarField >	alpha (const label patchi) const =0
	Thermal diffusivity for enthalpy of mixture for patch [kg/m/s]. More...
virtual tmp< volScalarField >	kappa () const =0
	Thermal diffusivity for temperature of mixture [J/m/s/K]. More...
virtual tmp< scalarField >	kappa (const label patchi) const =0
	Thermal diffusivity for temperature of mixture. More...
virtual tmp< volScalarField >	alphahe () const =0
	Thermal diffusivity for energy of mixture [kg/m/s]. More...
virtual tmp< scalarField >	alphahe (const label patchi) const =0
	Thermal diffusivity for energy of mixture for patch [kg/m/s]. More...
virtual tmp< volScalarField >	kappaEff (const volScalarField &alphat) const =0
	Effective thermal turbulent diffusivity for temperature. More...
virtual tmp< scalarField >	kappaEff (const scalarField &alphat, const label patchi) const =0
	Effective thermal turbulent diffusivity for temperature. More...
virtual tmp< volScalarField >	alphaEff (const volScalarField &alphat) const =0
	Effective thermal turbulent diffusivity of mixture [kg/m/s]. More...
virtual tmp< scalarField >	alphaEff (const scalarField &alphat, const label patchi) const =0
	Effective thermal turbulent diffusivity of mixture. More...
virtual tmp< volScalarField >	mut () const =0
	Return the turbulent dynamic viscosity. More...
virtual tmp< volScalarField >	muEff () const =0
	Return the effective dynamic viscosity. More...
virtual tmp< volScalarField >	nut () const =0
	Return the turbulent kinematic viscosity. More...
virtual tmp< volScalarField >	nuEff () const =0
	Return the effective kinematic viscosity. More...
virtual tmp< volScalarField >	kappaEff () const =0
	Effective thermal turbulent diffusivity for temperature. More...
virtual tmp< scalarField >	kappaEff (const label patchi) const =0
	Effective thermal turbulent diffusivity for temperature. More...
virtual tmp< volScalarField >	alphaEff () const =0
	Effective thermal turbulent diffusivity of mixture [kg/m/s]. More...
virtual tmp< scalarField >	alphaEff (const label patchi) const =0
	Effective thermal turbulent diffusivity of mixture. More...
virtual tmp< volScalarField >	k () const =0
	Return the turbulent kinetic energy. More...
virtual tmp< volScalarField >	pPrime () const =0
	Return the phase-pressure'. More...
	phaseModel (const twoPhaseSystem &fluid, const dictionary &phaseProperties, const word &phaseName)
virtual	~phaseModel ()
	Destructor. More...
const word &	name () const
	Return the name of this phase. More...
const twoPhaseSystem &	fluid () const
	Return the twoPhaseSystem to which this phase belongs. More...
const phaseModel &	otherPhase () const
	Return the other phase in this two-phase system. More...
const dimensionedScalar &	residualAlpha () const
	Return the residual phase-fraction for given phase. More...
scalar	alphaMax () const
	Optional maximum phase-fraction (e.g. packing limit) More...
tmp< volScalarField >	d () const
	Return the Sauter-mean diameter. More...
const PhaseCompressibleTurbulenceModel< phaseModel > &	turbulence () const
	Return the turbulence model. More...
PhaseCompressibleTurbulenceModel< phaseModel > &	turbulence ()
	Return non-const access to the turbulence model. More...
const rhoThermo &	thermo () const
	Return the thermophysical model. More...
rhoThermo &	thermo ()
	Return non-const access to the thermophysical model. More...
tmp< volScalarField >	nu () const
	Return the laminar viscosity. More...
tmp< scalarField >	nu (const label patchi) const
	Return the laminar viscosity for patch. More...
tmp< volScalarField >	mu () const
	Return the laminar dynamic viscosity. More...
tmp< scalarField >	mu (const label patchi) const
	Return the laminar dynamic viscosity for patch. More...
tmp< scalarField >	kappa (const label patchi) const
	Return the thermal conductivity on a patch. More...
tmp< volScalarField >	kappa () const
	Return the thermal conductivity. More...
tmp< volScalarField >	alphahe () const
	Thermal diffusivity for energy of mixture [kg/m/s]. More...
tmp< scalarField >	alphahe (const label patchi) const
	Thermal diffusivity for energy of mixture for patch [kg/m/s]. More...
tmp< volScalarField >	kappaEff (const volScalarField &alphat) const
	Return the laminar thermal conductivity. More...
tmp< scalarField >	kappaEff (const scalarField &alphat, const label patchi) const
	Return the laminar thermal conductivity on a patch. More...
tmp< volScalarField >	alpha () const
	Return the laminar thermal diffusivity for enthalpy. More...
tmp< scalarField >	alpha (const label patchi) const
	Return the laminar thermal diffusivity for enthalpy on a patch. More...
tmp< volScalarField >	alphaEff (const volScalarField &alphat) const
	Return the effective thermal diffusivity for enthalpy. More...
tmp< scalarField >	alphaEff (const scalarField &alphat, const label patchi) const
	Return the effective thermal diffusivity for enthalpy on a patch. More...
tmp< volScalarField >	Cp () const
	Return the specific heat capacity. More...
const volScalarField &	rho () const
	Return the density. More...
const volVectorField &	U () const
	Return the velocity. More...
volVectorField &	U ()
	Return non-const access to the velocity. More...
const surfaceScalarField &	phi () const
	Return the volumetric flux. More...
surfaceScalarField &	phi ()
	Return non-const access to the volumetric flux. More...
const surfaceScalarField &	alphaPhi () const
	Return the volumetric flux of the phase. More...
surfaceScalarField &	alphaPhi ()
	Return non-const access to the volumetric flux of the phase. More...
const surfaceScalarField &	alphaRhoPhi () const
	Return the mass flux of the phase. More...
surfaceScalarField &	alphaRhoPhi ()
	Return non-const access to the mass flux of the phase. More...
void	correctInflowOutflow (surfaceScalarField &alphaPhi) const
	Ensure that the flux at inflow/outflow BCs is preserved. More...
void	correct ()
	Correct the phase properties. More...
virtual bool	read (const dictionary &phaseProperties)
	Read phaseProperties dictionary. More...
virtual bool	read ()
	Dummy Read for transportModel. More...
	phaseModel (const word &phaseName, const volScalarField &p, const volScalarField &T)
	Construct from components. More...
autoPtr< phaseModel >	clone () const
	Return clone. More...
const word &	name () const
const word &	keyword () const
const rhoThermo &	thermo () const
	Return const-access to phase rhoThermo. More...
rhoThermo &	thermo ()
	Return access to phase rhoThermo. More...
const volScalarField &	dgdt () const
	Return const-access to phase divergence. More...
volScalarField &	dgdt ()
	Return access to phase divergence. More...
void	correct ()
	Correct the laminar viscosity. More...
Public Member Functions inherited from GeometricField< Type, PatchField, GeoMesh >
	TypeName ("GeometricField")
	Runtime type information. More...
	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, const word &patchFieldType=PatchField< Type >::calculatedType())
	Construct given IOobject, mesh, dimensions and patch type. More...
	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
	Construct given IOobject, mesh, dimensions and patch types. More...
	GeometricField (const IOobject &io, const Mesh &mesh, const Type &value, const dimensionSet &dims, const word &patchFieldType=PatchField< Type >::calculatedType())
	Construct given IOobject, mesh, dimensions, initial field value and given patch type. More...
	GeometricField (const IOobject &io, const Mesh &mesh, const Type &value, const dimensionSet &dims, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
	Construct given IOobject, mesh, dimensions, initial field value and given patch types. More...
	GeometricField (const IOobject &io, const Mesh &mesh, const dimensioned< Type > &dt, const word &patchFieldType=PatchField< Type >::calculatedType())
	Construct given IOobject, mesh, dimensioned<Type> and patch type. More...
	GeometricField (const IOobject &io, const Mesh &mesh, const dimensioned< Type > &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< PatchField< Type >> &ptfl)
	Copy construct from internal field and a patch list to clone. More...
	GeometricField (const IOobject &io, Internal &&diField, const PtrList< PatchField< Type >> &ptfl)
	Move construct from internal field and a patch list to clone. More...
	GeometricField (const IOobject &io, const tmp< Internal > &tfield, const PtrList< PatchField< Type >> &ptfl)
	Move construct from internal field and a patch list to clone. More...
	GeometricField (const Internal &diField, const PtrList< PatchField< Type >> &ptfl)
	Copy construct from internal field and a patch list to clone. More...
	GeometricField (Internal &&diField, const PtrList< PatchField< Type >> &ptfl)
	Move construct from internal field and a patch list to clone. More...
	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, const Field< Type > &iField, const word &patchFieldType=PatchField< Type >::calculatedType())
	Copy construct from internal field, with specified patch type. More...
	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, Field< Type > &&iField, const word &patchFieldType=PatchField< Type >::calculatedType())
	Move construct from internal field, with specified patch type. More...
	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, const Field< Type > &iField, const PtrList< PatchField< Type >> &ptfl)
	Copy construct from components. More...
	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, Field< Type > &&iField, const PtrList< PatchField< Type >> &ptfl)
	Move construct from internal field and a patch list to clone. More...
	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, const tmp< Field< Type >> &tiField, const PtrList< PatchField< Type >> &ptfl)
	Copy construct from components. More...
	GeometricField (const IOobject &io, const Mesh &mesh, const bool readOldTime=true)
	Read construct using given IOobject. Always reads! More...
	GeometricField (const IOobject &io, const Mesh &mesh, const dictionary &dict)
	Construct from dictionary. More...
	GeometricField (const GeometricField< Type, PatchField, GeoMesh > &gf)
	Copy construct. More...
	GeometricField (const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf)
	Construct from tmp<GeometricField> deleting argument. More...
	GeometricField (const IOobject &io, const GeometricField< Type, PatchField, GeoMesh > &gf)
	Construct as copy resetting IO parameters. More...
	GeometricField (const IOobject &io, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf)
	Construct from tmp<GeometricField> resetting IO parameters. More...
	GeometricField (const word &newName, const GeometricField< Type, PatchField, GeoMesh > &gf)
	Copy construct with a new name. More...
	GeometricField (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf)
	Construct with a new name from tmp<GeometricField> More...
	GeometricField (const IOobject &io, const GeometricField< Type, PatchField, GeoMesh > &gf, const word &patchFieldType)
	Construct as copy resetting IO parameters and patch type. More...
	GeometricField (const IOobject &io, const GeometricField< Type, PatchField, GeoMesh > &gf, const labelList &patchIDs, const word &patchFieldType)
	Construct as copy resetting IO parameters and boundary type for selected patchIDs. More...
	GeometricField (const IOobject &io, const GeometricField< Type, PatchField, GeoMesh > &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< Type, PatchField, GeoMesh >> &tgf, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
	Construct as copy resetting IO parameters and boundary types. More...
tmp< GeometricField< Type, PatchField, GeoMesh > >	clone () const
	Clone. More...
virtual	~GeometricField ()
	Destructor. More...
const Internal &	internalField () const noexcept
	Return a const-reference to the dimensioned internal field. More...
Internal &	internalFieldRef (const bool updateAccessTime=true)
	Return a reference to the dimensioned internal field. More...
Internal &	ref (const bool updateAccessTime=true)
	Same as internalFieldRef() More...
const Internal &	v () const
	Return a const-reference to the dimensioned internal field of a "vol" field. More...
const Internal::FieldType &	primitiveField () const noexcept
	Return a const-reference to the internal field values. More...
Internal::FieldType &	primitiveFieldRef (const bool updateAccessTime=true)
	Return a reference to the internal field values. More...
const Boundary &	boundaryField () const noexcept
	Return const-reference to the boundary field. More...
Boundary &	boundaryFieldRef (const bool updateAccessTime=true)
	Return a reference to the boundary field. More...
label	timeIndex () const noexcept
	Return the time index of the field. More...
label &	timeIndex () noexcept
	Write-access to the time index of the field. More...
label	nOldTimes () const noexcept
	The number of old time fields stored. More...
void	storeOldTimes () const
	Store the old-time fields. More...
void	storeOldTime () const
	Store the old-time field. 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	clearOldTimes ()
	Remove old-time and prev-iter fields. More...
void	correctBoundaryConditions ()
	Correct boundary field. More...
void	correctLocalBoundaryConditions ()
	Correct boundary conditions after a purely local operation. 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...
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 by returning the field name + "Final" otherwise the standard parameters by returning the field name. More...
void	writeMinMax (Ostream &os) const
	Helper function to write the min and max to an Ostream. More...
void	negate ()
	Negate the field inplace. See notes in Field. More...
void	normalise ()
	Normalise the field inplace. See notes in Field. More...
void	replace (const direction d, const GeometricField< cmptType, PatchField, GeoMesh > &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	clamp_min (const Type &lower)
	Impose lower (floor) clamp on the field values (in-place) More...
void	clamp_max (const Type &upper)
	Impose upper (ceiling) clamp on the field values (in-place) More...
void	clamp_min (const dimensioned< Type > &lower)
	Impose lower (floor) clamp on the field values (in-place) More...
void	clamp_max (const dimensioned< Type > &upper)
	Impose upper (ceiling) clamp on the field values (in-place) More...
void	clamp_range (const dimensioned< MinMax< Type >> &range)
	Clamp field values (in-place) to the specified range. More...
void	clamp_range (const Type &lower, const Type &upper)
	Clamp field values (in-place) to the specified range. More...
void	clamp_range (const MinMax< Type > &range)
	Clamp field values (in-place) to the specified range. More...
void	clamp_range (const dimensioned< Type > &lower, const dimensioned< Type > &upper)
	Clamp field values (in-place) to the specified range. More...
const Internal &	operator() () const
	Same as internalField(). More...
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 > &)
bool	operator!= (const GeometricField< Type, PatchField, GeoMesh > &)=delete
bool	operator!= (const tmp< GeometricField< Type, PatchField, GeoMesh >> &)=delete
bool	operator!= (const dimensioned< Type > &)=delete
bool	writeData (Ostream &os) const
	The writeData function (required by regIOobject) More...
void	clip (const dimensioned< MinMax< Type >> &range)
	Clamp field values (in-place) to the specified range. More...
void	clip (const dimensioned< Type > &lo, const dimensioned< Type > &hi)
	Clamp field values (in-place) to the specified range. More...
void	min (const dimensioned< Type > &upper)
	Use minimum of the field and specified value. ie, clamp_max(). More...
void	max (const dimensioned< Type > &lower)
	Use maximum of the field and specified value. ie, clamp_min(). More...
void	maxMin (const dimensioned< Type > &lo, const dimensioned< Type > &hi)
	Deprecated(2019-01) identical to clamp_range() More...
template<>
tmp< GeometricField< scalar, faPatchField, areaMesh > >	component (const direction) const
template<>
void	replace (const direction, const GeometricField< scalar, faPatchField, areaMesh > &gsf)
template<>
tmp< GeometricField< scalar, faPatchField, areaMesh > >	component (const direction) const
template<>
void	replace (const direction, const GeometricField< scalar, faPatchField, areaMesh > &sf)
template<>
tmp< GeometricField< scalar, fvPatchField, volMesh > >	component (const direction) const
template<>
void	replace (const direction, const GeometricField< scalar, fvPatchField, volMesh > &gsf)
template<>
tmp< GeometricField< scalar, fvPatchField, volMesh > >	component (const direction) const
template<>
void	replace (const direction, const GeometricField< scalar, fvPatchField, volMesh > &sf)
template<class... Args>
Foam::tmp< Foam::GeometricField< Type, PatchField, GeoMesh > >	New_impl (IOobjectOption::registerOption regOpt, const word &name, const Mesh &mesh, Args &&... args)
template<class AnyType >
Foam::tmp< Foam::GeometricField< Type, PatchField, GeoMesh > >	New (const GeometricField< AnyType, PatchField, GeoMesh > &fld, const word &name, const dimensionSet &dims, const word &patchFieldType)
template<class AnyType >
Foam::tmp< Foam::GeometricField< Type, PatchField, GeoMesh > >	New (const GeometricField< AnyType, PatchField, GeoMesh > &fld, const word &name, const dimensioned< Type > &dt, const word &patchFieldType)
Public Member Functions inherited from DimensionedField< Type, GeoMesh >
	TypeName ("DimensionedField")
	Runtime type information. More...
	DimensionedField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, const Field< Type > &field)
	Construct from components, copy initial field content. More...
	DimensionedField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, Field< Type > &&field)
	Construct from components, transferring initial field content. More...
	DimensionedField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, List< Type > &&field)
	Construct from components, transferring initial field content. More...
	DimensionedField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, const tmp< Field< Type >> &tfield)
	Construct from components, copy or transfer tmp content. More...
	DimensionedField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, const bool checkIOFlags=true)
	Construct from components, setting initial size and dimensions, but not initialising any field values. More...
	DimensionedField (const IOobject &io, const Mesh &mesh, const Type &value, const dimensionSet &dims, const bool checkIOFlags=true)
	Construct from components, setting dimensions and initial uniform field value. More...
	DimensionedField (const IOobject &io, const Mesh &mesh, const dimensioned< Type > &dt, const bool checkIOFlags=true)
	Construct from components, setting dimensions and initial uniform field value. More...
	DimensionedField (const IOobject &io, const Mesh &mesh, const word &fieldDictEntry="value")
	Construct from Istream. More...
	DimensionedField (const IOobject &io, const Mesh &mesh, const dictionary &fieldDict, const word &fieldDictEntry="value")
	Construct from dictionary. More...
	DimensionedField (const DimensionedField< Type, GeoMesh > &df)
	Copy construct. More...
	DimensionedField (DimensionedField< Type, GeoMesh > &&df)
	Move construct. More...
	DimensionedField (DimensionedField< Type, GeoMesh > &df, bool reuse)
	Copy construct or reuse (move) as specified. More...
	DimensionedField (const tmp< DimensionedField< Type, GeoMesh >> &tdf)
	Construct from tmp<DimensionedField> deleting argument. More...
	DimensionedField (const IOobject &io, const DimensionedField< Type, GeoMesh > &df)
	Copy construct, resetting IO parameters. More...
	DimensionedField (const IOobject &io, DimensionedField< Type, GeoMesh > &&df)
	Move construct, resetting IO parameters. More...
	DimensionedField (const IOobject &io, DimensionedField< Type, GeoMesh > &df, bool reuse)
	Copy or move construct, resetting IO parameters. More...
	DimensionedField (const IOobject &io, const tmp< DimensionedField< Type, GeoMesh >> &tdf)
	Construct from tmp<DimensionedField> deleting argument, resetting IO parameters. More...
	DimensionedField (const word &newName, const DimensionedField< Type, GeoMesh > &df)
	Copy construct with a new name. More...
	DimensionedField (const word &newName, DimensionedField< Type, GeoMesh > &&df)
	Move construct with a new name. More...
	DimensionedField (const word &newName, DimensionedField< Type, GeoMesh > &df, bool reuse)
	Copy or move construct, resetting name. More...
	DimensionedField (const word &newName, const tmp< DimensionedField< Type, GeoMesh >> &tdf)
	Construct with a new name from tmp<DimensionedField> More...
tmp< DimensionedField< Type, GeoMesh > >	clone () const
	Clone. More...
virtual	~DimensionedField ()
	Destructor. More...
void	readField (const dictionary &fieldDict, const word &fieldDictEntry="value")
	Resize to the mesh size and read the field from the dictionary. Internal implementation checks field vs mesh size. More...
const Mesh &	mesh () const noexcept
	Return mesh. More...
const dimensionSet &	dimensions () const noexcept
	Return dimensions. More...
dimensionSet &	dimensions () noexcept
	Return non-const access to dimensions. More...
orientedType	oriented () const noexcept
	Return oriented type. More...
orientedType &	oriented () noexcept
	Return non-const access to the oriented type. More...
bool	is_oriented () const noexcept
	True if field is ORIENTED. More...
void	setOriented (bool on=true) noexcept
	Set the oriented flag: on/off. More...
const Field< Type > &	field () const noexcept
	Return const-reference to the field values. More...
Field< Type > &	field () noexcept
	Return reference to the field values. More...
tmp< DimensionedField< cmptType, GeoMesh > >	component (const direction d) const
	Return a component field of the field. More...
void	replace (const direction d, const DimensionedField< cmptType, GeoMesh > &df)
	Replace a component field of the field. More...
void	replace (const direction d, const tmp< DimensionedField< cmptType, GeoMesh >> &tdf)
	Replace a component field of the field. More...
tmp< DimensionedField< Type, GeoMesh > >	T () const
	Return the field transpose (only defined for second rank tensors) More...
dimensioned< Type >	average () const
	Calculate and return arithmetic average. More...
dimensioned< Type >	weightedAverage (const DimensionedField< scalar, GeoMesh > &weightField) const
	Calculate and return weighted average. More...
dimensioned< Type >	weightedAverage (const tmp< DimensionedField< scalar, GeoMesh >> &tweightField) const
	Calculate and return weighted average. More...
bool	writeData (Ostream &os, const word &fieldDictEntry) const
	Write dimensions, oriented flag (if valid) and the field data as a dictionary entry with the specified name. More...
void	operator= (const DimensionedField< Type, GeoMesh > &df)
void	operator= (const tmp< DimensionedField< Type, GeoMesh >> &tdf)
void	operator= (const dimensioned< Type > &dt)
	Assign dimensions and value. More...
void	operator+= (const DimensionedField< Type, GeoMesh > &df)
void	operator+= (const tmp< DimensionedField< Type, GeoMesh >> &tdf)
void	operator-= (const DimensionedField< Type, GeoMesh > &df)
void	operator-= (const tmp< DimensionedField< Type, GeoMesh >> &tdf)
void	operator*= (const DimensionedField< scalar, GeoMesh > &df)
void	operator*= (const tmp< DimensionedField< scalar, GeoMesh >> &tdf)
void	operator/= (const DimensionedField< scalar, GeoMesh > &df)
void	operator/= (const tmp< DimensionedField< scalar, GeoMesh >> &tdf)
void	operator+= (const dimensioned< Type > &dt)
void	operator-= (const dimensioned< Type > &dt)
void	operator*= (const dimensioned< scalar > &dt)
void	operator/= (const dimensioned< scalar > &dt)
template<>
const word	typeName ("volScalarField::Internal")
template<>
const word	typeName ("volVectorField::Internal")
template<>
const word	typeName ("volSphericalTensorField::Internal")
template<>
const word	typeName ("volSymmTensorField::Internal")
template<>
const word	typeName ("volTensorField::Internal")
template<class... Args>
Foam::tmp< Foam::DimensionedField< Type, GeoMesh > >	New_impl (IOobjectOption::registerOption regOpt, const word &name, const Mesh &mesh, Args &&... args)
template<class AnyType >
Foam::tmp< Foam::DimensionedField< Type, GeoMesh > >	New (const DimensionedField< AnyType, GeoMesh > &fld, const word &name, const dimensionSet &dims)
template<class AnyType >
Foam::tmp< Foam::DimensionedField< Type, GeoMesh > >	New (const DimensionedField< AnyType, GeoMesh > &fld, const word &name, const dimensioned< Type > &dt)
Public Member Functions inherited from regIOobject
void	operator= (const regIOobject &)=delete
	No copy assignment. More...
	TypeName ("regIOobject")
	Runtime type information. More...
	regIOobject (const IOobject &io, const bool isTimeObject=false)
	Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time). More...
	regIOobject (const regIOobject &rio)
	Copy construct. More...
	regIOobject (const regIOobject &rio, bool registerCopy)
	Copy construct, transferring registry registration to the copy if registerCopy is true. More...
	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy construct with new name, transferring registry registration to the copy if registerCopy is true. More...
	regIOobject (const IOobject &io, const regIOobject &rio)
	Copy construct with new IO parameters. More...
virtual	~regIOobject ()
	Destructor. More...
bool	checkIn ()
	Add object to registry, if not already registered. More...
bool	checkOut ()
	Remove object from registry, and remove all file watches. More...
virtual void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED) More...
bool	registered () const noexcept
	Query the registered state (ie, has been checked in). This is not necessarily the same as registerObject(), which is just a stated preference. More...
bool	ownedByRegistry () const noexcept
	Is this object owned by the registry? More...
bool	store ()
	Register object with its registry and transfer ownership to the registry. More...
void	release (const bool unregister=false) noexcept
	Set object as not ownedByRegistry. More...
label	eventNo () const noexcept
	Event number at last update. More...
label &	eventNo () noexcept
	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 as up-to-date. More...
virtual void	rename (const word &newName)
	Rename. More...
const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data or nullptr. More...
dictionary &	getMetaData () noexcept
	Get or create meta-data. More...
void	removeMetaData ()
	Remove meta-data. More...
virtual void	updateMetaData ()
	Update internal meta-data (eg, prior to writing) More...
virtual fileName	filePath () const
	Return complete path + object name if the file exists. More...
bool	headerOk ()
	Read and check header info. Does not check the headerClassName. More...
Istream &	readStream (const word &, const bool readOnProc=true)
	Return Istream and check object type against that given. More...
void	close ()
	Close Istream. More...
virtual bool	readData (Istream &)
	Virtual readData function. More...
virtual label	addWatch (const fileName &)
	Add file watch for fileName on object if not yet watched. More...
const labelList &	watchIndices () const noexcept
	Read access to file-monitoring handles. More...
labelList &	watchIndices () noexcept
	Write access to file-monitoring handles. More...
virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) have been modified. (modified state is cached by Time) More...
virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...
virtual bool	writeObject (IOstreamOption streamOpt, const bool writeOnProc) const
	Write using stream options. More...
virtual bool	write (const bool writeOnProc=true) const
	Write using setting from DB. More...
virtual bool	global () const
	Is object global. More...
void	operator= (const IOobject &io)
	Copy assignment. More...
virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc) const
	Write using given format, version and compression. More...
Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Declare type-name, virtual type (with debug switch) More...
	IOobject (const IOobject &)=default
	Copy construct. More...
virtual	~IOobject ()=default
	Destructor. More...
	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from name, instance, registry, io options. More...
	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from name, instance, local, registry, io options. More...
	IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from path, registry, io options. More...
	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, registry, io options. More...
	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, local, registry, io options. More...
	IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from path, registry, io options. More...
	IOobject (const IOobject &io, const objectRegistry &registry)
	Copy construct, resetting registry. More...
	IOobject (const IOobject &io, const word &name)
	Copy construct, resetting name. More...
	IOobject (const IOobject &io, const word &name, const fileName &local)
	Copy construct, resetting name and local component. More...
	IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt)
	Copy construct, resetting read/write options. More...
	IOobject (const IOobject &io, IOobjectOption::registerOption regOpt)
	Copy construct, resetting register option. More...
autoPtr< IOobject >	clone () const
	Clone. More...
autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...
const objectRegistry &	db () const noexcept
	Return the local objectRegistry. More...
const Time &	time () const noexcept
	Return Time associated with the objectRegistry. More...
const word &	name () const noexcept
	Return the object name. More...
const word &	headerClassName () const noexcept
	Return name of the class name read from header. More...
word &	headerClassName () noexcept
	Return non-constant access to the class name read from header. More...
const string &	note () const noexcept
	Return the optional note. More...
string &	note () noexcept
	Modifiable access to the optional note. More...
unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes, possibly read from the header. More...
unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes, possibly read from the header. More...
void	resetHeader (const word &newName=word::null)
	Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file. More...
bool	hasHeaderClass () const noexcept
	True if headerClassName() is non-empty (after reading) More...
template<class Type >
bool	isHeaderClass () const
	Check if headerClassName() equals Type::typeName. More...
template<class Type >
bool	isHeaderClassName () const
	Same as isHeaderClass() More...
word	group () const
	Return group (extension part of name) More...
word	member () const
	Return member (name without the extension) More...
const fileName &	rootPath () const noexcept
	Return the Time::rootPath() More...
const fileName &	caseName () const noexcept
	Return the Time::caseName() More...
const fileName &	globalCaseName () const noexcept
	Return the Time::globalCaseName() More...
const fileName &	instance () const noexcept
	Read access to instance path component. More...
fileName &	instance () noexcept
	Write access to instance path component. More...
const fileName &	local () const noexcept
	Read access to local path component. More...
fileName	path () const
	The complete path for the object (with instance, local,...). More...
fileName	globalPath () const
	The complete global path for the object (with instance, local,...) More...
fileName	path (const word &instance, const fileName &local=fileName::null) const
	The complete path with alternative instance and local. More...
fileName	globalPath (const word &instance, const fileName &local=fileName::null) const
	The complete global path with alternative instance and local. More...
fileName	objectPath () const
	The complete path + object name. More...
fileName	globalObjectPath () const
	The complete global path + object name. More...
fileName	objectRelPath () const
	The object path relative to the root. More...
fileName	localFilePath (const word &typeName, const bool search=true) const
	Redirect to fileHandler filePath, searching locally. More...
fileName	globalFilePath (const word &typeName, const bool search=true) const
	Redirect to fileHandler filePath, searching up if in parallel. More...
IOstreamOption	parseHeader (const dictionary &headerDict)
	Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics. More...
bool	readHeader (Istream &is)
	Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics. More...
bool	readHeader (dictionary &headerDict, Istream &is)
	Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics. More...
template<class Type >
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
	Read header (respects is_globalIOobject trait) and check its info. More...
template<class Type >
fileName	typeFilePath (const bool search=true) const
	Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait. More...
template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. More...
bool	writeHeader (Ostream &os) const
	Write header with current type() More...
bool	writeHeader (Ostream &os, const word &objectType) const
	Write header with override of type. More...
void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const
	Write header into a dictionary with current type() and given output format. More...
void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
	Write header into a dictionary with override of type and given output format. More...
bool	good () const noexcept
	Did last readHeader() succeed? More...
bool	bad () const noexcept
	Did last readHeader() fail? More...
InfoProxy< IOobject >	info () const noexcept
	Return info proxy, for printing information to a stream. More...
void	operator= (const IOobject &io)
	Copy assignment, copies all values (except the registry) More...
template<>
bool	isHeaderClass () const
	Specialization for void always returns true (no headerClassName check). More...
template<class StringType >
Foam::word	groupName (StringType base, const word &group)
template<class Type >
Foam::fileName	typeFilePath (const bool search) const
Public Member Functions inherited from IOobjectOption
constexpr	IOobjectOption (readOption rOpt=readOption::NO_READ, writeOption wOpt=writeOption::NO_WRITE, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Default construct (NO_READ, NO_WRITE, REGISTER, non-global) or construct with specified options. More...
constexpr	IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Construct NO_WRITE with specified read/register options. More...
constexpr	IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Construct NO_READ with specified write/register options. More...
constexpr	IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept
	Construct (NO_READ, NO_WRITE) with specified register option. More...
constexpr	IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept
	Construct from components with specified register option as bool. More...
constexpr	IOobjectOption (bool registerObject, bool globalObject=false) noexcept
	Construct (NO_READ, NO_WRITE) with specified register option as bool. More...
readOption	readOpt () const noexcept
	Get the read option. More...
readOption	readOpt (readOption opt) noexcept
	Set the read option. More...
writeOption	writeOpt () const noexcept
	Get the write option. More...
writeOption	writeOpt (writeOption opt) noexcept
	Set the write option. More...
bool	registerObject () const noexcept
	Should objects created with this IOobject be registered? More...
bool	registerObject (bool on) noexcept
	Change registration preference. More...
bool	globalObject () const noexcept
	True if object is treated the same for all processors. More...
bool	globalObject (bool on) noexcept
	Change global-object status. More...
bool	isAnyRead () const noexcept
	True if any reading may be required (ie, != NO_READ) More...
bool	isReadRequired () const noexcept
	True if (MUST_READ | READ_MODIFIED) bits are set. More...
bool	isReadOptional () const noexcept
	True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More...
readOption &	readOpt () noexcept
	Access to the read option. More...
writeOption &	writeOpt () noexcept
	Access to the write option. More...
bool &	registerObject () noexcept
	Access to the register object option. More...
bool &	globalObject () noexcept
	Access to the global object option. More...
Public Member Functions inherited from Field< Type >
constexpr	Field () noexcept
	Default construct. More...
	Field (const label len)
	Construct given size. More...
	Field (const label len, const Type &val)
	Construct given size and initial value. More...
	Field (const label len, const Foam::zero)
	Construct given size and initial values of zero. More...
	Field (const Foam::one, const Type &val)
	Construct with length=1, copying the value as the only content. More...
	Field (const Foam::one, Type &&val)
	Construct with length=1, moving the value as the only content. More...
	Field (const Foam::one, const Foam::zero)
	Construct with length=1, initializing content to zero. More...
	Field (const Field< Type > &fld)
	Copy construct. More...
	Field (const UList< Type > &list)
	Copy construct from UList<Type> More...
template<class Addr >
	Field (const IndirectListBase< Type, Addr > &list)
	Copy construct from IndirectList. More...
	Field (Field< Type > &&fld) noexcept
	Move construct from Field. More...
	Field (List< Type > &&list) noexcept
	Move construct from List. More...
template<int SizeMin>
	Field (DynamicList< Type, SizeMin > &&list)
	Move construct from DynamicList. More...
	Field (const UList< Type > &mapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given field. More...
	Field (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given tmp field. More...
	Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given field. More...
	Field (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given tmp field. More...
	Field (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given field. More...
	Field (const UList< Type > &mapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)
	Construct by mapping from the given field. More...
	Field (const UList< Type > &mapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)
	Construct by mapping from the given field. More...
	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given tmp field. More...
	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)
	Construct by mapping from the given tmp field. Uses supplied uniform value for unmapped items. More...
	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)
	Construct by mapping from the given tmp field. Uses supplied values for unmapped items. More...
	Field (Field< Type > &fld, bool reuse)
	Copy construct or re-use as specified. More...
	Field (const tmp< Field< Type >> &tfld)
	Copy or move construct from tmp. More...
	Field (Istream &is)
	Construct from Istream. More...
	Field (const entry &e, const label len)
	Construct from a dictionary (primitive) entry. More...
	Field (const word &key, const dictionary &dict, const label len, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ)
	Lookup of a primitive dictionary entry by (literal) name and assign its contents to this. The behaviour largely as described in assign(): More...
tmp< Field< Type > >	clone () const
	Clone. More...
void	assign (const entry &e, const label len)
	Assign from a primitive dictionary entry with the following behaviour: More...
bool	assign (const word &key, const dictionary &dict, const label len, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ)
	Lookup a primitive dictionary entry by (literal) name and assign its contents to this (behaviour as described above). More...
void	map (const UList< Type > &mapF, const labelUList &mapAddressing)
	1 to 1 map from the given field More...
void	map (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)
	1 to 1 map from the given tmp field More...
void	map (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given field. More...
void	map (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given tmp field. More...
void	map (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Map from the given field. More...
void	map (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Map from the given tmp field. More...
void	autoMap (const FieldMapper &map, const bool applyFlip=true)
	Map from self. More...
void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given field More...
void	rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given tmp field More...
void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given field. More...
void	rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given tmp field. More...
void	negate ()
	Inplace negate this field (negative). More...
void	normalise ()
	Inplace normalise this field. Generally a no-op except for vector fields. More...
tmp< Field< cmptType > >	component (const direction) const
	Return a component field of the field. More...
void	replace (const direction, const UList< cmptType > &)
	Replace a component field of the field. More...
void	replace (const direction, const tmp< Field< cmptType >> &)
	Replace a component field of the field. More...
void	replace (const direction, const cmptType &)
	Replace a component field of the field. More...
void	clamp_min (const Type &lower)
	Impose lower (floor) clamp on the field values (in-place) More...
void	clamp_max (const Type &upper)
	Impose upper (ceiling) clamp on the field values (in-place) More...
void	clamp_range (const Type &lower, const Type &upper)
	Clamp field values (in-place) to the specified range. More...
void	clamp_range (const MinMax< Type > &range)
	Clamp field values (in-place) to the specified range. More...
template<class VSForm >
VSForm	block (const label start) const
tmp< Field< Type > >	T () const
	Return the field transpose (only defined for second rank tensors) More...
void	writeEntry (const word &keyword, Ostream &os) const
	Write the field as a dictionary entry. More...
SubField< Type >	slice (const label pos, label len=-1)
	Return SubField slice (non-const access) - no range checking. More...
const SubField< Type >	slice (const label pos, label len=-1) const
	Return SubField slice (const access) - no range checking. More...
SubField< Type >	slice (const labelRange &range)
	Return SubField slice (non-const access) - with range checking. More...
const SubField< Type >	slice (const labelRange &range) const
	Return SubField slice (const access) - with range checking. More...
void	operator= (const Field< Type > &)
	Copy assignment. More...
void	operator= (const tmp< Field< Type >> &)
void	operator= (const UList< Type > &rhs)
void	operator= (const SubField< Type > &rhs)
template<class Addr >
void	operator= (const IndirectListBase< Type, Addr > &rhs)
	Copy assign from IndirectList. More...
void	operator= (Field< Type > &&rhs)
	Move assignment. More...
void	operator= (List< Type > &&rhs)
template<int SizeMin>
void	operator= (DynamicList< Type, SizeMin > &&rhs)
void	operator= (const Type &val)
	Assign entries to the given value. More...
void	operator= (const Foam::zero)
	Assign entries to zero. More...
template<class Form , class Cmpt , direction nCmpt>
void	operator= (const VectorSpace< Form, Cmpt, nCmpt > &)
void	operator+= (const UList< Type > &)
void	operator+= (const tmp< Field< Type >> &)
void	operator-= (const UList< Type > &)
void	operator-= (const tmp< Field< Type >> &)
void	operator*= (const UList< scalar > &)
void	operator*= (const tmp< Field< scalar >> &)
void	operator/= (const UList< scalar > &)
void	operator/= (const tmp< Field< scalar >> &)
void	operator+= (const Type &)
void	operator-= (const Type &)
void	operator*= (const scalar &)
void	operator/= (const scalar &)
template<class Type>
void	operator= (const tmp< Field > &rhs)
template<>
void	normalise ()
template<>
void	normalise ()
template<>
void	normalise ()
	Inplace normalise (float) vector field. More...
template<>
void	normalise ()
	Inplace normalise (double) vector field. More...
Public Member Functions inherited from FieldBase
constexpr	FieldBase () noexcept
	Default construct. More...
Public Member Functions inherited from refCount
constexpr	refCount () noexcept
	Default construct, initializing count to 0. More...
int	use_count () const noexcept
	Return the current reference count. More...
bool	unique () const noexcept
	Return true if the reference count is zero. More...
void	operator++ () noexcept
	Increment the reference count. More...
void	operator++ (int) noexcept
	Increment the reference count. More...
void	operator-- () noexcept
	Decrement the reference count. More...
void	operator-- (int) noexcept
	Decrement the reference count. More...
Public Member Functions inherited from List< Type >
constexpr	List () noexcept
	Default construct. More...
	List (const label len)
	Construct with given size. More...
	List (const label len, const Type &val)
	Construct with given size and value for all elements. More...
	List (const label len, const Foam::zero)
	Construct with given size initializing all elements to zero. More...
	List (const Foam::one, const Type &val)
	Construct with length=1, copying the value as the only content. More...
	List (const Foam::one, Type &&val)
	Construct with length=1, moving the value as the only content. More...
	List (const Foam::one, const Foam::zero)
	Construct with length=1, initializing content to zero. More...
	List (const List< Type > &list)
	Copy construct from list. More...
	List (const UList< Type > &list)
	Copy construct contents from list. More...
	List (List< Type > &list, bool reuse)
	Construct as copy or re-use as specified. More...
	List (const UList< Type > &list, const labelUList &indices)
	Copy construct subset of list. More...
	List (const UList< Type > &list, const FixedList< label, N > &indices)
	Copy construct subset of list. More...
	List (const FixedList< Type, N > &list)
	Construct as copy of FixedList<T, N> More...
	List (const PtrList< Type > &list)
	Construct as copy of PtrList<T> More...
	List (const IndirectListBase< Type, Addr > &list)
	Construct as copy of IndirectList contents. More...
	List (std::initializer_list< Type > list)
	Construct from an initializer list. More...
	List (List< Type > &&list) noexcept
	Move construct from List. More...
	List (DynamicList< Type, SizeMin > &&list)
	Move construct from DynamicList. More...
	List (Istream &is)
	Construct from Istream. More...
	List (const SLList< Type > &list)
	Copy construct from SLList. More...
autoPtr< List< Type > >	clone () const
	Clone. More...
	~List ()
	Destructor. More...
void	clear ()
	Clear the list, i.e. set size to zero. More...
void	resize (const label len)
	Adjust allocated size of list. More...
void	resize (const label len, const Type &val)
	Adjust allocated size of list and set val for new elements. More...
void	resize (const label newLen)
void	resize_fill (const label len, const Type &val)
	Adjust allocated size of list and set val for all elements. More...
void	resize_nocopy (const label len)
	Adjust allocated size of list without necessarily. More...
void	resize_unsafe (const label len) noexcept
	Change the addressed list size directly without affecting any memory management (advanced usage). More...
void	setSize (const label n)
	Alias for resize() More...
void	setSize (const label n, const Type &val)
	Alias for resize() More...
void	transfer (List< Type > &list)
	Transfer the contents of the argument List into this list and annul the argument list. More...
void	transfer (DynamicList< Type, SizeMin > &list)
	Transfer the contents of the argument List into this list and annul the argument list. More...
Type &	newElmt (const label i)
	Return subscript-checked element of UList and resizing the list if required. More...
Type &	emplace_back (Args &&... args)
	Construct an element at the end of the list, return reference to the new list element. More...
void	push_back (const Type &val)
	Append an element at the end of the list. More...
void	push_back (Type &&val)
	Move append an element at the end of the list. More...
void	push_back (const UList< Type > &list)
	Append a List to the end of this list. More...
void	push_back (const IndirectListBase< Type, Addr > &list)
	Append IndirectList contents at the end of this list. More...
label	push_uniq (const Type &val)
	Append an element if not already in the list. More...
void	pop_back (label n=1)
	Reduce size by 1 or more elements. Can be called on an empty list. More...
void	operator= (const UList< Type > &list)
	Assignment to UList operator. Takes linear time. More...
void	operator= (const List< Type > &list)
	Assignment operator. Takes linear time. More...
void	operator= (const IndirectListBase< Type, Addr > &list)
	Assignment from IndirectList. Takes linear time. More...
void	operator= (const FixedList< Type, N > &list)
	Copy assignment from FixedList. More...
void	operator= (std::initializer_list< Type > list)
	Assignment to an initializer list. More...
void	operator= (const Type &val)
	Assignment of all entries to the given value. More...
void	operator= (const Foam::zero)
	Assignment of all entries to zero. More...
void	operator= (List< Type > &&list)
	Move assignment. Takes constant time. More...
void	operator= (DynamicList< Type, SizeMin > &&list)
	Move assignment. Takes constant time. More...
void	operator= (const SLList< Type > &list)
	Copy assign from SLList in linear time. More...
Istream &	readList (Istream &is)
	Read List from Istream, discarding contents of existing List. More...
void	shallowCopy (const UList< Type > &)=delete
	No shallowCopy permitted. More...
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	set (const label i, bool val=true)
	A bitSet::set() method for a list of bool. More...
void	append (const Type &val)
	Append an element at the end of the list. More...
void	append (Type &&val)
	Move append an element at the end of the list. More...
void	append (const UList< Type > &list)
	Append a List to the end of this list. More...
void	append (const IndirectListBase< Type, Addr > &list)
	Append IndirectList contents at the end of this list. More...
label	appendUniq (const Type &val)
	Same as push_uniq() More...
Public Member Functions inherited from UList< Type >
label	size () const noexcept
	The number of elements in the container. More...
void	writeEntry (const word &keyword, Ostream &os) const
	Write the List as a dictionary entry with keyword. More...
void	operator= (const Type &val)
	Assignment of all entries to the given value. More...
void	operator= (const Foam::zero)
	Assignment of all entries to zero. More...
	UList (const UList< Type > &)=default
	Copy construct. More...
constexpr	UList () noexcept
	Default construct, zero-sized and nullptr. More...
	UList (Type *__restrict__ v, const label len) noexcept
	Construct from components. More...
label	fcIndex (const label i) const noexcept
	The forward circular index. The next index in the list which returns to the first at the end of the list. More...
label	rcIndex (const label i) const noexcept
	The reverse circular index. The previous index in the list which returns to the last at the beginning of the list. More...
const Type &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list) More...
Type &	fcValue (const label i)
	Return forward circular value (ie, next value in the list) More...
const Type &	rcValue (const label i) const
	Return reverse circular value (ie, previous value in the list) More...
Type &	rcValue (const label i)
	Return reverse circular value (ie, previous value in the list) More...
const Type *	cdata () const noexcept
	Return pointer to the underlying array serving as data storage. More...
Type *	data () noexcept
	Return pointer to the underlying array serving as data storage. More...
const char *	cdata_bytes () const noexcept
	Return pointer to the underlying array serving as data storage,. More...
char *	data_bytes () noexcept
	Return pointer to the underlying array serving as data storage,. More...
Type &	front ()
	Access first element of the list, position [0]. More...
const Type &	front () const
	Access first element of the list. More...
Type &	back ()
	Access last element of the list, position [size()-1]. More...
const Type &	back () const
	Access last element of the list, position [size()-1]. More...
std::streamsize	size_bytes () const noexcept
	Number of contiguous bytes for the List data. More...
std::streamsize	byteSize () const
	Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous. More...
void	checkStart (const label start) const
	Check start is within valid range [0,size) More...
void	checkSize (const label size) const
	Check size is within valid range [0,size]. More...
void	checkRange (const label start, const label len) const
	Check that start and length define a valid range. More...
void	checkIndex (const label i) const
	Check index is within valid range [0,size) More...
bool	uniform () const
	True if all entries have identical values, and list is non-empty. More...
bool	contains (const Type &val) const
	True if the value is contained in the list. More...
bool	contains (const Type &val, label pos, label len=-1) const
	Is the value contained in the list? More...
label	find (const Type &val) const
	Find index of the first occurrence of the value. More...
label	find (const Type &val, label pos, label len=-1) const
	Find index of the first occurrence of the value. More...
label	rfind (const Type &val, label pos=-1) const
	Find index of the last occurrence of the value. More...
void	moveFirst (const label i)
	Move element to the first position. More...
void	moveLast (const label i)
	Move element to the last position. More...
void	swapFirst (const label i)
	Swap element with the first element. Fatal on an empty list. More...
void	swapLast (const label i)
	Swap element with the last element. Fatal on an empty list. More...
void	shallowCopy (Type *__restrict__ ptr, const label len) noexcept
	Copy the pointer and size. More...
void	shallowCopy (std::nullptr_t) noexcept
	Copy nullptr and zero size. More...
void	shallowCopy (const UList< Type > &list) noexcept
	Copy the pointer and size held by the given UList. More...
void	deepCopy (const UList< Type > &list)
	Copy elements of the given UList. Sizes must match! More...
void	deepCopy (const IndirectListBase< Type, Addr > &list)
	Copy elements of the given indirect list. Sizes must match! More...
SubList< Type >	slice (const label pos, label len=-1)
	Return SubList slice (non-const access) - no range checking. More...
const SubList< Type >	slice (const label pos, label len=-1) const
	Return SubList slice (const access) - no range checking. More...
SubList< Type >	slice (const labelRange &range)
	Return SubList slice (non-const access) - with range checking. More...
const SubList< Type >	slice (const labelRange &range) const
	Return SubList slice (const access) - with range checking. More...
Type &	operator[] (const label i)
	Return element of UList. More...
const Type &	operator[] (const label i) const
	Return element of constant UList. More...
const bool &	operator[] (const label i) const
UPstream::commsStruct &	operator[] (const label procID)
const UPstream::commsStruct &	operator[] (const label procID) const
Foam::UPstream::commsStruct &	operator[] (const label procID)
const Foam::UPstream::commsStruct &	operator[] (const label procID) const
	operator const Foam::List< Type > & () const
	Allow cast to a const List<T>&. More...
iterator	begin () noexcept
	Return an iterator to begin traversing the UList. More...
iterator	begin (const label i) noexcept
	Return iterator at offset i from begin, clamped to [0,size] range. More...
const_iterator	begin () const noexcept
	Return const_iterator to begin traversing the constant UList. More...
const_iterator	begin (const label i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,size] range. More...
iterator	end () noexcept
	Return an iterator to end traversing the UList. More...
const_iterator	end () const noexcept
	Return const_iterator to end traversing the constant UList. More...
const_iterator	cbegin () const noexcept
	Return const_iterator to begin traversing the constant UList. More...
const_iterator	cbegin (const label i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,size] range. More...
const_iterator	cend () const noexcept
	Return const_iterator to end traversing the constant UList. More...
reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the UList. More...
const_reverse_iterator	rbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...
reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the UList. More...
const_reverse_iterator	rend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...
const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...
const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...
bool	empty () const noexcept
	True if List is empty (ie, size() is zero) More...
label	capacity () const noexcept
	Size of the underlying storage. More...
void	swap (UList< Type > &list) noexcept
	Swap content with another UList of the same type in constant time. More...
bool	operator== (const UList< Type > &list) const
	Equality operation on ULists of the same type. More...
bool	operator!= (const UList< Type > &list) const
	The opposite of the equality operation. Takes linear time. More...
bool	operator< (const UList< Type > &list) const
	Compare two ULists lexicographically. Takes linear time. More...
bool	operator> (const UList< Type > &list) const
	Compare two ULists lexicographically. Takes linear time. More...
bool	operator<= (const UList< Type > &list) const
	Return true if !(a > b). Takes linear time. More...
bool	operator>= (const UList< Type > &list) const
	Return true if !(a < b). Takes linear time. More...
Istream &	readList (Istream &is)
	Read List contents from Istream. More...
Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen. More...
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	test (const label i) const
	Test bool value at specified position, always false for out-of-range access. More...
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	get (const label i) const
	Return bool value at specified position, always false for out-of-range access. More...
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	unset (const label i)
	Unset the bool entry at specified position, always false for out-of-range access. More...
Type &	first ()
	Access first element of the list, position [0]. More...
const Type &	first () const
	Access first element of the list. More...
Type &	last ()
	Access last element of the list, position [size()-1]. More...
const Type &	last () const
	Access last element of the list, position [size()-1]. More...
bool	found (const Type &val, label pos=0) const
	Same as contains() More...
Public Member Functions inherited from transportModel
	TypeName ("transportModel")
	Runtime type information. More...
	transportModel ()
	Construct from components. More...
virtual	~transportModel ()
	Destructor. More...

Static Public Member Functions
static autoPtr< phaseModel >	New (const phaseSystem &fluid, const word &phaseName, const label index)
Static Public Member Functions inherited from GeometricField< Type, PatchField, GeoMesh >
static const GeometricField< Type, PatchField, GeoMesh > &	null () noexcept
	Return a null GeometricField (reference to a nullObject). More...
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &name, IOobjectOption::registerOption regOpt, const Mesh &mesh, const dimensionSet &dims, const word &patchFieldType=PatchField< Type >::calculatedType())
	Return tmp field (NO_READ, NO_WRITE) from name, mesh, dimensions and patch type. [Takes current timeName from the mesh registry]. More...
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &name, const Mesh &mesh, const dimensionSet &dims, const word &patchFieldType=PatchField< Type >::calculatedType())
	Return tmp field (NO_READ, NO_WRITE) from name, mesh, dimensions and patch type. [Takes current timeName from the mesh registry]. More...
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &name, IOobjectOption::registerOption regOpt, const Mesh &mesh, const dimensionSet &dims, const Field< Type > &iField, const word &patchFieldType=PatchField< Type >::calculatedType())
	Return tmp field (NO_READ, NO_WRITE) from name, mesh, dimensions, copy of internal field and patch type. [Takes current timeName from the mesh registry]. More...
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &name, const Mesh &mesh, const dimensionSet &dims, const Field< Type > &iField, const word &patchFieldType=PatchField< Type >::calculatedType())
	Return tmp field (NO_READ, NO_WRITE) from name, mesh, dimensions, copy of internal field and patch type. [Takes current timeName from the mesh registry]. More...
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &name, IOobjectOption::registerOption regOpt, const Mesh &mesh, const dimensionSet &dims, Field< Type > &&iField, const word &patchFieldType=PatchField< Type >::calculatedType())
	Return tmp field (NO_READ, NO_WRITE) from name, mesh, dimensions, moved internal field contents and patch type. [Takes current timeName from the mesh registry]. More...
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &name, const Mesh &mesh, const dimensionSet &dims, Field< Type > &&iField, const word &patchFieldType=PatchField< Type >::calculatedType())
	Return tmp field (NO_READ, NO_WRITE) from name, mesh, dimensions, moved internal field contents and patch type. [Takes current timeName from the mesh registry]. More...
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &name, IOobjectOption::registerOption regOpt, const Mesh &mesh, const dimensionSet &dims, const Field< Type > &iField, const PtrList< PatchField< Type >> &pflds)
	Return tmp field (NO_READ, NO_WRITE) from name, mesh, dimensions, copy of internal field contents and patch list to clone. [Takes current timeName from the mesh registry]. More...
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &name, const Mesh &mesh, const dimensionSet &dims, const Field< Type > &iField, const PtrList< PatchField< Type >> &pflds)
	Return tmp field (NO_READ, NO_WRITE) from name, mesh, dimensions, copy of internal field contents and patch list to clone. [Takes current timeName from the mesh registry]. More...
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &name, IOobjectOption::registerOption regOpt, const Mesh &mesh, const dimensionSet &dims, Field< Type > &&iField, const PtrList< PatchField< Type >> &pflds)
	Return tmp field (NO_READ, NO_WRITE) from name, mesh, dimensions, moved internal field contents and patch list to clone. [Takes current timeName from the mesh registry]. More...
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &name, const Mesh &mesh, const dimensionSet &dims, Field< Type > &&iField, const PtrList< PatchField< Type >> &pflds)
	Return tmp field (NO_READ, NO_WRITE) from name, mesh, dimensions, moved internal field contents and patch list to clone. [Takes current timeName from the mesh registry]. More...
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &name, IOobjectOption::registerOption regOpt, const Mesh &mesh, const Type &value, const dimensionSet &dims, const word &patchFieldType=PatchField< Type >::calculatedType())
	Return tmp field (NO_READ, NO_WRITE) from name, mesh, field value, dimensions and patch type. [Takes current timeName from the mesh registry]. More...
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &name, const Mesh &mesh, const Type &value, const dimensionSet &dims, const word &patchFieldType=PatchField< Type >::calculatedType())
	Return tmp field (NO_READ, NO_WRITE) from name, mesh, field value, dimensions and patch type. [Takes current timeName from the mesh registry]. More...
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &name, IOobjectOption::registerOption regOpt, const Mesh &mesh, const Type &value, const dimensionSet &dims, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
	Return tmp field (NO_READ, NO_WRITE) from name, mesh, field value, dimensions and patch field types. [Takes current timeName from the mesh registry]. More...
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &name, const Mesh &mesh, const Type &value, const dimensionSet &dims, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
	Return tmp field (NO_READ, NO_WRITE) from name, mesh, field value, dimensions and patch field types. [Takes current timeName from the mesh registry]. More...
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &name, IOobjectOption::registerOption regOpt, const Mesh &mesh, const dimensioned< Type > &dt, const word &patchFieldType=PatchField< Type >::calculatedType())
	Return tmp field (NO_READ, NO_WRITE) from name, mesh, dimensioned-type and patch type. [Takes current timeName from the mesh registry]. More...
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &name, const Mesh &mesh, const dimensioned< Type > &dt, const word &patchFieldType=PatchField< Type >::calculatedType())
	Return tmp field (NO_READ, NO_WRITE) from name, mesh, dimensioned-type and patch type. [Takes current timeName from the mesh registry]. More...
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &name, IOobjectOption::registerOption regOpt, const Mesh &mesh, const dimensioned< Type > &dt, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
	Return tmp field (NO_READ, NO_WRITE) from name, mesh, dimensioned-type and patch field types. [Takes current timeName from the mesh registry]. More...
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &name, const Mesh &mesh, const dimensioned< Type > &dt, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
	Return tmp field (NO_READ, NO_WRITE) from name, mesh, dimensioned-type and patch field types. [Takes current timeName from the mesh registry]. More...
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &newName, IOobjectOption::registerOption regOpt, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tfld)
	Return renamed tmp field (NO_READ, NO_WRITE) retaining its instance/local. More...
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tfld)
	Return renamed tmp field (NO_READ, NO_WRITE) retaining its instance/local. More...
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &newName, IOobjectOption::registerOption regOpt, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tfld, const word &patchFieldType)
	Return renamed tmp field (NO_READ, NO_WRITE) with reset patch field type, retaining its instance/local. More...
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tfld, const word &patchFieldType)
	Return renamed tmp field (NO_READ, NO_WRITE) with reset patch field type, retaining its instance/local. More...
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &newName, IOobjectOption::registerOption regOpt, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tfld, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
	Return renamed tmp field (NO_READ, NO_WRITE) with reset patch field types, retaining its instance/local. More...
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tfld, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
	Return renamed tmp field (NO_READ, NO_WRITE) with reset patch field types, retaining its instance/local. More...
template<class AnyType >
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const GeometricField< AnyType, PatchField, GeoMesh > &fld, const word &name, const dimensionSet &dims, const word &patchFieldType=PatchField< Type >::calculatedType())
	Construct tmp field (NO_READ, NO_WRITE) based on mesh/registry information from an existing field. [Takes instance from the field]. More...
template<class AnyType >
static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const GeometricField< AnyType, PatchField, GeoMesh > &fld, const word &name, const dimensioned< Type > &dt, const word &patchFieldType=PatchField< Type >::calculatedType())
	Construct tmp field (NO_READ, NO_WRITE) based on mesh/registry information from an existing field. and initialise with value. [Takes instance from the field]. More...
Static Public Member Functions inherited from DimensionedField< Type, GeoMesh >
static const DimensionedField< Type, GeoMesh > &	null () noexcept
	Return a null DimensionedField (reference to a nullObject). More...
static tmp< DimensionedField< Type, GeoMesh > >	New (const word &name, IOobjectOption::registerOption regOpt, const Mesh &mesh, const dimensionSet &dims, const Field< Type > &iField)
	Return tmp field (NO_READ, NO_WRITE) from name, mesh, dimensions, copy of internal field. [Takes current timeName from the mesh registry]. More...
static tmp< DimensionedField< Type, GeoMesh > >	New (const word &name, const Mesh &mesh, const dimensionSet &dims, const Field< Type > &iField)
	Return tmp field (NO_READ, NO_WRITE) from name, mesh, dimensions, copy of internal field. [Takes current timeName from the mesh registry]. More...
static tmp< DimensionedField< Type, GeoMesh > >	New (const word &name, IOobjectOption::registerOption regOpt, const Mesh &mesh, const dimensionSet &dims, Field< Type > &&iField)
	Return tmp field (NO_READ, NO_WRITE) from name, mesh, dimensions, move internal field contents. [Takes current timeName from the mesh registry]. More...
static tmp< DimensionedField< Type, GeoMesh > >	New (const word &name, const Mesh &mesh, const dimensionSet &dims, Field< Type > &&iField)
	Return tmp field (NO_READ, NO_WRITE) from name, mesh, dimensions, move internal field contents. [Takes current timeName from the mesh registry]. More...
static tmp< DimensionedField< Type, GeoMesh > >	New (const word &name, IOobjectOption::registerOption regOpt, const Mesh &mesh, const dimensionSet &dims)
	Return tmp field (NO_READ, NO_WRITE) from name, mesh, dimensions. [Takes current timeName from the mesh registry]. More...
static tmp< DimensionedField< Type, GeoMesh > >	New (const word &name, const Mesh &mesh, const dimensionSet &dims)
	Return tmp field (NO_READ, NO_WRITE) from name, mesh, dimensions. [Takes current timeName from the mesh registry]. More...
static tmp< DimensionedField< Type, GeoMesh > >	New (const word &name, IOobjectOption::registerOption regOpt, const Mesh &mesh, const Type &value, const dimensionSet &dims)
	Return tmp field (NO_READ, NO_WRITE) from name, mesh, value, dimensions. [Takes current timeName from the mesh registry]. More...
static tmp< DimensionedField< Type, GeoMesh > >	New (const word &name, const Mesh &mesh, const Type &value, const dimensionSet &dims)
	Return tmp field (NO_READ, NO_WRITE) from name, mesh, value, dimensions. [Takes current timeName from the mesh registry]. More...
static tmp< DimensionedField< Type, GeoMesh > >	New (const word &name, IOobjectOption::registerOption regOpt, const Mesh &mesh, const dimensioned< Type > &dt)
	Return tmp field (NO_READ, NO_WRITE) from name, mesh, dimensioned-type. [Takes current timeName from the mesh registry]. More...
static tmp< DimensionedField< Type, GeoMesh > >	New (const word &name, const Mesh &mesh, const dimensioned< Type > &dt)
	Return tmp field (NO_READ, NO_WRITE) from name, mesh, dimensioned-type. [Takes current timeName from the mesh registry]. More...
static tmp< DimensionedField< Type, GeoMesh > >	New (const word &newName, IOobjectOption::registerOption regOpt, const tmp< DimensionedField< Type, GeoMesh >> &tfld)
	Return renamed tmp field (NO_READ, NO_WRITE) retaining its instance/local. More...
static tmp< DimensionedField< Type, GeoMesh > >	New (const word &newName, const tmp< DimensionedField< Type, GeoMesh >> &tfld)
	Return renamed tmp field (NO_READ, NO_WRITE) retaining its instance/local. More...
template<class AnyType >
static tmp< DimensionedField< Type, GeoMesh > >	New (const DimensionedField< AnyType, GeoMesh > &fld, const word &name, const dimensionSet &dims)
	Construct tmp field (NO_READ, NO_WRITE) based on mesh/registry information from an existing field. [Takes instance from the field]. More...
template<class AnyType >
static tmp< DimensionedField< Type, GeoMesh > >	New (const DimensionedField< AnyType, GeoMesh > &fld, const word &name, const dimensioned< Type > &dt)
	Construct tmp field (NO_READ, NO_WRITE) based on mesh/registry information from an existing field and initialise with value. More...
Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *p)
	Transfer pointer ownership to its registry. More...
template<class Type >
static Type &	store (std::unique_ptr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...
template<class Type >
static Type &	store (autoPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...
template<class Type >
static Type &	store (autoPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...
template<class Type >
static Type &	store (refPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...
template<class Type >
static Type &	store (refPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...
template<class Type >
static Type &	store (tmp< Type > &ptr)
	Transfer pointer ownership to its registry. More...
template<class Type >
static Type &	store (tmp< Type > &&ptr)
	Transfer pointer ownership to its registry. More...
Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept
	Status of output file banner. More...
static bool	bannerEnabled (bool on) noexcept
	Enable/disable output file banner. More...
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...
template<class StringType >
static word	groupName (StringType base, const word &group)
	Create dot-delimited name.group string. More...
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...
static word	scopedName (const std::string &scope, const word &name)
	Create scope:name or scope_name string. More...
static word	scopedName (const std::string &scope, const word &name1, const word &name2)
	Create scope:name1:name2 or scope_name1_name2 string. More...
static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
	Return the IOobject, but also consider an alternative file name. More...
static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...
static Ostream &	writeDivider (Ostream &os)
	Write the standard file section divider. More...
static Ostream &	writeEndDivider (Ostream &os)
	Write the standard end file divider. More...
Static Public Member Functions inherited from IOobjectOption
static bool	isAnyRead (readOption opt) noexcept
	True if any reading may be required (ie, != NO_READ) More...
static bool	isReadRequired (readOption opt) noexcept
	True if (MUST_READ | READ_MODIFIED) bits are set. More...
static bool	isReadOptional (readOption opt) noexcept
	True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More...
static readOption	lazierRead (readOption opt) noexcept
	Downgrade readOption optional (LAZY_READ), leaves NO_READ intact. More...
Static Public Member Functions inherited from Field< Type >
static const Field< Type > &	null () noexcept
	Return a null Field (reference to a nullObject). Behaves like an empty Field. More...
static autoPtr< Field< Type > >	New (Istream &is)
	Return a pointer to a new Field created on freestore. More...
template<class Type2 >
static tmp< Field< Type > >	NewCalculatedType (const Field< Type2 > &f)
	Return a pointer to a new calculatedFvPatchFieldField created on freestore without setting patchField values. More...
Static Public Member Functions inherited from List< Type >
static const List< Type > &	null () noexcept
	Return a null List (reference to a nullObject). Behaves like an empty List. More...
Static Public Member Functions inherited from UList< Type >
static const UList< Type > &	null () noexcept
	Return a null UList (reference to a nullObject). Behaves like an empty UList. More...
static constexpr label	max_size () noexcept
	The size of the largest possible UList. More...

Additional Inherited Members
Public Types inherited from GeometricField< Type, PatchField, GeoMesh >
typedef GeoMesh::Mesh	Mesh
	The mesh type for the GeometricField. More...
typedef GeoMesh::BoundaryMesh	BoundaryMesh
	The boundary mesh type for the boundary fields. More...
typedef DimensionedField< Type, GeoMesh >	Internal
	The internal field type from which this GeometricField is derived. More...
typedef GeometricBoundaryField< Type, PatchField, GeoMesh >	Boundary
	Type of boundary fields. More...
typedef PatchField< Type >	Patch
	The patch field type for the GeometricBoundaryField. More...
typedef Field< Type >::cmptType	cmptType
	Component type of the field elements. More...
Public Types inherited from DimensionedField< Type, GeoMesh >
typedef GeoMesh::Mesh	Mesh
	The mesh type for the DimensionedField. More...
typedef DimensionedField< Type, GeoMesh >	Internal
	The DimensionedField is usually synonymous with an internal field. More...
typedef Field< Type >	FieldType
	Type of the field from which this DimensionedField is derived. More...
typedef Field< Type >::cmptType	cmptType
	Component type of the field elements. More...
Public Types inherited from IOobject
enum	objectState : char { GOOD, BAD }
	Enumeration defining the valid states of an IOobject. More...
enum	fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
	Enumeration defining the file checking options. More...
Public Types inherited from IOobjectOption
enum	readOption : unsigned char {   NO_READ = 0, MUST_READ = 0x1, READ_MODIFIED = 0x3, MUST_READ_IF_MODIFIED = 0x3,   LAZY_READ = 0x4, READ_IF_PRESENT = 0x4 }
	Enumeration defining read preferences. More...
enum	writeOption : unsigned char { NO_WRITE = 0, AUTO_WRITE = 0x10 }
	Enumeration defining write preferences. More...
enum	registerOption : unsigned char { NO_REGISTER = 0, REGISTER = 1, LEGACY_REGISTER = 2 }
	Enumeration for use with registerObject(). Values map to bool (false/true) More...
Public Types inherited from Field< Type >
typedef pTraits< Type >::cmptType	cmptType
	Component type. More...
typedef SubField< Type >	subField
	Declare type of subField. More...
Public Types inherited from List< Type >
typedef SubList< Type >	subList
	Declare type of subList. More...
Public Types inherited from UList< Type >
typedef Type	value_type
	The value type the list contains. More...
typedef Type *	pointer
	The pointer type for non-const access to value_type items. More...
typedef const Type *	const_pointer
	The pointer type for const access to value_type items. More...
typedef Type &	reference
	The type used for storing into value_type objects. More...
typedef const Type &	const_reference
	The type used for reading from constant value_type objects. More...
typedef Type *	iterator
	Random access iterator for traversing a UList. More...
typedef const Type *	const_iterator
	Random access iterator for traversing a UList. More...
typedef label	size_type
	The type to represent the size of a UList. More...
typedef label	difference_type
	The difference between iterator objects. More...
typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator (non-const access) More...
typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator (const access) More...
Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames
	Names for the fileCheckTypes. More...
static char	scopeSeparator
	Character for scoping object names (':' or '_') More...
static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...
static float	fileModificationSkew
	Time skew (seconds) for file modification checks. More...
static int	maxFileModificationPolls
	Max number of times to poll for file modification changes. More...
Static Public Attributes inherited from FieldBase
static const char *const	typeName
	Typename for Field. More...
static bool	allowConstructFromLargerSize = false
	Permit read construct from a larger size. More...
Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
	Helper: check readOpt flags and read if necessary. More...
Protected Member Functions inherited from IOobject
void	setBad (const string &s)
	Set the object state to bad. More...
Protected Member Functions inherited from UList< Type >
void	setAddressableSize (const label n) noexcept
	Set addressed size to be inconsistent with allocated storage. More...
void	size (const label n)
	Older name for setAddressableSize. More...
void	writeEntry (Ostream &os) const
	Write the UList with its compound type. More...
void	writeEntry (Ostream &os) const
	Character list writeEntry. More...
void	writeEntry (Ostream &os) const
labelRange	validateRange (const labelRange &requestedRange) const
	Return a validated (start,size) subset range, which means that it always addresses a valid section of the list. More...
void	fill_uniform (const Type &val)
	Assign all entries to the given value. More...
void	fill_uniform (const Foam::zero)
	Assign all entries to zero. More...
UList< Type > &	operator= (const UList< Type > &)=delete
	No copy assignment (default: shallow copy) More...
void	operator= (const Foam::zero)
	Character list assign zero - avoids Foam::zero casting ambiguities. More...
void	operator= (const Foam::zero)
Static Protected Member Functions inherited from IOobject
static void	writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)
	Helper: write content for FoamFile IOobject header with optional meta information. More...
static void	writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)
	Helper: write dictionary content for FoamFile header with optional meta information. More...
Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects. 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

• phaseModel.H
• phaseModel.C

Source files

• phaseModel.H
• phaseModel.C

Source files

• phaseModel.H
• phaseModel.C

Source files

• phaseModel.H
• phaseModel.C

Source files

• phaseModel.H
• phaseModel.C

Definition at line 53 of file phaseModel.H.

Constructor & Destructor Documentation

phaseModel() [1/4]

phaseModel	(	const word &	phaseName,
		const dictionary &	phaseDict,
		const fvMesh &	mesh
	)

Definition at line 33 of file phaseModel.C.

References Foam::fieldTypes::calculatedType, Foam::endl(), Foam::fvc::flux(), forAll, Foam::Info, io(), mesh, Foam::New(), and DimensionedField< Type, GeoMesh >::setOriented().

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

Here is the call graph for this function:

Here is the caller graph for this function:

~phaseModel() [1/3]

~phaseModel ( )

virtual

Destructor.

Definition at line 176 of file phaseModel.C.

phaseModel() [2/4]

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

Definition at line 38 of file phaseModel.C.

References fluid, and Foam::New().

Here is the call graph for this function:

~phaseModel() [2/3]

virtual ~phaseModel ( )

virtual

Destructor.

phaseModel() [3/4]

phaseModel	(	const twoPhaseSystem &	fluid,
		const dictionary &	phaseProperties,
		const word &	phaseName
	)

Definition at line 40 of file phaseModel.C.

References Foam::fieldTypes::calculatedType, Foam::endl(), Foam::fvc::flux(), forAll, Foam::Info, Foam::New(), phi, and DimensionedField< Type, GeoMesh >::setOriented().

Here is the call graph for this function:

~phaseModel() [3/3]

virtual ~phaseModel ( )

virtual

Destructor.

phaseModel() [4/4]

phaseModel	(	const word &	phaseName,
		const volScalarField &	p,
		const volScalarField &	T
	)

Construct from components.

Member Function Documentation

clone() [1/3]

Foam::autoPtr< Foam::phaseModel > clone

(

)

const

Return clone.

Definition at line 182 of file phaseModel.C.

References NotImplemented.

name() [1/4]

const Foam::word & name ( ) const

inline

Definition at line 166 of file phaseModel.H.

Referenced by Luo::addToCoalescenceRate(), phaseChange::addToDriftRate(), Zuber::CHF(), HuaXu::CHFSubCool(), turbulentDispersionModel::continuousTurbulence(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), MassTransferPhaseSystem< BasePhaseSystem >::correctMassSources(), KocamustafaogullariIshii::dDeparture(), MassTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), BreenWestwater::htcFilmBoil(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::InterfaceCompositionPhaseChangePhaseSystem(), phaseModel::keyword(), MassTransferPhaseSystem< BasePhaseSystem >::massSpeciesTransfer(), PopulationBalancePhaseSystem< BasePhaseSystem >::massTransfer(), PhaseTransferPhaseSystem< BasePhaseSystem >::massTransfer(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::massTransfer(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::massTransfer(), Jeschar::MHF(), multiphaseSystem::multiphaseSystem(), velocityGroup::postSolve(), Kutadeladze::qNucleate(), and velocityGroup::velocityGroup().

Here is the caller graph for this function:

keyword() [1/3]

const Foam::word & keyword ( ) const

inline

Definition at line 171 of file phaseModel.H.

References phaseModel::name().

Here is the call graph for this function:

d() [1/3]

Foam::tmp< Foam::volScalarField > d

(

)

const

Definition at line 233 of file phaseModel.C.

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

Here is the caller graph for this function:

nu() [1/5]

const dimensionedScalar& nu ( ) const

inlinevirtual

Return the laminar viscosity.

Implements transportModel.

Definition at line 178 of file phaseModel.H.

Referenced by LuoSvendsen::correct().

Here is the caller graph for this function:

kappa() [1/5]

const dimensionedScalar& kappa ( ) const

inline

Definition at line 183 of file phaseModel.H.

Referenced by Bromley::htcFilmBoil().

Here is the caller graph for this function:

Cp() [1/2]

const dimensionedScalar& Cp ( ) const

inline

Definition at line 188 of file phaseModel.H.

rho() [1/3]

const dimensionedScalar& rho ( ) const

inline

Definition at line 193 of file phaseModel.H.

Referenced by LehrMilliesMewes::addToBinaryBreakupRate(), LuoSvendsen::addToBinaryBreakupRate(), CoulaloglouTavlaridesCoalescence::addToCoalescenceRate(), Luo::addToCoalescenceRate(), PrinceBlanch::addToCoalescenceRate(), densityChangeDrift::addToDriftRate(), phaseChange::addToDriftRate(), multiphaseSystem::Cvm(), deposition::dmdt(), liftModel::Fi(), virtualMassModel::Ki(), phasePair::rho(), LaakkonenAlopaeusAittamaa::setBreakupRate(), and multiphaseSystem::Svm().

Here is the caller graph for this function:

U() [1/5]

const volVectorField& U ( ) const

inline

Definition at line 198 of file phaseModel.H.

Referenced by LehrMilliesMewesCoalescence::addToCoalescenceRate(), constant::d(), isothermal::d(), MomentumTransferPhaseSystem< BasePhaseSystem >::ddtCorrByAs(), deposition::dmdt(), multiphaseSystem::dragCoeffs(), phaseForces::execute(), liftModel::Fi(), MomentumTransferPhaseSystem< BasePhaseSystem >::momentumTransfer(), MomentumTransferPhaseSystem< BasePhaseSystem >::momentumTransferf(), and dummy::R().

Here is the caller graph for this function:

U() [2/5]

volVectorField& U ( )

inline

Definition at line 203 of file phaseModel.H.

DDtU() [1/2]

const volVectorField& DDtU ( ) const

inline

Definition at line 208 of file phaseModel.H.

Referenced by multiphaseSystem::Svm().

Here is the caller graph for this function:

DDtU() [2/2]

volVectorField& DDtU ( )

inline

Definition at line 213 of file phaseModel.H.

phi() [1/5]

const surfaceScalarField& phi ( ) const

inline

Definition at line 218 of file phaseModel.H.

Referenced by MomentumTransferPhaseSystem< BasePhaseSystem >::ddtCorrByAs(), and multiphaseSystem::dragCoeffs().

Here is the caller graph for this function:

phi() [2/5]

surfaceScalarField& phi ( )

inline

Definition at line 223 of file phaseModel.H.

alphaPhi() [1/5]

const surfaceScalarField& alphaPhi ( ) const

inline

Definition at line 228 of file phaseModel.H.

alphaPhi() [2/5]

surfaceScalarField& alphaPhi ( )

inline

Definition at line 233 of file phaseModel.H.

correctInflowOutflow() [1/3]

void correctInflowOutflow

(

surfaceScalarField &

alphaPhi

)

const

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

Definition at line 214 of file phaseModel.C.

References alphaPhi(), GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), fvsPatchFieldBase::coupled(), forAll, and phi.

Here is the call graph for this function:

correct() [1/4]

void correct ( )

virtual

Correct the phase properties.

Implements transportModel.

Definition at line 190 of file phaseModel.C.

read() [1/4]

bool read

(

const dictionary &

phaseDict

)

Read base transportProperties dictionary.

Definition at line 196 of file phaseModel.C.

References dictionary::readEntry().

Here is the call graph for this function:

ClassName()

ClassName

(

"phaseModel"

)

Runtime type information.

declareRunTimeSelectionTable()

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

clone() [2/3]

autoPtr<phaseModel> clone

(

)

const

Return clone.

New()

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

static

Definition at line 85 of file phaseModel.C.

References Foam::abort(), dict, Foam::endl(), Foam::FatalIOError, FatalIOErrorInLookup, fluid, dictionary::get(), Foam::Info, 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() [2/4]

const word& name

(

)

const

Return the name of this phase.

keyword() [2/3]

const word& keyword

(

)

const

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

index()

Foam::label index

(

)

const

Return the index of the phase.

Definition at line 135 of file phaseModel.C.

Referenced by MomentumTransferPhaseSystem< BasePhaseSystem >::ddtCorrByAs(), and MomentumTransferPhaseSystem< BasePhaseSystem >::momentumTransferf().

Here is the caller graph for this function:

fluid() [1/2]

const Foam::phaseSystem & fluid

(

)

const

Return the system to which this phase belongs.

Definition at line 141 of file phaseModel.C.

Referenced by deposition::dmdt(), orderedPhasePair::E(), IATEsource::fluid(), and phasePair::sigma().

Here is the caller graph for this function:

residualAlpha() [1/2]

const Foam::dimensionedScalar & residualAlpha

(

)

const

Return the residual phase-fraction for given phase.

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

Definition at line 147 of file phaseModel.C.

Referenced by LehrMilliesMewesCoalescence::addToCoalescenceRate().

Here is the caller graph for this function:

alphaMax() [1/2]

Foam::scalar alphaMax

(

)

const

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

Definition at line 153 of file phaseModel.C.

d() [2/3]

tmp<volScalarField> d

(

)

const

Return the Sauter-mean diameter.

dPtr()

const Foam::autoPtr< Foam::diameterModel > & dPtr

(

)

const

Return const-reference to diameterModel of the phase.

Definition at line 165 of file phaseModel.C.

correct() [2/4]

virtual void correct ( )

virtual

Correct the phase properties.

Implements transportModel.

correctKinematics()

void correctKinematics ( )

virtual

Correct the kinematics.

Definition at line 177 of file phaseModel.C.

correctThermo()

void correctThermo ( )

virtual

Correct the thermodynamics.

Definition at line 181 of file phaseModel.C.

correctTurbulence()

void correctTurbulence ( )

virtual

Correct the turbulence.

Definition at line 185 of file phaseModel.C.

correctEnergyTransport()

void correctEnergyTransport ( )

virtual

Correct the energy transport.

Definition at line 189 of file phaseModel.C.

correctInflowOutflow() [2/3]

void correctInflowOutflow

(

surfaceScalarField &

alphaPhi

)

const

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

read() [2/4]

bool read ( )

virtual

Read phase properties dictionary.

Implements transportModel.

Definition at line 193 of file phaseModel.C.

compressible()

virtual bool compressible ( ) const

pure virtual

Return true if the phase is compressible otherwise false.

divU() [1/2]

virtual tmp<volScalarField> divU ( ) const

pure virtual

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

divU() [2/2]

virtual void divU ( tmp< volScalarField >  divU )

pure virtual

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

isothermal()

virtual bool isothermal ( ) const

pure virtual

Return whether the phase is isothermal.

heEqn()

virtual tmp<fvScalarMatrix> heEqn ( )

pure virtual

Return the enthalpy equation.

thermo() [1/5]

virtual const rhoThermo& thermo ( ) const

pure virtual

Return the thermophysical model.

Referenced by Zuber::CHF(), Tatsumoto::CHFSubCool(), HuaXu::CHFSubCool(), KocamustafaogullariIshii::dDeparture(), Cole::fDeparture(), OneResistanceHeatTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), BreenWestwater::htcFilmBoil(), Bromley::htcFilmBoil(), Jeschar::MHF(), and Kutadeladze::qNucleate().

Here is the caller graph for this function:

thermoRef()

virtual rhoThermo& thermoRef ( )

pure virtual

Access the thermophysical model.

rho() [2/3]

virtual tmp<volScalarField> rho ( ) const

pure virtual

Return the density field.

pure()

virtual bool pure ( ) const

pure virtual

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

YiEqn()

virtual tmp<fvScalarMatrix> YiEqn ( volScalarField &  Yi )

pure virtual

Return the species fraction equation.

Y() [1/2]

virtual const PtrList<volScalarField>& Y ( ) const

pure virtual

Return the species mass fractions.

Y() [2/2]

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.

YActive()

virtual const UPtrList<volScalarField>& YActive ( ) const

pure virtual

Return the active species mass fractions.

YActiveRef()

virtual UPtrList<volScalarField>& YActiveRef ( )

pure virtual

Access the active species mass fractions.

stationary()

virtual bool stationary ( ) const

pure virtual

Return whether the phase is stationary.

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() [3/5]

virtual tmp<volVectorField> U ( ) const

pure virtual

Return the velocity.

URef()

virtual volVectorField& URef ( )

pure virtual

Access the velocity.

phi() [3/5]

virtual tmp<surfaceScalarField> phi ( ) const

pure virtual

Return the volumetric flux.

phiRef()

virtual surfaceScalarField& phiRef ( )

pure virtual

Access the volumetric flux.

alphaPhi() [3/5]

virtual tmp<surfaceScalarField> alphaPhi ( ) const

pure virtual

Return the volumetric flux of the phase.

alphaPhiRef()

virtual surfaceScalarField& alphaPhiRef ( )

pure virtual

Access the volumetric flux of the phase.

alphaRhoPhi() [1/3]

virtual tmp<surfaceScalarField> alphaRhoPhi ( ) const

pure virtual

Return the mass flux of the phase.

alphaRhoPhiRef()

virtual surfaceScalarField& alphaRhoPhiRef ( )

pure virtual

Access the mass flux of the phase.

DUDt()

virtual tmp<volVectorField> DUDt ( ) const

pure virtual

Return the substantive acceleration.

Referenced by phaseForces::execute(), and MomentumTransferPhaseSystem< BasePhaseSystem >::momentumTransfer().

Here is the caller graph for this function:

DUDtf()

virtual tmp<surfaceScalarField> DUDtf ( ) const

pure virtual

Return the substantive acceleration on the faces.

continuityError()

virtual tmp<volScalarField> continuityError ( ) const

pure virtual

Return the continuity error.

continuityErrorFlow()

virtual tmp<volScalarField> continuityErrorFlow ( ) const

pure virtual

Return the continuity error due to the flow field.

continuityErrorSources()

virtual tmp<volScalarField> continuityErrorSources ( ) const

pure virtual

Return the continuity error due to any sources.

K()

virtual tmp<volScalarField> K ( ) const

pure virtual

Return the phase kinetic energy.

mu() [1/4]

virtual tmp<volScalarField> mu ( ) const

pure virtual

Return the laminar dynamic viscosity.

Referenced by CoulaloglouTavlaridesCoalescence::addToCoalescenceRate(), Bromley::htcFilmBoil(), and LaakkonenAlopaeusAittamaa::setBreakupRate().

Here is the caller graph for this function:

mu() [2/4]

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

pure virtual

Return the laminar dynamic viscosity on a patch.

nu() [2/5]

virtual tmp<volScalarField> nu ( ) const

pure virtual

Return the laminar kinematic viscosity.

Implements transportModel.

nu() [3/5]

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

pure virtual

Return the laminar kinematic viscosity on a patch.

Implements transportModel.

alpha() [1/4]

virtual tmp<volScalarField> alpha ( ) const

pure virtual

Thermal diffusivity for enthalpy of mixture [kg/m/s].

alpha() [2/4]

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

pure virtual

Thermal diffusivity for enthalpy of mixture for patch [kg/m/s].

kappa() [2/5]

virtual tmp<volScalarField> kappa ( ) const

pure virtual

Thermal diffusivity for temperature of mixture [J/m/s/K].

kappa() [3/5]

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

pure virtual

Thermal diffusivity for temperature of mixture.

for patch [J/m/s/K]

alphahe() [1/4]

virtual tmp<volScalarField> alphahe ( ) const

pure virtual

Thermal diffusivity for energy of mixture [kg/m/s].

alphahe() [2/4]

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

pure virtual

Thermal diffusivity for energy of mixture for patch [kg/m/s].

kappaEff() [1/6]

virtual tmp<volScalarField> kappaEff ( const volScalarField &  alphat ) const

pure virtual

Effective thermal turbulent diffusivity for temperature.

of mixture [J/m/s/K]

kappaEff() [2/6]

virtual tmp<scalarField> kappaEff ( const scalarField &  alphat, const label  patchi  ) const

pure virtual

Effective thermal turbulent diffusivity for temperature.

of mixture for patch [J/m/s/K]

alphaEff() [1/6]

virtual tmp<volScalarField> alphaEff ( const volScalarField &  alphat ) const

pure virtual

Effective thermal turbulent diffusivity of mixture [kg/m/s].

alphaEff() [2/6]

virtual tmp<scalarField> alphaEff ( const scalarField &  alphat, const label  patchi  ) const

pure virtual

Effective thermal turbulent diffusivity of mixture.

for patch [kg/m/s]

mut()

virtual tmp<volScalarField> mut ( ) const

pure virtual

Return the turbulent dynamic viscosity.

muEff()

virtual tmp<volScalarField> muEff ( ) const

pure virtual

Return the effective dynamic viscosity.

nut()

virtual tmp<volScalarField> nut ( ) const

pure virtual

Return the turbulent kinematic viscosity.

nuEff()

virtual tmp<volScalarField> nuEff ( ) const

pure virtual

Return the effective kinematic viscosity.

kappaEff() [3/6]

virtual tmp<volScalarField> kappaEff ( ) const

pure virtual

Effective thermal turbulent diffusivity for temperature.

of mixture [J/m/s/K]

kappaEff() [4/6]

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

pure virtual

Effective thermal turbulent diffusivity for temperature.

of mixture for patch [J/m/s/K]

alphaEff() [3/6]

virtual tmp<volScalarField> alphaEff ( ) const

pure virtual

Effective thermal turbulent diffusivity of mixture [kg/m/s].

alphaEff() [4/6]

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

pure virtual

Effective thermal turbulent diffusivity of mixture.

for patch [kg/m/s]

k()

virtual tmp<volScalarField> k ( ) const

pure virtual

Return the turbulent kinetic energy.

pPrime()

virtual tmp<volScalarField> pPrime ( ) const

pure virtual

Return the phase-pressure'.

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

name() [3/4]

const word& name ( ) const

inline

Return the name of this phase.

Definition at line 145 of file phaseModel.H.

fluid() [2/2]

const twoPhaseSystem& fluid ( ) const

inline

Return the twoPhaseSystem to which this phase belongs.

Definition at line 153 of file phaseModel.H.

otherPhase()

const Foam::phaseModel & otherPhase

(

)

const

Return the other phase in this two-phase system.

Definition at line 211 of file phaseModel.C.

References phaseModel::otherPhase().

Referenced by ThermalPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), MomentumTransferPhaseSystem< BasePhaseSystem >::ddtCorrByAs(), OneResistanceHeatTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::iDmdt(), MomentumTransferPhaseSystem< BasePhaseSystem >::momentumTransfer(), MomentumTransferPhaseSystem< BasePhaseSystem >::momentumTransferf(), IATEsource::otherPhase(), and phaseModel::otherPhase().

Here is the call graph for this function:

Here is the caller graph for this function:

residualAlpha() [2/2]

const dimensionedScalar& residualAlpha ( ) const

inline

Return the residual phase-fraction for given phase.

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

Definition at line 168 of file phaseModel.H.

alphaMax() [2/2]

scalar alphaMax ( ) const

inline

Optional maximum phase-fraction (e.g. packing limit)

Defaults to 1

Definition at line 178 of file phaseModel.H.

d() [3/3]

tmp<volScalarField> d

(

)

const

Return the Sauter-mean diameter.

turbulence() [1/2]

const Foam::PhaseCompressibleTurbulenceModel< Foam::phaseModel > & turbulence

(

)

const

Return the turbulence model.

Definition at line 231 of file phaseModel.C.

turbulence() [2/2]

Foam::PhaseCompressibleTurbulenceModel< Foam::phaseModel > & turbulence

(

)

Return non-const access to the turbulence model.

for correction

Definition at line 224 of file phaseModel.C.

thermo() [2/5]

const rhoThermo& thermo ( ) const

inline

Return the thermophysical model.

Definition at line 205 of file phaseModel.H.

thermo() [3/5]

rhoThermo& thermo ( )

inline

Return non-const access to the thermophysical model.

for correction

Definition at line 215 of file phaseModel.H.

nu() [4/5]

tmp<volScalarField> nu ( ) const

inlinevirtual

Return the laminar viscosity.

Implements transportModel.

Definition at line 223 of file phaseModel.H.

nu() [5/5]

tmp<scalarField> nu ( const label  patchi ) const

inlinevirtual

Return the laminar viscosity for patch.

Implements transportModel.

Definition at line 231 of file phaseModel.H.

mu() [3/4]

tmp<volScalarField> mu ( ) const

inline

Return the laminar dynamic viscosity.

Definition at line 239 of file phaseModel.H.

mu() [4/4]

tmp<scalarField> mu ( const label  patchi ) const

inline

Return the laminar dynamic viscosity for patch.

Definition at line 247 of file phaseModel.H.

kappa() [4/5]

tmp<scalarField> kappa ( const label  patchi ) const

inline

Return the thermal conductivity on a patch.

Definition at line 255 of file phaseModel.H.

kappa() [5/5]

tmp<volScalarField> kappa ( ) const

inline

Return the thermal conductivity.

Definition at line 263 of file phaseModel.H.

alphahe() [3/4]

tmp<volScalarField> alphahe ( ) const

inline

Thermal diffusivity for energy of mixture [kg/m/s].

Definition at line 271 of file phaseModel.H.

alphahe() [4/4]

tmp<scalarField> alphahe ( const label  patchi ) const

inline

Thermal diffusivity for energy of mixture for patch [kg/m/s].

Definition at line 279 of file phaseModel.H.

kappaEff() [5/6]

tmp<volScalarField> kappaEff ( const volScalarField &  alphat ) const

inline

Return the laminar thermal conductivity.

Definition at line 288 of file phaseModel.H.

kappaEff() [6/6]

tmp<scalarField> kappaEff ( const scalarField &  alphat, const label  patchi  ) const

inline

Return the laminar thermal conductivity on a patch.

Definition at line 299 of file phaseModel.H.

alpha() [3/4]

tmp<volScalarField> alpha ( ) const

inline

Return the laminar thermal diffusivity for enthalpy.

Definition at line 310 of file phaseModel.H.

alpha() [4/4]

tmp<scalarField> alpha ( const label  patchi ) const

inline

Return the laminar thermal diffusivity for enthalpy on a patch.

Definition at line 318 of file phaseModel.H.

alphaEff() [5/6]

tmp<volScalarField> alphaEff ( const volScalarField &  alphat ) const

inline

Return the effective thermal diffusivity for enthalpy.

Definition at line 327 of file phaseModel.H.

alphaEff() [6/6]

tmp<scalarField> alphaEff ( const scalarField &  alphat, const label  patchi  ) const

inline

Return the effective thermal diffusivity for enthalpy on a patch.

Definition at line 338 of file phaseModel.H.

Cp() [2/2]

tmp<volScalarField> Cp ( ) const

inline

Return the specific heat capacity.

Definition at line 349 of file phaseModel.H.

rho() [3/3]

const volScalarField& rho ( ) const

inline

Return the density.

Definition at line 357 of file phaseModel.H.

U() [4/5]

const volVectorField& U ( ) const

inline

Return the velocity.

Definition at line 365 of file phaseModel.H.

U() [5/5]

volVectorField& U ( )

inline

Return non-const access to the velocity.

Used in the momentum equation

Definition at line 375 of file phaseModel.H.

phi() [4/5]

const surfaceScalarField& phi ( ) const

inline

Return the volumetric flux.

Definition at line 383 of file phaseModel.H.

phi() [5/5]

surfaceScalarField& phi ( )

inline

Return non-const access to the volumetric flux.

Definition at line 391 of file phaseModel.H.

alphaPhi() [4/5]

const surfaceScalarField& alphaPhi ( ) const

inline

Return the volumetric flux of the phase.

Definition at line 399 of file phaseModel.H.

alphaPhi() [5/5]

surfaceScalarField& alphaPhi ( )

inline

Return non-const access to the volumetric flux of the phase.

Definition at line 407 of file phaseModel.H.

alphaRhoPhi() [2/3]

const surfaceScalarField& alphaRhoPhi ( ) const

inline

Return the mass flux of the phase.

Definition at line 415 of file phaseModel.H.

alphaRhoPhi() [3/3]

surfaceScalarField& alphaRhoPhi ( )

inline

Return non-const access to the mass flux of the phase.

Definition at line 423 of file phaseModel.H.

correctInflowOutflow() [3/3]

void correctInflowOutflow

(

surfaceScalarField &

alphaPhi

)

const

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

correct() [3/4]

void correct ( )

virtual

Correct the phase properties.

other than the thermodynamics and turbulence which have special treatment

Implements transportModel.

read() [3/4]

virtual bool read ( const dictionary &  phaseProperties )

virtual

Read phaseProperties dictionary.

read() [4/4]

virtual bool read ( )

inlinevirtual

Dummy Read for transportModel.

Implements transportModel.

Definition at line 449 of file phaseModel.H.

clone() [3/3]

autoPtr<phaseModel> clone

(

)

const

Return clone.

name() [4/4]

const word& name ( ) const

inline

Definition at line 112 of file phaseModel.H.

keyword() [3/3]

const word& keyword ( ) const

inline

Definition at line 117 of file phaseModel.H.

References phaseModel::name().

Here is the call graph for this function:

thermo() [4/5]

const rhoThermo& thermo ( ) const

inline

Return const-access to phase rhoThermo.

Definition at line 125 of file phaseModel.H.

thermo() [5/5]

rhoThermo& thermo ( )

inline

Return access to phase rhoThermo.

Definition at line 133 of file phaseModel.H.

dgdt() [1/2]

const volScalarField& dgdt ( ) const

inline

Return const-access to phase divergence.

Definition at line 141 of file phaseModel.H.

dgdt() [2/2]

volScalarField& dgdt ( )

inline

Return access to phase divergence.

Definition at line 149 of file phaseModel.H.

correct() [4/4]

void correct ( )

virtual

Correct the laminar viscosity.

Implements transportModel.

---

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

• src/phaseSystemModels/multiphaseEuler/multiphaseSystem/phaseModel/phaseModel.H
• src/phaseSystemModels/multiphaseEuler/multiphaseSystem/phaseModel/phaseModel.C