zhyang-dev/OpenFOAM-12
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Standardised and rationalised the way in which units are written in function documentation

Browse Source
This commit is contained in:
Henry Weller
2019-06-20 10:54:14 +01:00
parent e599162b09
commit 96b69f6f88
188 changed files with 575 additions and 575 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
applications/solvers/combustion/chemFoam/readInitialConditions.H
View File

@ -99,5 +99,5 @@
Info << constProp << " will be held constant." << nl
<< " p = " << p[0] << " [Pa]" << nl
<< " T = " << thermo.T()[0] << " [K] " << nl
<< " rho = " << rho[0] << " [kg/m3]" << nl
<< " rho = " << rho[0] << " [kg/m^3]" << nl
<< endl;

2
applications/solvers/compressible/rhoCentralFoam/BCs/rho/fixedRhoFvPatchScalarField.H
View File

@ -37,7 +37,7 @@ Description
where
\vartable
p | pressure [Pa]
\rho | density [kg/m3]
\rho | density [kg/m^3]
\endvartable

12
applications/solvers/multiphase/compressibleInterFoam/twoPhaseMixtureThermo/twoPhaseMixtureThermo.H
View File

@ -260,10 +260,10 @@ public:
//- Kinematic viscosity of mixture for patch [m^2/s]
virtual tmp<scalarField> nu(const label patchi) const;
//- Thermal diffusivity for temperature of mixture [J/m/s/K]
//- Thermal diffusivity for temperature of mixture [W/m/K]
virtual tmp<volScalarField> kappa() const;
//- Thermal diffusivity of mixture for patch [J/m/s/K]
//- Thermal diffusivity of mixture for patch [W/m/K]
virtual tmp<scalarField> kappa
(
const label patchi
@ -275,26 +275,26 @@ public:
//- Thermal diffusivity for energy of mixture for patch [kg/m/s]
virtual tmp<scalarField> alphahe(const label patchi) const;
//- Effective thermal diffusivity of mixture [J/m/s/K]
//- Effective thermal diffusivity of mixture [W/m/K]
virtual tmp<volScalarField> kappaEff
(
const volScalarField& alphat
) const;
//- Effective thermal diffusivity of mixture for patch [J/m/s/K]
//- Effective thermal diffusivity of mixture for patch [W/m/K]
virtual tmp<scalarField> kappaEff
(
const scalarField& alphat,
const label patchi
) const;
//- Effective thermal diffusivity of mixture [J/m/s/K]
//- Effective thermal diffusivity of mixture [W/m/K]
virtual tmp<volScalarField> alphaEff
(
const volScalarField& alphat
) const;
//- Effective thermal diffusivity of mixture for patch [J/m/s/K]
//- Effective thermal diffusivity of mixture for patch [W/m/K]
virtual tmp<scalarField> alphaEff
(
const scalarField& alphat,

12
applications/solvers/multiphase/compressibleMultiphaseInterFoam/multiphaseMixtureThermo/multiphaseMixtureThermo.H
View File

@ -391,10 +391,10 @@ public:
//- Kinematic viscosity of mixture for patch [m^2/s]
virtual tmp<scalarField> nu(const label patchi) const;
//- Thermal diffusivity for temperature of mixture [J/m/s/K]
//- Thermal diffusivity for temperature of mixture [W/m/K]
virtual tmp<volScalarField> kappa() const;
//- Thermal diffusivity of mixture for patch [J/m/s/K]
//- Thermal diffusivity of mixture for patch [W/m/K]
virtual tmp<scalarField> kappa
(
const label patchi
@ -406,26 +406,26 @@ public:
//- Thermal diffusivity for energy of mixture for patch [kg/m/s]
virtual tmp<scalarField> alphahe(const label patchi) const;
//- Effective thermal diffusivity of mixture [J/m/s/K]
//- Effective thermal diffusivity of mixture [W/m/K]
virtual tmp<volScalarField> kappaEff
(
const volScalarField& alphat
) const;
//- Effective thermal diffusivity of mixture for patch [J/m/s/K]
//- Effective thermal diffusivity of mixture for patch [W/m/K]
virtual tmp<scalarField> kappaEff
(
const scalarField& alphat,
const label patchi
) const;
//- Effective thermal diffusivity of mixture [J/m/s/K]
//- Effective thermal diffusivity of mixture [W/m/K]
virtual tmp<volScalarField> alphaEff
(
const volScalarField& alphat
) const;
//- Effective thermal diffusivity of mixture for patch [J/m/s/K]
//- Effective thermal diffusivity of mixture for patch [W/m/K]
virtual tmp<scalarField> alphaEff
(
const scalarField& alphat,

2
applications/solvers/multiphase/reactingEulerFoam/derivedFvPatchFields/alphatPhaseChangeJayatillekeWallFunction/alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField.C
View File

@ -155,7 +155,7 @@ alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField::calcAlphat
scalarField Tp(Tw.patchInternalField());
// Heat flux [W/m2] - lagging alphatw
// Heat flux [W/m^2] - lagging alphatw
const scalarField qDot
(
(prevAlphat + alphaw)*hew.snGrad()

4
applications/solvers/multiphase/reactingEulerFoam/derivedFvPatchFields/alphatWallBoilingWallFunction/alphatWallBoilingWallFunctionFvPatchScalarField.H
View File

@ -289,13 +289,13 @@ public:
return dDep_;
}
//- Return the quenching surface heat flux [W/m2]
//- Return the quenching surface heat flux [W/m^2]
const scalarField& qq() const
{
return qq_;
}
//- Return the evaporation surface heat flux [W/m2]
//- Return the evaporation surface heat flux [W/m^2]
tmp<scalarField> qe() const
{
return mDotL_/AbyV_;

2
applications/solvers/multiphase/reactingEulerFoam/derivedFvPatchFields/fixedMultiPhaseHeatFlux/fixedMultiPhaseHeatFluxFvPatchScalarField.H
View File

@ -61,7 +61,7 @@ class fixedMultiPhaseHeatFluxFvPatchScalarField
{
// Private Data
//- Heat power [W] or flux [W/m2]
//- Heat power [W] or flux [W/m^2]
scalarField q_;
//- Relaxation factor

2
applications/solvers/multiphase/reactingEulerFoam/phaseSystems/phaseModel/MovingPhaseModel/MovingPhaseModel.H
View File

@ -222,7 +222,7 @@ public:
virtual tmp<volScalarField> nuEff() const;
//- Effective thermal turbulent diffusivity for temperature
// of mixture for patch [J/m/s/K]
// of mixture for patch [W/m/K]
using BasePhaseModel::kappaEff;
//- Return the effective thermal conductivity

2
applications/solvers/multiphase/reactingEulerFoam/phaseSystems/phaseModel/StationaryPhaseModel/StationaryPhaseModel.H
View File

@ -186,7 +186,7 @@ public:
virtual tmp<volScalarField> nuEff() const;
//- Effective thermal turbulent diffusivity for temperature
// of mixture for patch [J/m/s/K]
// of mixture for patch [W/m/K]
using BasePhaseModel::kappaEff;
//- Return the effective thermal conductivity

12
applications/solvers/multiphase/reactingEulerFoam/phaseSystems/phaseModel/ThermoPhaseModel/ThermoPhaseModel.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2015-2018 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2015-2019 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -118,11 +118,11 @@ public:
//- Thermal diffusivity for enthalpy of mixture for patch [kg/m/s]
virtual tmp<scalarField> alpha(const label patchi) const;
//- Thermal diffusivity for temperature of mixture [J/m/s/K]
//- Thermal diffusivity for temperature of mixture [W/m/K]
virtual tmp<volScalarField> kappa() const;
//- Thermal diffusivity for temperature of mixture
// for patch [J/m/s/K]
// for patch [W/m/K]
virtual tmp<scalarField> kappa(const label patchi) const;
//- Thermal diffusivity for energy of mixture [kg/m/s]
@ -135,18 +135,18 @@ public:
// Turbulence
//- Effective thermal turbulent diffusivity for temperature
// of mixture for patch [J/m/s/K]
// of mixture for patch [W/m/K]
using BasePhaseModel::kappaEff;
//- Effective thermal turbulent diffusivity for temperature
// of mixture [J/m/s/K]
// of mixture [W/m/K]
virtual tmp<volScalarField> kappaEff
(
const volScalarField& alphat
) const;
//- Effective thermal turbulent diffusivity for temperature
// of mixture for patch [J/m/s/K]
// of mixture for patch [W/m/K]
virtual tmp<scalarField> kappaEff
(
const scalarField& alphat,

12
applications/solvers/multiphase/reactingEulerFoam/phaseSystems/phaseModel/phaseModel/phaseModel.H
View File

@ -333,11 +333,11 @@ public:
//- Thermal diffusivity for enthalpy of mixture for patch [kg/m/s]
virtual tmp<scalarField> alpha(const label patchi) const = 0;
//- Thermal diffusivity for temperature of mixture [J/m/s/K]
//- Thermal diffusivity for temperature of mixture [W/m/K]
virtual tmp<volScalarField> kappa() const = 0;
//- Thermal diffusivity for temperature of mixture
// for patch [J/m/s/K]
// for patch [W/m/K]
virtual tmp<scalarField> kappa(const label patchi) const = 0;
//- Thermal diffusivity for energy of mixture [kg/m/s]
@ -347,14 +347,14 @@ public:
virtual tmp<scalarField> alphahe(const label patchi) const = 0;
//- Effective thermal turbulent diffusivity for temperature
// of mixture [J/m/s/K]
// of mixture [W/m/K]
virtual tmp<volScalarField> kappaEff
(
const volScalarField& alphat
) const = 0;
//- Effective thermal turbulent diffusivity for temperature
// of mixture for patch [J/m/s/K]
// of mixture for patch [W/m/K]
virtual tmp<scalarField> kappaEff
(
const scalarField& alphat,
@ -391,11 +391,11 @@ public:
virtual tmp<volScalarField> nuEff() const = 0;
//- Effective thermal turbulent diffusivity for temperature
// of mixture [J/m/s/K]
// of mixture [W/m/K]
virtual tmp<volScalarField> kappaEff() const = 0;
//- Effective thermal turbulent diffusivity for temperature
// of mixture for patch [J/m/s/K]
// of mixture for patch [W/m/K]
virtual tmp<scalarField> kappaEff(const label patchi) const = 0;
//- Effective thermal turbulent diffusivity of mixture [kg/m/s]

10
applications/solvers/multiphase/reactingEulerFoam/phaseSystems/populationBalanceModel/binaryBreakupModels/LehrMilliesMewes/LehrMilliesMewes.H
View File

@ -63,11 +63,11 @@ Description
\f]
\vartable
\rho_c | Density of continuous phase [kg/m3]
\sigma | Surface tension [N/m]
\epsilon_c | Continuous phase turbulent dissipation rate [m2/s3]
d_i | Diameter of daughter bubble i [m]
d_j | Diameter of mother bubble j [m]
\rho_c | Density of continuous phase [kg/m^3]
\sigma | Surface tension [N/m]
\epsilon_c | Continuous phase turbulent dissipation rate [m2/s^3]
d_i | Diameter of daughter bubble i [m]
d_j | Diameter of mother bubble j [m]
\endvartable
References:

10
applications/solvers/multiphase/reactingEulerFoam/phaseSystems/populationBalanceModel/binaryBreakupModels/LuoSvendsen/LuoSvendsen.H
View File

@ -87,15 +87,15 @@ Description
\vartable
\alpha_c | Void fraction of continuous phase [-]
\epsilon_c | Turbulent dissipation rate of continuous phase [m2/s3]
d_j | Diameter of mother bubble j [m3]
v_i | Volume of daughter bubble i [m3]
v_j | Volume of mother bubble j [m3]
\epsilon_c | Turbulent dissipation rate of continuous phase [m2/s^3]
d_j | Diameter of mother bubble j [m^3]
v_i | Volume of daughter bubble i [m^3]
v_j | Volume of mother bubble j [m^3]
\xi | Integration variable [-]
\xi_{min} | Lower bound of integral [-]
c_f | Increase coefficient of surface area [-]
\sigma | Surface tension [N/m]
\rho_c | Density of continuous phase [kg/m3]
\rho_c | Density of continuous phase [kg/m^3]
\eta | Kolmogorov length scale [m]
\Gamma(a,z) | Upper incomplete gamma function
Q(a,z) | Regularized upper incomplete gamma function

6
applications/solvers/multiphase/reactingEulerFoam/phaseSystems/populationBalanceModel/breakupModels/LaakkonenAlopaeusAittamaa/LaakkonenAlopaeusAittamaa.H
View File

@ -45,10 +45,10 @@ Description
\vartable
\sigma | Surface tension [N/m]
v_i | Volume of mother bubble i [m]
\epsilon_c | Turbulent dissipation rate of continuous phase [m2/s3]
\epsilon_c | Turbulent dissipation rate of continuous phase [m2/s^3]
\mu_c | Molecular dynamic viscosity of liquid phase [Pa s]
\rho_c | Density of continuous phase [kg/m3]
\rho_d | Density of disperse phase [kg/m3]
\rho_c | Density of continuous phase [kg/m^3]
\rho_d | Density of disperse phase [kg/m^3]
\endvartable
References:

8
applications/solvers/multiphase/reactingEulerFoam/phaseSystems/populationBalanceModel/coalescenceModels/CoulaloglouTavlaridesCoalescence/CoulaloglouTavlaridesCoalescence.H
View File

@ -45,12 +45,12 @@ Description
\vartable
\sigma | Surface tension [N/m]
v_i | Volume of droplet i [m3]
v_j | Volume of droplet j [m3]
\epsilon_c | Turbulent dissipation rate of continuous phase [m2/s3]
v_i | Volume of droplet i [m^3]
v_j | Volume of droplet j [m^3]
\epsilon_c | Turbulent dissipation rate of continuous phase [m2/s^3]
\alpha_d | Total void fraction of disperse phase [-]
\mu_c | Molecular dynamic viscosity of liquid phase [Pa s]
\rho_c | Density of continuous phase [kg/m3]
\rho_c | Density of continuous phase [kg/m^3]
\endvartable
References:

2
applications/solvers/multiphase/reactingEulerFoam/phaseSystems/populationBalanceModel/coalescenceModels/LehrMilliesMewesCoalescence/LehrMilliesMewesCoalescence.H
View File

@ -54,7 +54,7 @@ Description
\vartable
d_i | Diameter of bubble i [m]
d_j | Diameter of bubble j [m]
\epsilon_c | Turbulent dissipation rate of continuous phase [m2/s3]
\epsilon_c | Turbulent dissipation rate of continuous phase [m2/s^3]
\alpha | Total void fraction of the bubbles [-]
\alpha_{max} | Maximum packing density of the bubbles [-]
u_{crit} | Critical velocity for coalescence [m/s]

6
applications/solvers/multiphase/reactingEulerFoam/phaseSystems/populationBalanceModel/coalescenceModels/Luo/Luo.H
View File

@ -58,13 +58,13 @@ Description
d_j | Diameter of bubble j [m]
u_{ij} | Mean approach velocity [m/s]
\xi_{ij} | Bubble size ratio [-]
\rho_d | Density of dispersed phase [kg/m3]
\rho_c | Density of continuous phase [kg/m3]
\rho_d | Density of dispersed phase [kg/m^3]
\rho_c | Density of continuous phase [kg/m^3]
\sigma | Surface tension [N/m]
C_{vm} | Virtual mass coefficient [-]
C_1 | Coefficient [-]
\beta | Coefficient [-]
\epsilon_c | Continuous phase turbulent dissipation rate [m2/s3]
\epsilon_c | Continuous phase turbulent dissipation rate [m2/s^3]
\endvartable
Reference:

30
applications/solvers/multiphase/reactingEulerFoam/phaseSystems/populationBalanceModel/coalescenceModels/PrinceBlanch/PrinceBlanch.H
View File

@ -83,21 +83,21 @@ Description
is currently neglected.
\vartable
\theta_{ij}^{T} | Turbulent collision rate [m3/s]
\theta_{ij}^{B} | Buoyancy-driven collision rate [m3/s]
\theta_{ij}^{LS} | Laminar shear collision rate [m3/s]
\lambda_{ij} | Coalescence efficiency [-]
r_{ij} | Equivalent radius [m]
\rho_c | Density of continuous phase [kg/m3]
\sigma | Surface tension [N/m]
h_0 | Initial film thickness [m]
h_f | Critical film thickness [m]
\epsilon_c | Continuous phase turbulent dissipation rate [m2/s3]
d_i | Diameter of bubble i [m]
d_j | Diameter of bubble j [m]
u_{ri} | Rise velocity of bubble i [m/s]
S_{ij} | Collision cross sectional area [m2]
g | Gravitational constant [m/s2]
\theta_{ij}^{T} | Turbulent collision rate [m3/s]
\theta_{ij}^{B} | Buoyancy-driven collision rate [m3/s]
\theta_{ij}^{LS}| Laminar shear collision rate [m3/s]
\lambda_{ij} | Coalescence efficiency [-]
r_{ij} | Equivalent radius [m]
\rho_c | Density of continuous phase [kg/m^3]
\sigma | Surface tension [N/m]
h_0 | Initial film thickness [m]
h_f | Critical film thickness [m]
\epsilon_c | Continuous phase turbulent dissipation rate [m2/s^3]
d_i | Diameter of bubble i [m]
d_j | Diameter of bubble j [m]
u_{ri} | Rise velocity of bubble i [m/s]
S_{ij} | Collision cross sectional area [m^2]
g | Gravitational constant [m/s^2]
\endvartable
Reference:

8
applications/solvers/multiphase/twoPhaseEulerFoam/twoPhaseSystem/phaseModel/phaseModel.H
View File

@ -208,14 +208,14 @@ public:
return thermo_->alpha(patchi);
}
//- Thermal diffusivity for temperature of mixture [J/m/s/K]
//- Thermal diffusivity for temperature of mixture [W/m/K]
tmp<scalarField> kappa(const label patchi) const
{
return thermo_->kappa(patchi);
}
//- Thermal diffusivity for temperature of mixture
// for patch [J/m/s/K]
// for patch [W/m/K]
tmp<volScalarField> kappa() const
{
return thermo_->kappa();
@ -234,7 +234,7 @@ public:
}
//- Effective thermal turbulent diffusivity for temperature
// of mixture [J/m/s/K]
// of mixture [W/m/K]
tmp<volScalarField> kappaEff
(
const volScalarField& alphat
@ -244,7 +244,7 @@ public:
}
//- Effective thermal turbulent diffusivity for temperature
// of mixture for patch [J/m/s/K]
// of mixture for patch [W/m/K]
tmp<scalarField> kappaEff
(
const scalarField& alphat,