zhyang-dev/openfoam
1
0
Fork 0
mirror of https://develop.openfoam.com/Development/openfoam.git synced 2025-11-28 03:28:01 +00:00
Code Issues 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 eb266e2add
commit 8628ef2fea
268 changed files with 818 additions and 818 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/mesh/autoMesh/autoHexMesh/autoHexMeshDriver/autoLayerDriver.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -284,7 +284,7 @@ private:
List<extrudeMode>& extrudeStatus
) const;
//- for truncateDisplacement: find strings of edges
//- For truncateDisplacement: find strings of edges
bool sameEdgeNeighbour
(
const labelListList& globalEdgeFaces,
@ -293,7 +293,7 @@ private:
const label edgeI
) const;
//- for truncateDisplacement: find strings of edges
//- For truncateDisplacement: find strings of edges
void getVertexString
(
const indirectPrimitivePatch& pp,

6
src/mesh/autoMesh/autoHexMesh/autoHexMeshDriver/autoSnapDriverFeature.C
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -856,7 +856,7 @@ void Foam::autoSnapDriver::featureAttractionUsingReconstruction
// Bin according to surface normal
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//- bins of differing normals:
//- Bins of differing normals:
// - one normal : flat(tish) surface
// - two normals : geometric feature edge
// - three normals: geometric feature point
@ -864,7 +864,7 @@ void Foam::autoSnapDriver::featureAttractionUsingReconstruction
surfacePoints.clear();
surfaceNormals.clear();
//- from face to above normals bin
//- From face to above normals bin
faceToNormalBin.setSize(pfDisp.size());
faceToNormalBin = -1;

6
src/mesh/autoMesh/autoHexMesh/autoHexMeshDriver/pointData/pointData.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
@ -57,10 +57,10 @@ class pointData
{
// Private data
//- additional information.
//- Additional information.
scalar s_;
//- additional information.
//- Additional information.
vector v_;
public:

6
src/mesh/autoMesh/autoHexMesh/externalDisplacementMeshMover/medialAxisMeshMover.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2014 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2014-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -78,11 +78,11 @@ class medialAxisMeshMover
// Pre-calculated medial axis information
//- normal of nearest wall. Where this normal changes direction
//- Normal of nearest wall. Where this normal changes direction
// defines the medial axis
pointVectorField dispVec_;
//- ratio of medial distance to wall distance.
//- Ratio of medial distance to wall distance.
// (1 at wall, 0 at medial axis)
pointScalarField medialRatio_;

24
src/mesh/autoMesh/autoHexMesh/meshRefinement/meshRefinement.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -159,10 +159,10 @@ private:
//- Reference to mesh
fvMesh& mesh_;
//- tolerance used for sorting coordinates (used in 'less' routine)
//- Tolerance used for sorting coordinates (used in 'less' routine)
const scalar mergeDistance_;
//- overwrite the mesh?
//- Overwrite the mesh?
const bool overwrite_;
//- Instance of mesh upon construction. Used when in overwrite_ mode.
@ -177,13 +177,13 @@ private:
//- All shell-refinement interaction
const shellSurfaces& shells_;
//- refinement engine
//- Refinement engine
hexRef8 meshCutter_;
//- per cc-cc vector the index of the surface hit
//- Per cc-cc vector the index of the surface hit
labelIOList surfaceIndex_;
//- user supplied face based data.
//- User supplied face based data.
List<Tuple2<mapType, labelList> > userFaceData_;
//- Meshed patches - are treated differently. Stored as wordList since
@ -605,7 +605,7 @@ public:
// Access
//- reference to mesh
//- Reference to mesh
const fvMesh& mesh() const
{
return mesh_;
@ -632,31 +632,31 @@ public:
return oldInstance_;
}
//- reference to surface search engines
//- Reference to surface search engines
const refinementSurfaces& surfaces() const
{
return surfaces_;
}
//- reference to feature edge mesh
//- Reference to feature edge mesh
const refinementFeatures& features() const
{
return features_;
}
//- reference to refinement shells (regions)
//- Reference to refinement shells (regions)
const shellSurfaces& shells() const
{
return shells_;
}
//- reference to meshcutting engine
//- Reference to meshcutting engine
const hexRef8& meshCutter() const
{
return meshCutter_;
}
//- per start-end edge the index of the surface hit
//- Per start-end edge the index of the surface hit
const labelList& surfaceIndex() const
{
return surfaceIndex_;

10
src/mesh/autoMesh/autoHexMesh/meshRefinement/meshRefinementRefine.C
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -83,7 +83,7 @@ namespace Foam
};
//- template specialization for pTraits<labelList> so we can have fields
//- Template specialization for pTraits<labelList> so we can have fields
template<>
class pTraits<labelList>
{
@ -94,7 +94,7 @@ namespace Foam
typedef labelList cmptType;
};
//- template specialization for pTraits<labelList> so we can have fields
//- Template specialization for pTraits<labelList> so we can have fields
template<>
class pTraits<vectorList>
{
@ -1519,7 +1519,7 @@ bool Foam::meshRefinement::isGap
const vector& normal1
) const
{
//- hits differ and angles are oppositeish and
//- Hits differ and angles are oppositeish and
// hits have a normal distance
vector d = point1-point0;
scalar magD = mag(d);
@ -1576,7 +1576,7 @@ bool Foam::meshRefinement::isNormalGap
const vector& normal1
) const
{
//- hits differ and angles are oppositeish and
//- Hits differ and angles are oppositeish and
// hits have a normal distance
vector d = point1-point0;
scalar magD = mag(d);

4
src/mesh/autoMesh/autoHexMesh/meshRefinement/patchFaceOrientation.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2013 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2013-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -55,7 +55,7 @@ class patchFaceOrientation
{
// Private data
//- flip status
//- Flip status
label flipStatus_;
public:

26
src/mesh/autoMesh/autoHexMesh/trackedParticle/trackedParticle.H
View File

@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2014 OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
@ -56,19 +56,19 @@ class trackedParticle
{
// Private data
//- end point to track to
//- End point to track to
point end_;
//- level of this particle
//- Level of this particle
label level_;
//- passive label (used to store feature edge mesh)
//- Passive label (used to store feature edge mesh)
label i_;
//- passive label (used to store feature edge point)
//- Passive label (used to store feature edge point)
label j_;
//- passive label (used to store feature edge label)
//- Passive label (used to store feature edge label)
label k_;
@ -162,43 +162,43 @@ public:
// Member Functions
//- point to track to
//- Point to track to
point& end()
{
return end_;
}
//- transported label
//- Transported label
label i() const
{
return i_;
}
//- transported label
//- Transported label
label& i()
{
return i_;
}
//- transported label
//- Transported label
label j() const
{
return j_;
}
//- transported label
//- Transported label
label& j()
{
return j_;
}
//- transported label
//- Transported label
label k() const
{
return k_;
}
//- transported label
//- Transported label
label& k()
{
return k_;

4
src/mesh/blockMesh/blockMesh/blockMesh.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
@ -140,7 +140,7 @@ class blockMesh
void createCells() const;
void createPatches() const;
//- as copy (not implemented)
//- As copy (not implemented)
blockMesh(const blockMesh&);

4
src/mesh/extrudeModel/linearDirection/linearDirection.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
@ -55,7 +55,7 @@ class linearDirection
//- Extrude direction
vector direction_;
//- layer thickness
//- Layer thickness
scalar thickness_;

8
src/mesh/extrudeModel/linearNormal/linearNormal.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
@ -53,13 +53,13 @@ class linearNormal
{
// Private data
//- layer thickness
//- Layer thickness
scalar thickness_;
//- first cell thickness
//- First cell thickness
scalar firstCellThickness_;
//- layer cell distibution
//- Layer cell distibution
scalarList layerPoints_;