Commit d858f7c8 authored by Mark Olesen's avatar Mark Olesen
Browse files

fixup doxygen for RAS/LES models, etc

parent cb08f660
......@@ -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;
}
};
}
......
......@@ -27,6 +27,7 @@ Class
Description
Templated base class for kinematic cloud
- Kinematic only
- Dispersion model
- Drag model
......
......@@ -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
......
......@@ -27,6 +27,7 @@ Class
Description
Cone injection
- User specifies
- time of start of injection
- injector position
......
......@@ -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
......
......@@ -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.
......
......@@ -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
......
......@@ -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
......
......@@ -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
......
......@@ -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.
......
......@@ -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.
......
......@@ -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.
......
......@@ -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
......
......@@ -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
......
......@@ -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.
......
......@@ -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.
......
......@@ -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
......
......@@ -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.
......
......@@ -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
......
......@@ -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.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment