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

Corrected capitalization of Doxygen documentation comments

Browse Source
This commit is contained in:
Henry
2015-02-14 13:10:15 +00:00
parent fb68661de8
commit f58fd14271
268 changed files with 818 additions and 818 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/dynamicMesh/boundaryMesh/boundaryMesh.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -87,16 +87,16 @@ class boundaryMesh
// Edge handling
//
//- points referenced by feature edges.
//- Points referenced by feature edges.
pointField featurePoints_;
//- feature edges. Indices into featurePoints.
//- Feature edges. Indices into featurePoints.
edgeList featureEdges_;
//- from feature edge to mesh edge.
//- From feature edge to mesh edge.
labelList featureToEdge_;
//- from mesh edges to featureEdges_;
//- From mesh edges to featureEdges_;
labelList edgeToFeature_;
//- Feature 'segments'. Collections of connected featureEdges.

4
src/dynamicMesh/meshCut/cellCuts/cellCuts.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -435,7 +435,7 @@ class cellCuts
//- Set orientation of loops
void orientPlanesAndLoops();
//- top level driver: adressing calculation and loop detection
//- Top level driver: adressing calculation and loop detection
void calcLoopsAndAddressing(const labelList& cutCells);
//- Check various consistencies.

4
src/dynamicMesh/meshCut/cellLooper/hexCellLooper.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -74,7 +74,7 @@ private:
// Private Member Functions
//- walk across faces of hex. Update loop/loopWeights with edges cut.
//- Walk across faces of hex. Update loop/loopWeights with edges cut.
// Return true if successful walk. (should be always!)
bool walkHex
(

6
src/dynamicMesh/meshCut/cellLooper/topoCellLooper.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -80,7 +80,7 @@ class topoCellLooper
DynamicList<T>& lst
);
//- walk across superface discarding non-feature points.
//- Walk across superface discarding non-feature points.
void walkFace
(
const cellFeatures& features,
@ -158,7 +158,7 @@ public:
// Static data members
//- cos of angle for feature recognition (of splitHexes)
//- Cos of angle for feature recognition (of splitHexes)
static const scalar featureCos;

8
src/dynamicMesh/meshCut/edgeVertex/edgeVertex.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -104,7 +104,7 @@ public:
// EdgeVertex handling
//- is eVert an edge?
//- Is eVert an edge?
static bool isEdge(const primitiveMesh& mesh, const label eVert)
{
if (eVert < 0 || eVert >= (mesh.nPoints() + mesh.nEdges()))
@ -125,7 +125,7 @@ public:
return isEdge(mesh_, eVert);
}
//- convert eVert to edge label
//- Convert eVert to edge label
static label getEdge(const primitiveMesh& mesh, const label eVert)
{
if (!isEdge(mesh, eVert))
@ -143,7 +143,7 @@ public:
return getEdge(mesh_, eVert);
}
//- convert eVert to vertex label
//- Convert eVert to vertex label
static label getVertex(const primitiveMesh& mesh, const label eVert)
{
if (isEdge(mesh, eVert) || (eVert < 0))

4
src/dynamicMesh/meshCut/meshModifiers/multiDirRefinement/multiDirRefinement.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -79,7 +79,7 @@ class multiDirRefinement
//- Current set of cells to refine. Extended with added cells.
labelList cellLabels_;
//- from original to added cells.
//- From original to added cells.
// Gives for every cell in the original mesh an empty list or the
// list of cells this one has been split into (note: will include
// itself so e.g. for hex will be 8 if 2x2x2 refinement)

6
src/dynamicMesh/meshCut/refineCell/refineCell.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -67,10 +67,10 @@ public:
//- Null
refineCell();
//- from components. Vector will be normalized upon construction.
//- From components. Vector will be normalized upon construction.
refineCell(const label, const vector&);
//- from Istream. Vector will be normalized upon construction.
//- From Istream. Vector will be normalized upon construction.
refineCell(Istream& is);

6
src/dynamicMesh/motionSmoother/motionSmootherAlgo.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2013 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -213,7 +213,7 @@ class motionSmootherAlgo
//- Calculate per-edge weight
tmp<scalarField> calcEdgeWeights(const pointField&) const;
//- explicit smoothing and min on all affected internal points
//- Explicit smoothing and min on all affected internal points
void minSmooth
(
const scalarField& edgeWeights,
@ -222,7 +222,7 @@ class motionSmootherAlgo
pointScalarField& newFld
) const;
//- same but only on selected points (usually patch points)
//- Same but only on selected points (usually patch points)
void minSmooth
(
const scalarField& edgeWeights,

4
src/dynamicMesh/polyTopoChange/polyTopoChange/addPatchCellLayer.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -288,7 +288,7 @@ public:
const labelListList& layerFaces
);
//- added cells given current mesh & layerfaces.
//- Added cells given current mesh & layerfaces.
labelListList addedCells() const;

4
src/dynamicMesh/polyTopoChange/polyTopoChange/hexRef8.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -90,7 +90,7 @@ class hexRef8
//- Level of saved cells
Map<label> savedCellLevel_;
//- cell shapes when seen as split hexes
//- Cell shapes when seen as split hexes
mutable autoPtr<cellShapeList> cellShapesPtr_;

6
src/dynamicMesh/polyTopoChange/polyTopoChange/refinementDistanceData.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -57,10 +57,10 @@ class refinementDistanceData
// Private data
//- unrefined (level0) buffer size (nBufferLayers*level0Size)
//- Unrefined (level0) buffer size (nBufferLayers*level0Size)
scalar level0Size_;
//- nearest point with highest level
//- Nearest point with highest level
point origin_;
label originLevel_;

4
src/dynamicMesh/polyTopoChange/polyTopoChange/refinementHistory.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2012 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -106,7 +106,7 @@ public:
// -2: free splitCell (so should also be in freeSplitCells_)
label parent_;
//- cells this cell was refined into
//- Cells this cell was refined into
autoPtr<FixedList<label, 8> > addedCellsPtr_;
//- Construct null (parent = -1)