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

fixup doxygen for RAS/LES models, etc

Browse Source
This commit is contained in:
Mark Olesen
2008-06-27 13:43:08 +02:00
parent cb08f660ec
commit d858f7c811
55 changed files with 68 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/dynamicMesh/polyTopoChange/polyTopoChange/hexRef8.C
View File

@ -50,15 +50,15 @@ namespace Foam
{
defineTypeNameAndDebug(hexRef8, 0);
// Reduction class. If x and y are not equal assign value.
//- Reduction class. If x and y are not equal assign value.
template< int value >
class ifEqEqOp
{
public:
void operator()( label& x, const label& y ) const
{
x = (x==y) ? x:value;
}
x = (x==y) ? x:value;
}
};
}

1
src/lagrangian/intermediate/clouds/Templates/KinematicCloud/KinematicCloud.H
View File

@ -27,6 +27,7 @@ Class
Description
Templated base class for kinematic cloud
- Kinematic only
- Dispersion model
- Drag model

4
src/lagrangian/intermediate/parcels/Templates/KinematicParcel/KinematicParcel.H
View File

@ -27,7 +27,9 @@ Class
Description
Kinematic parcel class with one/two-way coupling with the continuous
phase. Sub-models include:
phase.
Sub-models include:
- drag
- break-up
- wall interactions

1
src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeInjection/ConeInjection.H
View File

@ -27,6 +27,7 @@ Class
Description
Cone injection
- User specifies
- time of start of injection
- injector position

16
src/meshTools/edgeFaceCirculator/edgeFaceCirculator.H
View File

