From 5babe5c67caa4e2b46d8bbe7b059584f42bbee2f Mon Sep 17 00:00:00 2001 From: Henry Weller Date: Sat, 6 Jul 2024 10:32:56 +0100 Subject: [PATCH] Documentation: Updated for Doxygen 1.11.0 Typos in documentation strings corrected with the aid of codespell --- .../PDRModels/XiGModels/basicXiSubG/basicXiSubG.H | 3 +-- .../velocityGroup/sizeGroup/sizeGroup.H | 4 ++-- .../advanced/refinementLevel/refinementLevel.C | 4 ++-- .../fluentMeshToFoam/extrudedQuadCellShape.C | 4 ++-- .../mesh/conversion/sammToFoam/writeMesh.C | 6 +++--- .../mesh/conversion/star3ToFoam/writeMesh.C | 6 +++--- .../mesh/generation/blockMesh/blockMesh.C | 2 +- .../createNonConformalCouples.C | 2 +- .../graphics/PVReaders/vtkPVFoam/vtkPVFoam.C | 4 ++-- .../snappyHexMeshConfig/snappyHexMeshConfig.C | 14 ++++++++------ .../surface/surfaceCoarsen/bunnylod/progmesh.C | 2 +- bin/dnsFoam | 4 ++-- bin/foamMonitor | 4 ++-- bin/foamUnits | 2 +- etc/caseDicts/annotated/particleTracksDict | 2 +- .../Lists/CompactListList/CompactListList.H | 4 ++-- src/OpenFOAM/containers/Lists/List/List.H | 4 ++-- src/OpenFOAM/containers/Lists/PtrList/PtrList.H | 4 ++-- src/OpenFOAM/containers/Lists/UPtrList/UPtrList.H | 4 ++-- src/OpenFOAM/db/IOobject/IOobject.H | 4 ++-- .../db/IOobjects/IOdictionary/timeIOdictionary.H | 4 ++-- src/OpenFOAM/db/typeInfo/typeInfo.H | 2 +- .../DimensionedField/DimensionedField.H | 6 +++--- .../fields/FieldFields/FieldField/FieldField.H | 4 ++-- .../fields/Fields/DynamicField/DynamicField.H | 2 +- src/OpenFOAM/fields/Fields/Field/Field.H | 2 +- .../hostCollatedFileOperation.H | 12 ++++++------ .../masterUncollatedFileOperation.H | 6 +++--- .../matrices/LduMatrix/LduMatrix/LduMatrix.H | 4 ++-- .../matrices/lduMatrix/lduMatrix/lduMatrix.H | 4 ++-- src/OpenFOAM/meshes/lduMesh/lduPrimitiveMesh.H | 4 ++-- src/OpenFOAM/meshes/meshShapes/cell/cell.C | 4 ++-- .../meshes/pointMesh/pointMeshMapper/pointMapper.C | 2 +- .../polyTopoChangeMap/cellMapper/cellMapper.C | 2 +- .../polyTopoChangeMap/faceMapper/faceMapper.C | 2 +- src/OpenFOAM/meshes/treeBoundBox/treeBoundBox.H | 2 +- .../functions/Function2/Product/Product2.H | 2 +- .../fluid/laminar/MaxwellStefan/MaxwellStefan.H | 4 ++-- .../fvMeshStitcher/fvMeshStitcher.H | 2 +- src/functionObjects/field/comfort/comfort.C | 4 ++-- .../field/wallShearStress/wallShearStress.H | 2 +- src/functionObjects/field/yPlus/yPlus.H | 4 ++-- src/functionObjects/forces/forces/forces.H | 2 +- .../forces/movingForces/movingForces.H | 2 +- .../utilities/stopAt/stopAtFile/stopAtFile.H | 8 ++++---- .../general/buoyancyEnergy/buoyancyEnergy.H | 2 +- .../solidThermalEquilibrium.H | 4 ++-- .../general/volumeBlockage/volumeBlockage.H | 8 ++++---- .../functionObjects/particles/particles.H | 4 ++-- src/lagrangian/parcel/fvModels/clouds/clouds.H | 4 ++-- .../ReactingMultiphaseParcel.C | 4 ++-- .../cellsToCells/matching/matchingCellsToCells.C | 4 ++-- .../edgeMeshFormats/edgeMesh/edgeMeshFormat.C | 6 +++--- .../extendedEdgeMeshFormat.C | 4 ++-- .../truncatedConeToCell/truncatedConeToCell.H | 2 +- .../radiationModels/viewFactor/viewFactor.C | 4 ++-- src/randomProcesses/fft/fftRenumber.H | 4 ++-- .../rigidBodyForces/rigidBodyForces.H | 2 +- .../UnsortedMeshedSurface/UnsortedMeshedSurface.C | 4 ++-- src/waves/fvModels/waveForcing/waveForcing.H | 12 ++++++------ 60 files changed, 122 insertions(+), 121 deletions(-) diff --git a/applications/legacy/combustion/PDRFoam/PDRModels/XiGModels/basicXiSubG/basicXiSubG.H b/applications/legacy/combustion/PDRFoam/PDRModels/XiGModels/basicXiSubG/basicXiSubG.H index 31a884a597..cc4ab21a4d 100644 --- a/applications/legacy/combustion/PDRFoam/PDRModels/XiGModels/basicXiSubG/basicXiSubG.H +++ b/applications/legacy/combustion/PDRFoam/PDRModels/XiGModels/basicXiSubG/basicXiSubG.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2023 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2024 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -25,7 +25,6 @@ Class Foam::XiGModels::basicSubGrid Description - Basic sub-grid obstacle flame-wrinkling generation rate coefficient model. Details supplied by J Puttock 2/7/06. diff --git a/applications/modules/multiphaseEuler/populationBalance/diameterModels/velocityGroup/sizeGroup/sizeGroup.H b/applications/modules/multiphaseEuler/populationBalance/diameterModels/velocityGroup/sizeGroup/sizeGroup.H index b103c6d0e9..05718f104a 100644 --- a/applications/modules/multiphaseEuler/populationBalance/diameterModels/velocityGroup/sizeGroup/sizeGroup.H +++ b/applications/modules/multiphaseEuler/populationBalance/diameterModels/velocityGroup/sizeGroup/sizeGroup.H @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2017-2023 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2017-2024 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -31,7 +31,7 @@ Description If present, the field is read from the start time directory, e.g. during restart. Otherwise, it is constructed as a uniform field using the size class fraction value provided by the user. In the latter case, the boundary - condition types are taken from the 'f.' field, which represents + condition types are taken from the 'f.\' field, which represents the sum of all size group fractions of a phase. The user specified value is also applied at fixed value boundary conditions and used as inlet value for mixed boundary conditions. diff --git a/applications/utilities/mesh/advanced/refinementLevel/refinementLevel.C b/applications/utilities/mesh/advanced/refinementLevel/refinementLevel.C index 6fc05e04ad..10997129e6 100644 --- a/applications/utilities/mesh/advanced/refinementLevel/refinementLevel.C +++ b/applications/utilities/mesh/advanced/refinementLevel/refinementLevel.C @@ -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 @@ -211,7 +211,7 @@ int main(int argc, char *argv[]) runTime.name(), runTime ), - clone(mesh.points()), // could we safely re-use the data? + clone(mesh.points()), // could we safely reuse the data? clone(mesh.faces()), clone(mesh.cells()) ); diff --git a/applications/utilities/mesh/conversion/fluentMeshToFoam/extrudedQuadCellShape.C b/applications/utilities/mesh/conversion/fluentMeshToFoam/extrudedQuadCellShape.C index 1fd7fbf5db..afd0836a80 100644 --- a/applications/utilities/mesh/conversion/fluentMeshToFoam/extrudedQuadCellShape.C +++ b/applications/utilities/mesh/conversion/fluentMeshToFoam/extrudedQuadCellShape.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2018 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2024 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -111,7 +111,7 @@ cellShape extrudedQuadCellShape // Create a label list for the model // This is done by finding two edges that do not share any vertices. - // Knowing the opposite pair of edges (with normals poining outward + // Knowing the opposite pair of edges (with normals pointing outward // is enough to make a cell if ( diff --git a/applications/utilities/mesh/conversion/sammToFoam/writeMesh.C b/applications/utilities/mesh/conversion/sammToFoam/writeMesh.C index 3c8dc00f5f..1aca3a22ee 100644 --- a/applications/utilities/mesh/conversion/sammToFoam/writeMesh.C +++ b/applications/utilities/mesh/conversion/sammToFoam/writeMesh.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2024 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -47,7 +47,7 @@ void Foam::sammMesh::writeMesh() runTime_.constant(), runTime_ ), - clone(points_), // we could probably re-use the data + clone(points_), // we could probably reuse the data cellShapes_, boundary_, patchNames_, @@ -78,7 +78,7 @@ void Foam::sammMesh::writeMesh() runTime_.constant(), runTime_ ), - move(points_), // we could probably re-use the data + move(points_), // we could probably reuse the data move(meshFaces_), move(cellPolys_) ); diff --git a/applications/utilities/mesh/conversion/star3ToFoam/writeMesh.C b/applications/utilities/mesh/conversion/star3ToFoam/writeMesh.C index a9bd02818e..894e9ce5b5 100644 --- a/applications/utilities/mesh/conversion/star3ToFoam/writeMesh.C +++ b/applications/utilities/mesh/conversion/star3ToFoam/writeMesh.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2024 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -51,7 +51,7 @@ void Foam::starMesh::writeMesh() runTime_.constant(), runTime_ ), - clone(points_), // we could probably re-use the data + clone(points_), // we could probably reuse the data cellShapes_, boundary_, patchNames_, @@ -84,7 +84,7 @@ void Foam::starMesh::writeMesh() runTime_.constant(), runTime_ ), - clone(points_), // we could probably re-use the data + clone(points_), // we could probably reuse the data clone(meshFaces_), clone(cellPolys_) ); diff --git a/applications/utilities/mesh/generation/blockMesh/blockMesh.C b/applications/utilities/mesh/generation/blockMesh/blockMesh.C index 441c05102a..4214bdf5af 100644 --- a/applications/utilities/mesh/generation/blockMesh/blockMesh.C +++ b/applications/utilities/mesh/generation/blockMesh/blockMesh.C @@ -216,7 +216,7 @@ int main(int argc, char *argv[]) runTime.constant(), runTime ), - clone(blocks.points()), // could we re-use space? + clone(blocks.points()), // could we reuse space? blocks.cells(), blocks.patches(), blocks.patchNames(), diff --git a/applications/utilities/mesh/manipulation/createNonConformalCouples/createNonConformalCouples.C b/applications/utilities/mesh/manipulation/createNonConformalCouples/createNonConformalCouples.C index 8b9be1d1f7..b3e2cdfd37 100644 --- a/applications/utilities/mesh/manipulation/createNonConformalCouples/createNonConformalCouples.C +++ b/applications/utilities/mesh/manipulation/createNonConformalCouples/createNonConformalCouples.C @@ -28,7 +28,7 @@ Description Utility to create non-conformal couples between non-coupled patches. Usage - \b createNonConformalCouples + \b createNonConformalCouples \ \ Options: - \par -overwrite \n diff --git a/applications/utilities/postProcessing/graphics/PVReaders/vtkPVFoam/vtkPVFoam.C b/applications/utilities/postProcessing/graphics/PVReaders/vtkPVFoam/vtkPVFoam.C index bd71202be3..48152a02ed 100644 --- a/applications/utilities/postProcessing/graphics/PVReaders/vtkPVFoam/vtkPVFoam.C +++ b/applications/utilities/postProcessing/graphics/PVReaders/vtkPVFoam/vtkPVFoam.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2011-2023 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2011-2024 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -195,7 +195,7 @@ void Foam::vtkPVFoam::topoChangePartsStatus() meshChanged_ = true; } - // This needs fixing if we wish to re-use the datasets + // This needs fixing if we wish to reuse the datasets partDataset_.setSize(nElem); partDataset_ = -1; diff --git a/applications/utilities/preProcessing/snappyHexMeshConfig/snappyHexMeshConfig.C b/applications/utilities/preProcessing/snappyHexMeshConfig/snappyHexMeshConfig.C index c005214a11..f4c6e6ae51 100644 --- a/applications/utilities/preProcessing/snappyHexMeshConfig/snappyHexMeshConfig.C +++ b/applications/utilities/preProcessing/snappyHexMeshConfig/snappyHexMeshConfig.C @@ -2,7 +2,7 @@ ========= | \\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / O peration | Website: https://openfoam.org - \\ / A nd | Copyright (C) 2023 OpenFOAM Foundation + \\ / A nd | Copyright (C) 2023-2024 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -117,19 +117,21 @@ Usage Refinement level at specified surfaces, e.g. '((pipe 2) (baffles 1))' - \par -refinementRegions \ - Refinement regions specified by '( ( ) (...) )' + Refinement regions specified by '( (\ \) (...) )' - \par -refinementBoxes \ - Refinement boxes specified by '( ( ) (...) )' + Refinement boxes specified by '( (\ \ \) (...) )' - \par -refinementDists \ - Refinement distance specified by '( ( ) (...) )' + Refinement distance specified by + '( (\ \ \) (...) )' - \par -defaultPatch \ - Name and type of default patch, '( )' + Name and type of default patch, '(\ \)' - \par -xMinPatch (-xMaxPatch, -yMinPatch, etc...) \ - Name and type of the xMin (xMax, yMin, etc...) patch, '( )' + Name and type of the xMin (xMax, yMin, etc...) patch, + '(\ \)' - \par -clearBoundary, Do not set default patch entries, i.e. xMin, xMax, yMin, etc... diff --git a/applications/utilities/surface/surfaceCoarsen/bunnylod/progmesh.C b/applications/utilities/surface/surfaceCoarsen/bunnylod/progmesh.C index 3c4777cc41..a20f60c9d8 100644 --- a/applications/utilities/surface/surfaceCoarsen/bunnylod/progmesh.C +++ b/applications/utilities/surface/surfaceCoarsen/bunnylod/progmesh.C @@ -34,7 +34,7 @@ class Vertex; class Triangle { public: Vertex * vertex[3]; // the 3 points that make this tri - Vector normal; // unit vector othogonal to this face + Vector normal; // unit vector orthogonal to this face Triangle(Vertex *v0,Vertex *v1,Vertex *v2); ~Triangle(); void ComputeNormal(); diff --git a/bin/dnsFoam b/bin/dnsFoam index 2fa9607d35..a0b12116b7 100755 --- a/bin/dnsFoam +++ b/bin/dnsFoam @@ -3,7 +3,7 @@ # ========= | # \\ / F ield | OpenFOAM: The Open Source CFD Toolbox # \\ / O peration | Website: https://openfoam.org -# \\ / A nd | Copyright (C) 2023 OpenFOAM Foundation +# \\ / A nd | Copyright (C) 2023-2024 OpenFOAM Foundation # \\/ M anipulation | #------------------------------------------------------------------------------ # License @@ -41,7 +41,7 @@ executed by the foamRun application: foamRun -solver incompressibleFluid The random OU process force is applied using the OUForce fvModel specified in the -contant/fvModels dictionary, e.g.: +constant/fvModels dictionary, e.g.: OUForce { diff --git a/bin/foamMonitor b/bin/foamMonitor index 89970ac5c4..3a9bc2179d 100755 --- a/bin/foamMonitor +++ b/bin/foamMonitor @@ -37,7 +37,7 @@ usage() { Usage: ${0##*/} [OPTION] options: -ascii | -a show the graph by printing ascii in the terminal - -columns | -c display specfied columns, comma-separated, e.g. "2,4" + -columns | -c display specified columns, comma-separated, e.g. "2,4" -flip | -f plot data on x-axis, independent variable on y-axis -help | -h print the usage -idle | -i