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
applications/utilities/mesh/advanced/refinementLevel/refinementLevel.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) 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())
);

4
applications/utilities/mesh/conversion/fluentMeshToFoam/extrudedQuadCellShape.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) 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
(

6
applications/utilities/mesh/conversion/sammToFoam/writeMesh.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) 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_)
);

6
applications/utilities/mesh/conversion/star3ToFoam/writeMesh.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) 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_)
);

2
applications/utilities/mesh/generation/blockMesh/blockMesh.C
View File

@ -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(),

2
applications/utilities/mesh/manipulation/createNonConformalCouples/createNonConformalCouples.C
View File

@ -28,7 +28,7 @@ Description
Utility to create non-conformal couples between non-coupled patches.
Usage
\b createNonConformalCouples <patch1> <patch2>
\b createNonConformalCouples \<patch1\> \<patch2\>
Options:
- \par -overwrite \n

4
applications/utilities/postProcessing/graphics/PVReaders/vtkPVFoam/vtkPVFoam.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) 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;

14
applications/utilities/preProcessing/snappyHexMeshConfig/snappyHexMeshConfig.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) 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 \<entry\>
Refinement regions specified by '( (<surface> <level>) (...) )'
Refinement regions specified by '( (\<surface\> \<level\>) (...) )'
- \par -refinementBoxes \<entry\>
Refinement boxes specified by '( (<min> <max> <level>) (...) )'
Refinement boxes specified by '( (\<min\> \<max\> \<level\>) (...) )'
- \par -refinementDists \<entry\>
Refinement distance specified by '( (<surface> <dist> <level>) (...) )'
Refinement distance specified by
'( (\<surface\> \<dist\> \<level\>) (...) )'
- \par -defaultPatch \<entry\>
Name and type of default patch, '(<name> <type>)'
Name and type of default patch, '(\<name\> \<type\>)'
- \par -xMinPatch (-xMaxPatch, -yMinPatch, etc...) \<entry\>
Name and type of the xMin (xMax, yMin, etc...) patch, '(<name> <type>)'
Name and type of the xMin (xMax, yMin, etc...) patch,
'(\<name\> \<type\>)'
- \par -clearBoundary,
Do not set default patch entries, i.e. xMin, xMax, yMin, etc...

2
applications/utilities/surface/surfaceCoarsen/bunnylod/progmesh.C
View File

@ -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();