@ -26,15 +26,15 @@ Class
Foam::edgeFaceCirculator
Description
Walks from starting face around edge. Implicit
description of edge:
Walks from starting face around edge.
Implicit description of edge:
- face
- index in face. edge is always between f[index] and f[index+1]
- direction (cell to walk into)
Use as:
1) in-place:
-# Use in-place: \n
@code
edgeFaceCirculator circ(..);
// Optionally rotate to beginning: circ.setCanonical();
@ -45,9 +45,10 @@ Description
++circ;
}
while (circ != circ.end());
@endcode
2) like STL iterator:
-# Use like STL iterator: \n
@code
edgeFaceCirculator circ(..);
for
(
@ -58,6 +59,7 @@ Description
{
Info<< "face:" << iter.face() << endl;
}
@endcode
SourceFiles

2
src/turbulenceModels/LES/compressible/LESModel/LESModel.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Namespace
Foam::compressible
Foam::compressible::LESModels
Description
Namespace for compressible LES models.

2
src/turbulenceModels/LES/incompressible/DeardorffDiffStress/DeardorffDiffStress.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::LES::DeardorffDiffStress
Foam::incompressible::LESModels::DeardorffDiffStress
Description
Differential SGS Stress Equation Model for incompressible flows

2
src/turbulenceModels/LES/incompressible/GenEddyVisc/GenEddyVisc.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::LES::GenEddyVisc
Foam::incompressible::LESModels::GenEddyVisc
Description
General base class for all incompressible models that can be implemented

2
src/turbulenceModels/LES/incompressible/GenSGSStress/GenSGSStress.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::LES::GenSGSStress
Foam::incompressible::LESModels::GenSGSStress
Description
General base class for all incompressible models that directly

2
src/turbulenceModels/LES/incompressible/LESModel/LESModel.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Namespace
Foam::incompressible
Foam::incompressible::LESModels
Description
Namespace for incompressible LES models.

2
src/turbulenceModels/LES/incompressible/LRRDiffStress/LRRDiffStress.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::LES::LRRDiffStress
Foam::incompressible::LESModels::LRRDiffStress
Description
Differential SGS Stress Equation Model for incompressible flows.

2
src/turbulenceModels/LES/incompressible/Smagorinsky/Smagorinsky.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::LES::Smagorinsky
Foam::incompressible::LESModels::Smagorinsky
Description
The Isochoric Smagorinsky Model for incompressible flows.

2
src/turbulenceModels/LES/incompressible/Smagorinsky2/Smagorinsky2.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::LES::Smagorinsky2
Foam::incompressible::LESModels::Smagorinsky2
Description
The Isochoric Smagorinsky Model for incompressible flows

2
src/turbulenceModels/LES/incompressible/SpalartAllmaras/SpalartAllmaras.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::LES::SpalartAllmaras
Foam::incompressible::LESModels::SpalartAllmaras
Description
SpalartAllmaras for incompressible flows

2
src/turbulenceModels/LES/incompressible/dynMixedSmagorinsky/dynMixedSmagorinsky.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::LES::dynMixedSmagorinsky
Foam::incompressible::LESModels::dynMixedSmagorinsky
Description
The Mixed Isochoric Smagorinsky Model for incompressible flows.

2
src/turbulenceModels/LES/incompressible/dynOneEqEddy/dynOneEqEddy.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::LES::dynOneEqEddy
Foam::incompressible::LESModels::dynOneEqEddy
Description
One Equation Eddy Viscosity Model for incompressible flows.

4
src/turbulenceModels/LES/incompressible/dynSmagorinsky/dynSmagorinsky.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::LES::dynSmagorinsky
Foam::incompressible::LESModels::dynSmagorinsky
Description
The Isochoric dynamic Smagorinsky Model for incompressible flows.
@ -56,7 +56,7 @@ Description
m = delta^2*(4*||F(D)||^2 - F(||D||^2))
L = dev(F(U*U) - F(U)*F(U))
M = delta^2*(F(||D||*dev(D)) - 4*||F(D)||*F(dev(D)))
@verbatim
@endverbatim
SourceFiles
dynSmagorinsky.C

2
src/turbulenceModels/LES/incompressible/laminar/laminar.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::LES::laminar
Foam::incompressible::LESModels::laminar
Description
LES model for laminar incompressible flow.

2
src/turbulenceModels/LES/incompressible/locDynOneEqEddy/locDynOneEqEddy.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::LES::locDynOneEqEddy
Foam::incompressible::LESModels::locDynOneEqEddy
Description
Localised Dynamic One Equation Eddy Viscosity Model for incompressible

2
src/turbulenceModels/LES/incompressible/mixedSmagorinsky/mixedSmagorinsky.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::LES::mixedSmagorinsky
Foam::incompressible::LESModels::mixedSmagorinsky
Description
The mixed Isochoric Smagorinsky Model for incompressible flows.

2
src/turbulenceModels/LES/incompressible/oneEqEddy/oneEqEddy.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::LES::oneEqEddy
Foam::incompressible::LESModels::oneEqEddy
Description
One Equation Eddy Viscosity Model for incompressible flows

2
src/turbulenceModels/LES/incompressible/scaleSimilarity/scaleSimilarity.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::LES::scaleSimilarity
Foam::incompressible::LESModels::scaleSimilarity
Description
General base class for all scale similarity models

2
src/turbulenceModels/LES/incompressible/spectEddyVisc/spectEddyVisc.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::LES::spectEddyVisc
Foam::incompressible::LESModels::spectEddyVisc
Description
The Isochoric spectral Eddy Viscosity Model for incompressible flows.

2
src/turbulenceModels/LES/incompressible/vanDriestDelta/vanDriestDelta.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::LES::vanDriestDelta
Foam::incompressible::LESModels::vanDriestDelta
Description
Simple cube-root of cell volume delta used in incompressible LES models.

2
src/turbulenceModels/LES/incompressible/wallFunc/nuSgsWallFunction/nuSgsWallFunctionFvPatchScalarField.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::LES::nuSgsWallFunctionFvPatchScalarField
Foam::incompressible::LESModels::nuSgsWallFunctionFvPatchScalarField
Description
wall function boundary condition for incompressible flows

2
src/turbulenceModels/RAS/compressible/LRR/LRR.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::compressible::RAS::LRR
Foam::compressible::RASModels::LRR
Description
Launder, Reece and Rodi Reynolds-stress turbulence model for

2
src/turbulenceModels/RAS/compressible/LaunderGibsonRSTM/LaunderGibsonRSTM.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::compressible::RAS::LaunderGibsonRSTM
Foam::compressible::RASModels::LaunderGibsonRSTM
Description
Launder-Gibson Reynolds stress turbulence model for compressible flows.

2
src/turbulenceModels/RAS/compressible/LaunderSharmaKE/LaunderSharmaKE.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::compressible::RAS::LaunderSharmaKE
Foam::compressible::RASModels::LaunderSharmaKE
Description
Launder and Sharma low-Reynolds k-epsilon turbulence model for

2
src/turbulenceModels/RAS/compressible/RASModel/RASModel.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Namespace
Foam::compressible::RAS
Foam::compressible::RASModels
Description
Namespace for compressible RAS turbulence models.

2
src/turbulenceModels/RAS/compressible/RNGkEpsilon/RNGkEpsilon.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::compressible::RAS::RNGkEpsilon
Foam::compressible::RASModels::RNGkEpsilon
Description
Renormalisation group k-epsilon turbulence model for compressible flows.

2
src/turbulenceModels/RAS/compressible/SpalartAllmaras/SpalartAllmaras.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::compressible::RAS::SpalartAllmaras
Foam::compressible::RASModels::SpalartAllmaras
Description
Spalart-Allmaras one-eqn mixing-length model for compressible

2
src/turbulenceModels/RAS/compressible/kEpsilon/kEpsilon.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::compressible::RAS::kEpsilon
Foam::compressible::RASModels::kEpsilon
Description
Standard k-epsilon turbulence model for compressible flows

2
src/turbulenceModels/RAS/compressible/kOmegaSST/kOmegaSST.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::compressible::RAS::kOmegaSST
Foam::compressible::RASModels::kOmegaSST
Description
Implementation of the k-omega-SST turbulence model for compressible flows.

2
src/turbulenceModels/RAS/compressible/laminar/laminar.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::compressible::RAS::laminar
Foam::compressible::RASModels::laminar
Description
Dummy turbulence model for laminar compressible flow.

2
src/turbulenceModels/RAS/compressible/realizableKE/realizableKE.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::compressible::RAS::realizableKE
Foam::compressible::RASModels::realizableKE
Description
Realizable k-epsilon turbulence model for compressible flows.

2
src/turbulenceModels/RAS/compressible/wallFunctions/mutWallFunctions/mutStandardRoughWallFunction/mutStandardRoughWallFunctionFvPatchScalarField.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::compressible::RAS::mutStandardRoughWallFunctionFvPatchScalarField
Foam::compressible::RASModels::mutStandardRoughWallFunctionFvPatchScalarField
Description
Wall function boundary condition for rough walls

2
src/turbulenceModels/RAS/incompressible/LRR/LRR.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::RAS::LRR
Foam::incompressible::RASModels::LRR
Description
Launder, Reece and Rodi Reynolds-stress turbulence model for

2
src/turbulenceModels/RAS/incompressible/LamBremhorstKE/LamBremhorstKE.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::RAS::LamBremhorstKE
Foam::incompressible::RASModels::LamBremhorstKE
Description
Lam and Bremhorst low-Reynolds number k-epsilon turbulence model

2
src/turbulenceModels/RAS/incompressible/LaunderGibsonRSTM/LaunderGibsonRSTM.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::RAS::LaunderGibsonRSTM
Foam::incompressible::RASModels::LaunderGibsonRSTM
Description
Launder-Gibson Reynolds stress turbulence model for incompressible flows.

2
src/turbulenceModels/RAS/incompressible/LaunderSharmaKE/LaunderSharmaKE.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::RAS::LaunderSharmaKE
Foam::incompressible::RASModels::LaunderSharmaKE
Description
Launder and Sharma low-Reynolds k-epsilon turbulence model for

2
src/turbulenceModels/RAS/incompressible/LienCubicKE/LienCubicKE.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::RAS::LienCubicKE
Foam::incompressible::RASModels::LienCubicKE
Description
Lien cubic non-linear k-epsilon turbulence model for incompressible flows.

2
src/turbulenceModels/RAS/incompressible/LienCubicKELowRe/LienCubicKELowRe.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::RAS::LienCubicKELowRe
Foam::incompressible::RASModels::LienCubicKELowRe
Description
Lien cubic non-linear low-Reynolds k-epsilon turbulence models for

2
src/turbulenceModels/RAS/incompressible/LienLeschzinerLowRe/LienLeschzinerLowRe.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::RAS::LienLeschzinerLowRe
Foam::incompressible::RASModels::LienLeschzinerLowRe
Description
Lien and Leschziner low-Reynolds k-epsilon turbulence model for

2
src/turbulenceModels/RAS/incompressible/NonlinearKEShih/NonlinearKEShih.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::RAS::NonlinearKEShih
Foam::incompressible::RASModels::NonlinearKEShih
Description
Shih's quadratic non-linear k-epsilon turbulence model for

2
src/turbulenceModels/RAS/incompressible/QZeta/QZeta.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::RAS::QZeta
Foam::incompressible::RASModels::QZeta
Description
Gibson and Dafa'Alla's q-zeta two-equation low-Re turbulence model

2
src/turbulenceModels/RAS/incompressible/RASModel/RASModel.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Namespace
Foam::incompressible
Foam::incompressible::RASModels
Description
Namespace for incompressible RAS turbulence models.

2
src/turbulenceModels/RAS/incompressible/RNGkEpsilon/RNGkEpsilon.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::RAS::RNGkEpsilon
Foam::incompressible::RASModels::RNGkEpsilon
Description
Renormalisation group k-epsilon turbulence model for incompressible flows.

2
src/turbulenceModels/RAS/incompressible/SpalartAllmaras/SpalartAllmaras.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::RAS::SpalartAllmaras
Foam::incompressible::RASModels::SpalartAllmaras
Description
Spalart-Allmaras 1-eqn mixing-length model for incompressible external

2
src/turbulenceModels/RAS/incompressible/kEpsilon/kEpsilon.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::RAS::kEpsilon
Foam::incompressible::RASModels::kEpsilon
Description
Standard k-epsilon turbulence model for incompressible flows.

2
src/turbulenceModels/RAS/incompressible/kOmegaSST/kOmegaSST.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::RAS::kOmegaSST
Foam::incompressible::RASModels::kOmegaSST
Description
Implementation of the k-omega-SST turbulence model for incompressible

2
src/turbulenceModels/RAS/incompressible/laminar/laminar.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::RAS::laminar
Foam::incompressible::RASModels::laminar
Description
Dummy turbulence model for laminar incompressible flow.

2
src/turbulenceModels/RAS/incompressible/realizableKE/realizableKE.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::RAS::realizableKE
Foam::incompressible::RASModels::realizableKE
Description
Realizable k-epsilon turbulence model for incompressible flows.

2
src/turbulenceModels/RAS/incompressible/wallFunctions/nutWallFunctions/nutStandardRoughWallFunction/nutStandardRoughWallFunctionFvPatchScalarField.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::RAS::nutStandardRoughWallFunctionFvPatchScalarField
Foam::incompressible::RASModels::nutStandardRoughWallFunctionFvPatchScalarField
Description
Wall function boundary condition for rough walls

2
src/turbulenceModels/RAS/incompressible/wallFunctions/nutWallFunctions/nutStandardWallFunction/nutStandardWallFunctionFvPatchScalarField.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::RAS::nutStandardWallFunctionFvPatchScalarField
Foam::incompressible::RASModels::nutStandardWallFunctionFvPatchScalarField
Description
Wall function boundary condition for walls

2
src/turbulenceModels/RAS/incompressible/wallFunctions/nutWallFunctions/nutWallFunction/nutWallFunctionFvPatchScalarField.H
View File

@ -23,7 +23,7 @@ License
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::incompressible::RAS::nutWallFunctionFvPatchScalarField
Foam::incompressible::RASModels::nutWallFunctionFvPatchScalarField
Description
Wall function boundary condition for walls