From e6a41726e2a6b6d498179ceb98fc9c57c2861607 Mon Sep 17 00:00:00 2001 From: andy Date: Thu, 19 Jul 2012 17:16:03 +0100 Subject: [PATCH 01/12] ENH: Updates to BC documentation --- .../SRFFreestreamVelocityFvPatchVectorField.H | 7 ++- .../SRFVelocityFvPatchVectorField.H | 22 +++++-- .../basic/mixed/mixedFvPatchField.H | 17 ++++-- .../zeroGradient/zeroGradientFvPatchField.H | 4 +- .../derived/fan/fanFvPatchField.H | 2 +- .../fanPressureFvPatchScalarField.H | 33 ++++++----- ...ppedFixedPushedInternalValueFvPatchField.H | 4 +- ...mappedVelocityFluxFixedValueFvPatchField.H | 2 +- ...phaseFixedFluxPressureFvPatchScalarField.H | 2 +- ...urfaceNormalFixedValueFvPatchVectorField.H | 2 +- ...ranslatingWallVelocityFvPatchVectorField.H | 2 +- .../gradientEnergyFvPatchScalarField.C | 6 +- .../gradientEnergyFvPatchScalarField.H | 18 +++++- .../alphaContactAngleFvPatchScalarField.H | 18 +++--- ...convectiveHeatTransferFvPatchScalarField.H | 2 +- ...ayatillekeWallFunctionFvPatchScalarField.H | 2 +- .../mutURoughWallFunctionFvPatchScalarField.H | 4 +- ...tUSpaldingWallFunctionFvPatchScalarField.H | 15 ++++- .../mutkRoughWallFunctionFvPatchScalarField.H | 4 +- .../fixedShearStressFvPatchVectorField.H | 3 +- .../porousBafflePressureFvPatchField.H | 59 +++++++++++++++---- ...ndaryLayerInletEpsilonFvPatchScalarField.H | 6 +- ...entHeatFluxTemperatureFvPatchScalarField.H | 2 +- .../nutURoughWallFunctionFvPatchScalarField.H | 2 +- ...tUSpaldingWallFunctionFvPatchScalarField.H | 15 ++++- .../nutkRoughWallFunctionFvPatchScalarField.H | 2 +- 26 files changed, 186 insertions(+), 69 deletions(-) diff --git a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H index fe50e35cac..58c7ab9ce0 100644 --- a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H +++ b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFFreestreamVelocityFvPatchVectorField/SRFFreestreamVelocityFvPatchVectorField.H @@ -48,12 +48,17 @@ Description \heading Patch usage + \table + Property | Description | Required | Default value + UInf | free stream velocity | yes | + \endtable + Example of the boundary condition specification: \verbatim myPatch { type SRFFreestreamVelocity; - UInf (0 0 0); // free stream velocity + UInf (0 0 0); value uniform (0 0 0); // optional value entry } \endverbatim diff --git a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H index 71bb989bcd..32aaa246a7 100644 --- a/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H +++ b/src/finiteVolume/cfdTools/general/SRF/derivedFvPatchFields/SRFVelocityFvPatchVectorField/SRFVelocityFvPatchVectorField.H @@ -41,24 +41,38 @@ Description - relative = yes: inlet velocity applied 'as is': \f[ - Up = U_in + U_p = U_{in} \f] - relative = no : SRF velocity is subtracted from the inlet velocity: \f[ - Up = U_in - U_srf + U_p = U_{in} - U_{p,srf} \f] + where + \vartable + U_p = patch velocity [m/s] + U_{in} = user-specified inlet velocity + U_{p,srf} = SRF velocity + \endvartable + + \heading Patch usage + \table + Property | Description | Required | Default value + relative | relative motion to the SRF? | yes | + inletValue | inlet velocity | yes | + \endtable + Example of the boundary condition specification: \verbatim myPatch { type SRFVelocity; - relative yes; // relative motion to the SRF? - inletValue uniform (0 0 0); // inlet velocity + relative yes; + inletValue uniform (0 0 0); value uniform (0 0 0); // initial value } \endverbatim diff --git a/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H index 3b1bc57c27..7c475c1111 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/mixed/mixedFvPatchField.H @@ -35,19 +35,28 @@ Description The respective contributions from each is determined by a weight field: \f[ - x_p = w*A + (1-w)*(x_c + B/\Delta) + x_p = w x_p + (1-w) \left(x_c + \frac{\nabla_\perp x}{\Delta}\right) \f] where \vartable x_p | patch values x_c | patch internal cell values - w | weight field, \c valueFraction_ - A | fixed value, \c refValue_ - B | patch normal gradient, \c refGrad_ + w | weight field \Delta| inverse distance from face centre to internal cell centre + w | weighting (0-1) \endvartable + + \heading Patch usage + + \table + Property | Description | Required | Default value + valueFraction | weight field | yes | + refValue | fixed value | yes | + refGrad | patch normal gradient | yes | + \endtable + \note This condition is not usually applied directly; instead, use a derived mixed condition such as \c inletOutlet diff --git a/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H index 99038a1240..cb238253f1 100644 --- a/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/basic/zeroGradient/zeroGradientFvPatchField.H @@ -28,7 +28,7 @@ Group grpGenericBoundaryConditions Description - This boundary condition appies a zero-gradient condition from the patch + This boundary condition applies a zero-gradient condition from the patch internal field onto the patch faces. \heading Patch usage @@ -57,7 +57,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class zeroGradientFvPatch Declaration + Class zeroGradientFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H index be28d24448..9306796d79 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fan/fanFvPatchField.H @@ -28,7 +28,7 @@ Group grpCoupledBoundaryConditions Description - This boundary condition supplies a jump condition, using the \c cyclic + This boundary condition provides a jump condition, using the \c cyclic condition as a base. The jump is specified as a \c DataEntry type, to enable the use of, e.g. diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H index a8124bb38b..022fb48ccb 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fanPressure/fanPressureFvPatchScalarField.H @@ -31,31 +31,36 @@ Description This boundary condition can be applied to assign either a pressure inlet or outlet total pressure condition for a fan. - User specifies: - \li pressure drop vs volumetric flow rate table (fan curve) file name; - \li direction of normal flow through the fan, in or out; - \li total pressure of the environment. + \heading Patch usage + + \table + Property | Description | Required | Default value + fileName | fan curve file name | yes | + outOfBounds | out of bounds handling | yes | + direction | direction of flow through fan [in/out] | yes | + p0 | environmental total pressure | yes | + \endtable Example of the boundary condition specification: \verbatim inlet { type fanPressure; - fileName "fanCurve"; // Fan curve file name - outOfBounds clamp; // (error|warn|clamp|repeat) - direction in; // Direction of flow through fan - p0 uniform 0; // Environmental total pressure - value uniform 0; // Initial pressure + fileName "fanCurve"; + outOfBounds clamp; + direction in; + p0 uniform 0; + value uniform 0; } outlet { type fanPressure; - fileName "fanCurve"; // Fan curve file name - outOfBounds clamp; // (error|warn|clamp|repeat) - direction out; // Direction of flow through fan - p0 uniform 0; // Environmental total pressure - value uniform 0; // Initial pressure + fileName "fanCurve"; + outOfBounds clamp; + direction out; + p0 uniform 0; + value uniform 0; } \endverbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H index 18884da980..04ec0c4ef7 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedFixedPushedInternalValue/mappedFixedPushedInternalValueFvPatchField.H @@ -44,7 +44,7 @@ Description \verbatim myPatch { - type mappedFixedInternalValue; + type mappedFixedPushedInternalValue; fieldName T; setAverage no; average 0; @@ -78,7 +78,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class mappedFixedPushedInternalValueFvPatchField Declaration + Class mappedFixedPushedInternalValueFvPatchField Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H index a160e2c292..8dac3f6f56 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/mappedVelocityFluxFixedValue/mappedVelocityFluxFixedValueFvPatchField.H @@ -42,7 +42,7 @@ Description \verbatim myPatch { - type mappedFixedInternalValue; + type mappedVelocityFlux; phi phi; value uniform 0; // place holder } diff --git a/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H b/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H index f71feaa1e3..c7f13d7506 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/multiphaseFixedFluxPressure/multiphaseFixedFluxPressureFvPatchScalarField.H @@ -61,7 +61,7 @@ Description \verbatim myPatch { - type externalWallHeatFluxTemperature; + type multiphaseFixedFluxPressure; phiHbyA phiHbyA; phi phi; rho rho; diff --git a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H index 5906f790a6..2b6242a42d 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/surfaceNormalFixedValue/surfaceNormalFixedValueFvPatchVectorField.H @@ -42,7 +42,7 @@ Description \verbatim myPatch { - type inletOutlet; + type surfaceNormalFixedValue; refValue -10; // 10 INTO the domain } \endverbatim diff --git a/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H index d32a1ba460..c6e9c70b88 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/translatingWallVelocity/translatingWallVelocityFvPatchVectorField.H @@ -42,7 +42,7 @@ Description \verbatim myPatch { - type rotatingWallVelocity; + type translatingWallVelocity; U (100 0 0); } \endverbatim diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.C b/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.C index 42ed096ea6..5f0e009d13 100644 --- a/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.C +++ b/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.C @@ -97,10 +97,8 @@ void Foam::gradientEnergyFvPatchScalarField::updateCoeffs() return; } - const basicThermo& thermo = db().lookupObject - ( - "thermophysicalProperties" - ); + const basicThermo& thermo = + db().lookupObject("thermophysicalProperties"); const label patchi = patch().index(); diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H b/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H index 2ee94c08cc..a510d3ac82 100644 --- a/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H +++ b/src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyFvPatchScalarField.H @@ -28,9 +28,25 @@ Group grpThermoBoundaryConditions Description - This boundary condition provides a gradient condition for internal energy + This boundary condition provides a gradient condition for internal energy, + where the gradient is calculated using: + + \f[ + \nabla(e_p) = \nabla_\perp C_p(p, T) + \frac{e_p - e_c}{\Delta} + \f] + + where + \vartable + e_p | energy at patch faces [J] + e_c | energy at patch internal cells [J] + p | pressure [bar] + T | temperature [K] + C_p | specific heat [J/kg/K] + \Delta | distance between patch face and internal cell centres [m] + \endvartable \heading Patch usage + Example of the boundary condition specification: \verbatim myPatch diff --git a/src/transportModels/twoPhaseInterfaceProperties/alphaContactAngle/alphaContactAngle/alphaContactAngleFvPatchScalarField.H b/src/transportModels/twoPhaseInterfaceProperties/alphaContactAngle/alphaContactAngle/alphaContactAngleFvPatchScalarField.H index de6086c906..6d1f65fe73 100644 --- a/src/transportModels/twoPhaseInterfaceProperties/alphaContactAngle/alphaContactAngle/alphaContactAngleFvPatchScalarField.H +++ b/src/transportModels/twoPhaseInterfaceProperties/alphaContactAngle/alphaContactAngle/alphaContactAngleFvPatchScalarField.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::alphaContactAngleFvPatchScalarField +Group + grpWallBoundaryConditions grpGenericBoundaryConditions + Description Abstract base class for alphaContactAngle boundary conditions. @@ -47,11 +50,12 @@ Description on p_rgh must set to guarantee that the flux is corrected to be zero at the wall e.g. - walls - { - type fixedFluxPressure; - adjoint no; - } + \verbatim + myPatch + { + type alphaContactAngle; + } + \endverbatim If "limit zeroGradient;" is used the pressure BCs can be left as before. @@ -72,7 +76,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class alphaContactAngleFvPatch Declaration + Class alphaContactAngleFvPatchScalarField Declaration \*---------------------------------------------------------------------------*/ class alphaContactAngleFvPatchScalarField diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H index aaaee1c650..2bc06bb0e4 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/convectiveHeatTransfer/convectiveHeatTransferFvPatchScalarField.H @@ -61,7 +61,7 @@ Description \verbatim myPatch { - type turbulentInlet; + type convectiveHeatTransfer; L 0.1; } \endverbatim diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H index 0998193046..60271aae48 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/alphatWallFunctions/alphatJayatillekeWallFunction/alphatJayatillekeWallFunctionFvPatchScalarField.H @@ -45,7 +45,7 @@ Description \verbatim myPatch { - type alphaSgsJayatillekeWallFunction; + type alphatJayatillekeWallFunction; Prt 0.85; kappa 0.41; E 9.8; diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutURoughWallFunction/mutURoughWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutURoughWallFunction/mutURoughWallFunctionFvPatchScalarField.H index ee89a45f6c..479cb18b40 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutURoughWallFunction/mutURoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutURoughWallFunction/mutURoughWallFunctionFvPatchScalarField.H @@ -37,14 +37,14 @@ Description Property | Description | Required | Default value roughnessHeight | roughness height | yes | roughnessConstant | roughness constanr | yes | - roughnessFactor | scaling factor | + roughnessFactor | scaling factor | yes | \endtable Example of the boundary condition specification: \verbatim myPatch { - type nutURoughWallFunction; + type mutURoughWallFunction; roughnessHeight 1e-5; roughnessConstant 0.5; roughnessFactor 1; diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUSpaldingWallFunction/mutUSpaldingWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUSpaldingWallFunction/mutUSpaldingWallFunctionFvPatchScalarField.H index 4eeefb74cc..2501fa5b71 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUSpaldingWallFunction/mutUSpaldingWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutUSpaldingWallFunction/mutUSpaldingWallFunctionFvPatchScalarField.H @@ -29,9 +29,22 @@ Group Description This boundary condition provides a turbulent viscosity condition when - using wall functions for rough walls, based on velocity, using Spaldings + using wall functions for rough walls, based on velocity, using Spalding's law to give a continuous nut profile to the wall (y+ = 0) + \f[ + y^+ = u^+ + \frac{1}{E} \left[exp(\kappa u^+) - 1 - \kappa u^+\, + - 0.5 (\kappa u^+)^2 - \frac{1}{6} (\kappa u^+)^3\right] + \f] + + where + \vartable + y^+ | non-dimensional position + u^+ | non-dimensional velocity + \kappa | Von Karman constant + \endvartable + + \heading Patch usage Example of the boundary condition specification: diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkRoughWallFunction/mutkRoughWallFunctionFvPatchScalarField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkRoughWallFunction/mutkRoughWallFunctionFvPatchScalarField.H index 8daa978a22..fdf5a0a7d6 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkRoughWallFunction/mutkRoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/mutWallFunctions/mutkRoughWallFunction/mutkRoughWallFunctionFvPatchScalarField.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -49,7 +49,7 @@ Description \verbatim myPatch { - type nutkAtmRoughWallFunction; + type mutkRoughWallFunction; Ks uniform 0; Cs uniform 0.5; } diff --git a/src/turbulenceModels/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.H b/src/turbulenceModels/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.H index e8d9cc0376..d1ad27977f 100644 --- a/src/turbulenceModels/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.H +++ b/src/turbulenceModels/derivedFvPatchFields/fixedShearStress/fixedShearStressFvPatchVectorField.H @@ -25,7 +25,8 @@ License Class Foam::fixedShearStressFvPatchVectorField -Group grpWallBoundaryConditions +Group + grpWallBoundaryConditions Description Set a constant shear stress as tau0 = -nuEff dU/dn. diff --git a/src/turbulenceModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H b/src/turbulenceModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H index 8e0dccd0cc..b45b7a330c 100644 --- a/src/turbulenceModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H +++ b/src/turbulenceModels/derivedFvPatchFields/porousBafflePressure/porousBafflePressureFvPatchField.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,18 +24,57 @@ License Class Foam::porousBafflePressureFvPatchField +Group + grpCoupledBoundaryConditions + Description - Foam::porousBafflePressureFvPatchField - the porous baffle operates on a cyclic patch and introduce a jump on the p - field as follow: + This boundary condition provides a jump condition, using the \cyclic + condition as a base. - deltaP = -(I*mu*U + 0.5*D*rho*magSqr(U)*L) + The porous baffle introduces a pressure jump defined by: - where: + \f[ + \Delta p = -(I \mu U + 0.5 D \rho |U|^2 L) + \f] - I is the inertial coefficient - D is the darcy coeafficient - L is the porous media lenght in the flow direction + where + + \vartable + p | pressure [Pa] + \rho | density [kg/m3] + \mu | viscosity [Pa s] + I | inertial coefficient + D | Darcy coefficient + L | porous media length in the flow direction + \endvartable + + + \heading Patch usage + + \table + Property | Description | Required | Default value + patchType | underlying patch type should be \c cyclic| yes | + D | Darcy coefficient | yes | + I | inertial coefficient | yes | + L | porous media length in the flow direction | yes | + \endtable + + Example of the boundary condition specification: + \verbatim + myPatch + { + type porousBafflePressure; + patchType cyclic; + jump uniform 0; + D 1000000; + I 0.001; + L 0.1; + value uniform 0; + } + \endverbatim + + \note + The underlying \c patchType should be set to \c cyclic SourceFiles porousBafflePressureFvPatchField.C @@ -63,7 +102,7 @@ class porousBafflePressureFvPatchField { // Private data - //- Darcy pressure lost coefficient + //- Darcy pressure loss coefficient scalar D_; //- Inertia pressure lost coefficient diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H index 10e6691933..f52dbac173 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletEpsilon/atmBoundaryLayerInletEpsilonFvPatchScalarField.H @@ -34,7 +34,7 @@ Description \c ABLInletVelocity inlet velocity boundary condition. \f[ - \epsilon = \frac{(U^*)^3}{(K(z - z_g + z_0))} + \epsilon = \frac{(U^*)^3}{K(z - z_g + z_0)} \f] where @@ -49,7 +49,7 @@ Description and: \f[ - U^* = K \frac{U_{ref}}{ln(\frac{Z_{ref} + z_0}{z_0})} + U^* = K \frac{U_{ref}}{ln\left(\frac{Z_{ref} + z_0}{z_0}\right)} \f] where: @@ -74,7 +74,7 @@ Description \verbatim myPatch { - type atmBoundaryLayerInletVelocity; + type atmBoundaryLayerInletEpsilon; z 1.0; kappa 0.41; Uref 1.0; diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H index 6e686dfbdd..60d150deb0 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/turbulentHeatFluxTemperature/turbulentHeatFluxTemperatureFvPatchScalarField.H @@ -37,7 +37,7 @@ Description \table Property | Description | Required | Default value heatSource | heat source type: \c flux [W/m2] or \c power [W]| yes | - q | heat source value | yea | + q | heat source value | yes | alphaEff | turbulent thermal diffusivity field name | yes | \endtable diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H index c0f8066e97..881752d9f5 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutURoughWallFunction/nutURoughWallFunctionFvPatchScalarField.H @@ -37,7 +37,7 @@ Description Property | Description | Required | Default value roughnessHeight | roughness height | yes | roughnessConstant | roughness constanr | yes | - roughnessFactor | scaling factor | + roughnessFactor | scaling factor | yes | \endtable Example of the boundary condition specification: diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H index ba1dde4514..b9f75ed1b1 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUSpaldingWallFunction/nutUSpaldingWallFunctionFvPatchScalarField.H @@ -30,7 +30,20 @@ Group Description This boundary condition provides a turbulent kinematic viscosity condition when using wall functions for rough walls, based on velocity, using - Spaldings law to give a continuous nut profile to the wall (y+ = 0) + Spalding's law to give a continuous nut profile to the wall (y+ = 0) + + \f[ + y^+ = u^+ + \frac{1}{E} \left[exp(\kappa u^+) - 1 - \kappa u^+\, + - 0.5 (\kappa u^+)^2 - \frac{1}{6} (\kappa u^+)^3\right] + \f] + + where + \vartable + y^+ | non-dimensional position + u^+ | non-dimensional velocity + \kappa | Von Karman constant + \endvartable + \heading Patch usage diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H index 8bbe8b16b8..980f55f3b1 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkRoughWallFunction/nutkRoughWallFunctionFvPatchScalarField.H @@ -48,7 +48,7 @@ Description \verbatim myPatch { - type nutkAtmRoughWallFunction; + type nutkRoughWallFunction; Ks uniform 0; Cs uniform 0.5; } From a17b0c75c651f32a44e0f486f23d62cb1d00827e Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 23 Jul 2012 15:23:35 +0100 Subject: [PATCH 02/12] ENH: Updates to function object documentation --- .../IO/partialWrite/partialWrite.H | 3 ++- .../removeRegisteredObject.H | 3 ++- .../writeRegisteredObject.H | 3 ++- .../cloud/cloudInfo/cloudInfo.H | 3 ++- .../fieldAverage/fieldAverage/fieldAverage.H | 3 ++- .../fieldCoordinateSystemTransform.H | 3 ++- .../field/fieldMinMax/fieldMinMax.H | 3 ++- .../field/fieldValues/fieldValue/fieldValue.H | 3 ++- .../field/nearWallFields/nearWallFields.H | 3 ++- .../field/processorField/processorField.H | 3 ++- .../field/readFields/readFields.H | 3 ++- .../regionSizeDistribution.H | 3 ++- .../field/streamLine/streamLine.H | 3 ++- .../surfaceInterpolateFields.H | 2 +- .../field/turbulenceFields/turbulenceFields.H | 3 ++- .../wallBoundedStreamLine.H | 3 ++- .../forces/forceCoeffs/forceCoeffs.H | 3 ++- .../functionObjects/forces/forces/forces.H | 3 ++- .../abortCalculation/abortCalculation.H | 3 ++- .../functionObjects/systemCall/systemCall.H | 3 ++- .../codedFunctionObject/codedFunctionObject.H | 3 ++- .../utilities/dsmcFields/dsmcFields.H | 3 ++- .../pressureCoefficient/pressureCoefficient.H | 18 ++++++++++++++---- .../utilities/staticPressure/staticPressure.H | 3 ++- .../timeActivatedFileUpdate.H | 3 ++- .../utilities/yPlusLES/yPlusLES.H | 3 ++- .../utilities/yPlusRAS/yPlusRAS.H | 3 ++- src/sampling/probes/probes.H | 7 +++---- .../sampledSet/sampledSet/sampledSet.H | 7 +++---- .../sampledSurface/sampledSurface.H | 7 +++---- 30 files changed, 74 insertions(+), 42 deletions(-) diff --git a/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H b/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H index bf0afd49a6..1d8d005f6c 100644 --- a/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H +++ b/src/postProcessing/functionObjects/IO/partialWrite/partialWrite.H @@ -24,7 +24,8 @@ License Class Foam::partialWrite -\ingroup grpIOFunctionObjects +Group + grpIOFunctionObjects Description Allows some fields/registered objects to be written more often than others. diff --git a/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H b/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H index c621047a0b..edd4e16bca 100644 --- a/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H +++ b/src/postProcessing/functionObjects/IO/removeRegisteredObject/removeRegisteredObject.H @@ -24,7 +24,8 @@ License Class Foam::removeRegisteredObject -\ingroup grpIOFunctionObjects +Group + grpIOFunctionObjects Description Removes registered IO objects if present in the database diff --git a/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H b/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H index d894fb392d..01d2c29037 100644 --- a/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H +++ b/src/postProcessing/functionObjects/IO/writeRegisteredObject/writeRegisteredObject.H @@ -24,7 +24,8 @@ License Class Foam::writeRegisteredObject -\ingroup grpIOFunctionObjects +Group + grpIOFunctionObjects Description Takes over the writing of registered IO objects diff --git a/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H b/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H index f45591d924..f0c56e71fb 100644 --- a/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H +++ b/src/postProcessing/functionObjects/cloud/cloudInfo/cloudInfo.H @@ -24,7 +24,8 @@ License Class Foam::cloudInfo -\ingroup grpCloudFunctionObjects +Group + grpCloudFunctionObjects Description This function object outputs lagrangian cloud information to a file. The diff --git a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H index ec00c29359..c85ef60678 100644 --- a/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H +++ b/src/postProcessing/functionObjects/field/fieldAverage/fieldAverage/fieldAverage.H @@ -24,7 +24,8 @@ License Class Foam::fieldAverage -\ingroup grpFieldFunctionObjects +Group + grpFieldFunctionObjects Description Calculates the field averages given list of fieldAverageItems, e.g. diff --git a/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H b/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H index 618b5da574..bda640e009 100644 --- a/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H +++ b/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H @@ -24,7 +24,8 @@ License class Foam::fieldCoordinateSystemTransform -\ingroup grpFieldFunctionObjects +Group + grpFieldFunctionObjects Description Transforms fields from global cartesian co-ordinates to local co-ordinate diff --git a/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H b/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H index 15e25484fe..96e87b5ff3 100644 --- a/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H +++ b/src/postProcessing/functionObjects/field/fieldMinMax/fieldMinMax.H @@ -24,7 +24,8 @@ License Class Foam::fieldMinMax -\ingroup grpFieldFunctionObjects +Group + grpFieldFunctionObjects Description Calculates scalar minimim and maximum field values. diff --git a/src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H b/src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H index 2c12c2d024..2a67404c43 100644 --- a/src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H +++ b/src/postProcessing/functionObjects/field/fieldValues/fieldValue/fieldValue.H @@ -24,7 +24,8 @@ License Class Foam::fieldValue -\ingroup grpFieldFunctionObjects +Group + grpFieldFunctionObjects Description Base class for field value -based function objects. diff --git a/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H b/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H index 151b8cd959..21c5bc7b09 100644 --- a/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H +++ b/src/postProcessing/functionObjects/field/nearWallFields/nearWallFields.H @@ -24,7 +24,8 @@ License Class Foam::nearWallFields -\ingroup grpFieldFunctionObjects +Group + grpFieldFunctionObjects Description Samples near-patch volFields diff --git a/src/postProcessing/functionObjects/field/processorField/processorField.H b/src/postProcessing/functionObjects/field/processorField/processorField.H index c748e17fd1..3be2dbe298 100644 --- a/src/postProcessing/functionObjects/field/processorField/processorField.H +++ b/src/postProcessing/functionObjects/field/processorField/processorField.H @@ -24,7 +24,8 @@ License Class Foam::processorField -\ingroup grpFieldFunctionObjects +Group + grpFieldFunctionObjects Description Writes a scalar field whose value is the local processor ID. Output diff --git a/src/postProcessing/functionObjects/field/readFields/readFields.H b/src/postProcessing/functionObjects/field/readFields/readFields.H index 32cc119cbf..8cf5b7be29 100644 --- a/src/postProcessing/functionObjects/field/readFields/readFields.H +++ b/src/postProcessing/functionObjects/field/readFields/readFields.H @@ -24,7 +24,8 @@ License Class Foam::readFields -\ingroup grpFieldFunctionObjects +Group + grpFieldFunctionObjects Description Reads fields from the time folders and adds them to the mesh database diff --git a/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H b/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H index 95cedb6517..149424fb27 100644 --- a/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H +++ b/src/postProcessing/functionObjects/field/regionSizeDistribution/regionSizeDistribution.H @@ -24,7 +24,8 @@ License Class Foam::regionSizeDistribution -\ingroup grpFieldFunctionObjects +Group + grpFieldFunctionObjects Description Looks up a field, interpolates it to the faces and determines a connected diff --git a/src/postProcessing/functionObjects/field/streamLine/streamLine.H b/src/postProcessing/functionObjects/field/streamLine/streamLine.H index 7ee9abec12..e17f8cedf0 100644 --- a/src/postProcessing/functionObjects/field/streamLine/streamLine.H +++ b/src/postProcessing/functionObjects/field/streamLine/streamLine.H @@ -24,7 +24,8 @@ License Class Foam::streamLine -\ingroup grpFieldFunctionObjects +Group + grpFieldFunctionObjects Description Generation of streamlines. Samples along track of passive particle. diff --git a/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H b/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H index b91fd64632..44c0d54608 100644 --- a/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H +++ b/src/postProcessing/functionObjects/field/surfaceInterpolateFields/surfaceInterpolateFields.H @@ -24,7 +24,7 @@ License Class Foam::surfaceInterpolateFields -\ingroup grpFieldFunctionObjects +Group grpFieldFunctionObjects Description Linear interpolates volFields to surfaceFields diff --git a/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H b/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H index 9cabbd0eb1..3148b5448b 100644 --- a/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H +++ b/src/postProcessing/functionObjects/field/turbulenceFields/turbulenceFields.H @@ -24,7 +24,8 @@ License Class Foam::turbulenceFields -\ingroup grpFieldFunctionObjects +Group + grpFieldFunctionObjects Description Stores turbulence fields on the mesh database for further manipulation. diff --git a/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H b/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H index a9d54a2ba8..14ab62724e 100644 --- a/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H +++ b/src/postProcessing/functionObjects/field/wallBoundedStreamLine/wallBoundedStreamLine.H @@ -24,7 +24,8 @@ License Class Foam::wallBoundedStreamLine -\ingroup grpFieldFunctionObjects +Group + grpFieldFunctionObjects Description Generation of streamlines. Samples along track of passive particle. diff --git a/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H b/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H index f51f180d24..2d6055ba86 100644 --- a/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H +++ b/src/postProcessing/functionObjects/forces/forceCoeffs/forceCoeffs.H @@ -24,7 +24,8 @@ License Class Foam::forceCoeffs -\ingroup grpForcesFunctionObjects +Group + grpForcesFunctionObjects Description Derived from the forces function object, creates a specialisation to diff --git a/src/postProcessing/functionObjects/forces/forces/forces.H b/src/postProcessing/functionObjects/forces/forces/forces.H index d2c224abaa..1d1e525b58 100644 --- a/src/postProcessing/functionObjects/forces/forces/forces.H +++ b/src/postProcessing/functionObjects/forces/forces/forces.H @@ -24,7 +24,8 @@ License Class Foam::forces -\ingroup grpForcesFunctionObjects +Group + grpForcesFunctionObjects Description Calculates the forces and moments by integrating the pressure and diff --git a/src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H b/src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H index 143b7b38b6..42da71f90c 100644 --- a/src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H +++ b/src/postProcessing/functionObjects/jobControl/abortCalculation/abortCalculation.H @@ -24,7 +24,8 @@ License Class Foam::abortCalculation -\ingroup grpJobControlFunctionObjects +Group + grpJobControlFunctionObjects Description Watches for presence of the named file in the $FOAM_CASE directory diff --git a/src/postProcessing/functionObjects/systemCall/systemCall.H b/src/postProcessing/functionObjects/systemCall/systemCall.H index 9726836d80..bb26a7e1b9 100644 --- a/src/postProcessing/functionObjects/systemCall/systemCall.H +++ b/src/postProcessing/functionObjects/systemCall/systemCall.H @@ -24,7 +24,8 @@ License Class Foam::systemCall -\ingroup grpFunctionObjects +Group + grpFunctionObjects Description Executes system calls, entered in the form of a string list diff --git a/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H b/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H index 8e2f1795ce..4a99468d09 100644 --- a/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H +++ b/src/postProcessing/functionObjects/utilities/codedFunctionObject/codedFunctionObject.H @@ -24,7 +24,8 @@ License Class Foam::codedFunctionObject -\ingroup grpUtilitiesFunctionObjects +Group + grpUtilitiesFunctionObjects Description functionObject using dynamic code compilation. diff --git a/src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H b/src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H index 0a037a2aec..512ac251c6 100644 --- a/src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H +++ b/src/postProcessing/functionObjects/utilities/dsmcFields/dsmcFields.H @@ -24,7 +24,8 @@ License Class Foam::dsmcFields -\ingroup grpUtilitiesFunctionObjects +Group + grpUtilitiesFunctionObjects Description Calculate intensive fields: diff --git a/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H b/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H index db5f1dcc4b..265ac0f656 100644 --- a/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H +++ b/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H @@ -24,18 +24,28 @@ License Class Foam::pressureCoefficient -\ingroup grpUtilitiesFunctionObjects +Group + grpUtilitiesFunctionObjects Description Calculates pressure coefficient, \f$c_p\f$ \f[ - c_p = p/p_{dyn,inf} + c_p = \frac{p}{p_{dyn,inf}} + \f] + where: + \f[ + p_{dyn,inf} = 0.5 \rho |U_{inf}|^2 \f] - where: + where + \vartable + c_p | pressure coefficient + p | pressure [bar] + \rho | density [kg/m3] + U | velocity [m/s] + \endvartable - p_dyn,inf = 0.5*rho*mag(U_inf)^2 SourceFiles pressureCoefficient.C diff --git a/src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H b/src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H index 56586b256d..6b270e7353 100644 --- a/src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H +++ b/src/postProcessing/functionObjects/utilities/staticPressure/staticPressure.H @@ -24,7 +24,8 @@ License Class Foam::staticPressure -\ingroup grpUtilitiesFunctionObjects +Group + grpUtilitiesFunctionObjects Description Converts kinematic pressure to static pressure, from the name of the diff --git a/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H b/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H index afb63cb323..786e0f21fa 100644 --- a/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H +++ b/src/postProcessing/functionObjects/utilities/timeActivatedFileUpdate/timeActivatedFileUpdate.H @@ -24,7 +24,8 @@ License Class Foam::timeActivatedFileUpdate -\ingroup grpUtilitiesFunctionObjects +Group + grpUtilitiesFunctionObjects Description Performs a file copy/replacement once a specified time has been reached. diff --git a/src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H b/src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H index 14a2ba895b..795e9aed89 100644 --- a/src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H +++ b/src/postProcessing/functionObjects/utilities/yPlusLES/yPlusLES.H @@ -24,7 +24,8 @@ License Class Foam::yPlusLES -\ingroup grpUtilitiesFunctionObjects +Group + grpUtilitiesFunctionObjects Description Evaluates and outputs turbulence y+ for LES models. Values written to diff --git a/src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H b/src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H index 3e35bb4bfb..38085ae722 100644 --- a/src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H +++ b/src/postProcessing/functionObjects/utilities/yPlusRAS/yPlusRAS.H @@ -24,7 +24,8 @@ License Class Foam::yPlusRAS -\ingroup grpUtilitiesFunctionObjects +Group + grpUtilitiesFunctionObjects Description Evaluates and outputs turbulence y+ for RAS models. Values written to diff --git a/src/sampling/probes/probes.H b/src/sampling/probes/probes.H index 18200ddcd7..9634d626dd 100644 --- a/src/sampling/probes/probes.H +++ b/src/sampling/probes/probes.H @@ -21,12 +21,12 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects -@{ - Class Foam::probes +Group + grpFunctionObjects + Description Set of locations to sample. @@ -34,7 +34,6 @@ Description SourceFiles probes.C -@} \*---------------------------------------------------------------------------*/ diff --git a/src/sampling/sampledSet/sampledSet/sampledSet.H b/src/sampling/sampledSet/sampledSet/sampledSet.H index 461e3c1ee3..51905951f9 100644 --- a/src/sampling/sampledSet/sampledSet/sampledSet.H +++ b/src/sampling/sampledSet/sampledSet/sampledSet.H @@ -21,12 +21,12 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects -@{ - Class Foam::sampledSet +Group + grpFunctionObjects + Description Holds list of sampling points which is filled at construction time. Various implementations of this base class to e.g. get sampling points @@ -38,7 +38,6 @@ Description SourceFiles sampledSet.C -@} \*---------------------------------------------------------------------------*/ diff --git a/src/sampling/sampledSurface/sampledSurface/sampledSurface.H b/src/sampling/sampledSurface/sampledSurface/sampledSurface.H index fe820c1b5d..8a2bfa9fed 100644 --- a/src/sampling/sampledSurface/sampledSurface/sampledSurface.H +++ b/src/sampling/sampledSurface/sampledSurface/sampledSurface.H @@ -21,12 +21,12 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -\addtogroup functionObjects -@{ - Class Foam::sampledSurface +Group + grpFunctionObjects + Description An abstract class for surfaces with sampling. @@ -46,7 +46,6 @@ Description SourceFiles sampledSurface.C sampledSurfaceTemplates.C -@} \*---------------------------------------------------------------------------*/ From c293b14bb758f432171571a805300b8c62af42c3 Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 23 Jul 2012 15:33:53 +0100 Subject: [PATCH 03/12] STYLE: use symbol for infinity instead of inf in docs --- .../utilities/pressureCoefficient/pressureCoefficient.H | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H b/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H index 265ac0f656..327dbb10c1 100644 --- a/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H +++ b/src/postProcessing/functionObjects/utilities/pressureCoefficient/pressureCoefficient.H @@ -31,11 +31,11 @@ Description Calculates pressure coefficient, \f$c_p\f$ \f[ - c_p = \frac{p}{p_{dyn,inf}} + c_p = \frac{p}{p_{dyn,\infty}} \f] where: \f[ - p_{dyn,inf} = 0.5 \rho |U_{inf}|^2 + p_{dyn,\infty} = 0.5 \rho |U_{\infty}|^2 \f] where From 5cbb50e1fdeae5131daaf84458f03a3ea78053e2 Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 23 Jul 2012 15:53:46 +0100 Subject: [PATCH 04/12] ENH: Make thermo BCs a subset of general BCs --- .../doc/thermophysicalBoundaryConditionsDoc.H | 1 + 1 file changed, 1 insertion(+) diff --git a/src/thermophysicalModels/basic/derivedFvPatchFields/doc/thermophysicalBoundaryConditionsDoc.H b/src/thermophysicalModels/basic/derivedFvPatchFields/doc/thermophysicalBoundaryConditionsDoc.H index 610d554454..f7f9389b71 100644 --- a/src/thermophysicalModels/basic/derivedFvPatchFields/doc/thermophysicalBoundaryConditionsDoc.H +++ b/src/thermophysicalModels/basic/derivedFvPatchFields/doc/thermophysicalBoundaryConditionsDoc.H @@ -25,6 +25,7 @@ License \defgroup grpThermoBoundaryConditions Thermophysical boundary conditions @{ + \ingroup grpBoundaryConditions This group contains thermophysical model boundary conditions @} From ea062b8e98ec0333358d1f3ed2ad613f640b7153 Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 23 Jul 2012 15:54:21 +0100 Subject: [PATCH 05/12] BUG: corrected class to Class for doxy docs --- .../fieldCoordinateSystemTransform.H | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H b/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H index bda640e009..dce7cbc144 100644 --- a/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H +++ b/src/postProcessing/functionObjects/field/fieldCoordinateSystemTransform/fieldCoordinateSystemTransform.H @@ -21,7 +21,7 @@ License You should have received a copy of the GNU General Public License along with OpenFOAM. If not, see . -class +Class Foam::fieldCoordinateSystemTransform Group From 7db6ec1bffa7d14e5eb735b6c9a1cf56121bd71b Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 23 Jul 2012 15:54:46 +0100 Subject: [PATCH 06/12] BUG: Corrected group for compressible kqR wall function --- .../kqRWallFunction/kqRWallFunctionFvPatchField.H | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H index 3ce69d19c0..d525d80b56 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H @@ -25,7 +25,7 @@ Class Foam::compressible::RASModels::kqRWallFunctionFvPatchField Group - grpIcoWallFunctions + grpCmpWallFunctions Description This boundary condition is applied to turbulence \c k, \c q, and \c R From 853a665aa5a057ab776002189c03c000dbee9e25 Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 23 Jul 2012 15:55:09 +0100 Subject: [PATCH 07/12] STLE: minor code formatting --- src/finiteVolume/fields/fvPatchFields/doc/fvPatchFieldDoc.H | 2 +- .../atmBoundaryLayerInletVelocityFvPatchVectorField.H | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/finiteVolume/fields/fvPatchFields/doc/fvPatchFieldDoc.H b/src/finiteVolume/fields/fvPatchFields/doc/fvPatchFieldDoc.H index 4cd593a213..8b6889ea03 100644 --- a/src/finiteVolume/fields/fvPatchFields/doc/fvPatchFieldDoc.H +++ b/src/finiteVolume/fields/fvPatchFields/doc/fvPatchFieldDoc.H @@ -34,7 +34,7 @@ License The difference between the methods is based on when the patch values are updated. When the condition is applied to a solution variable, the call to updateCoeffs() occurs as a preliminary step of the - \.solve(). The evaluate() method is invoked after, or idependent + \.solve(). The evaluate() method is invoked after, or independent of the matrix solve, via a call to \.correctBoundaryConditions(). @} diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H index 79b3dc08b6..58813df8ce 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/atmBoundaryLayerInletVelocity/atmBoundaryLayerInletVelocityFvPatchVectorField.H @@ -34,7 +34,7 @@ Description co-ordinate \c z. \f[ - U = \frac{U^*}{K} ln(\frac{z - z_g + z_0}{z_0}) + U = \frac{U^*}{K} ln\left(\frac{z - z_g + z_0}{z_0}\right) \f] where @@ -49,7 +49,7 @@ Description and: \f[ - U^* = K \frac{U_{ref}}{ln(\frac{Z_{ref} + z_0}{z_0})} + U^* = K \frac{U_{ref}}{ln\left(\frac{Z_{ref} + z_0}{z_0}\right)} \f] where: From 05dad2aa10b29a203bbd11b37fe9f8bfb2af900e Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 23 Jul 2012 17:10:02 +0100 Subject: [PATCH 08/12] ENH: Added preliminary docs for RAS turbulence --- .../compressible/RAS/LRR/LRR.H | 5 ++- .../RAS/LaunderGibsonRSTM/LaunderGibsonRSTM.H | 5 ++- .../RAS/LaunderSharmaKE/LaunderSharmaKE.H | 5 ++- .../compressible/RAS/RASModel/RASModel.H | 1 - .../compressible/RAS/RASModel/RASModelDoc.H | 31 +++++++++++++++++++ .../RAS/RNGkEpsilon/RNGkEpsilon.H | 5 ++- .../RAS/SpalartAllmaras/SpalartAllmaras.H | 5 ++- .../compressibleRASBoundaryConditionsDoc.H | 1 + .../compressible/RAS/kEpsilon/kEpsilon.H | 5 ++- .../compressible/RAS/kOmegaSST/kOmegaSST.H | 5 ++- .../compressible/RAS/laminar/laminar.H | 5 ++- .../RAS/realizableKE/realizableKE.H | 5 ++- .../incompressible/RAS/LRR/LRR.H | 5 ++- .../RAS/LamBremhorstKE/LamBremhorstKE.H | 5 ++- .../RAS/LaunderGibsonRSTM/LaunderGibsonRSTM.H | 5 ++- .../RAS/LaunderSharmaKE/LaunderSharmaKE.H | 5 ++- .../RAS/LienCubicKE/LienCubicKE.H | 3 ++ .../RAS/LienCubicKELowRe/LienCubicKELowRe.H | 3 ++ .../LienLeschzinerLowRe/LienLeschzinerLowRe.H | 5 ++- .../RAS/NonlinearKEShih/NonlinearKEShih.H | 3 ++ .../incompressible/RAS/RASModel/RASModel.H | 3 ++ .../incompressible/RAS/RASModel/RASModelDoc.H | 31 +++++++++++++++++++ .../RAS/RNGkEpsilon/RNGkEpsilon.H | 5 ++- .../RAS/SpalartAllmaras/SpalartAllmaras.H | 5 ++- .../incompressibleRASBoundaryConditionsDoc.H | 1 + .../incompressible/RAS/kEpsilon/kEpsilon.H | 5 ++- .../incompressible/RAS/kOmega/kOmega.H | 5 ++- .../incompressible/RAS/kOmegaSST/kOmegaSST.H | 3 ++ .../incompressible/RAS/kkLOmega/kkLOmega.H | 5 ++- .../incompressible/RAS/laminar/laminar.H | 5 ++- .../incompressible/RAS/qZeta/qZeta.H | 5 ++- .../RAS/realizableKE/realizableKE.H | 5 ++- 32 files changed, 167 insertions(+), 23 deletions(-) create mode 100644 src/turbulenceModels/compressible/RAS/RASModel/RASModelDoc.H create mode 100644 src/turbulenceModels/incompressible/RAS/RASModel/RASModelDoc.H diff --git a/src/turbulenceModels/compressible/RAS/LRR/LRR.H b/src/turbulenceModels/compressible/RAS/LRR/LRR.H index 14237fd20a..6ff918abc7 100644 --- a/src/turbulenceModels/compressible/RAS/LRR/LRR.H +++ b/src/turbulenceModels/compressible/RAS/LRR/LRR.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::RASModels::LRR +Group + grpCmpRASTurbulence + Description Launder, Reece and Rodi Reynolds-stress turbulence model for compressible flows. diff --git a/src/turbulenceModels/compressible/RAS/LaunderGibsonRSTM/LaunderGibsonRSTM.H b/src/turbulenceModels/compressible/RAS/LaunderGibsonRSTM/LaunderGibsonRSTM.H index 4266e05e5d..4d8208dd3c 100644 --- a/src/turbulenceModels/compressible/RAS/LaunderGibsonRSTM/LaunderGibsonRSTM.H +++ b/src/turbulenceModels/compressible/RAS/LaunderGibsonRSTM/LaunderGibsonRSTM.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::RASModels::LaunderGibsonRSTM +Group + grpCmpRASTurbulence + Description Launder-Gibson Reynolds stress turbulence model for compressible flows. diff --git a/src/turbulenceModels/compressible/RAS/LaunderSharmaKE/LaunderSharmaKE.H b/src/turbulenceModels/compressible/RAS/LaunderSharmaKE/LaunderSharmaKE.H index 7afa0d232c..149b4cc9c3 100644 --- a/src/turbulenceModels/compressible/RAS/LaunderSharmaKE/LaunderSharmaKE.H +++ b/src/turbulenceModels/compressible/RAS/LaunderSharmaKE/LaunderSharmaKE.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::RASModels::LaunderSharmaKE +Group + grpCmpRASTurbulence + Description Launder and Sharma low-Reynolds k-epsilon turbulence model for compressible and combusting flows. diff --git a/src/turbulenceModels/compressible/RAS/RASModel/RASModel.H b/src/turbulenceModels/compressible/RAS/RASModel/RASModel.H index 1a24cb78ee..ba86355602 100644 --- a/src/turbulenceModels/compressible/RAS/RASModel/RASModel.H +++ b/src/turbulenceModels/compressible/RAS/RASModel/RASModel.H @@ -27,7 +27,6 @@ Namespace Description Namespace for compressible RAS turbulence models. - Class Foam::compressible::RASModel diff --git a/src/turbulenceModels/compressible/RAS/RASModel/RASModelDoc.H b/src/turbulenceModels/compressible/RAS/RASModel/RASModelDoc.H new file mode 100644 index 0000000000..552123ed17 --- /dev/null +++ b/src/turbulenceModels/compressible/RAS/RASModel/RASModelDoc.H @@ -0,0 +1,31 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2012 OpenFOAM Foundation + \\/ M anipulation | +------------------------------------------------------------------------------- +License + This file is part of OpenFOAM. + + OpenFOAM is free software: you can redistribute it and/or modify it + under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + OpenFOAM is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + for more details. + + You should have received a copy of the GNU General Public License + along with OpenFOAM. If not, see . + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\defgroup grpCmpRASTurbulence Compressible RAS turbulence +@{ + This group contains compressible RAS models. +@} + +\*---------------------------------------------------------------------------*/ diff --git a/src/turbulenceModels/compressible/RAS/RNGkEpsilon/RNGkEpsilon.H b/src/turbulenceModels/compressible/RAS/RNGkEpsilon/RNGkEpsilon.H index 477cfba15f..87c2918f1d 100644 --- a/src/turbulenceModels/compressible/RAS/RNGkEpsilon/RNGkEpsilon.H +++ b/src/turbulenceModels/compressible/RAS/RNGkEpsilon/RNGkEpsilon.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::RASModels::RNGkEpsilon +Group + grpCmpRASTurbulence + Description Renormalisation group k-epsilon turbulence model for compressible flows. diff --git a/src/turbulenceModels/compressible/RAS/SpalartAllmaras/SpalartAllmaras.H b/src/turbulenceModels/compressible/RAS/SpalartAllmaras/SpalartAllmaras.H index f3b83a1148..a7fb64b73c 100644 --- a/src/turbulenceModels/compressible/RAS/SpalartAllmaras/SpalartAllmaras.H +++ b/src/turbulenceModels/compressible/RAS/SpalartAllmaras/SpalartAllmaras.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::RASModels::SpalartAllmaras +Group + grpCmpRASTurbulence + Description Spalart-Allmaras one-eqn mixing-length model for compressible external flows. diff --git a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/doc/compressibleRASBoundaryConditionsDoc.H b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/doc/compressibleRASBoundaryConditionsDoc.H index 152f631578..d0ef1e1af9 100644 --- a/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/doc/compressibleRASBoundaryConditionsDoc.H +++ b/src/turbulenceModels/compressible/RAS/derivedFvPatchFields/doc/compressibleRASBoundaryConditionsDoc.H @@ -25,6 +25,7 @@ License \defgroup grpCmpRASBoundaryConditions RAS compressible boundary conditions @{ + \ingroup grpCmpRASTurbulence This group contains compressible RAS turbulence model boundary conditions @} diff --git a/src/turbulenceModels/compressible/RAS/kEpsilon/kEpsilon.H b/src/turbulenceModels/compressible/RAS/kEpsilon/kEpsilon.H index 62e2f65c38..3cd23cf6a5 100644 --- a/src/turbulenceModels/compressible/RAS/kEpsilon/kEpsilon.H +++ b/src/turbulenceModels/compressible/RAS/kEpsilon/kEpsilon.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::RASModels::kEpsilon +Group + grpCmpRASTurbulence + Description Standard k-epsilon turbulence model for compressible flows diff --git a/src/turbulenceModels/compressible/RAS/kOmegaSST/kOmegaSST.H b/src/turbulenceModels/compressible/RAS/kOmegaSST/kOmegaSST.H index f4798d852d..fc28cdebb1 100644 --- a/src/turbulenceModels/compressible/RAS/kOmegaSST/kOmegaSST.H +++ b/src/turbulenceModels/compressible/RAS/kOmegaSST/kOmegaSST.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::RASModels::kOmegaSST +Group + grpCmpRASTurbulence + Description Implementation of the k-omega-SST turbulence model for compressible flows. diff --git a/src/turbulenceModels/compressible/RAS/laminar/laminar.H b/src/turbulenceModels/compressible/RAS/laminar/laminar.H index 09597983ce..953dbc5e97 100644 --- a/src/turbulenceModels/compressible/RAS/laminar/laminar.H +++ b/src/turbulenceModels/compressible/RAS/laminar/laminar.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::RASModels::laminar +Group + grpCmpRASTurbulence + Description Dummy turbulence model for laminar compressible flow. diff --git a/src/turbulenceModels/compressible/RAS/realizableKE/realizableKE.H b/src/turbulenceModels/compressible/RAS/realizableKE/realizableKE.H index 8098dd0ee6..b173013a58 100644 --- a/src/turbulenceModels/compressible/RAS/realizableKE/realizableKE.H +++ b/src/turbulenceModels/compressible/RAS/realizableKE/realizableKE.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::RASModels::realizableKE +Group + grpCmpRASTurbulence + Description Realizable k-epsilon turbulence model for compressible flows. diff --git a/src/turbulenceModels/incompressible/RAS/LRR/LRR.H b/src/turbulenceModels/incompressible/RAS/LRR/LRR.H index 2f1a119b9c..9b03c598eb 100644 --- a/src/turbulenceModels/incompressible/RAS/LRR/LRR.H +++ b/src/turbulenceModels/incompressible/RAS/LRR/LRR.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::LRR +Group + grpIcoRASTurbulence + Description Launder, Reece and Rodi Reynolds-stress turbulence model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/RAS/LamBremhorstKE/LamBremhorstKE.H b/src/turbulenceModels/incompressible/RAS/LamBremhorstKE/LamBremhorstKE.H index 449055f4c5..9f826ce1ee 100644 --- a/src/turbulenceModels/incompressible/RAS/LamBremhorstKE/LamBremhorstKE.H +++ b/src/turbulenceModels/incompressible/RAS/LamBremhorstKE/LamBremhorstKE.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::LamBremhorstKE +Group + grpIcoRASTurbulence + Description Lam and Bremhorst low-Reynolds number k-epsilon turbulence model for incompressible flows diff --git a/src/turbulenceModels/incompressible/RAS/LaunderGibsonRSTM/LaunderGibsonRSTM.H b/src/turbulenceModels/incompressible/RAS/LaunderGibsonRSTM/LaunderGibsonRSTM.H index 0b6fc91b4b..909844a5ed 100644 --- a/src/turbulenceModels/incompressible/RAS/LaunderGibsonRSTM/LaunderGibsonRSTM.H +++ b/src/turbulenceModels/incompressible/RAS/LaunderGibsonRSTM/LaunderGibsonRSTM.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::LaunderGibsonRSTM +Group + grpIcoRASTurbulence + Description Launder-Gibson Reynolds stress turbulence model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/RAS/LaunderSharmaKE/LaunderSharmaKE.H b/src/turbulenceModels/incompressible/RAS/LaunderSharmaKE/LaunderSharmaKE.H index 3f2338e18e..92a53434d7 100644 --- a/src/turbulenceModels/incompressible/RAS/LaunderSharmaKE/LaunderSharmaKE.H +++ b/src/turbulenceModels/incompressible/RAS/LaunderSharmaKE/LaunderSharmaKE.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::LaunderSharmaKE +Group + grpIcoRASTurbulence + Description Launder and Sharma low-Reynolds k-epsilon turbulence model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/RAS/LienCubicKE/LienCubicKE.H b/src/turbulenceModels/incompressible/RAS/LienCubicKE/LienCubicKE.H index ebe7c373d8..bbeedbff05 100644 --- a/src/turbulenceModels/incompressible/RAS/LienCubicKE/LienCubicKE.H +++ b/src/turbulenceModels/incompressible/RAS/LienCubicKE/LienCubicKE.H @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::LienCubicKE +Group + grpIcoRASTurbulence + Description Lien cubic non-linear k-epsilon turbulence model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/RAS/LienCubicKELowRe/LienCubicKELowRe.H b/src/turbulenceModels/incompressible/RAS/LienCubicKELowRe/LienCubicKELowRe.H index 0efd63a454..cae720d40d 100644 --- a/src/turbulenceModels/incompressible/RAS/LienCubicKELowRe/LienCubicKELowRe.H +++ b/src/turbulenceModels/incompressible/RAS/LienCubicKELowRe/LienCubicKELowRe.H @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::LienCubicKELowRe +Group + grpIcoRASTurbulence + Description Lien cubic non-linear low-Reynolds k-epsilon turbulence models for incompressible flows. diff --git a/src/turbulenceModels/incompressible/RAS/LienLeschzinerLowRe/LienLeschzinerLowRe.H b/src/turbulenceModels/incompressible/RAS/LienLeschzinerLowRe/LienLeschzinerLowRe.H index 3fa1c790fe..2131ac8784 100644 --- a/src/turbulenceModels/incompressible/RAS/LienLeschzinerLowRe/LienLeschzinerLowRe.H +++ b/src/turbulenceModels/incompressible/RAS/LienLeschzinerLowRe/LienLeschzinerLowRe.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::LienLeschzinerLowRe +Group + grpIcoRASTurbulence + Description Lien and Leschziner low-Reynolds k-epsilon turbulence model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/RAS/NonlinearKEShih/NonlinearKEShih.H b/src/turbulenceModels/incompressible/RAS/NonlinearKEShih/NonlinearKEShih.H index c7ad8a3713..19f5b9c427 100644 --- a/src/turbulenceModels/incompressible/RAS/NonlinearKEShih/NonlinearKEShih.H +++ b/src/turbulenceModels/incompressible/RAS/NonlinearKEShih/NonlinearKEShih.H @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::NonlinearKEShih +Group + grpIcoRASTurbulence + Description Shih's quadratic non-linear k-epsilon turbulence model for incompressible flows diff --git a/src/turbulenceModels/incompressible/RAS/RASModel/RASModel.H b/src/turbulenceModels/incompressible/RAS/RASModel/RASModel.H index 0d0d41ea1e..b1a97681c2 100644 --- a/src/turbulenceModels/incompressible/RAS/RASModel/RASModel.H +++ b/src/turbulenceModels/incompressible/RAS/RASModel/RASModel.H @@ -24,6 +24,9 @@ License Namespace Foam::incompressible::RASModels +Group + grpIcoRASTurbulence + Description Namespace for incompressible RAS turbulence models. diff --git a/src/turbulenceModels/incompressible/RAS/RASModel/RASModelDoc.H b/src/turbulenceModels/incompressible/RAS/RASModel/RASModelDoc.H new file mode 100644 index 0000000000..95b87a7c92 --- /dev/null +++ b/src/turbulenceModels/incompressible/RAS/RASModel/RASModelDoc.H @@ -0,0 +1,31 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2012 OpenFOAM Foundation + \\/ M anipulation | +------------------------------------------------------------------------------- +License + This file is part of OpenFOAM. + + OpenFOAM is free software: you can redistribute it and/or modify it + under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + OpenFOAM is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + for more details. + + You should have received a copy of the GNU General Public License + along with OpenFOAM. If not, see . + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\defgroup grpIcoRASTurbulence Incompressible RAS turbulence +@{ + This group contains incompressible RAS models. +@} + +\*---------------------------------------------------------------------------*/ diff --git a/src/turbulenceModels/incompressible/RAS/RNGkEpsilon/RNGkEpsilon.H b/src/turbulenceModels/incompressible/RAS/RNGkEpsilon/RNGkEpsilon.H index 62b60b9804..0b7951ad85 100644 --- a/src/turbulenceModels/incompressible/RAS/RNGkEpsilon/RNGkEpsilon.H +++ b/src/turbulenceModels/incompressible/RAS/RNGkEpsilon/RNGkEpsilon.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::RNGkEpsilon +Group + grpIcoRASTurbulence + Description Renormalisation group k-epsilon turbulence model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/RAS/SpalartAllmaras/SpalartAllmaras.H b/src/turbulenceModels/incompressible/RAS/SpalartAllmaras/SpalartAllmaras.H index fbd1248181..26c38db037 100644 --- a/src/turbulenceModels/incompressible/RAS/SpalartAllmaras/SpalartAllmaras.H +++ b/src/turbulenceModels/incompressible/RAS/SpalartAllmaras/SpalartAllmaras.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::SpalartAllmaras +Group + grpIcoRASTurbulence + Description Spalart-Allmaras 1-eqn mixing-length model for incompressible external flows. diff --git a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/doc/incompressibleRASBoundaryConditionsDoc.H b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/doc/incompressibleRASBoundaryConditionsDoc.H index 366f7e5c9e..c593102064 100644 --- a/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/doc/incompressibleRASBoundaryConditionsDoc.H +++ b/src/turbulenceModels/incompressible/RAS/derivedFvPatchFields/doc/incompressibleRASBoundaryConditionsDoc.H @@ -25,6 +25,7 @@ License \defgroup grpIcoRASBoundaryConditions RAS incompressible boundary conditions @{ + \ingroup grpIcoRASTurbulence This group contains incompressible RAS turbulence model boundary conditions @} diff --git a/src/turbulenceModels/incompressible/RAS/kEpsilon/kEpsilon.H b/src/turbulenceModels/incompressible/RAS/kEpsilon/kEpsilon.H index a3baf20513..2e07ffde49 100644 --- a/src/turbulenceModels/incompressible/RAS/kEpsilon/kEpsilon.H +++ b/src/turbulenceModels/incompressible/RAS/kEpsilon/kEpsilon.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::kEpsilon +Group + grpIcoRASTurbulence + Description Standard k-epsilon turbulence model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/RAS/kOmega/kOmega.H b/src/turbulenceModels/incompressible/RAS/kOmega/kOmega.H index 10729f334e..098f55e811 100644 --- a/src/turbulenceModels/incompressible/RAS/kOmega/kOmega.H +++ b/src/turbulenceModels/incompressible/RAS/kOmega/kOmega.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::kOmega +Group + grpIcoRASTurbulence + Description Standard high Reynolds-number k-omega turbulence model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/RAS/kOmegaSST/kOmegaSST.H b/src/turbulenceModels/incompressible/RAS/kOmegaSST/kOmegaSST.H index bd4b3742b5..f4d207cf84 100644 --- a/src/turbulenceModels/incompressible/RAS/kOmegaSST/kOmegaSST.H +++ b/src/turbulenceModels/incompressible/RAS/kOmegaSST/kOmegaSST.H @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::kOmegaSST +Group + grpIcoRASTurbulence + Description Implementation of the k-omega-SST turbulence model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/RAS/kkLOmega/kkLOmega.H b/src/turbulenceModels/incompressible/RAS/kkLOmega/kkLOmega.H index 83db5f82d5..6151e8ca9f 100644 --- a/src/turbulenceModels/incompressible/RAS/kkLOmega/kkLOmega.H +++ b/src/turbulenceModels/incompressible/RAS/kkLOmega/kkLOmega.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::kkLOmega +Group + grpIcoRASTurbulence + Description Low Reynolds-number k-kl-omega turbulence model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/RAS/laminar/laminar.H b/src/turbulenceModels/incompressible/RAS/laminar/laminar.H index 90afadff13..18f824b284 100644 --- a/src/turbulenceModels/incompressible/RAS/laminar/laminar.H +++ b/src/turbulenceModels/incompressible/RAS/laminar/laminar.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::laminar +Group + grpIcoRASTurbulence + Description Dummy turbulence model for laminar incompressible flow. diff --git a/src/turbulenceModels/incompressible/RAS/qZeta/qZeta.H b/src/turbulenceModels/incompressible/RAS/qZeta/qZeta.H index ba8dc1b413..88e54c8a06 100644 --- a/src/turbulenceModels/incompressible/RAS/qZeta/qZeta.H +++ b/src/turbulenceModels/incompressible/RAS/qZeta/qZeta.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::qZeta +Group + grpIcoRASTurbulence + Description Gibson and Dafa'Alla's q-zeta two-equation low-Re turbulence model for incompressible flows diff --git a/src/turbulenceModels/incompressible/RAS/realizableKE/realizableKE.H b/src/turbulenceModels/incompressible/RAS/realizableKE/realizableKE.H index 045f333390..c467b0b797 100644 --- a/src/turbulenceModels/incompressible/RAS/realizableKE/realizableKE.H +++ b/src/turbulenceModels/incompressible/RAS/realizableKE/realizableKE.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::RASModels::realizableKE +Group + grpIcoRASTurbulence + Description Realizable k-epsilon turbulence model for incompressible flows. From 645ed32eb7f7de2c316212ecc9e001c27498d37b Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 23 Jul 2012 18:08:15 +0100 Subject: [PATCH 09/12] ENH: Added preliminary docs for LES turbulence --- .../DeardorffDiffStress/DeardorffDiffStress.H | 5 ++- .../LES/GenEddyVisc/GenEddyVisc.H | 5 ++- .../LES/GenSGSStress/GenSGSStress.H | 7 ++-- .../compressible/LES/LESModel/LESModel.H | 4 ++- .../compressible/LES/LESModel/LESModelDoc.H | 32 +++++++++++++++++++ .../LES/Smagorinsky/Smagorinsky.H | 3 ++ .../LES/SpalartAllmaras/SpalartAllmaras.H | 5 ++- .../homogeneousDynOneEqEddy.H | 5 ++- .../LES/lowReOneEqEddy/lowReOneEqEddy.H | 5 ++- .../compressible/LES/oneEqEddy/oneEqEddy.H | 5 ++- .../compressible/RAS/RASModel/RASModelDoc.H | 1 + .../turbulenceModel/turbulenceModelDoc.H | 31 ++++++++++++++++++ .../DeardorffDiffStress/DeardorffDiffStress.H | 19 ++++++----- .../LES/GenEddyVisc/GenEddyVisc.H | 5 ++- .../LES/GenSGSStress/GenSGSStress.H | 5 ++- .../incompressible/LES/LESModel/LESModel.H | 3 ++ .../incompressible/LES/LESModel/LESModelDoc.H | 32 +++++++++++++++++++ .../LES/LRRDiffStress/LRRDiffStress.H | 5 ++- .../LES/Smagorinsky/Smagorinsky.H | 5 ++- .../LES/Smagorinsky2/Smagorinsky2.H | 5 ++- .../LES/SpalartAllmaras/SpalartAllmaras.H | 5 ++- .../SpalartAllmarasDDES/SpalartAllmarasDDES.H | 5 ++- .../SpalartAllmarasIDDES.H | 5 ++- .../LES/dynLagrangian/dynLagrangian.H | 5 ++- .../LES/dynOneEqEddy/dynOneEqEddy.H | 5 ++- .../homogeneousDynOneEqEddy.H | 5 ++- .../homogeneousDynSmagorinsky.H | 5 ++- .../LES/kOmegaSSTSAS/kOmegaSSTSAS.H | 5 ++- .../LES/mixedSmagorinsky/mixedSmagorinsky.H | 5 ++- .../incompressible/LES/oneEqEddy/oneEqEddy.H | 5 ++- .../LES/scaleSimilarity/scaleSimilarity.H | 5 ++- .../LES/spectEddyVisc/spectEddyVisc.H | 5 ++- .../incompressible/RAS/RASModel/RASModelDoc.H | 1 + .../turbulenceModel/turbulenceModelDoc.H | 31 ++++++++++++++++++ 34 files changed, 245 insertions(+), 34 deletions(-) create mode 100644 src/turbulenceModels/compressible/LES/LESModel/LESModelDoc.H create mode 100644 src/turbulenceModels/compressible/turbulenceModel/turbulenceModelDoc.H create mode 100644 src/turbulenceModels/incompressible/LES/LESModel/LESModelDoc.H create mode 100644 src/turbulenceModels/incompressible/turbulenceModel/turbulenceModelDoc.H diff --git a/src/turbulenceModels/compressible/LES/DeardorffDiffStress/DeardorffDiffStress.H b/src/turbulenceModels/compressible/LES/DeardorffDiffStress/DeardorffDiffStress.H index 9e57d10e11..3581ca5191 100644 --- a/src/turbulenceModels/compressible/LES/DeardorffDiffStress/DeardorffDiffStress.H +++ b/src/turbulenceModels/compressible/LES/DeardorffDiffStress/DeardorffDiffStress.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::LESModels::DeardorffDiffStress +Group + grpCmpLESTurbulence + Description Differential SGS Stress Equation Model for compressible flows diff --git a/src/turbulenceModels/compressible/LES/GenEddyVisc/GenEddyVisc.H b/src/turbulenceModels/compressible/LES/GenEddyVisc/GenEddyVisc.H index f11a06da9b..0c8aaea8c6 100644 --- a/src/turbulenceModels/compressible/LES/GenEddyVisc/GenEddyVisc.H +++ b/src/turbulenceModels/compressible/LES/GenEddyVisc/GenEddyVisc.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::LESModels::GenEddyVisc +Group + grpCmpLESTurbulence + Description General base class for all compressible models that can be implemented as an eddy viscosity, i.e. algebraic and one-equation models. diff --git a/src/turbulenceModels/compressible/LES/GenSGSStress/GenSGSStress.H b/src/turbulenceModels/compressible/LES/GenSGSStress/GenSGSStress.H index 20309c3203..4fbb54be1b 100644 --- a/src/turbulenceModels/compressible/LES/GenSGSStress/GenSGSStress.H +++ b/src/turbulenceModels/compressible/LES/GenSGSStress/GenSGSStress.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::LESModels::GenSGSStress +Group + grpCmpLESTurbulence + Description General base class for all compressible models that directly solve for the SGS stress tensor B. @@ -52,7 +55,7 @@ namespace LESModels { /*---------------------------------------------------------------------------*\ - Class GenSGSStress Declaration + Class GenSGSStress Declaration \*---------------------------------------------------------------------------*/ class GenSGSStress diff --git a/src/turbulenceModels/compressible/LES/LESModel/LESModel.H b/src/turbulenceModels/compressible/LES/LESModel/LESModel.H index 32bd44971d..7e0f0aace2 100644 --- a/src/turbulenceModels/compressible/LES/LESModel/LESModel.H +++ b/src/turbulenceModels/compressible/LES/LESModel/LESModel.H @@ -24,10 +24,12 @@ License Namespace Foam::compressible::LESModels +Group + grpCmpLESTurbulence + Description Namespace for compressible LES models. - Class Foam::compressible::LESModel diff --git a/src/turbulenceModels/compressible/LES/LESModel/LESModelDoc.H b/src/turbulenceModels/compressible/LES/LESModel/LESModelDoc.H new file mode 100644 index 0000000000..ac8c52e36a --- /dev/null +++ b/src/turbulenceModels/compressible/LES/LESModel/LESModelDoc.H @@ -0,0 +1,32 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2012 OpenFOAM Foundation + \\/ M anipulation | +------------------------------------------------------------------------------- +License + This file is part of OpenFOAM. + + OpenFOAM is free software: you can redistribute it and/or modify it + under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + OpenFOAM is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + for more details. + + You should have received a copy of the GNU General Public License + along with OpenFOAM. If not, see . + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\defgroup grpCmpLESTurbulence Compressible LES turbulence +@{ + \ingroup grpCmpTurbulence + This group contains compressible LES models. +@} + +\*---------------------------------------------------------------------------*/ diff --git a/src/turbulenceModels/compressible/LES/Smagorinsky/Smagorinsky.H b/src/turbulenceModels/compressible/LES/Smagorinsky/Smagorinsky.H index 947b49fa75..14f880450a 100644 --- a/src/turbulenceModels/compressible/LES/Smagorinsky/Smagorinsky.H +++ b/src/turbulenceModels/compressible/LES/Smagorinsky/Smagorinsky.H @@ -24,6 +24,9 @@ License Class Foam::compressible::LESModels::Smagorinsky +Group + grpCmpLESTurbulence + Description The choric Smagorinsky Model for compressible flows. diff --git a/src/turbulenceModels/compressible/LES/SpalartAllmaras/SpalartAllmaras.H b/src/turbulenceModels/compressible/LES/SpalartAllmaras/SpalartAllmaras.H index 5caa292642..9597eed61b 100644 --- a/src/turbulenceModels/compressible/LES/SpalartAllmaras/SpalartAllmaras.H +++ b/src/turbulenceModels/compressible/LES/SpalartAllmaras/SpalartAllmaras.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::LESModels::SpalartAllmaras +Group + grpCmpLESTurbulence + Description SpalartAllmaras for compressible flows diff --git a/src/turbulenceModels/compressible/LES/homogeneousDynOneEqEddy/homogeneousDynOneEqEddy.H b/src/turbulenceModels/compressible/LES/homogeneousDynOneEqEddy/homogeneousDynOneEqEddy.H index 8464dd8cf7..3248bbabf0 100644 --- a/src/turbulenceModels/compressible/LES/homogeneousDynOneEqEddy/homogeneousDynOneEqEddy.H +++ b/src/turbulenceModels/compressible/LES/homogeneousDynOneEqEddy/homogeneousDynOneEqEddy.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::LESModels::homogeneousDynOneEqEddy +Group + grpCmpLESTurbulence + Description One Equation Eddy Viscosity Model for compressible flows. diff --git a/src/turbulenceModels/compressible/LES/lowReOneEqEddy/lowReOneEqEddy.H b/src/turbulenceModels/compressible/LES/lowReOneEqEddy/lowReOneEqEddy.H index 42aca80291..cdd38223c3 100644 --- a/src/turbulenceModels/compressible/LES/lowReOneEqEddy/lowReOneEqEddy.H +++ b/src/turbulenceModels/compressible/LES/lowReOneEqEddy/lowReOneEqEddy.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::LESModels::lowReOneEqEddy +Group + grpCmpLESTurbulence + Description One Equation Eddy Viscosity Model for compressible flow diff --git a/src/turbulenceModels/compressible/LES/oneEqEddy/oneEqEddy.H b/src/turbulenceModels/compressible/LES/oneEqEddy/oneEqEddy.H index aa00969499..bf3e527977 100644 --- a/src/turbulenceModels/compressible/LES/oneEqEddy/oneEqEddy.H +++ b/src/turbulenceModels/compressible/LES/oneEqEddy/oneEqEddy.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::compressible::LESModels::oneEqEddy +Group + grpCmpLESTurbulence + Description One Equation Eddy Viscosity Model for incompressible flows diff --git a/src/turbulenceModels/compressible/RAS/RASModel/RASModelDoc.H b/src/turbulenceModels/compressible/RAS/RASModel/RASModelDoc.H index 552123ed17..53757f8141 100644 --- a/src/turbulenceModels/compressible/RAS/RASModel/RASModelDoc.H +++ b/src/turbulenceModels/compressible/RAS/RASModel/RASModelDoc.H @@ -25,6 +25,7 @@ License \defgroup grpCmpRASTurbulence Compressible RAS turbulence @{ + \ingroup grpCmpTurbulence This group contains compressible RAS models. @} diff --git a/src/turbulenceModels/compressible/turbulenceModel/turbulenceModelDoc.H b/src/turbulenceModels/compressible/turbulenceModel/turbulenceModelDoc.H new file mode 100644 index 0000000000..17bc210959 --- /dev/null +++ b/src/turbulenceModels/compressible/turbulenceModel/turbulenceModelDoc.H @@ -0,0 +1,31 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2012 OpenFOAM Foundation + \\/ M anipulation | +------------------------------------------------------------------------------- +License + This file is part of OpenFOAM. + + OpenFOAM is free software: you can redistribute it and/or modify it + under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + OpenFOAM is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + for more details. + + You should have received a copy of the GNU General Public License + along with OpenFOAM. If not, see . + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\defgroup grpCmpTurbulence Compressible turbulence +@{ + This group contains compressible turbulence models. +@} + +\*---------------------------------------------------------------------------*/ diff --git a/src/turbulenceModels/incompressible/LES/DeardorffDiffStress/DeardorffDiffStress.H b/src/turbulenceModels/incompressible/LES/DeardorffDiffStress/DeardorffDiffStress.H index 7862490dc8..f9e87de208 100644 --- a/src/turbulenceModels/incompressible/LES/DeardorffDiffStress/DeardorffDiffStress.H +++ b/src/turbulenceModels/incompressible/LES/DeardorffDiffStress/DeardorffDiffStress.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,26 +24,29 @@ License Class Foam::incompressible::LESModels::DeardorffDiffStress +Group + grpIcoLESTurbulence + Description Differential SGS Stress Equation Model for incompressible flows The DSEM uses a model version of the full balance equation for the SGS stress tensor to simulate the behaviour of B. Thus, - \verbatim - d/dt(B) + div(U*B) - div(nuSgs*grad(B)) - = - P - c1*epsilon/k*B - 0.667*(1 - c1)*epsilon*I - c2*(P - 0.333*trP*I) + \f[ + \frac{d}{dt}(B) + \nabla\cdot(U B) - \nabla\cdot(\nu_{sgs}\nabla B) + = + P - c_1 \frac{\epsilon}{k}B - 0.667(1 - c_1)\epsilon I + - c_2 (P - 0.333 trP I) + \f] where - k = 0.5*tr(B), epsilon = ce*k^3/2/delta, epsilon/k = ce*k^1/2/delta P = -(B'L + L'B) nuSgs = ck*sqrt(k)*delta nuEff = nuSgs + nu - \endverbatim SourceFiles DeardorffDiffStress.C @@ -65,7 +68,7 @@ namespace LESModels { /*---------------------------------------------------------------------------*\ - Class DeardorffDiffStress Declaration + Class DeardorffDiffStress Declaration \*---------------------------------------------------------------------------*/ class DeardorffDiffStress diff --git a/src/turbulenceModels/incompressible/LES/GenEddyVisc/GenEddyVisc.H b/src/turbulenceModels/incompressible/LES/GenEddyVisc/GenEddyVisc.H index 0746377eb7..c5a8119332 100644 --- a/src/turbulenceModels/incompressible/LES/GenEddyVisc/GenEddyVisc.H +++ b/src/turbulenceModels/incompressible/LES/GenEddyVisc/GenEddyVisc.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::GenEddyVisc +Group + grpIcoLESTurbulence + Description General base class for all incompressible models that can be implemented as an eddy viscosity, i.e. algebraic and one-equation models. diff --git a/src/turbulenceModels/incompressible/LES/GenSGSStress/GenSGSStress.H b/src/turbulenceModels/incompressible/LES/GenSGSStress/GenSGSStress.H index 36d84f9c77..afe797b409 100644 --- a/src/turbulenceModels/incompressible/LES/GenSGSStress/GenSGSStress.H +++ b/src/turbulenceModels/incompressible/LES/GenSGSStress/GenSGSStress.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::GenSGSStress +Group + grpIcoLESTurbulence + Description General base class for all incompressible models that directly solve for the SGS stress tensor B. diff --git a/src/turbulenceModels/incompressible/LES/LESModel/LESModel.H b/src/turbulenceModels/incompressible/LES/LESModel/LESModel.H index deca26e793..ab1265b7d2 100644 --- a/src/turbulenceModels/incompressible/LES/LESModel/LESModel.H +++ b/src/turbulenceModels/incompressible/LES/LESModel/LESModel.H @@ -24,6 +24,9 @@ License Namespace Foam::incompressible::LESModels +Group + grpIcoLESTurbulence + Description Namespace for incompressible LES models. diff --git a/src/turbulenceModels/incompressible/LES/LESModel/LESModelDoc.H b/src/turbulenceModels/incompressible/LES/LESModel/LESModelDoc.H new file mode 100644 index 0000000000..9b400e23ee --- /dev/null +++ b/src/turbulenceModels/incompressible/LES/LESModel/LESModelDoc.H @@ -0,0 +1,32 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2012 OpenFOAM Foundation + \\/ M anipulation | +------------------------------------------------------------------------------- +License + This file is part of OpenFOAM. + + OpenFOAM is free software: you can redistribute it and/or modify it + under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + OpenFOAM is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + for more details. + + You should have received a copy of the GNU General Public License + along with OpenFOAM. If not, see . + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\defgroup grpIcoLESTurbulence Incompressible LES turbulence +@{ + \ingroup grpIcoTurbulence + This group contains incompressible LES models. +@} + +\*---------------------------------------------------------------------------*/ diff --git a/src/turbulenceModels/incompressible/LES/LRRDiffStress/LRRDiffStress.H b/src/turbulenceModels/incompressible/LES/LRRDiffStress/LRRDiffStress.H index afe530a00e..62aaaa3ef0 100644 --- a/src/turbulenceModels/incompressible/LES/LRRDiffStress/LRRDiffStress.H +++ b/src/turbulenceModels/incompressible/LES/LRRDiffStress/LRRDiffStress.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::LRRDiffStress +Group + grpIcoLESTurbulence + Description Differential SGS Stress Equation Model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/LES/Smagorinsky/Smagorinsky.H b/src/turbulenceModels/incompressible/LES/Smagorinsky/Smagorinsky.H index e110591917..8af2bbe08a 100644 --- a/src/turbulenceModels/incompressible/LES/Smagorinsky/Smagorinsky.H +++ b/src/turbulenceModels/incompressible/LES/Smagorinsky/Smagorinsky.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::Smagorinsky +Group + grpIcoLESTurbulence + Description The Isochoric Smagorinsky Model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/LES/Smagorinsky2/Smagorinsky2.H b/src/turbulenceModels/incompressible/LES/Smagorinsky2/Smagorinsky2.H index 89c77912cd..139e66fe53 100644 --- a/src/turbulenceModels/incompressible/LES/Smagorinsky2/Smagorinsky2.H +++ b/src/turbulenceModels/incompressible/LES/Smagorinsky2/Smagorinsky2.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::Smagorinsky2 +Group + grpIcoLESTurbulence + Description The Isochoric Smagorinsky Model for incompressible flows diff --git a/src/turbulenceModels/incompressible/LES/SpalartAllmaras/SpalartAllmaras.H b/src/turbulenceModels/incompressible/LES/SpalartAllmaras/SpalartAllmaras.H index 7ed507712a..9a4ee17388 100644 --- a/src/turbulenceModels/incompressible/LES/SpalartAllmaras/SpalartAllmaras.H +++ b/src/turbulenceModels/incompressible/LES/SpalartAllmaras/SpalartAllmaras.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::SpalartAllmaras +Group + grpIcoLESTurbulence + Description SpalartAllmaras DES (SA + LES) turbulence model for incompressible flows diff --git a/src/turbulenceModels/incompressible/LES/SpalartAllmarasDDES/SpalartAllmarasDDES.H b/src/turbulenceModels/incompressible/LES/SpalartAllmarasDDES/SpalartAllmarasDDES.H index b721e8b8b8..eebe26cfa5 100644 --- a/src/turbulenceModels/incompressible/LES/SpalartAllmarasDDES/SpalartAllmarasDDES.H +++ b/src/turbulenceModels/incompressible/LES/SpalartAllmarasDDES/SpalartAllmarasDDES.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::SpalartAllmarasDDES +Group + grpIcoLESTurbulence + Description SpalartAllmaras DDES LES turbulence model for incompressible flows diff --git a/src/turbulenceModels/incompressible/LES/SpalartAllmarasIDDES/SpalartAllmarasIDDES.H b/src/turbulenceModels/incompressible/LES/SpalartAllmarasIDDES/SpalartAllmarasIDDES.H index bf44430e5a..43f10eee33 100644 --- a/src/turbulenceModels/incompressible/LES/SpalartAllmarasIDDES/SpalartAllmarasIDDES.H +++ b/src/turbulenceModels/incompressible/LES/SpalartAllmarasIDDES/SpalartAllmarasIDDES.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::SpalartAllmarasIDDES +Group + grpIcoLESTurbulence + Description SpalartAllmarasIDDES LES turbulence model for incompressible flows diff --git a/src/turbulenceModels/incompressible/LES/dynLagrangian/dynLagrangian.H b/src/turbulenceModels/incompressible/LES/dynLagrangian/dynLagrangian.H index 2d83299d4a..004efeaaed 100644 --- a/src/turbulenceModels/incompressible/LES/dynLagrangian/dynLagrangian.H +++ b/src/turbulenceModels/incompressible/LES/dynLagrangian/dynLagrangian.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::dynLagrangian +Group + grpIcoLESTurbulence + Description Dynamic eddy-viscosity model with Lagrangian averaging for incompressible flow diff --git a/src/turbulenceModels/incompressible/LES/dynOneEqEddy/dynOneEqEddy.H b/src/turbulenceModels/incompressible/LES/dynOneEqEddy/dynOneEqEddy.H index 5b744eb0d2..6a9384f406 100644 --- a/src/turbulenceModels/incompressible/LES/dynOneEqEddy/dynOneEqEddy.H +++ b/src/turbulenceModels/incompressible/LES/dynOneEqEddy/dynOneEqEddy.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::dynOneEqEddy +Group + grpIcoLESTurbulence + Description Localised Dynamic One Equation Eddy Viscosity Model for incompressible flows diff --git a/src/turbulenceModels/incompressible/LES/homogeneousDynOneEqEddy/homogeneousDynOneEqEddy.H b/src/turbulenceModels/incompressible/LES/homogeneousDynOneEqEddy/homogeneousDynOneEqEddy.H index 6de3992574..68e0183345 100644 --- a/src/turbulenceModels/incompressible/LES/homogeneousDynOneEqEddy/homogeneousDynOneEqEddy.H +++ b/src/turbulenceModels/incompressible/LES/homogeneousDynOneEqEddy/homogeneousDynOneEqEddy.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::homogeneousDynOneEqEddy +Group + grpIcoLESTurbulence + Description One Equation Eddy Viscosity Model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/LES/homogeneousDynSmagorinsky/homogeneousDynSmagorinsky.H b/src/turbulenceModels/incompressible/LES/homogeneousDynSmagorinsky/homogeneousDynSmagorinsky.H index 05ac587a5b..cc95bb047a 100644 --- a/src/turbulenceModels/incompressible/LES/homogeneousDynSmagorinsky/homogeneousDynSmagorinsky.H +++ b/src/turbulenceModels/incompressible/LES/homogeneousDynSmagorinsky/homogeneousDynSmagorinsky.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::homogeneousDynSmagorinsky +Group + grpIcoLESTurbulence + Description The Isochoric homogeneous dynamic Smagorinsky Model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/LES/kOmegaSSTSAS/kOmegaSSTSAS.H b/src/turbulenceModels/incompressible/LES/kOmegaSSTSAS/kOmegaSSTSAS.H index 2ca98380af..97354ff492 100644 --- a/src/turbulenceModels/incompressible/LES/kOmegaSSTSAS/kOmegaSSTSAS.H +++ b/src/turbulenceModels/incompressible/LES/kOmegaSSTSAS/kOmegaSSTSAS.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::kOmegaSSTSAS +Group + grpIcoLESTurbulence + Description kOmegaSSTSAS LES turbulence model for incompressible flows based on: diff --git a/src/turbulenceModels/incompressible/LES/mixedSmagorinsky/mixedSmagorinsky.H b/src/turbulenceModels/incompressible/LES/mixedSmagorinsky/mixedSmagorinsky.H index c8557db239..1793c8053d 100644 --- a/src/turbulenceModels/incompressible/LES/mixedSmagorinsky/mixedSmagorinsky.H +++ b/src/turbulenceModels/incompressible/LES/mixedSmagorinsky/mixedSmagorinsky.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::mixedSmagorinsky +Group + grpIcoLESTurbulence + Description The mixed Isochoric Smagorinsky Model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/LES/oneEqEddy/oneEqEddy.H b/src/turbulenceModels/incompressible/LES/oneEqEddy/oneEqEddy.H index 0f040d829a..dd68b53258 100644 --- a/src/turbulenceModels/incompressible/LES/oneEqEddy/oneEqEddy.H +++ b/src/turbulenceModels/incompressible/LES/oneEqEddy/oneEqEddy.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::oneEqEddy +Group + grpIcoLESTurbulence + Description One Equation Eddy Viscosity Model for incompressible flows diff --git a/src/turbulenceModels/incompressible/LES/scaleSimilarity/scaleSimilarity.H b/src/turbulenceModels/incompressible/LES/scaleSimilarity/scaleSimilarity.H index 0dff31d87e..5a6a5d97a6 100644 --- a/src/turbulenceModels/incompressible/LES/scaleSimilarity/scaleSimilarity.H +++ b/src/turbulenceModels/incompressible/LES/scaleSimilarity/scaleSimilarity.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::scaleSimilarity +Group + grpIcoLESTurbulence + Description General base class for all scale similarity models for incompressible flows. diff --git a/src/turbulenceModels/incompressible/LES/spectEddyVisc/spectEddyVisc.H b/src/turbulenceModels/incompressible/LES/spectEddyVisc/spectEddyVisc.H index 9b3782e49b..a223a9d076 100644 --- a/src/turbulenceModels/incompressible/LES/spectEddyVisc/spectEddyVisc.H +++ b/src/turbulenceModels/incompressible/LES/spectEddyVisc/spectEddyVisc.H @@ -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-2012 OpenFOAM Foundation \\/ M anipulation | ------------------------------------------------------------------------------- License @@ -24,6 +24,9 @@ License Class Foam::incompressible::LESModels::spectEddyVisc +Group + grpIcoLESTurbulence + Description The Isochoric spectral Eddy Viscosity Model for incompressible flows. diff --git a/src/turbulenceModels/incompressible/RAS/RASModel/RASModelDoc.H b/src/turbulenceModels/incompressible/RAS/RASModel/RASModelDoc.H index 95b87a7c92..216165664d 100644 --- a/src/turbulenceModels/incompressible/RAS/RASModel/RASModelDoc.H +++ b/src/turbulenceModels/incompressible/RAS/RASModel/RASModelDoc.H @@ -25,6 +25,7 @@ License \defgroup grpIcoRASTurbulence Incompressible RAS turbulence @{ + \ingroup grpIcoTurbulence This group contains incompressible RAS models. @} diff --git a/src/turbulenceModels/incompressible/turbulenceModel/turbulenceModelDoc.H b/src/turbulenceModels/incompressible/turbulenceModel/turbulenceModelDoc.H new file mode 100644 index 0000000000..f9751dc542 --- /dev/null +++ b/src/turbulenceModels/incompressible/turbulenceModel/turbulenceModelDoc.H @@ -0,0 +1,31 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2012 OpenFOAM Foundation + \\/ M anipulation | +------------------------------------------------------------------------------- +License + This file is part of OpenFOAM. + + OpenFOAM is free software: you can redistribute it and/or modify it + under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + OpenFOAM is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + for more details. + + You should have received a copy of the GNU General Public License + along with OpenFOAM. If not, see . + +// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // + +\defgroup grpIcoTurbulence Incompressible turbulence +@{ + This group contains incompressible turbulence models. +@} + +\*---------------------------------------------------------------------------*/ From 5a6d6578c422fd6e9a3d7536bf8794c81948c183 Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 23 Jul 2012 18:08:56 +0100 Subject: [PATCH 10/12] ENH: Added boundary condition documentation --- .../fvPatchFields/doc/boundaryConditions.dox | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox b/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox index 72a3078da4..7bb0894d70 100644 --- a/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox +++ b/src/finiteVolume/fields/fvPatchFields/doc/boundaryConditions.dox @@ -24,11 +24,13 @@ License // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // \page pageBoundaryConditions Boundary Conditions - -\ref grpBoundaryConditions - +\ref grpBoundaryConditions are required to 'close' the simulation problem. +Careful attention should be applied to their selection so as to create a +well-posed system of equations, which can be solved numerically. \section secBoundaryConditionsOverview Overview +The set of available \ref grpBoundaryConditions comprise of basic, turbulent and +thermophysical types. \subsection secBC1 Basic boundary conditions - \ref grpConstraintBoundaryConditions @@ -47,6 +49,10 @@ License \section secWallFunctions Wall functions +Wall functions in OpenFOAM are modelled as boundary conditions, applied to +the viscosity for momentum, and thermal diffusivity for energy. Two groups of +wall functions are available, which vary in terms of the underlying +compressibility assumption. Wall functions for incompressible flow - \ref grpIcoWallFunctions @@ -56,6 +62,9 @@ Wall functions for compressible flow \section secBoundaryConditions Typical usage for pressure-velocity systems +The choice as to the most appropriate set of boundary conditions is dictated by +the type of flow problem. In many cases, multiple possible selections exist; +the following tables offer suggestions for subsonic flow. subsonic inlet (flow specified): \table @@ -75,7 +84,7 @@ subsonic outlet: derived property | - | \link Foam::calculatedFvPatchField calculated\endlink or \link Foam::zeroGradientFvPatchField zeroGradient\endlink \endtable -wall: +wall (impermeable, non-slip): \table Variable | Symbol | Type pressure | p | \link Foam::zeroGradientFvPatchField zeroGradient\endlink From b57e6295c1c1417d557e7af06f0f8358759c7b1e Mon Sep 17 00:00:00 2001 From: andy Date: Mon, 23 Jul 2012 18:24:31 +0100 Subject: [PATCH 11/12] ENH: updated DeardorffDiffStress header doc --- .../LES/DeardorffDiffStress/DeardorffDiffStress.H | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/src/turbulenceModels/incompressible/LES/DeardorffDiffStress/DeardorffDiffStress.H b/src/turbulenceModels/incompressible/LES/DeardorffDiffStress/DeardorffDiffStress.H index f9e87de208..f3b8c6c448 100644 --- a/src/turbulenceModels/incompressible/LES/DeardorffDiffStress/DeardorffDiffStress.H +++ b/src/turbulenceModels/incompressible/LES/DeardorffDiffStress/DeardorffDiffStress.H @@ -41,12 +41,14 @@ Description \f] where - k = 0.5*tr(B), - epsilon = ce*k^3/2/delta, - epsilon/k = ce*k^1/2/delta - P = -(B'L + L'B) - nuSgs = ck*sqrt(k)*delta - nuEff = nuSgs + nu + \f{eqnarray*}{ + k &=& 0.5 tr(B) \\ + \epsilon &=& c_e k^{3/2}/\Delta \\ + \epsilon/k &=& c_e k^{1/2}/\Delta \\ + P &=& -(B'L + L'B) \\ + \nu_{sgs} &=& c_k k^{1/2} \Delta \\ + \nu_{eff} &=& \nu_{sgs} + \nu + \f} SourceFiles DeardorffDiffStress.C From 708a8e9ea0719d01be2e62e473123ae76170bb55 Mon Sep 17 00:00:00 2001 From: andy Date: Tue, 24 Jul 2012 10:59:53 +0100 Subject: [PATCH 12/12] BUG: Corrected typo --- .../turbulentIntensityKineticEnergyInletFvPatchScalarField.C | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.C b/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.C index cb3395f0a6..7689d3d763 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.C +++ b/src/finiteVolume/fields/fvPatchFields/derived/turbulentIntensityKineticEnergyInlet/turbulentIntensityKineticEnergyInletFvPatchScalarField.C @@ -85,7 +85,7 @@ turbulentIntensityKineticEnergyInletFvPatchScalarField "(" "const fvPatch&, " "const DimensionedField&, " - "const dictionary& + "const dictionary&" ")" ) << "Turbulence intensity should be specified as a fraction 0-1 " "of the mean velocity\n"