Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
Development
openfoam
Commits
8628ef2f
Commit
8628ef2f
authored
Feb 14, 2015
by
Henry
Browse files
Corrected capitalization of Doxygen documentation comments
parent
eb266e2a
Changes
268
Hide whitespace changes
Inline
Side-by-side
applications/solvers/compressible/rhoCentralFoam/BCs/mixedFixedValueSlip/mixedFixedValueSlipFvPatchField.H
View file @
8628ef2f
...
...
@@ -85,7 +85,7 @@ public:
);
//- Construct by mapping given mixedFixedValueSlipFvPatchField
//-
o
nto a new patch
//-
O
nto a new patch
mixedFixedValueSlipFvPatchField
(
const
mixedFixedValueSlipFvPatchField
<
Type
>&
,
...
...
applications/solvers/multiphase/compressibleInterFoam/twoPhaseMixtureThermo/twoPhaseMixtureThermo.H
View file @
8628ef2f
...
...
@@ -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
;
//-
g
amma = Cp/Cv []
//-
G
amma = Cp/Cv []
virtual
tmp
<
volScalarField
>
gamma
()
const
;
//-
g
amma = Cp/Cv for patch []
//-
G
amma = Cp/Cv for patch []
virtual
tmp
<
scalarField
>
gamma
(
const
scalarField
&
p
,
...
...
applications/solvers/multiphase/compressibleMultiphaseInterFoam/multiphaseMixtureThermo/multiphaseMixtureThermo.H
View file @
8628ef2f
...
...
@@ -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
;
//-
g
amma = Cp/Cv []
//-
G
amma = Cp/Cv []
virtual
tmp
<
volScalarField
>
gamma
()
const
;
//-
g
amma = Cp/Cv for patch []
//-
G
amma = Cp/Cv for patch []
virtual
tmp
<
scalarField
>
gamma
(
const
scalarField
&
p
,
...
...
applications/solvers/multiphase/driftFluxFoam/relativeVelocityModels/general/general.H
View file @
8628ef2f
...
...
@@ -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
...
...
applications/solvers/multiphase/driftFluxFoam/relativeVelocityModels/simple/simple.H
View file @
8628ef2f
...
...
@@ -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
...
...
applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/Kunz/Kunz.H
View file @
8628ef2f
...
...
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-201
3
OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-201
5
OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
...
...
@@ -87,7 +87,7 @@ public:
// Constructors
//-
c
onstruct from components
//-
C
onstruct from components
Kunz
(
const
volVectorField
&
U
,
...
...
applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/Merkle/Merkle.H
View file @
8628ef2f
...
...
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-201
3
OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-201
5
OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
...
...
@@ -81,7 +81,7 @@ public:
// Constructors
//-
c
onstruct from components
//-
C
onstruct from components
Merkle
(
const
volVectorField
&
U
,
...
...
applications/solvers/multiphase/interPhaseChangeFoam/phaseChangeTwoPhaseMixtures/SchnerrSauer/SchnerrSauer.H
View file @
8628ef2f
...
...
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-201
3
OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-201
5
OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
...
...
@@ -94,7 +94,7 @@ public:
// Constructors
//-
c
onstruct from components
//-
C
onstruct from components
SchnerrSauer
(
const
volVectorField
&
U
,
...
...
applications/solvers/multiphase/multiphaseEulerFoam/interfacialModels/dragModels/dragModel/dragModel.H
View file @
8628ef2f
...
...
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-201
2
OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-201
5
OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
...
...
@@ -128,7 +128,7 @@ public:
return
residualSlip_
;
}
//-
t
he dragfunction K used in the momentum eq.
//-
T
he 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! *****************************
...
...
applications/solvers/multiphase/multiphaseEulerFoam/interfacialModels/heatTransferModels/heatTransferModel/heatTransferModel.H
View file @
8628ef2f
...
...
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-201
2
OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-201
5
OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
...
...
@@ -111,7 +111,7 @@ public:
// Member Functions
//-
t
he heat-transfer function K used in the enthalpy eq.
//-
T
he 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! *****************************
...
...
applications/solvers/multiphase/twoPhaseEulerFoam/phaseCompressibleTurbulenceModels/kineticTheoryModels/conductivityModel/HrenyaSinclair/HrenyaSinclairConductivity.H
View file @
8628ef2f
...
...
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-201
4
OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-201
5
OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
...
...
@@ -55,7 +55,7 @@ class HrenyaSinclair
{
dictionary
coeffDict_
;
//-
c
haracteristic length of geometry
//-
C
haracteristic length of geometry
dimensionedScalar
L_
;
...
...
applications/solvers/multiphase/twoPhaseEulerFoam/twoPhaseSystem/phaseModel/phaseModel.H
View file @
8628ef2f
...
...
@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-201
4
OpenFOAM Foundation
\\ / A nd | Copyright (C) 2011-201
5
OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
...
...
@@ -92,7 +92,7 @@ class phaseModel
//- Diameter model
autoPtr
<
diameterModel
>
dPtr_
;
//-
t
urbulence model
//-
T
urbulence model
autoPtr
<
PhaseCompressibleTurbulenceModel
<
phaseModel
>
>
turbulence_
;
...
...
applications/utilities/mesh/advanced/collapseEdges/meshQualityDict
View file @
8628ef2f
...
...
@@ -50,7 +50,7 @@ minArea -1;
// and face centre triangles normal
minTwist 0.0;
//-
m
inimum normalised cell determinant
//-
M
inimum normalised cell determinant
// 1 = hex, <= 0 = folded or flattened illegal cell
minDeterminant 0.001;
...
...
applications/utilities/mesh/conversion/star3ToFoam/starMesh.H
View file @
8628ef2f
...
...
@@ -192,10 +192,10 @@ class starMesh
void
operator
=
(
const
starMesh
&
);
//-
r
ead fixed format vertex label
//-
R
ead fixed format vertex label
static
label
readVtxLabel
(
IFstream
&
);
//-
r
ead fixed format vertex coordinate component
//-
R
ead fixed format vertex coordinate component
static
scalar
readVtxCmpt
(
IFstream
&
);
//- Read to nl
...
...
applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/backgroundMeshDecomposition/backgroundMeshDecomposition.H
View file @
8628ef2f
...
...
@@ -133,7 +133,7 @@ class backgroundMeshDecomposition
//- Decomposition method
autoPtr
<
decompositionMethod
>
decomposerPtr_
;
//-
m
erge distance required by fvMeshDistribute
//-
M
erge distance required by fvMeshDistribute
scalar
mergeDist_
;
//- Scale of a cell span vs cell size used to decide to refine a cell
...
...
applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cellSizeControlSurfaces/cellSizeFunction/linearDistance/linearDistance.H
View file @
8628ef2f
...
...
@@ -54,13 +54,13 @@ private:
// Private data
//-
c
ell size at distance_ from the surface
//-
C
ell size at distance_ from the surface
scalar
distanceCellSize_
;
//-
d
istance from the surface to control over
//-
D
istance from the surface to control over
scalar
distance_
;
//-
d
istance squared
//-
D
istance squared
scalar
distanceSqr_
;
...
...
applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/cellSizeControlSurfaces/cellSizeFunction/surfaceOffsetLinearDistance/surfaceOffsetLinearDistance.H
View file @
8628ef2f
...
...
@@ -54,7 +54,7 @@ private:
// Private data
//-
c
ell size at distance_ from the surface
//-
C
ell size at distance_ from the surface
scalar
distanceCellSize_
;
//- Offset distance from surface for constant size portion
...
...
applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/conformalVoronoiMesh/conformalVoronoiMesh.H
View file @
8628ef2f
...
...
@@ -546,7 +546,7 @@ private:
)
const
;
//- Check if a location is in the exclusion range of an existing feature
//-
e
dge conformation location
//-
E
dge 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
//-
d
ual points
//-
D
ual points
void
indexDualVertices
(
pointField
&
pts
,
...
...
applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/conformalVoronoiMesh/featurePointConformer/pointFeatureEdgesTypes.H
View file @
8628ef2f
...
...
@@ -58,7 +58,7 @@ class pointFeatureEdgesTypes
//- Reference to the feature edge mesh
const
extendedFeatureEdgeMesh
&
feMesh_
;
//-
l
abel of the point
//-
L
abel of the point
label
pointLabel_
;
...
...
applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/conformalVoronoiMesh/indexedCell/indexedCell.H
View file @
8628ef2f
...
...
@@ -88,7 +88,7 @@ class indexedCell
// Private data
//- The index for this Delaunay tetrahedral cell. Type information is
//-
a
lso carried:
//-
A
lso carried:
// ctFar : the dual point of this cell does not form part of the
// internal or boundary of the dual mesh
...
...
Prev
1
2
3
4
5
…
14
Next
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment