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

2
src/functionObjects/forces/forces/forces.H
View File

@ -78,7 +78,7 @@ Usage
- For incompressible cases, set \c rho to \c rhoInf and provide
a \c rhoInf value corresponding to the free-stream constant density.
- If the \c phase name is specified the corresponding phase-fraction field
\c alpha.<phase> is used to filter the surface force field
\c alpha.\<phase\> is used to filter the surface force field
before integration.
- If the force density is supplied directly, set the \c directForceDensity
flag to 'yes', and supply the force density field using the \c

2
src/functionObjects/forces/movingForces/movingForces.H
View File

@ -84,7 +84,7 @@ Usage
- For incompressible cases, set \c rho to \c rhoInf and provide
a \c rhoInf value corresponding to the free-stream constant density.
- If the \c phase name is specified the corresponding phase-fraction field
\c alpha.<phase> is used to filter the surface force field
\c alpha.\<phase\> is used to filter the surface force field
before integration.
- If the force density is supplied directly, set the \c directForceDensity
flag to 'yes', and supply the force density field using the \c

8
src/functionObjects/utilities/stopAt/stopAtFile/stopAtFile.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) 2011-2022 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2024 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -28,8 +28,8 @@ Description
Stops the run when the specified file is created in the case directory
and optionally write results before stopping.
The default name of the trigger file is \c $FOAM_CASE/<name> where \c
<name> is the name of the functionObject entry.
The default name of the trigger file is \c $FOAM_CASE/\<name\> where \c
\<name\> is the name of the functionObject entry.
Currently the following action types are supported:
- noWriteNow
@ -64,7 +64,7 @@ Usage
\table
Property | Description | Required | Default value
type | type name: stopAtFile | yes |
file | Trigger file path name | no | $FOAM_CASE/<name>
file | Trigger file path name | no | $FOAM_CASE/\<name\>
action | Action executed | no | nextWrite
\endtable