Commit 8628ef2f authored by Henry's avatar Henry
Browse files

Corrected capitalization of Doxygen documentation comments

parent eb266e2a
......@@ -85,7 +85,7 @@ public:
);
//- Construct by mapping given mixedFixedValueSlipFvPatchField
//- onto a new patch
//- Onto a new patch
mixedFixedValueSlipFvPatchField
(
const mixedFixedValueSlipFvPatchField<Type>&,
......
......@@ -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
......@@ -203,10 +203,10 @@ public:
const label patchi
) const;
//- gamma = Cp/Cv []
//- Gamma = Cp/Cv []
virtual tmp<volScalarField> gamma() const;
//- gamma = Cp/Cv for patch []
//- Gamma = Cp/Cv for patch []
virtual tmp<scalarField> gamma
(
const scalarField& p,
......
......@@ -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
......@@ -337,10 +337,10 @@ public:
const label patchi
) const;
//- gamma = Cp/Cv []
//- Gamma = Cp/Cv []
virtual tmp<volScalarField> gamma() const;
//- gamma = Cp/Cv for patch []
//- Gamma = Cp/Cv for patch []
virtual tmp<scalarField> gamma
(
const scalarField& p,
......
......@@ -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
......@@ -54,7 +54,7 @@ class general
{
// Private data
//- a coefficient
//- A coefficient
dimensionedScalar a_;
//- a1 coefficient
......
......@@ -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
......@@ -54,7 +54,7 @@ class simple
{
// Private data
//- a coefficient
//- A coefficient
dimensionedScalar a_;
//- Drift velocity
......
......@@ -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
......@@ -87,7 +87,7 @@ public:
// Constructors
//- construct from components
//- Construct from components
Kunz
(
const volVectorField& U,
......
......@@ -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
......@@ -81,7 +81,7 @@ public:
// Constructors
//- construct from components
//- Construct from components
Merkle
(
const volVectorField& U,
......
......@@ -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
......@@ -94,7 +94,7 @@ public:
// Constructors
//- construct from components
//- Construct from components
SchnerrSauer
(
const volVectorField& U,
......
......@@ -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
......@@ -128,7 +128,7 @@ public:
return residualSlip_;
}
//- the dragfunction K used in the momentum eq.
//- The dragfunction K used in the momentum eq.
// ddt(alpha1*rho1*U1) + ... = ... alpha1*alpha2*K*(U1-U2)
// ddt(alpha2*rho2*U2) + ... = ... alpha1*alpha2*K*(U2-U1)
// ********************************** NB! *****************************
......
......@@ -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
......@@ -111,7 +111,7 @@ public:
// Member Functions
//- the heat-transfer function K used in the enthalpy eq.
//- The heat-transfer function K used in the enthalpy eq.
// ddt(alpha1*rho1*ha) + ... = ... alpha1*alpha2*K*(Ta - Tb)
// ddt(alpha2*rho2*hb) + ... = ... alpha1*alpha2*K*(Tb - Ta)
// ********************************** NB! *****************************
......
......@@ -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
......@@ -55,7 +55,7 @@ class HrenyaSinclair
{
dictionary coeffDict_;
//- characteristic length of geometry
//- Characteristic length of geometry
dimensionedScalar L_;
......
......@@ -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
......@@ -92,7 +92,7 @@ class phaseModel
//- Diameter model
autoPtr<diameterModel> dPtr_;
//- turbulence model
//- Turbulence model
autoPtr<PhaseCompressibleTurbulenceModel<phaseModel> > turbulence_;
......
......@@ -50,7 +50,7 @@ minArea -1;
// and face centre triangles normal
minTwist 0.0;
//- minimum normalised cell determinant
//- Minimum normalised cell determinant
// 1 = hex, <= 0 = folded or flattened illegal cell
minDeterminant 0.001;
......
......@@ -192,10 +192,10 @@ class starMesh
void operator=(const starMesh&);
//- read fixed format vertex label
//- Read fixed format vertex label
static label readVtxLabel(IFstream&);
//- read fixed format vertex coordinate component
//- Read fixed format vertex coordinate component
static scalar readVtxCmpt(IFstream&);
//- Read to nl
......
......@@ -133,7 +133,7 @@ class backgroundMeshDecomposition
//- Decomposition method
autoPtr<decompositionMethod> decomposerPtr_;
//- merge distance required by fvMeshDistribute
//- Merge distance required by fvMeshDistribute
scalar mergeDist_;
//- Scale of a cell span vs cell size used to decide to refine a cell
......
......@@ -54,13 +54,13 @@ private:
// Private data
//- cell size at distance_ from the surface
//- Cell size at distance_ from the surface
scalar distanceCellSize_;
//- distance from the surface to control over
//- Distance from the surface to control over
scalar distance_;
//- distance squared
//- Distance squared
scalar distanceSqr_;
......
......@@ -54,7 +54,7 @@ private:
// Private data
//- cell size at distance_ from the surface
//- Cell size at distance_ from the surface
scalar distanceCellSize_;
//- Offset distance from surface for constant size portion
......
......@@ -546,7 +546,7 @@ private:
) const;
//- Check if a location is in the exclusion range of an existing feature
//- edge conformation location
//- Edge conformation location
bool nearFeatureEdgeLocation
(
const pointIndexHit& pHit,
......@@ -731,7 +731,7 @@ private:
label classifyBoundaryPoint(Cell_handle cit) const;
//- Index all of the the Delaunay cells and calculate their
//- dual points
//- Dual points
void indexDualVertices
(
pointField& pts,
......
......@@ -58,7 +58,7 @@ class pointFeatureEdgesTypes
//- Reference to the feature edge mesh
const extendedFeatureEdgeMesh& feMesh_;
//- label of the point
//- Label of the point
label pointLabel_;
......
......@@ -88,7 +88,7 @@ class indexedCell
// Private data
//- The index for this Delaunay tetrahedral cell. Type information is
//- also carried:
//- Also carried:
// ctFar : the dual point of this cell does not form part of the
// internal or boundary of the dual mesh
......
......@@ -163,7 +163,7 @@ class cvControls
//- Allowed relative load unbalance
scalar maxLoadUnbalance_;
//- cosine of angle of alignment with required direction within which a
//- Cosine of angle of alignment with required direction within which a
// face will be accepted for rotation
scalar cosAlignmentAcceptanceAngle_;
......@@ -179,7 +179,7 @@ class cvControls
// size
scalar faceAreaRatioCoeff_;
//- cosine of the angle of alignment with the required direction
//- Cosine of the angle of alignment with the required direction
// within which a long De will be accepted for a new Dv insertion
scalar cosInsertionAcceptanceAngle_;
......
......@@ -457,7 +457,7 @@ meshQualityControls
// and face centre triangles normal
minTwist 0.02;
//- minimum normalised cell determinant
//- Minimum normalised cell determinant
//- 1 = hex, <= 0 = folded or flattened illegal cell
minDeterminant 0.001;
......
......@@ -149,7 +149,7 @@ public:
// Member Functions
//- test function
//- Test function
virtual bool need_refine( const Cube &c )
{
int l = c.lv() ;
......@@ -352,7 +352,7 @@ public:
//}
}
//- data function
//- Data function
virtual real value_at( const Cube &c )
{
return signedDistance(converter_.toGlobal(c)) - _iso_val;
......
......@@ -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
......@@ -443,7 +443,7 @@ int main(int argc, char *argv[])
PtrList<volTensorField> volTensorFields;
ReadFields(mesh, objects, volTensorFields);
//- uncomment if you want to interpolate surface fields (usually bad idea)
//- Uncomment if you want to interpolate surface fields (usually bad idea)
//Info<< "Reading all current surfaceFields" << endl;
//PtrList<surfaceScalarField> surfaceScalarFields;
//ReadFields(mesh, objects, surfaceScalarFields);
......
......@@ -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
......@@ -206,7 +206,7 @@ void Foam::ensightLagrangianField
}
//- write generalized field components
//- Write generalized field components
template<class Type>
void Foam::ensightVolField
(
......
......@@ -64,7 +64,7 @@ void ensightParticlePositions
);
//- write lagrangian parcels
//- Write lagrangian parcels
template<class Type>
void ensightLagrangianField
(
......@@ -75,7 +75,7 @@ void ensightLagrangianField
IOstream::streamFormat format
);
//- write generalized field components
//- Write generalized field components
template<class Type>
void ensightVolField
(
......
......@@ -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
......@@ -89,7 +89,7 @@ public:
// Access
//- whole mesh
//- Whole mesh
const fvMesh& baseMesh() const
{
return baseMesh_;
......
......@@ -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
......@@ -90,7 +90,7 @@ public:
// Access
//- whole mesh
//- Whole mesh
const fvMesh& baseMesh() const
{
return baseMesh_;
......
......@@ -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 @@ public:
// Public static data
//- equivalent to enumeration in "vtkCellType.h"
//- Equivalent to enumeration in "vtkCellType.h"
enum vtkTypes
{
VTK_TRIANGLE = 5,
......
......@@ -184,7 +184,7 @@ class vtkPV3Foam
}
};
//- bookkeeping for polyhedral cell decomposition
//- Bookkeeping for polyhedral cell decomposition
// hide in extra pointMap (cellSet/cellZone) for now
class polyDecomp
{
......@@ -536,7 +536,7 @@ class vtkPV3Foam
const label datasetNo
);
//- face set/zone field
//- Face set/zone field
template<class Type>
void convertFaceField
(
......@@ -700,7 +700,7 @@ public:
//- Add/remove patch names to/from the view
void renderPatchNames(vtkRenderer*, const bool show);
//- set the runTime to the first plausible request time,
//- Set the runTime to the first plausible request time,
// returns the timeIndex
// sets to "constant" on error
int setTime(int count, const double requestTimes[]);
......
......@@ -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
......@@ -243,7 +243,7 @@ class vtkPV3blockMesh
//- Internal block info
void updateInfoBlocks(vtkDataArraySelection*);
//- block curved edges info
//- Block curved edges info
void updateInfoEdges(vtkDataArraySelection*);
// Update helper functions
......@@ -253,13 +253,13 @@ class vtkPV3blockMesh
// Mesh conversion functions
//- mesh blocks
//- Mesh blocks
void convertMeshBlocks(vtkMultiBlockDataSet*, int& blockNo);
//- mesh curved edges
//- Mesh curved edges
void convertMeshEdges(vtkMultiBlockDataSet*, int& blockNo);
//- mesh corners
//- Mesh corners
void convertMeshCorners(vtkMultiBlockDataSet*, int& blockNo);
......
......@@ -184,7 +184,7 @@ class vtkPV4Foam
}
};
//- bookkeeping for polyhedral cell decomposition
//- Bookkeeping for polyhedral cell decomposition
// hide in extra pointMap (cellSet/cellZone) for now
class polyDecomp
{
......@@ -536,7 +536,7 @@ class vtkPV4Foam
const label datasetNo
);
//- face set/zone field
//- Face set/zone field
template<class Type>
void convertFaceField
(
......@@ -700,7 +700,7 @@ public:
//- Add/remove patch names to/from the view