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

Documentation: Updated for Doxygen 1.11.0

Browse Source 
Typos in documentation strings corrected with the aid of codespell
This commit is contained in:
Henry Weller
2024-07-06 10:32:56 +01:00
parent 5405cb9375
commit 5babe5c67c
60 changed files with 122 additions and 121 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/functionObjects/field/comfort/comfort.C
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2019-2023 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2019-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -63,7 +63,7 @@ Foam::dimensionedScalar Foam::functionObjects::comfort::Trad() const
// The mean radiation is calculated by the mean wall temperatures
// which are summed and divided by the area | only walls are taken into
// account. This approach might be correct for a squared room but will
// defintely be inconsistent for complex room geometries. The norm does
// definitely be inconsistent for complex room geometries. The norm does
// not provide any information about the calculation of this quantity.
if (!TradSet_)
{

2
src/functionObjects/field/wallShearStress/wallShearStress.H
View File

@ -26,7 +26,7 @@ Class
Description
Calculates and write the shear-stress at wall patches as
the volVectorField field 'wallShearStress' or 'wallShearStress.<phase>'.
the volVectorField field 'wallShearStress' or 'wallShearStress.\<phase\>'.
\f[
Stress = R \dot n

4
src/functionObjects/field/yPlus/yPlus.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) 2013-2022 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -26,7 +26,7 @@ Class
Description
Evaluates and outputs turbulence y+ for models. Values written to
time directories as field 'yPlus' or 'yPlus.<phase>'.
time directories as field 'yPlus' or 'yPlus.\<phase\>'.
Example of function object specification:
\verbatim