diff --git a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalInletOutletVelocity/fixedNormalInletOutletVelocityFvPatchVectorField.H b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalInletOutletVelocity/fixedNormalInletOutletVelocityFvPatchVectorField.H index 6d6bb2e736..5106d31ead 100644 --- a/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalInletOutletVelocity/fixedNormalInletOutletVelocityFvPatchVectorField.H +++ b/src/finiteVolume/fields/fvPatchFields/derived/fixedNormalInletOutletVelocity/fixedNormalInletOutletVelocityFvPatchVectorField.H @@ -28,10 +28,11 @@ Group grpInletletBoundaryConditions grpOutletBoundaryConditions Description - This velocity inlet/outlet boundary condition combines a fixed normal component obtained from the "normalVelocity" patchField supplied with a - fixed or zero-gradiented tangential component depending on the direction + fixed or zero-gradiented tangential component. + + The tangential component is set depending on the direction of the flow and the setting of "fixTangentialInflow": - Outflow: apply zero-gradient condition to tangential components - Inflow: @@ -64,9 +65,9 @@ Description offset (0 -1 0); amplitude table ( - ( 0 0) - ( 2 0.088) - ( 8 0.088) + (0 0) + (2 0.088) + (8 0.088) ); frequency constant 1; } diff --git a/src/finiteVolume/finiteVolume/convectionSchemes/boundedConvectionScheme/boundedConvectionScheme.H b/src/finiteVolume/finiteVolume/convectionSchemes/boundedConvectionScheme/boundedConvectionScheme.H index 9426104d33..ffeb257846 100644 --- a/src/finiteVolume/finiteVolume/convectionSchemes/boundedConvectionScheme/boundedConvectionScheme.H +++ b/src/finiteVolume/finiteVolume/convectionSchemes/boundedConvectionScheme/boundedConvectionScheme.H @@ -24,6 +24,9 @@ License Class Foam::fv::boundedConvectionScheme +Group + grpFvConvectionSchemes + Description Bounded form of the selected convection scheme. diff --git a/src/finiteVolume/finiteVolume/convectionSchemes/convectionScheme/convectionScheme.H b/src/finiteVolume/finiteVolume/convectionSchemes/convectionScheme/convectionScheme.H index 491ed48496..0374ed72ea 100644 --- a/src/finiteVolume/finiteVolume/convectionSchemes/convectionScheme/convectionScheme.H +++ b/src/finiteVolume/finiteVolume/convectionSchemes/convectionScheme/convectionScheme.H @@ -24,6 +24,9 @@ License Class Foam::fv::convectionScheme +Group + grpFvConvectionSchemes + Description Abstract base class for convection schemes. diff --git a/src/finiteVolume/finiteVolume/convectionSchemes/gaussConvectionScheme/gaussConvectionScheme.H b/src/finiteVolume/finiteVolume/convectionSchemes/gaussConvectionScheme/gaussConvectionScheme.H index 83b50416e9..2442101245 100644 --- a/src/finiteVolume/finiteVolume/convectionSchemes/gaussConvectionScheme/gaussConvectionScheme.H +++ b/src/finiteVolume/finiteVolume/convectionSchemes/gaussConvectionScheme/gaussConvectionScheme.H @@ -24,6 +24,9 @@ License Class Foam::fv::gaussConvectionScheme +Group + grpFvConvectionSchemes + Description Basic second-order convection using face-gradients and Gauss' theorem. diff --git a/src/finiteVolume/finiteVolume/convectionSchemes/multivariateGaussConvectionScheme/multivariateGaussConvectionScheme.H b/src/finiteVolume/finiteVolume/convectionSchemes/multivariateGaussConvectionScheme/multivariateGaussConvectionScheme.H index df8fde08be..782c826673 100644 --- a/src/finiteVolume/finiteVolume/convectionSchemes/multivariateGaussConvectionScheme/multivariateGaussConvectionScheme.H +++ b/src/finiteVolume/finiteVolume/convectionSchemes/multivariateGaussConvectionScheme/multivariateGaussConvectionScheme.H @@ -24,6 +24,9 @@ License Class Foam::fv::multivariateGaussConvectionScheme +Group + grpFvConvectionSchemes + Description Basic second-order convection using face-gradients and Gauss' theorem. diff --git a/src/finiteVolume/finiteVolume/ddtSchemes/CoEulerDdtScheme/CoEulerDdtScheme.H b/src/finiteVolume/finiteVolume/ddtSchemes/CoEulerDdtScheme/CoEulerDdtScheme.H index e743a0cb40..c3c6675658 100644 --- a/src/finiteVolume/finiteVolume/ddtSchemes/CoEulerDdtScheme/CoEulerDdtScheme.H +++ b/src/finiteVolume/finiteVolume/ddtSchemes/CoEulerDdtScheme/CoEulerDdtScheme.H @@ -24,6 +24,9 @@ License Class Foam::fv::CoEulerDdtScheme +Group + grpFvDdtSchemes + Description Courant number limited first-order Euler implicit/explicit ddt. diff --git a/src/finiteVolume/finiteVolume/ddtSchemes/CrankNicolsonDdtScheme/CrankNicolsonDdtScheme.H b/src/finiteVolume/finiteVolume/ddtSchemes/CrankNicolsonDdtScheme/CrankNicolsonDdtScheme.H index db2c5a08f0..70caa7b3f4 100644 --- a/src/finiteVolume/finiteVolume/ddtSchemes/CrankNicolsonDdtScheme/CrankNicolsonDdtScheme.H +++ b/src/finiteVolume/finiteVolume/ddtSchemes/CrankNicolsonDdtScheme/CrankNicolsonDdtScheme.H @@ -24,6 +24,9 @@ License Class Foam::fv::CrankNicolsonDdtScheme +Group + grpFvDdtSchemes + Description Second-oder Crank-Nicolson implicit ddt using the current and previous time-step fields as well as the previous time-step ddt. diff --git a/src/finiteVolume/finiteVolume/ddtSchemes/EulerDdtScheme/EulerDdtScheme.H b/src/finiteVolume/finiteVolume/ddtSchemes/EulerDdtScheme/EulerDdtScheme.H index 2818fa123f..9c48e78e2f 100644 --- a/src/finiteVolume/finiteVolume/ddtSchemes/EulerDdtScheme/EulerDdtScheme.H +++ b/src/finiteVolume/finiteVolume/ddtSchemes/EulerDdtScheme/EulerDdtScheme.H @@ -24,6 +24,9 @@ License Class Foam::fv::EulerDdtScheme +Group + grpFvDdtSchemes + Description Basic first-order Euler implicit/explicit ddt using only the current and previous time-step values. diff --git a/src/finiteVolume/finiteVolume/ddtSchemes/SLTSDdtScheme/SLTSDdtScheme.H b/src/finiteVolume/finiteVolume/ddtSchemes/SLTSDdtScheme/SLTSDdtScheme.H index ee92d658b6..e56d6fcf54 100644 --- a/src/finiteVolume/finiteVolume/ddtSchemes/SLTSDdtScheme/SLTSDdtScheme.H +++ b/src/finiteVolume/finiteVolume/ddtSchemes/SLTSDdtScheme/SLTSDdtScheme.H @@ -24,6 +24,9 @@ License Class Foam::fv::SLTSDdtScheme +Group + grpFvDdtSchemes + Description Stabilised local time-step first-order Euler implicit/explicit ddt. The time-step is adjusted locally so that an advective equations remains diff --git a/src/finiteVolume/finiteVolume/ddtSchemes/backwardDdtScheme/backwardDdtScheme.H b/src/finiteVolume/finiteVolume/ddtSchemes/backwardDdtScheme/backwardDdtScheme.H index 9855ad5599..0ce855dbc0 100644 --- a/src/finiteVolume/finiteVolume/ddtSchemes/backwardDdtScheme/backwardDdtScheme.H +++ b/src/finiteVolume/finiteVolume/ddtSchemes/backwardDdtScheme/backwardDdtScheme.H @@ -24,6 +24,9 @@ License Class Foam::fv::backwardDdtScheme +Group + grpFvDdtSchemes + Description Second-order backward-differencing ddt using the current and two previous time-step values. diff --git a/src/finiteVolume/finiteVolume/ddtSchemes/boundedDdtScheme/boundedDdtScheme.H b/src/finiteVolume/finiteVolume/ddtSchemes/boundedDdtScheme/boundedDdtScheme.H index 741e7c1e0f..44d2553609 100644 --- a/src/finiteVolume/finiteVolume/ddtSchemes/boundedDdtScheme/boundedDdtScheme.H +++ b/src/finiteVolume/finiteVolume/ddtSchemes/boundedDdtScheme/boundedDdtScheme.H @@ -24,6 +24,9 @@ License Class Foam::fv::boundedDdtScheme +Group + grpFvDdtSchemes + Description Bounded form of the selected ddt scheme. diff --git a/src/finiteVolume/finiteVolume/ddtSchemes/ddtScheme/ddtScheme.H b/src/finiteVolume/finiteVolume/ddtSchemes/ddtScheme/ddtScheme.H index 5c35996c38..1f9fa2b07e 100644 --- a/src/finiteVolume/finiteVolume/ddtSchemes/ddtScheme/ddtScheme.H +++ b/src/finiteVolume/finiteVolume/ddtSchemes/ddtScheme/ddtScheme.H @@ -24,6 +24,9 @@ License Class Foam::fv::ddtScheme +Group + grpFvDdtSchemes + Description Abstract base class for ddt schemes. diff --git a/src/finiteVolume/finiteVolume/ddtSchemes/localEulerDdtScheme/localEulerDdtScheme.H b/src/finiteVolume/finiteVolume/ddtSchemes/localEulerDdtScheme/localEulerDdtScheme.H index b28227939f..ca5203e308 100644 --- a/src/finiteVolume/finiteVolume/ddtSchemes/localEulerDdtScheme/localEulerDdtScheme.H +++ b/src/finiteVolume/finiteVolume/ddtSchemes/localEulerDdtScheme/localEulerDdtScheme.H @@ -24,6 +24,9 @@ License Class Foam::fv::localEulerDdtScheme +Group + grpFvDdtSchemes + Description Local time-step first-order Euler implicit/explicit ddt. diff --git a/src/finiteVolume/finiteVolume/ddtSchemes/steadyStateDdtScheme/steadyStateDdtScheme.H b/src/finiteVolume/finiteVolume/ddtSchemes/steadyStateDdtScheme/steadyStateDdtScheme.H index 7d990746f2..4a30d6c0a4 100644 --- a/src/finiteVolume/finiteVolume/ddtSchemes/steadyStateDdtScheme/steadyStateDdtScheme.H +++ b/src/finiteVolume/finiteVolume/ddtSchemes/steadyStateDdtScheme/steadyStateDdtScheme.H @@ -24,6 +24,9 @@ License Class Foam::fv::steadyStateDdtScheme +Group + grpFvDdtSchemes + Description SteadyState implicit/explicit ddt which returns 0. diff --git a/src/finiteVolume/finiteVolume/divSchemes/divScheme/divScheme.H b/src/finiteVolume/finiteVolume/divSchemes/divScheme/divScheme.H index 4032e2d5cf..8e06eaacdf 100644 --- a/src/finiteVolume/finiteVolume/divSchemes/divScheme/divScheme.H +++ b/src/finiteVolume/finiteVolume/divSchemes/divScheme/divScheme.H @@ -24,6 +24,9 @@ License Class Foam::fv::divScheme +Group + grpFvDivSchemes + Description Abstract base class for div schemes. diff --git a/src/finiteVolume/finiteVolume/divSchemes/gaussDivScheme/gaussDivScheme.H b/src/finiteVolume/finiteVolume/divSchemes/gaussDivScheme/gaussDivScheme.H index 34b444437d..5fbf78ec13 100644 --- a/src/finiteVolume/finiteVolume/divSchemes/gaussDivScheme/gaussDivScheme.H +++ b/src/finiteVolume/finiteVolume/divSchemes/gaussDivScheme/gaussDivScheme.H @@ -24,6 +24,9 @@ License Class Foam::fv::gaussDivScheme +Group + grpFvDivSchemes + Description Basic second-order div using face-gradients and Gauss' theorem. diff --git a/src/finiteVolume/finiteVolume/doc/finiteVolumeSchemesDoc.H b/src/finiteVolume/finiteVolume/doc/finiteVolumeSchemesDoc.H new file mode 100644 index 0000000000..6a82c72d9c --- /dev/null +++ b/src/finiteVolume/finiteVolume/doc/finiteVolumeSchemesDoc.H @@ -0,0 +1,80 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2016 OpenCFD Ltd. + \\/ 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 grpFvSchemes Finite volume numerical schemes +@{ + This group contains finite volume numerical schemes +@} + +\defgroup grpFvGradSchemes Gradient schemes +@{ + \ingroup grpFvSchemes + This group contains finite volume gradient schemes +@} + +\defgroup grpFvSnGradSchemes Surface normal gradient schemes +@{ + \ingroup grpFvSchemes + This group contains finite volume surface normal gradient schemes +@} + +\defgroup grpFvDivSchemes Divergence schemes +@{ + \ingroup grpFvSchemes + This group contains finite volume divergence schemes +@} + +\defgroup grpFvLaplacianSchemes Laplacian schemes +@{ + \ingroup grpFvSchemes + This group contains finite volume Laplacian schemes +@} + +\defgroup grpFvDdtSchemes Time schemes +@{ + \ingroup grpFvSchemes + This group contains finite volume time schemes +@} + +\defgroup grpFvConvectionSchemes Convection schemes +@{ + \ingroup grpFvSchemes + This group contains finite volume convection schemes +@} + +\defgroup grpFvSurfaceInterpolationSchemes Surface interpolation schemes +@{ + \ingroup grpFvSchemes + This group contains finite volume surface interpolation schemes +@} + +\defgroup grpFvLimitedSurfaceInterpolationSchemes Limited interpolation schemes +@{ + \ingroup grpFvSurfaceInterpolationSchemes + This group contains finite volume limited surface interpolation schemes +@} + + +\*---------------------------------------------------------------------------*/ diff --git a/src/finiteVolume/finiteVolume/gradSchemes/LeastSquaresGrad/LeastSquaresGrad.H b/src/finiteVolume/finiteVolume/gradSchemes/LeastSquaresGrad/LeastSquaresGrad.H index a71d0e87ab..17fefdc7c0 100644 --- a/src/finiteVolume/finiteVolume/gradSchemes/LeastSquaresGrad/LeastSquaresGrad.H +++ b/src/finiteVolume/finiteVolume/gradSchemes/LeastSquaresGrad/LeastSquaresGrad.H @@ -24,6 +24,9 @@ License Class Foam::fv::LeastSquaresGrad +Group + grpFvGradSchemes + Description Gradient calculated using weighted least-squares on an arbitrary stencil. The stencil type is provided via a template argument and any cell-based diff --git a/src/finiteVolume/finiteVolume/gradSchemes/fourthGrad/fourthGrad.H b/src/finiteVolume/finiteVolume/gradSchemes/fourthGrad/fourthGrad.H index effe6d7ffd..bb2f6386b3 100644 --- a/src/finiteVolume/finiteVolume/gradSchemes/fourthGrad/fourthGrad.H +++ b/src/finiteVolume/finiteVolume/gradSchemes/fourthGrad/fourthGrad.H @@ -24,6 +24,9 @@ License Class Foam::fv::fourthGrad +Group + grpFvGradSchemes + Description Second-order gradient scheme using least-squares. diff --git a/src/finiteVolume/finiteVolume/gradSchemes/gaussGrad/gaussGrad.H b/src/finiteVolume/finiteVolume/gradSchemes/gaussGrad/gaussGrad.H index 6559ed22aa..63d2e44461 100644 --- a/src/finiteVolume/finiteVolume/gradSchemes/gaussGrad/gaussGrad.H +++ b/src/finiteVolume/finiteVolume/gradSchemes/gaussGrad/gaussGrad.H @@ -24,6 +24,9 @@ License Class Foam::fv::gaussGrad +Group + grpFvGradSchemes + Description Basic second-order gradient scheme using face-interpolation and Gauss' theorem. diff --git a/src/finiteVolume/finiteVolume/gradSchemes/leastSquaresGrad/leastSquaresGrad.H b/src/finiteVolume/finiteVolume/gradSchemes/leastSquaresGrad/leastSquaresGrad.H index cf8c570480..a919101b6c 100644 --- a/src/finiteVolume/finiteVolume/gradSchemes/leastSquaresGrad/leastSquaresGrad.H +++ b/src/finiteVolume/finiteVolume/gradSchemes/leastSquaresGrad/leastSquaresGrad.H @@ -24,6 +24,9 @@ License Class Foam::fv::leastSquaresGrad +Group + grpFvGradSchemes + Description Second-order gradient scheme using least-squares. diff --git a/src/finiteVolume/finiteVolume/gradSchemes/limitedGradSchemes/cellLimitedGrad/cellLimitedGrad.H b/src/finiteVolume/finiteVolume/gradSchemes/limitedGradSchemes/cellLimitedGrad/cellLimitedGrad.H index 6ee95bdbcc..5f2a61be98 100644 --- a/src/finiteVolume/finiteVolume/gradSchemes/limitedGradSchemes/cellLimitedGrad/cellLimitedGrad.H +++ b/src/finiteVolume/finiteVolume/gradSchemes/limitedGradSchemes/cellLimitedGrad/cellLimitedGrad.H @@ -24,6 +24,9 @@ License Class Foam::fv::cellLimitedGrad +Group + grpFvGradSchemes + Description cellLimitedGrad gradient scheme applied to a runTime selected base gradient scheme. diff --git a/src/finiteVolume/finiteVolume/gradSchemes/limitedGradSchemes/cellMDLimitedGrad/cellMDLimitedGrad.H b/src/finiteVolume/finiteVolume/gradSchemes/limitedGradSchemes/cellMDLimitedGrad/cellMDLimitedGrad.H index 0ef0b44ad6..12da9a9aa9 100644 --- a/src/finiteVolume/finiteVolume/gradSchemes/limitedGradSchemes/cellMDLimitedGrad/cellMDLimitedGrad.H +++ b/src/finiteVolume/finiteVolume/gradSchemes/limitedGradSchemes/cellMDLimitedGrad/cellMDLimitedGrad.H @@ -24,6 +24,9 @@ License Class Foam::fv::cellMDLimitedGrad +Group + grpFvGradSchemes + Description cellMDLimitedGrad gradient scheme applied to a runTime selected base gradient scheme. diff --git a/src/finiteVolume/finiteVolume/gradSchemes/limitedGradSchemes/faceLimitedGrad/faceLimitedGrad.H b/src/finiteVolume/finiteVolume/gradSchemes/limitedGradSchemes/faceLimitedGrad/faceLimitedGrad.H index a3ce867666..a71c1ccfd9 100644 --- a/src/finiteVolume/finiteVolume/gradSchemes/limitedGradSchemes/faceLimitedGrad/faceLimitedGrad.H +++ b/src/finiteVolume/finiteVolume/gradSchemes/limitedGradSchemes/faceLimitedGrad/faceLimitedGrad.H @@ -24,6 +24,9 @@ License Class Foam::fv::faceLimitedGrad +Group + grpFvGradSchemes + Description faceLimitedGrad gradient scheme applied to a runTime selected base gradient scheme. diff --git a/src/finiteVolume/finiteVolume/gradSchemes/limitedGradSchemes/faceMDLimitedGrad/faceMDLimitedGrad.H b/src/finiteVolume/finiteVolume/gradSchemes/limitedGradSchemes/faceMDLimitedGrad/faceMDLimitedGrad.H index 9da9990353..e36830da61 100644 --- a/src/finiteVolume/finiteVolume/gradSchemes/limitedGradSchemes/faceMDLimitedGrad/faceMDLimitedGrad.H +++ b/src/finiteVolume/finiteVolume/gradSchemes/limitedGradSchemes/faceMDLimitedGrad/faceMDLimitedGrad.H @@ -24,6 +24,9 @@ License Class Foam::fv::faceMDLimitedGrad +Group + grpFvGradSchemes + Description faceMDLimitedGrad gradient scheme applied to a runTime selected base gradient scheme. diff --git a/src/finiteVolume/finiteVolume/laplacianSchemes/gaussLaplacianScheme/gaussLaplacianScheme.H b/src/finiteVolume/finiteVolume/laplacianSchemes/gaussLaplacianScheme/gaussLaplacianScheme.H index 1ff2a71843..932ba5680d 100644 --- a/src/finiteVolume/finiteVolume/laplacianSchemes/gaussLaplacianScheme/gaussLaplacianScheme.H +++ b/src/finiteVolume/finiteVolume/laplacianSchemes/gaussLaplacianScheme/gaussLaplacianScheme.H @@ -24,6 +24,9 @@ License Class Foam::fv::gaussLaplacianScheme +Group + grpFvLaplacianSchemes + Description Basic second-order laplacian using face-gradients and Gauss' theorem. diff --git a/src/finiteVolume/finiteVolume/laplacianSchemes/laplacianScheme/laplacianScheme.H b/src/finiteVolume/finiteVolume/laplacianSchemes/laplacianScheme/laplacianScheme.H index 781d2044d5..6851730ccc 100644 --- a/src/finiteVolume/finiteVolume/laplacianSchemes/laplacianScheme/laplacianScheme.H +++ b/src/finiteVolume/finiteVolume/laplacianSchemes/laplacianScheme/laplacianScheme.H @@ -24,6 +24,9 @@ License Class Foam::fv::laplacianScheme +Group + grpFvLaplacianSchemes + Description Abstract base class for laplacian schemes. diff --git a/src/finiteVolume/finiteVolume/snGradSchemes/CentredFitSnGrad/CentredFitSnGradScheme.H b/src/finiteVolume/finiteVolume/snGradSchemes/CentredFitSnGrad/CentredFitSnGradScheme.H index 4cebfa3e7b..b89a519ad2 100644 --- a/src/finiteVolume/finiteVolume/snGradSchemes/CentredFitSnGrad/CentredFitSnGradScheme.H +++ b/src/finiteVolume/finiteVolume/snGradSchemes/CentredFitSnGrad/CentredFitSnGradScheme.H @@ -24,6 +24,9 @@ License Class Foam::CentredFitSnGradScheme +Group + grpFvSnGradSchemes + Description Centred fit snGrad scheme which applies an explicit correction to snGrad diff --git a/src/finiteVolume/finiteVolume/snGradSchemes/correctedSnGrad/correctedSnGrad.H b/src/finiteVolume/finiteVolume/snGradSchemes/correctedSnGrad/correctedSnGrad.H index 1361ed9de2..f69eba48df 100644 --- a/src/finiteVolume/finiteVolume/snGradSchemes/correctedSnGrad/correctedSnGrad.H +++ b/src/finiteVolume/finiteVolume/snGradSchemes/correctedSnGrad/correctedSnGrad.H @@ -24,6 +24,9 @@ License Class Foam::fv::correctedSnGrad +Group + grpFvSnGradSchemes + Description Simple central-difference snGrad scheme with non-orthogonal correction. diff --git a/src/finiteVolume/finiteVolume/snGradSchemes/faceCorrectedSnGrad/faceCorrectedSnGrad.H b/src/finiteVolume/finiteVolume/snGradSchemes/faceCorrectedSnGrad/faceCorrectedSnGrad.H index a13dd62d18..2853440351 100644 --- a/src/finiteVolume/finiteVolume/snGradSchemes/faceCorrectedSnGrad/faceCorrectedSnGrad.H +++ b/src/finiteVolume/finiteVolume/snGradSchemes/faceCorrectedSnGrad/faceCorrectedSnGrad.H @@ -24,6 +24,9 @@ License Class Foam::fv::faceCorrectedSnGrad +Group + grpFvSnGradSchemes + Description Simple central-difference snGrad scheme with non-orthogonal correction. diff --git a/src/finiteVolume/finiteVolume/snGradSchemes/limitedSnGrad/limitedSnGrad.H b/src/finiteVolume/finiteVolume/snGradSchemes/limitedSnGrad/limitedSnGrad.H index ca9b2a8a5d..96c2d9ed73 100644 --- a/src/finiteVolume/finiteVolume/snGradSchemes/limitedSnGrad/limitedSnGrad.H +++ b/src/finiteVolume/finiteVolume/snGradSchemes/limitedSnGrad/limitedSnGrad.H @@ -24,6 +24,9 @@ License Class Foam::fv::limitedSnGrad +Group + grpFvSnGradSchemes + Description Run-time selected snGrad scheme with limited non-orthogonal correction. diff --git a/src/finiteVolume/finiteVolume/snGradSchemes/orthogonalSnGrad/orthogonalSnGrad.H b/src/finiteVolume/finiteVolume/snGradSchemes/orthogonalSnGrad/orthogonalSnGrad.H index b903298162..6bbaec4d0a 100644 --- a/src/finiteVolume/finiteVolume/snGradSchemes/orthogonalSnGrad/orthogonalSnGrad.H +++ b/src/finiteVolume/finiteVolume/snGradSchemes/orthogonalSnGrad/orthogonalSnGrad.H @@ -24,6 +24,9 @@ License Class Foam::fv::orthogonalSnGrad +Group + grpFvSnGradSchemes + Description Simple central-difference snGrad scheme without non-orthogonal correction. diff --git a/src/finiteVolume/finiteVolume/snGradSchemes/snGradScheme/snGradScheme.H b/src/finiteVolume/finiteVolume/snGradSchemes/snGradScheme/snGradScheme.H index e507cc837f..7ee1720489 100644 --- a/src/finiteVolume/finiteVolume/snGradSchemes/snGradScheme/snGradScheme.H +++ b/src/finiteVolume/finiteVolume/snGradSchemes/snGradScheme/snGradScheme.H @@ -24,6 +24,9 @@ License Class Foam::fv::snGradScheme +Group + grpFvSnGradSchemes + Description Abstract base class for snGrad schemes. diff --git a/src/finiteVolume/finiteVolume/snGradSchemes/uncorrectedSnGrad/uncorrectedSnGrad.H b/src/finiteVolume/finiteVolume/snGradSchemes/uncorrectedSnGrad/uncorrectedSnGrad.H index 082eeabbd0..48b7969278 100644 --- a/src/finiteVolume/finiteVolume/snGradSchemes/uncorrectedSnGrad/uncorrectedSnGrad.H +++ b/src/finiteVolume/finiteVolume/snGradSchemes/uncorrectedSnGrad/uncorrectedSnGrad.H @@ -24,6 +24,9 @@ License Class Foam::fv::uncorrectedSnGrad +Group + grpFvSnGradSchemes + Description Simple central-difference snGrad scheme without non-orthogonal correction. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/Gamma/Gamma.H b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/Gamma/Gamma.H index 20283602f6..eff1addbb2 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/Gamma/Gamma.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/Gamma/Gamma.H @@ -24,6 +24,9 @@ License Class Foam::GammaLimiter +Group + grpFvLimitedSurfaceInterpolationSchemes + Description Class with limiter function which returns the limiter for the Gamma differencing scheme based on phict obtained from the LimiterFunc diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/Limited/Limited.H b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/Limited/Limited.H index 48291ea360..c5880d9206 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/Limited/Limited.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/Limited/Limited.H @@ -24,6 +24,9 @@ License Class Foam::LimitedLimiter +Group + grpFvLimitedSurfaceInterpolationSchemes + Description Foam::LimitedLimiter diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/Limited01/Limited01.H b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/Limited01/Limited01.H index 010ab2f68e..d12eee0490 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/Limited01/Limited01.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/Limited01/Limited01.H @@ -24,6 +24,9 @@ License Class Foam::Limited01Limiter +Group + grpFvLimitedSurfaceInterpolationSchemes + Description A LimitedLimiter with the range 0-1 diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/LimitedScheme/LimitedScheme.H b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/LimitedScheme/LimitedScheme.H index e41b280a12..52c7988bdc 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/LimitedScheme/LimitedScheme.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/LimitedScheme/LimitedScheme.H @@ -24,6 +24,9 @@ License Class Foam::LimitedScheme +Group + grpFvLimitedSurfaceInterpolationSchemes + Description Class to create NVD/TVD limited weighting-factors. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/MUSCL/MUSCL.H b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/MUSCL/MUSCL.H index d4486788dd..48c9f95e09 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/MUSCL/MUSCL.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/MUSCL/MUSCL.H @@ -24,6 +24,9 @@ License Class Foam::MUSCLLimiter +Group + grpFvLimitedSurfaceInterpolationSchemes + Description Class with limiter function which returns the limiter for the van Leer's MUSCL differencing scheme. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/Minmod/Minmod.H b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/Minmod/Minmod.H index 5de25347fd..46ba72c88a 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/Minmod/Minmod.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/Minmod/Minmod.H @@ -24,6 +24,9 @@ License Class Foam::MinmodLimiter +Group + grpFvLimitedSurfaceInterpolationSchemes + Description Class with limiter function which returns the limiter for the Minmod differencing scheme. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/OSPRE/OSPRE.H b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/OSPRE/OSPRE.H index 2436d0e7bc..1f8f6ece33 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/OSPRE/OSPRE.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/OSPRE/OSPRE.H @@ -24,6 +24,9 @@ License Class Foam::OSPRELimiter +Group + grpFvLimitedSurfaceInterpolationSchemes + Description Class with limiter function which returns the limiter for the OSPRE differencing scheme based on r obtained from the LimiterFunc diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/Phi/Phi.H b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/Phi/Phi.H index 92ae810946..a06970e0d8 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/Phi/Phi.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/Phi/Phi.H @@ -24,6 +24,9 @@ License Class Foam::PhiLimiter +Group + grpFvLimitedSurfaceInterpolationSchemes + Description Class with limiter function which returns the limiter for the Phi differencing scheme. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/PhiScheme/PhiScheme.H b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/PhiScheme/PhiScheme.H index 358c17e473..c9624e867e 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/PhiScheme/PhiScheme.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/PhiScheme/PhiScheme.H @@ -24,6 +24,9 @@ License Class Foam::PhiScheme +Group + grpFvLimitedSurfaceInterpolationSchemes + Description Class to create the weighting-factors based on the face-flux. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/QUICK/QUICK.H b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/QUICK/QUICK.H index 3d0cb42889..e62f8643f4 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/QUICK/QUICK.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/QUICK/QUICK.H @@ -24,6 +24,9 @@ License Class Foam::QUICKLimiter +Group + grpFvLimitedSurfaceInterpolationSchemes + Description Class with limiter function which returns the limiter for the quadratic-upwind differencing scheme. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/SFCD/SFCD.H b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/SFCD/SFCD.H index 23cbde4620..6963624145 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/SFCD/SFCD.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/SFCD/SFCD.H @@ -24,6 +24,9 @@ License Class Foam::SFCDLimiter +Group + grpFvLimitedSurfaceInterpolationSchemes + Description Class with limiter function which returns the limiter for the SFCD differencing scheme based on phict obtained from the LimiterFunc diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/SuperBee/SuperBee.H b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/SuperBee/SuperBee.H index ffd8d6c83b..7e25e5372d 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/SuperBee/SuperBee.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/SuperBee/SuperBee.H @@ -24,6 +24,9 @@ License Class Foam::SuperBeeLimiter +Group + grpFvLimitedSurfaceInterpolationSchemes + Description Class with limiter function which returns the limiter for the SuperBee differencing scheme based on r obtained from the LimiterFunc diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/UMIST/UMIST.H b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/UMIST/UMIST.H index 0945471e8a..3932b0da4c 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/UMIST/UMIST.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/UMIST/UMIST.H @@ -24,6 +24,9 @@ License Class Foam::UMISTLimiter +Group + grpFvLimitedSurfaceInterpolationSchemes + Description Class with limiter function which returns the limiter for the UMIST differencing scheme. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/blended/blended.H b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/blended/blended.H index 74ed9b1575..491683ee68 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/blended/blended.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/blended/blended.H @@ -24,6 +24,9 @@ License Class Foam::blended +Group + grpFvLimitedSurfaceInterpolationSchemes + Description linear/upwind blended differencing scheme. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/filteredLinear/filteredLinear.H b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/filteredLinear/filteredLinear.H index a32b29b9ba..012472e196 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/filteredLinear/filteredLinear.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/filteredLinear/filteredLinear.H @@ -24,6 +24,9 @@ License Class Foam::filteredLinearLimiter +Group + grpFvLimitedSurfaceInterpolationSchemes + Description Class to generate weighting factors for the filteredLinear differencing scheme. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/filteredLinear2/filteredLinear2.H b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/filteredLinear2/filteredLinear2.H index 99a136ef59..4b36d81b97 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/filteredLinear2/filteredLinear2.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/filteredLinear2/filteredLinear2.H @@ -24,6 +24,9 @@ License Class Foam::filteredLinear2Limiter +Group + grpFvLimitedSurfaceInterpolationSchemes + Description Class to generate weighting factors for the filteredLinear2 differencing scheme. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/filteredLinear3/filteredLinear3.H b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/filteredLinear3/filteredLinear3.H index 52e3d8ab51..08a31153b6 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/filteredLinear3/filteredLinear3.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/filteredLinear3/filteredLinear3.H @@ -24,6 +24,9 @@ License Class Foam::filteredLinear3Limiter +Group + grpFvLimitedSurfaceInterpolationSchemes + Description Class to generate weighting factors for the filteredLinear differencing scheme. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/limitWith/limitWith.H b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/limitWith/limitWith.H index 0c33e74d87..bb584c7565 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/limitWith/limitWith.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/limitWith/limitWith.H @@ -24,6 +24,9 @@ License Class Foam::limitWith +Group + grpFvLimitedSurfaceInterpolationSchemes + Description limitWith differencing scheme limits the specified scheme with the specified limiter. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/limitedCubic/limitedCubic.H b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/limitedCubic/limitedCubic.H index de85f2684b..c7ca594215 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/limitedCubic/limitedCubic.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/limitedCubic/limitedCubic.H @@ -24,6 +24,9 @@ License Class Foam::limitedCubicLimiter +Group + grpFvLimitedSurfaceInterpolationSchemes + Description Class with limiter function which returns the limiter for the TVD limited centred-cubic differencing scheme based on r obtained from diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/limitedLinear/limitedLinear.H b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/limitedLinear/limitedLinear.H index 260ab8271c..ede9b33ecd 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/limitedLinear/limitedLinear.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/limitedLinear/limitedLinear.H @@ -24,6 +24,9 @@ License Class Foam::limitedLinearLimiter +Group + grpFvLimitedSurfaceInterpolationSchemes + Description Class with limiter function which returns the limiter for the TVD limited linear differencing scheme based on r obtained from the diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/limitedSurfaceInterpolationScheme/limitedSurfaceInterpolationScheme.H b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/limitedSurfaceInterpolationScheme/limitedSurfaceInterpolationScheme.H index 322608fc99..048847a928 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/limitedSurfaceInterpolationScheme/limitedSurfaceInterpolationScheme.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/limitedSurfaceInterpolationScheme/limitedSurfaceInterpolationScheme.H @@ -24,6 +24,9 @@ License Class Foam::limitedSurfaceInterpolationScheme +Group + grpFvLimitedSurfaceInterpolationSchemes + Description Abstract base class for limited surface interpolation schemes. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/upwind/upwind.H b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/upwind/upwind.H index 65958ea8fa..30aa055539 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/upwind/upwind.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/upwind/upwind.H @@ -24,6 +24,9 @@ License Class Foam::upwind +Group + grpFvLimitedSurfaceInterpolationSchemes + Description Upwind differencing scheme class. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/vanAlbada/vanAlbada.H b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/vanAlbada/vanAlbada.H index 60552001b9..00162da46f 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/vanAlbada/vanAlbada.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/vanAlbada/vanAlbada.H @@ -24,6 +24,9 @@ License Class Foam::vanAlbadaLimiter +Group + grpFvLimitedSurfaceInterpolationSchemes + Description Class with limiter function which returns the limiter for the vanAlbada differencing scheme based on r obtained from the LimiterFunc diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/vanLeer/vanLeer.H b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/vanLeer/vanLeer.H index 8ea0d805b3..41fc31a6b7 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/vanLeer/vanLeer.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/vanLeer/vanLeer.H @@ -24,6 +24,9 @@ License Class Foam::vanLeerLimiter +Group + grpFvLimitedSurfaceInterpolationSchemes + Description Class with limiter function which returns the limiter for the vanLeer differencing scheme based on r obtained from the LimiterFunc diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/CentredFitScheme/CentredFitScheme.H b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/CentredFitScheme/CentredFitScheme.H index 8d6bd3a1f4..8c7d06dfd4 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/CentredFitScheme/CentredFitScheme.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/CentredFitScheme/CentredFitScheme.H @@ -24,6 +24,9 @@ License Class Foam::CentredFitScheme +Group + grpFvSurfaceInterpolationSchemes + Description Centred fit surface interpolation scheme which applies an explicit correction to linear. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/CoBlended/CoBlended.H b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/CoBlended/CoBlended.H index c2aa8498f9..c77882566a 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/CoBlended/CoBlended.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/CoBlended/CoBlended.H @@ -24,6 +24,9 @@ License Class Foam::CoBlended +Group + grpFvSurfaceInterpolationSchemes + Description Two-scheme Courant number based blending differencing scheme. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/LUST/LUST.H b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/LUST/LUST.H index 1c407f8a8c..0efaafd97a 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/LUST/LUST.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/LUST/LUST.H @@ -24,6 +24,9 @@ License Class Foam::LUST +Group + grpFvSurfaceInterpolationSchemes + Description LUST: Linear-upwind stabilised transport. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/PureUpwindFitScheme/PureUpwindFitScheme.H b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/PureUpwindFitScheme/PureUpwindFitScheme.H index 2070b5ae07..d0872f6c4b 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/PureUpwindFitScheme/PureUpwindFitScheme.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/PureUpwindFitScheme/PureUpwindFitScheme.H @@ -24,6 +24,9 @@ License Class Foam::PureUpwindFitScheme +Group + grpFvSurfaceInterpolationSchemes + Description Upwind biased fit surface interpolation scheme that applies an explicit correction to upwind. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/UpwindFitScheme/UpwindFitScheme.H b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/UpwindFitScheme/UpwindFitScheme.H index 62ff6b6603..25eaad30b0 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/UpwindFitScheme/UpwindFitScheme.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/UpwindFitScheme/UpwindFitScheme.H @@ -24,6 +24,9 @@ License Class Foam::UpwindFitScheme +Group + grpFvSurfaceInterpolationSchemes + Description Upwind biased fit surface interpolation scheme that applies an explicit correction to linear. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/cellCoBlended/cellCoBlended.H b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/cellCoBlended/cellCoBlended.H index 11e24700a4..3bf988e2ad 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/cellCoBlended/cellCoBlended.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/cellCoBlended/cellCoBlended.H @@ -24,6 +24,9 @@ License Class Foam::cellCoBlended +Group + grpFvSurfaceInterpolationSchemes + Description Two-scheme cell-based Courant number based blending differencing scheme. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/clippedLinear/clippedLinear.H b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/clippedLinear/clippedLinear.H index b704841a40..0365b5561f 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/clippedLinear/clippedLinear.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/clippedLinear/clippedLinear.H @@ -24,6 +24,9 @@ License Class Foam::clippedLinear +Group + grpFvSurfaceInterpolationSchemes + Description Central-differencing interpolation scheme using clipped-weights to improve stability on meshes with very rapid variations in cell size. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/cubic/cubic.H b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/cubic/cubic.H index b1148be4b7..4539f1b83a 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/cubic/cubic.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/cubic/cubic.H @@ -24,6 +24,9 @@ License Class Foam::cubic +Group + grpFvSurfaceInterpolationSchemes + Description Cubic interpolation scheme class derived from linear and returns linear weighting factors but also applies an explicit correction. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/downwind/downwind.H b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/downwind/downwind.H index ace1df9885..6b47c13750 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/downwind/downwind.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/downwind/downwind.H @@ -24,6 +24,9 @@ License Class Foam::downwind +Group + grpFvSurfaceInterpolationSchemes + Description Downwind differencing scheme class. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/fixedBlended/fixedBlended.H b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/fixedBlended/fixedBlended.H index d521157dad..848afe288f 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/fixedBlended/fixedBlended.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/fixedBlended/fixedBlended.H @@ -24,6 +24,9 @@ License Class Foam::fixedBlended +Group + grpFvSurfaceInterpolationSchemes + Description Two-scheme fixed-blending differencing scheme. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/harmonic/harmonic.H b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/harmonic/harmonic.H index 4dd2e87ba3..6131191320 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/harmonic/harmonic.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/harmonic/harmonic.H @@ -24,6 +24,9 @@ License Class Foam::harmonic +Group + grpFvSurfaceInterpolationSchemes + Description Harmonic-mean differencing scheme class. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/limiterBlended/limiterBlended.H b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/limiterBlended/limiterBlended.H index 169036e337..f710d31df2 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/limiterBlended/limiterBlended.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/limiterBlended/limiterBlended.H @@ -24,6 +24,9 @@ License Class Foam::limiterBlended +Group + grpFvSurfaceInterpolationSchemes + Description Blends two specified schemes using the limiter function provided by a limitedSurfaceInterpolationScheme. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/linear/linear.H b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/linear/linear.H index 99234939e7..bc0368ebed 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/linear/linear.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/linear/linear.H @@ -24,6 +24,9 @@ License Class Foam::linear +Group + grpFvSurfaceInterpolationSchemes + Description Central-differencing interpolation scheme class diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/linearUpwind/linearUpwind.H b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/linearUpwind/linearUpwind.H index 1ef0c000f7..f1da79b5e5 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/linearUpwind/linearUpwind.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/linearUpwind/linearUpwind.H @@ -24,6 +24,9 @@ License Class Foam::linearUpwind +Group + grpFvSurfaceInterpolationSchemes + Description linearUpwind interpolation scheme class derived from upwind and returns upwind weighting factors and also applies a gradient-based explicit diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/localBlended/localBlended.H b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/localBlended/localBlended.H index 0e85f0ea76..198ac85252 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/localBlended/localBlended.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/localBlended/localBlended.H @@ -24,6 +24,9 @@ License Class Foam::localBlended +Group + grpFvSurfaceInterpolationSchemes + Description Two-scheme localBlended differencing scheme. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/localMax/localMax.H b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/localMax/localMax.H index e6d5849bd4..a685e2eae9 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/localMax/localMax.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/localMax/localMax.H @@ -24,6 +24,9 @@ License Class Foam::localMax +Group + grpFvSurfaceInterpolationSchemes + Description LocalMax-mean differencing scheme class. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/localMin/localMin.H b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/localMin/localMin.H index 9cd25a8352..b858b7e1b7 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/localMin/localMin.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/localMin/localMin.H @@ -24,6 +24,9 @@ License Class Foam::localMin +Group + grpFvSurfaceInterpolationSchemes + Description LocalMin-mean differencing scheme class. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/midPoint/midPoint.H b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/midPoint/midPoint.H index 1841b832db..09174b18e7 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/midPoint/midPoint.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/midPoint/midPoint.H @@ -24,6 +24,9 @@ License Class Foam::midPoint +Group + grpFvSurfaceInterpolationSchemes + Description Mid-point interpolation (weighting factors = 0.5) scheme class. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/outletStabilised/outletStabilised.H b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/outletStabilised/outletStabilised.H index 2860aeb60e..77bdbacc33 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/outletStabilised/outletStabilised.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/outletStabilised/outletStabilised.H @@ -24,6 +24,9 @@ License Class Foam::outletStabilised +Group + grpFvSurfaceInterpolationSchemes + Description Outlet-stabilised interpolation scheme which applies upwind differencing to the faces of the cells adjacent to outlets. @@ -53,7 +56,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class outletStabilised Declaration + Class outletStabilised Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/pointLinear/pointLinear.H b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/pointLinear/pointLinear.H index e95997d55d..4aa43e3930 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/pointLinear/pointLinear.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/pointLinear/pointLinear.H @@ -24,6 +24,9 @@ License Class Foam::pointLinear +Group + grpFvSurfaceInterpolationSchemes + Description Face-point interpolation scheme class derived from linear and returns linear weighting factors but also applies an explicit correction. diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/reverseLinear/reverseLinear.H b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/reverseLinear/reverseLinear.H index 3f3cae05fe..02a0830f1b 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/reverseLinear/reverseLinear.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/reverseLinear/reverseLinear.H @@ -24,6 +24,9 @@ License Class Foam::reverseLinear +Group + grpFvSurfaceInterpolationSchemes + Description Inversed weight central-differencing interpolation scheme class. @@ -46,7 +49,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class reverseLinear Declaration + Class reverseLinear Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/skewCorrected/skewCorrected.H b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/skewCorrected/skewCorrected.H index 2adde6c23e..d91c0732d3 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/skewCorrected/skewCorrected.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/skewCorrected/skewCorrected.H @@ -24,6 +24,9 @@ License Class Foam::skewCorrected +Group + grpFvSurfaceInterpolationSchemes + Description Skewness-corrected interpolation scheme that applies an explicit correction to given scheme. @@ -47,7 +50,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class skewCorrected Declaration + Class skewCorrected Declaration \*---------------------------------------------------------------------------*/ template diff --git a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/weighted/weighted.H b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/weighted/weighted.H index b131a93843..f390d81751 100644 --- a/src/finiteVolume/interpolation/surfaceInterpolation/schemes/weighted/weighted.H +++ b/src/finiteVolume/interpolation/surfaceInterpolation/schemes/weighted/weighted.H @@ -24,6 +24,9 @@ License Class Foam::weighted +Group + grpFvSurfaceInterpolationSchemes + Description Interpolation scheme class using weights looked-up from the objectRegistry. diff --git a/src/lagrangian/coalCombustion/submodels/surfaceReactionModel/COxidationDiffusionLimitedRate/COxidationDiffusionLimitedRate.H b/src/lagrangian/coalCombustion/submodels/surfaceReactionModel/COxidationDiffusionLimitedRate/COxidationDiffusionLimitedRate.H index 26a741062c..1feef63a8f 100644 --- a/src/lagrangian/coalCombustion/submodels/surfaceReactionModel/COxidationDiffusionLimitedRate/COxidationDiffusionLimitedRate.H +++ b/src/lagrangian/coalCombustion/submodels/surfaceReactionModel/COxidationDiffusionLimitedRate/COxidationDiffusionLimitedRate.H @@ -24,6 +24,9 @@ License Class Foam::COxidationDiffusionLimitedRate +Group + grpLagrangianIntermediateSurfaceReactionSubModels + Description Diffusion limited rate surface reaction model for coal parcels. Limited to: diff --git a/src/lagrangian/coalCombustion/submodels/surfaceReactionModel/COxidationHurtMitchell/COxidationHurtMitchell.H b/src/lagrangian/coalCombustion/submodels/surfaceReactionModel/COxidationHurtMitchell/COxidationHurtMitchell.H index 08e20f74c8..e3ba7db16c 100644 --- a/src/lagrangian/coalCombustion/submodels/surfaceReactionModel/COxidationHurtMitchell/COxidationHurtMitchell.H +++ b/src/lagrangian/coalCombustion/submodels/surfaceReactionModel/COxidationHurtMitchell/COxidationHurtMitchell.H @@ -24,6 +24,9 @@ License Class Foam::COxidationHurtMitchell +Group + grpLagrangianIntermediateSurfaceReactionSubModels + Description Char oxidation model given by Hurt and Mitchell: diff --git a/src/lagrangian/coalCombustion/submodels/surfaceReactionModel/COxidationIntrinsicRate/COxidationIntrinsicRate.H b/src/lagrangian/coalCombustion/submodels/surfaceReactionModel/COxidationIntrinsicRate/COxidationIntrinsicRate.H index ead8d85d26..e820f45dee 100644 --- a/src/lagrangian/coalCombustion/submodels/surfaceReactionModel/COxidationIntrinsicRate/COxidationIntrinsicRate.H +++ b/src/lagrangian/coalCombustion/submodels/surfaceReactionModel/COxidationIntrinsicRate/COxidationIntrinsicRate.H @@ -24,6 +24,9 @@ License Class Foam::COxidationIntrinsicRate +Group + grpLagrangianIntermediateSurfaceReactionSubModels + Description Intrinsic char surface reaction mndel diff --git a/src/lagrangian/coalCombustion/submodels/surfaceReactionModel/COxidationKineticDiffusionLimitedRate/COxidationKineticDiffusionLimitedRate.H b/src/lagrangian/coalCombustion/submodels/surfaceReactionModel/COxidationKineticDiffusionLimitedRate/COxidationKineticDiffusionLimitedRate.H index a57c847799..c7ffd6c430 100644 --- a/src/lagrangian/coalCombustion/submodels/surfaceReactionModel/COxidationKineticDiffusionLimitedRate/COxidationKineticDiffusionLimitedRate.H +++ b/src/lagrangian/coalCombustion/submodels/surfaceReactionModel/COxidationKineticDiffusionLimitedRate/COxidationKineticDiffusionLimitedRate.H @@ -24,6 +24,9 @@ License Class Foam::COxidationKineticDiffusionLimitedRate +Group + grpLagrangianIntermediateSurfaceReactionSubModels + Description Kinetic/diffusion limited rate surface reaction model for coal parcels. Limited to: diff --git a/src/lagrangian/coalCombustion/submodels/surfaceReactionModel/COxidationMurphyShaddix/COxidationMurphyShaddix.H b/src/lagrangian/coalCombustion/submodels/surfaceReactionModel/COxidationMurphyShaddix/COxidationMurphyShaddix.H index 95dd8b2bce..2cb5ccf052 100644 --- a/src/lagrangian/coalCombustion/submodels/surfaceReactionModel/COxidationMurphyShaddix/COxidationMurphyShaddix.H +++ b/src/lagrangian/coalCombustion/submodels/surfaceReactionModel/COxidationMurphyShaddix/COxidationMurphyShaddix.H @@ -24,6 +24,9 @@ License Class Foam::COxidationMurphyShaddix +Group + grpLagrangianIntermediateSurfaceReactionSubModels + Description Limited to C(s) + O2 -> CO2 diff --git a/src/lagrangian/intermediate/clouds/Templates/CollidingCloud/CollidingCloud.H b/src/lagrangian/intermediate/clouds/Templates/CollidingCloud/CollidingCloud.H index ceac587e93..0456f1f99d 100644 --- a/src/lagrangian/intermediate/clouds/Templates/CollidingCloud/CollidingCloud.H +++ b/src/lagrangian/intermediate/clouds/Templates/CollidingCloud/CollidingCloud.H @@ -24,6 +24,9 @@ License Class Foam::CollidingCloud +Group + grpLagrangianIntermediateClouds + Description Adds coolisions to kinematic clouds diff --git a/src/lagrangian/intermediate/clouds/Templates/KinematicCloud/KinematicCloud.H b/src/lagrangian/intermediate/clouds/Templates/KinematicCloud/KinematicCloud.H index 9c2a75157b..69cb4836c0 100644 --- a/src/lagrangian/intermediate/clouds/Templates/KinematicCloud/KinematicCloud.H +++ b/src/lagrangian/intermediate/clouds/Templates/KinematicCloud/KinematicCloud.H @@ -24,6 +24,9 @@ License Class Foam::KinematicCloud +Group + grpLagrangianIntermediateClouds + Description Templated base class for kinematic cloud diff --git a/src/lagrangian/intermediate/clouds/Templates/MPPICCloud/MPPICCloud.H b/src/lagrangian/intermediate/clouds/Templates/MPPICCloud/MPPICCloud.H index 8583f6b739..08abb75f4e 100644 --- a/src/lagrangian/intermediate/clouds/Templates/MPPICCloud/MPPICCloud.H +++ b/src/lagrangian/intermediate/clouds/Templates/MPPICCloud/MPPICCloud.H @@ -24,6 +24,9 @@ License Class Foam::MPPICCloud +Group + grpLagrangianIntermediateClouds + Description Adds MPPIC modelling to kinematic clouds diff --git a/src/lagrangian/intermediate/clouds/Templates/ReactingCloud/ReactingCloud.H b/src/lagrangian/intermediate/clouds/Templates/ReactingCloud/ReactingCloud.H index ed7d0202cb..5252fdd97e 100644 --- a/src/lagrangian/intermediate/clouds/Templates/ReactingCloud/ReactingCloud.H +++ b/src/lagrangian/intermediate/clouds/Templates/ReactingCloud/ReactingCloud.H @@ -24,6 +24,9 @@ License Class Foam::ReactingCloud +Group + grpLagrangianIntermediateClouds + Description Templated base class for reacting cloud diff --git a/src/lagrangian/intermediate/clouds/Templates/ReactingMultiphaseCloud/ReactingMultiphaseCloud.H b/src/lagrangian/intermediate/clouds/Templates/ReactingMultiphaseCloud/ReactingMultiphaseCloud.H index de157da343..ed7155fd30 100644 --- a/src/lagrangian/intermediate/clouds/Templates/ReactingMultiphaseCloud/ReactingMultiphaseCloud.H +++ b/src/lagrangian/intermediate/clouds/Templates/ReactingMultiphaseCloud/ReactingMultiphaseCloud.H @@ -24,6 +24,9 @@ License Class Foam::ReactingMultiphaseCloud +Group + grpLagrangianIntermediateClouds + Description Templated base class for multiphase reacting cloud diff --git a/src/lagrangian/intermediate/clouds/Templates/ThermoCloud/ThermoCloud.H b/src/lagrangian/intermediate/clouds/Templates/ThermoCloud/ThermoCloud.H index 4f858d6643..968ca2067d 100644 --- a/src/lagrangian/intermediate/clouds/Templates/ThermoCloud/ThermoCloud.H +++ b/src/lagrangian/intermediate/clouds/Templates/ThermoCloud/ThermoCloud.H @@ -24,6 +24,9 @@ License Class Foam::ThermoCloud +Group + grpLagrangianIntermediateClouds + Description Templated base class for thermodynamic cloud diff --git a/src/lagrangian/intermediate/doc/finiteVolumeSchemesDoc.H b/src/lagrangian/intermediate/doc/finiteVolumeSchemesDoc.H new file mode 100644 index 0000000000..238d0a0a5b --- /dev/null +++ b/src/lagrangian/intermediate/doc/finiteVolumeSchemesDoc.H @@ -0,0 +1,220 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2016 OpenCFD Ltd. + \\/ 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 grpLagrangianIntermediate Lagrangian particle modelling +@{ + This group contains Lagrangian modelling available in the 'intermediate' library +@} + +\defgroup grpLagrangianIntermediateClouds Clouds +@{ + \ingroup grpLagrangianIntermediate + This group contains Lagrangian clouds +@} + +\defgroup grpLagrangianIntermediateParcels Parcels +@{ + \ingroup grpLagrangianIntermediate + This group contains Lagrangian parcels +@} + +// Submodels +\defgroup grpLagrangianIntermediateSubModels Submodels +@{ + \ingroup grpLagrangianIntermediate + This group contains Lagrangian parcel submodels +@} + +\defgroup grpLagrangianIntermediateKinematicSubModels Kinematic +@{ + \ingroup grpLagrangianIntermediateSubModels + This group contains Lagrangian kinematic parcel submodels +@} + +\defgroup grpLagrangianIntermediateThermoSubModels Thermodynamic +@{ + \ingroup grpLagrangianIntermediateSubModels + This group contains Lagrangian thermo parcel submodels +@} + +\defgroup grpLagrangianIntermediateReactingSubModels Reacting +@{ + \ingroup grpLagrangianIntermediateSubModels + This group contains Lagrangian reacting parcel submodels +@} + +\defgroup grpLagrangianIntermediateReactingMultiphaseSubModels Reacting multiphase +@{ + \ingroup grpLagrangianIntermediateSubModels + This group contains Lagrangian reacting multiphase parcel submodels +@} + +\defgroup grpLagrangianIntermediateMPPICSubModels MP-PIC +@{ + \ingroup grpLagrangianIntermediateSubModels + This group contains Lagrangian MP-PIC parcel submodels +@} + + +// Kinematic parcel sub models +\defgroup grpLagrangianIntermediateCollisionSubModels Collision +@{ + \ingroup grpLagrangianIntermediateKinematicSubModels + This group contains Lagrangian particle collision submodes +@} + +\defgroup grpLagrangianIntermediateDispersionSubModels Dispersion +@{ + \ingroup grpLagrangianIntermediateKinematicSubModels + This group contains Lagrangian particle dispersion submodes +@} + +\defgroup grpLagrangianIntermediateInjectionSubModels Injection +@{ + \ingroup grpLagrangianIntermediateKinematicSubModels + This group contains Lagrangian particle injection submodes +@} + +\defgroup grpLagrangianIntermediateForceSubModels Forces +@{ + \ingroup grpLagrangianIntermediateKinematicSubModels + This group contains Lagrangian particle force submodels +@} + +\defgroup grpLagrangianIntermediatePatchInteractionSubModels Patch interaction +@{ + \ingroup grpLagrangianIntermediateKinematicSubModels + This group contains Lagrangian particle patch interaction submodels +@} + +\defgroup grpLagrangianIntermediateSurfaceFilmSubModels Surface film +@{ + \ingroup grpLagrangianIntermediateKinematicSubModels + This group contains Lagrangian particle patch interaction submodels +@} + + +// Thermo parcel submodels +\defgroup grpLagrangianIntermediateHeatTransferSubModels Heat transfer +@{ + \ingroup grpLagrangianIntermediateThermoSubModels + This group contains Lagrangian particle heat transfer submodels +@} + + +// Reacting parcel submodels +\defgroup grpLagrangianIntermediateCompositionSubModels Composition +@{ + \ingroup grpLagrangianIntermediateReactingSubModels + This group contains Lagrangian particle composition submodels +@} + +\defgroup grpLagrangianIntermediatePhaseChangeSubModels Phase change +@{ + \ingroup grpLagrangianIntermediateReactingSubModels + This group contains Lagrangian particle phase change submodels +@} + +// Spray parcel submodels (Spray derived from Reacting) +\defgroup grpLagrangianIntermediateAtomizationSubModels Atomization +@{ + \ingroup grpLagrangianIntermediateReactingSubModels + This group contains Lagrangian particle atomization submodels +@} + +\defgroup grpLagrangianIntermediateBreakupSubModels Breakup +@{ + \ingroup grpLagrangianIntermediateReactingSubModels + This group contains Lagrangian particle breakup submodels +@} + + +// Reacting multiphase parcel submodels +\defgroup grpLagrangianIntermediateDevolatilisationSubModels Devolatilisation +@{ + \ingroup grpLagrangianIntermediateReactingMultiphaseSubModels + This group contains Lagrangian particle devolatilisation submodels +@} + +\defgroup grpLagrangianIntermediateSurfaceReactionSubModels Surface reaction +@{ + \ingroup grpLagrangianIntermediateReactingMultiphaseSubModels + This group contains Lagrangian particle surface reaction submodels +@} + + +// MP-PIC parcel submodels +\defgroup grpLagrangianIntermediateMPPICAveragingMethods Averaging +@{ + \ingroup grpLagrangianIntermediateMPPICSubModels + This group contains Lagrangian MP-PIC particle averaging methods +@} + +\defgroup grpLagrangianIntermediateMPPICCorrectionLimitingMethods Correction limiting +@{ + \ingroup grpLagrangianIntermediateMPPICSubModels + This group contains Lagrangian MP-PIC particle correction limiting methods +@} + +\defgroup grpLagrangianIntermediateMPPICDampingSubModels Damping +@{ + \ingroup grpLagrangianIntermediateMPPICSubModels + This group contains Lagrangian MP-PIC particle damping submodels +@} + +\defgroup grpLagrangianIntermediateMPPICIsotropySubModels Isotropy +@{ + \ingroup grpLagrangianIntermediateMPPICSubModels + This group contains Lagrangian MP-PIC particle isotropy submodels +@} + +\defgroup grpLagrangianIntermediateMPPICPackingSubModels Packing +@{ + \ingroup grpLagrangianIntermediateMPPICSubModels + This group contains Lagrangian MP-PIC particle packing submodels +@} + +\defgroup grpLagrangianIntermediateMPPICParticleStressSubModels Particle stress +@{ + \ingroup grpLagrangianIntermediateMPPICSubModels + This group contains Lagrangian MP-PIC particle stress submodels +@} + +\defgroup grpLagrangianIntermediateMPPICTimeScaleSubModels Time scale +@{ + \ingroup grpLagrangianIntermediateMPPICSubModels + This group contains Lagrangian MP-PIC particle time scale submodels +@} + + +// Function objects +\defgroup grpLagrangianIntermediateFunctionObjects Function objects +@{ + \ingroup grpLagrangianIntermediateSubModels + This group contains Lagrangian function objects +@} + + +\*---------------------------------------------------------------------------*/ diff --git a/src/lagrangian/intermediate/parcels/Templates/CollidingParcel/CollidingParcel.H b/src/lagrangian/intermediate/parcels/Templates/CollidingParcel/CollidingParcel.H index ae98aae256..2dfe186a1d 100644 --- a/src/lagrangian/intermediate/parcels/Templates/CollidingParcel/CollidingParcel.H +++ b/src/lagrangian/intermediate/parcels/Templates/CollidingParcel/CollidingParcel.H @@ -24,6 +24,9 @@ License Class Foam::CollidingParcel +Group + grpLagrangianIntermediateParcels + Description Wrapper around kinematic parcel types to add collision modelling diff --git a/src/lagrangian/intermediate/parcels/Templates/KinematicParcel/KinematicParcel.H b/src/lagrangian/intermediate/parcels/Templates/KinematicParcel/KinematicParcel.H index 85d48c5982..c595d59ee7 100644 --- a/src/lagrangian/intermediate/parcels/Templates/KinematicParcel/KinematicParcel.H +++ b/src/lagrangian/intermediate/parcels/Templates/KinematicParcel/KinematicParcel.H @@ -24,6 +24,9 @@ License Class Foam::KinematicParcel +Group + grpLagrangianIntermediateParcels + Description Kinematic parcel class with rotational motion (as spherical particles only) and one/two-way coupling with the continuous diff --git a/src/lagrangian/intermediate/parcels/Templates/MPPICParcel/MPPICParcel.H b/src/lagrangian/intermediate/parcels/Templates/MPPICParcel/MPPICParcel.H index b4d6573ea4..aad6de5494 100644 --- a/src/lagrangian/intermediate/parcels/Templates/MPPICParcel/MPPICParcel.H +++ b/src/lagrangian/intermediate/parcels/Templates/MPPICParcel/MPPICParcel.H @@ -24,6 +24,9 @@ License Class Foam::MPPICParcel +Group + grpLagrangianIntermediateParcels + Description Wrapper around kinematic parcel types to add MPPIC modelling diff --git a/src/lagrangian/intermediate/parcels/Templates/ReactingMultiphaseParcel/ReactingMultiphaseParcel.H b/src/lagrangian/intermediate/parcels/Templates/ReactingMultiphaseParcel/ReactingMultiphaseParcel.H index 4539dc3cb2..ab7c55ef1e 100644 --- a/src/lagrangian/intermediate/parcels/Templates/ReactingMultiphaseParcel/ReactingMultiphaseParcel.H +++ b/src/lagrangian/intermediate/parcels/Templates/ReactingMultiphaseParcel/ReactingMultiphaseParcel.H @@ -24,6 +24,9 @@ License Class Foam::ReactingMultiphaseParcel +Group + grpLagrangianIntermediateParcels + Description Multiphase variant of the reacting parcel class with one/two-way coupling with the continuous phase. diff --git a/src/lagrangian/intermediate/parcels/Templates/ReactingParcel/ReactingParcel.H b/src/lagrangian/intermediate/parcels/Templates/ReactingParcel/ReactingParcel.H index c077a29bb4..696914f887 100644 --- a/src/lagrangian/intermediate/parcels/Templates/ReactingParcel/ReactingParcel.H +++ b/src/lagrangian/intermediate/parcels/Templates/ReactingParcel/ReactingParcel.H @@ -24,6 +24,9 @@ License Class Foam::ReactingParcel +Group + grpLagrangianIntermediateParcels + Description Reacting parcel class with one/two-way coupling with the continuous phase. diff --git a/src/lagrangian/intermediate/parcels/Templates/ThermoParcel/ThermoParcel.H b/src/lagrangian/intermediate/parcels/Templates/ThermoParcel/ThermoParcel.H index 47424b0820..a1d7309495 100644 --- a/src/lagrangian/intermediate/parcels/Templates/ThermoParcel/ThermoParcel.H +++ b/src/lagrangian/intermediate/parcels/Templates/ThermoParcel/ThermoParcel.H @@ -24,6 +24,9 @@ License Class Foam::ThermoParcel +Group + grpLagrangianIntermediateParcels + Description Thermodynamic parcel class with one/two-way coupling with the continuous phase. Includes Kinematic parcel sub-models, plus: diff --git a/src/lagrangian/intermediate/submodels/CloudFunctionObjects/CloudFunctionObject/CloudFunctionObject.H b/src/lagrangian/intermediate/submodels/CloudFunctionObjects/CloudFunctionObject/CloudFunctionObject.H index 523f818e06..47b18aab87 100644 --- a/src/lagrangian/intermediate/submodels/CloudFunctionObjects/CloudFunctionObject/CloudFunctionObject.H +++ b/src/lagrangian/intermediate/submodels/CloudFunctionObjects/CloudFunctionObject/CloudFunctionObject.H @@ -24,6 +24,9 @@ License Class Foam::CloudFunctionObject +Group + grpLagrangianIntermediateFunctionObjects + Description Templated cloud function object base class diff --git a/src/lagrangian/intermediate/submodels/CloudFunctionObjects/CloudToVTK/CloudToVTK.H b/src/lagrangian/intermediate/submodels/CloudFunctionObjects/CloudToVTK/CloudToVTK.H index 13a68f1879..0bea2f58ad 100644 --- a/src/lagrangian/intermediate/submodels/CloudFunctionObjects/CloudToVTK/CloudToVTK.H +++ b/src/lagrangian/intermediate/submodels/CloudFunctionObjects/CloudToVTK/CloudToVTK.H @@ -24,6 +24,9 @@ License Class Foam::CloudToVTK +Group + grpLagrangianIntermediateFunctionObjects + Description Write cloud data in VTK format diff --git a/src/lagrangian/intermediate/submodels/CloudFunctionObjects/FacePostProcessing/FacePostProcessing.H b/src/lagrangian/intermediate/submodels/CloudFunctionObjects/FacePostProcessing/FacePostProcessing.H index 4db5ed16b2..ff022916b8 100644 --- a/src/lagrangian/intermediate/submodels/CloudFunctionObjects/FacePostProcessing/FacePostProcessing.H +++ b/src/lagrangian/intermediate/submodels/CloudFunctionObjects/FacePostProcessing/FacePostProcessing.H @@ -24,6 +24,9 @@ License Class Foam::FacePostProcessing +Group + grpLagrangianIntermediateFunctionObjects + Description Records particle face quantities on used-specified face zone diff --git a/src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleCollector/ParticleCollector.H b/src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleCollector/ParticleCollector.H index e7ed170e97..fd0667c73c 100644 --- a/src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleCollector/ParticleCollector.H +++ b/src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleCollector/ParticleCollector.H @@ -24,6 +24,9 @@ License Class Foam::ParticleCollector +Group + grpLagrangianIntermediateFunctionObjects + Description Function object to collect the parcel mass- and mass flow rate over a set of polygons. The polygons can either be specified by sets of user- diff --git a/src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleErosion/ParticleErosion.H b/src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleErosion/ParticleErosion.H index 5e4e0db1cb..1eb9162356 100644 --- a/src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleErosion/ParticleErosion.H +++ b/src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleErosion/ParticleErosion.H @@ -24,6 +24,9 @@ License Class Foam::ParticleErosion +Group + grpLagrangianIntermediateFunctionObjects + Description Creates particle erosion field, Q diff --git a/src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleTracks/ParticleTracks.H b/src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleTracks/ParticleTracks.H index 4bf65edd53..e5da2e197f 100644 --- a/src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleTracks/ParticleTracks.H +++ b/src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleTracks/ParticleTracks.H @@ -24,6 +24,9 @@ License Class Foam::ParticleTracks +Group + grpLagrangianIntermediateFunctionObjects + Description Records particle state (all variables) on each call to postFace diff --git a/src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleTrap/ParticleTrap.H b/src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleTrap/ParticleTrap.H index fc03b0c91a..3a5222aed9 100644 --- a/src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleTrap/ParticleTrap.H +++ b/src/lagrangian/intermediate/submodels/CloudFunctionObjects/ParticleTrap/ParticleTrap.H @@ -24,6 +24,9 @@ License Class Foam::ParticleTrap +Group + grpLagrangianIntermediateFunctionObjects + Description Traps particles within a given phase fraction for multi-phase cases diff --git a/src/lagrangian/intermediate/submodels/CloudFunctionObjects/PatchPostProcessing/PatchPostProcessing.H b/src/lagrangian/intermediate/submodels/CloudFunctionObjects/PatchPostProcessing/PatchPostProcessing.H index 9b023a87e2..c5134e685f 100644 --- a/src/lagrangian/intermediate/submodels/CloudFunctionObjects/PatchPostProcessing/PatchPostProcessing.H +++ b/src/lagrangian/intermediate/submodels/CloudFunctionObjects/PatchPostProcessing/PatchPostProcessing.H @@ -24,6 +24,9 @@ License Class Foam::PatchPostProcessing +Group + grpLagrangianIntermediateFunctionObjects + Description Standard post-processing diff --git a/src/lagrangian/intermediate/submodels/CloudFunctionObjects/VoidFraction/VoidFraction.H b/src/lagrangian/intermediate/submodels/CloudFunctionObjects/VoidFraction/VoidFraction.H index a5fb87265f..7050cc39e1 100644 --- a/src/lagrangian/intermediate/submodels/CloudFunctionObjects/VoidFraction/VoidFraction.H +++ b/src/lagrangian/intermediate/submodels/CloudFunctionObjects/VoidFraction/VoidFraction.H @@ -24,6 +24,9 @@ License Class Foam::VoidFraction +Group + grpLagrangianIntermediateFunctionObjects + Description Creates particle void fraction field on carrier phase diff --git a/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/CollisionModel/CollisionModel.H b/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/CollisionModel/CollisionModel.H index 9134745f62..c84ed10ba2 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/CollisionModel/CollisionModel.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/CollisionModel/CollisionModel.H @@ -24,6 +24,9 @@ License Class Foam::CollisionModel +Group + grpLagrangianIntermediateCollisionSubModels + Description Templated collision model class. diff --git a/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/NoCollision/NoCollision.H b/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/NoCollision/NoCollision.H index 95b029f6d8..887bf5258a 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/NoCollision/NoCollision.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/NoCollision/NoCollision.H @@ -24,6 +24,9 @@ License Class Foam::NoCollision +Group + grpLagrangianIntermediateCollisionSubModels + Description Place holder for 'none' option diff --git a/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/PairCollision.H b/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/PairCollision.H index d17e0af9c7..61c8fc919a 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/PairCollision.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/CollisionModel/PairCollision/PairCollision.H @@ -24,6 +24,9 @@ License Class Foam::PairCollision +Group + grpLagrangianIntermediateCollisionSubModels + Description SourceFiles diff --git a/src/lagrangian/intermediate/submodels/Kinematic/DispersionModel/DispersionModel/DispersionModel.H b/src/lagrangian/intermediate/submodels/Kinematic/DispersionModel/DispersionModel/DispersionModel.H index 1af0caeb51..5f38eb8247 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/DispersionModel/DispersionModel/DispersionModel.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/DispersionModel/DispersionModel/DispersionModel.H @@ -24,7 +24,11 @@ License Class Foam::DispersionModel +Group + grpLagrangianIntermediateDispersionSubModels + Description + Base class for dispersion modelling \*---------------------------------------------------------------------------*/ diff --git a/src/lagrangian/intermediate/submodels/Kinematic/DispersionModel/NoDispersion/NoDispersion.H b/src/lagrangian/intermediate/submodels/Kinematic/DispersionModel/NoDispersion/NoDispersion.H index 887c1b02f9..926ccd9dd6 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/DispersionModel/NoDispersion/NoDispersion.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/DispersionModel/NoDispersion/NoDispersion.H @@ -24,6 +24,9 @@ License Class Foam::NoDispersion +Group + grpLagrangianIntermediateDispersionSubModels + Description Place holder for 'none' option diff --git a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/CellZoneInjection/CellZoneInjection.H b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/CellZoneInjection/CellZoneInjection.H index ece119404d..63022867ba 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/CellZoneInjection/CellZoneInjection.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/CellZoneInjection/CellZoneInjection.H @@ -24,6 +24,9 @@ License Class Foam::CellZoneInjection +Group + grpLagrangianIntermediateInjectionSubModels + Description Injection positions specified by a particle number density within a cell set diff --git a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeInjection/ConeInjection.H b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeInjection/ConeInjection.H index 56519243e4..1413376d81 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeInjection/ConeInjection.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeInjection/ConeInjection.H @@ -24,6 +24,9 @@ License Class Foam::ConeInjection +Group + grpLagrangianIntermediateInjectionSubModels + Description Multi-point cone injection model diff --git a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeNozzleInjection/ConeNozzleInjection.H b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeNozzleInjection/ConeNozzleInjection.H index 9490c31128..47589429ca 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeNozzleInjection/ConeNozzleInjection.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ConeNozzleInjection/ConeNozzleInjection.H @@ -24,6 +24,9 @@ License Class Foam::ConeNozzleInjection +Group + grpLagrangianIntermediateInjectionSubModels + Description Cone injection diff --git a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/FieldActivatedInjection/FieldActivatedInjection.H b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/FieldActivatedInjection/FieldActivatedInjection.H index 8e7c7d682d..8ee67b1068 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/FieldActivatedInjection/FieldActivatedInjection.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/FieldActivatedInjection/FieldActivatedInjection.H @@ -24,6 +24,9 @@ License Class Foam::FieldActivatedInjection +Group + grpLagrangianIntermediateInjectionSubModels + Description Conditional injection at specified positions. diff --git a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/InflationInjection/InflationInjection.H b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/InflationInjection/InflationInjection.H index 8d3dd8dcc7..e55c7290c5 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/InflationInjection/InflationInjection.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/InflationInjection/InflationInjection.H @@ -24,6 +24,9 @@ License Class Foam::InflationInjection +Group + grpLagrangianIntermediateInjectionSubModels + Description Inflation injection - creates new particles by splitting existing particles within in a set of generation cells, then inflating them diff --git a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/InjectionModel/InjectionModel.H b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/InjectionModel/InjectionModel.H index fc0e285608..abf18afd2e 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/InjectionModel/InjectionModel.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/InjectionModel/InjectionModel.H @@ -24,6 +24,9 @@ License Class Foam::InjectionModel +Group + grpLagrangianIntermediateInjectionSubModels + Description Templated injection model class. diff --git a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/KinematicLookupTableInjection/KinematicLookupTableInjection.H b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/KinematicLookupTableInjection/KinematicLookupTableInjection.H index f17410bc1d..e6d744cefd 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/KinematicLookupTableInjection/KinematicLookupTableInjection.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/KinematicLookupTableInjection/KinematicLookupTableInjection.H @@ -24,6 +24,9 @@ License Class Foam::KinematicLookupTableInjection +Group + grpLagrangianIntermediateInjectionSubModels + Description Particle injection sources read from look-up table. Each row corresponds to an injection site. diff --git a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ManualInjection/ManualInjection.H b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ManualInjection/ManualInjection.H index c9a91e8be6..9427687781 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ManualInjection/ManualInjection.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/ManualInjection/ManualInjection.H @@ -24,6 +24,9 @@ License Class Foam::ManualInjection +Group + grpLagrangianIntermediateInjectionSubModels + Description Manual injection diff --git a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/NoInjection/NoInjection.H b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/NoInjection/NoInjection.H index 938e8cfad2..048084caf0 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/NoInjection/NoInjection.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/NoInjection/NoInjection.H @@ -24,6 +24,9 @@ License Class Foam::NoInjection +Group + grpLagrangianIntermediateInjectionSubModels + Description Place holder for 'none' option diff --git a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/PatchFlowRateInjection/PatchFlowRateInjection.H b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/PatchFlowRateInjection/PatchFlowRateInjection.H index 72ea50e261..d6c7bf2a32 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/PatchFlowRateInjection/PatchFlowRateInjection.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/PatchFlowRateInjection/PatchFlowRateInjection.H @@ -24,6 +24,9 @@ License Class Foam::PatchFlowRateInjection +Group + grpLagrangianIntermediateInjectionSubModels + Description Patch injection - uses patch flow rate to determine concentration and velociy diff --git a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/PatchInjection/PatchInjection.H b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/PatchInjection/PatchInjection.H index e32b291851..785e069ec9 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/PatchInjection/PatchInjection.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/PatchInjection/PatchInjection.H @@ -24,6 +24,9 @@ License Class Foam::PatchInjection +Group + grpLagrangianIntermediateInjectionSubModels + Description Patch injection diff --git a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Drag/DistortedSphereDrag/DistortedSphereDragForce.H b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Drag/DistortedSphereDrag/DistortedSphereDragForce.H index eb9dd62d5d..8bf6915f39 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Drag/DistortedSphereDrag/DistortedSphereDragForce.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Drag/DistortedSphereDrag/DistortedSphereDragForce.H @@ -24,6 +24,9 @@ License Class Foam::DistortedSphereDragForce +Group + grpLagrangianIntermediateForceSubModels + Description Drag model based on assumption of distorted spheres according to: diff --git a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Drag/ErgunWenYuDrag/ErgunWenYuDragForce.H b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Drag/ErgunWenYuDrag/ErgunWenYuDragForce.H index 1d10ea6b42..200ca2f9ca 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Drag/ErgunWenYuDrag/ErgunWenYuDragForce.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Drag/ErgunWenYuDrag/ErgunWenYuDragForce.H @@ -24,6 +24,9 @@ License Class Foam::ErgunWenYuDragForce +Group + grpLagrangianIntermediateForceSubModels + Description Ergun-Wen-Yu drag model for solid spheres. diff --git a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Drag/NonSphereDrag/NonSphereDragForce.H b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Drag/NonSphereDrag/NonSphereDragForce.H index 3655ec78cb..e3b303f836 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Drag/NonSphereDrag/NonSphereDragForce.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Drag/NonSphereDrag/NonSphereDragForce.H @@ -24,6 +24,9 @@ License Class Foam::NonSphereDragForce +Group + grpLagrangianIntermediateForceSubModels + Description Drag model for non-spherical particles. diff --git a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Drag/PlessisMasliyahDrag/PlessisMasliyahDragForce.H b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Drag/PlessisMasliyahDrag/PlessisMasliyahDragForce.H index 5bd9be8e45..e0e668037e 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Drag/PlessisMasliyahDrag/PlessisMasliyahDragForce.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Drag/PlessisMasliyahDrag/PlessisMasliyahDragForce.H @@ -24,6 +24,9 @@ License Class Foam::PlessisMasliyahDragForce +Group + grpLagrangianIntermediateForceSubModels + Description PlessisMasliyahDragForce drag model for solid spheres. diff --git a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Drag/SphereDrag/SphereDragForce.H b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Drag/SphereDrag/SphereDragForce.H index 6b2a084f0b..bbb1a8d264 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Drag/SphereDrag/SphereDragForce.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Drag/SphereDrag/SphereDragForce.H @@ -24,6 +24,9 @@ License Class Foam::SphereDragForce +Group + grpLagrangianIntermediateForceSubModels + Description Drag model based on assumption of solid spheres diff --git a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Drag/WenYuDrag/WenYuDragForce.H b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Drag/WenYuDrag/WenYuDragForce.H index 46a6ff5e19..89be847a82 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Drag/WenYuDrag/WenYuDragForce.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Drag/WenYuDrag/WenYuDragForce.H @@ -24,6 +24,9 @@ License Class Foam::WenYuDragForce +Group + grpLagrangianIntermediateForceSubModels + Description Wen-Yu drag model for solid spheres. diff --git a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Gravity/GravityForce.H b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Gravity/GravityForce.H index cfb2017794..8e988f9ca5 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Gravity/GravityForce.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Gravity/GravityForce.H @@ -24,6 +24,9 @@ License Class Foam::GravityForce +Group + grpLagrangianIntermediateForceSubModels + Description Calculates particle gravity force diff --git a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/LiftForce/LiftForce.H b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/LiftForce/LiftForce.H index 13cab0ac54..b31cd90e0e 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/LiftForce/LiftForce.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/LiftForce/LiftForce.H @@ -24,6 +24,9 @@ License Class Foam::LiftForce +Group + grpLagrangianIntermediateForceSubModels + Description Base class for particle lift force models diff --git a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/SaffmanMeiLift/SaffmanMeiLiftForce.H b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/SaffmanMeiLift/SaffmanMeiLiftForce.H index 66d29416b9..0fd506b7f3 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/SaffmanMeiLift/SaffmanMeiLiftForce.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/SaffmanMeiLift/SaffmanMeiLiftForce.H @@ -24,6 +24,9 @@ License Class Foam::SaffmanMeiLiftForce +Group + grpLagrangianIntermediateForceSubModels + Description Saffman-Mei particle lift force model applicable to spherical particles. diff --git a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/TomiyamaLift/TomiyamaLiftForce.H b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/TomiyamaLift/TomiyamaLiftForce.H index 3edf43b0a3..f9469ab7ed 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/TomiyamaLift/TomiyamaLiftForce.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Lift/TomiyamaLift/TomiyamaLiftForce.H @@ -24,6 +24,9 @@ License Class Foam::TomiyamaLiftForce +Group + grpLagrangianIntermediateForceSubModels + Description Tomiyama particle lift force model applicable to deformable bubbles. diff --git a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/NonInertialFrame/NonInertialFrameForce.H b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/NonInertialFrame/NonInertialFrameForce.H index 7c411002cf..d82e2c15e8 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/NonInertialFrame/NonInertialFrameForce.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/NonInertialFrame/NonInertialFrameForce.H @@ -24,6 +24,9 @@ License Class Foam::NonInertialFrameForce +Group + grpLagrangianIntermediateForceSubModels + Description Calculates particle non-inertial reference frame force. Variable names as from Landau and Lifshitz, Mechanics, 3rd Ed, p126-129. diff --git a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Paramagnetic/ParamagneticForce.H b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Paramagnetic/ParamagneticForce.H index 2d24eb8c1b..9293c7a04a 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Paramagnetic/ParamagneticForce.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/Paramagnetic/ParamagneticForce.H @@ -24,6 +24,9 @@ License Class Foam::ParamagneticForce +Group + grpLagrangianIntermediateForceSubModels + Description Calculates particle paramagnetic (magnetic field) force diff --git a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/ParticleForce/ParticleForce.H b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/ParticleForce/ParticleForce.H index c2ef62d536..8041816d14 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/ParticleForce/ParticleForce.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/ParticleForce/ParticleForce.H @@ -24,6 +24,9 @@ License Class Foam::ParticleForce +Group + grpLagrangianIntermediateForceSubModels + Description Abstract base class for particle forces diff --git a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/PressureGradient/PressureGradientForce.H b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/PressureGradient/PressureGradientForce.H index c4768d0478..8b4333e4ad 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/PressureGradient/PressureGradientForce.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/PressureGradient/PressureGradientForce.H @@ -24,6 +24,9 @@ License Class Foam::PressureGradientForce +Group + grpLagrangianIntermediateForceSubModels + Description Calculates particle pressure gradient force diff --git a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/SRF/SRFForce.H b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/SRF/SRFForce.H index 5c9927473a..5172ee8232 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/SRF/SRFForce.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/SRF/SRFForce.H @@ -24,6 +24,9 @@ License Class Foam::SRFForce +Group + grpLagrangianIntermediateForceSubModels + Description Calculates particle SRF reference frame force diff --git a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/VirtualMass/VirtualMassForce.H b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/VirtualMass/VirtualMassForce.H index ea0d580932..fcbc890e66 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/VirtualMass/VirtualMassForce.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/ParticleForces/VirtualMass/VirtualMassForce.H @@ -24,6 +24,9 @@ License Class Foam::VirtualMassForce +Group + grpLagrangianIntermediateForceSubModels + Description Calculates particle virtual mass force diff --git a/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/LocalInteraction/LocalInteraction.H b/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/LocalInteraction/LocalInteraction.H index 3a8c776776..de43f76029 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/LocalInteraction/LocalInteraction.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/LocalInteraction/LocalInteraction.H @@ -24,6 +24,9 @@ License Class Foam::LocalInteraction +Group + grpLagrangianIntermediatePatchInteractionSubModels + Description Patch interaction specified on a patch-by-patch basis diff --git a/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/MultiInteraction/MultiInteraction.H b/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/MultiInteraction/MultiInteraction.H index 673cd325ed..2017db53e1 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/MultiInteraction/MultiInteraction.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/MultiInteraction/MultiInteraction.H @@ -24,6 +24,9 @@ License Class Foam::MultiInteraction +Group + grpLagrangianIntermediatePatchInteractionSubModels + Description Runs multiple patch interaction models in turn. Takes dictionary where all the subdictionaries are the interaction models. diff --git a/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/NoInteraction/NoInteraction.H b/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/NoInteraction/NoInteraction.H index 41a43685f8..fe6d20b7fe 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/NoInteraction/NoInteraction.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/NoInteraction/NoInteraction.H @@ -24,6 +24,9 @@ License Class Foam::NoInteraction +Group + grpLagrangianIntermediatePatchInteractionSubModels + Description Dummy class for 'none' option - will raise an error if any functions are called that require return values. diff --git a/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/PatchInteractionModel/PatchInteractionModel.H b/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/PatchInteractionModel/PatchInteractionModel.H index 66fc753f07..4c3587a0d8 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/PatchInteractionModel/PatchInteractionModel.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/PatchInteractionModel/PatchInteractionModel.H @@ -24,6 +24,9 @@ License Class Foam::PatchInteractionModel +Group + grpLagrangianIntermediatePatchInteractionSubModels + Description Templated patch interaction model class diff --git a/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/Rebound/Rebound.H b/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/Rebound/Rebound.H index d9414b83d4..58fb9f40dc 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/Rebound/Rebound.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/Rebound/Rebound.H @@ -24,6 +24,9 @@ License Class Foam::Rebound +Group + grpLagrangianIntermediatePatchInteractionSubModels + Description Simple rebound patch interaction model diff --git a/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/StandardWallInteraction/StandardWallInteraction.H b/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/StandardWallInteraction/StandardWallInteraction.H index 68a5a8965b..0563f5ba0c 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/StandardWallInteraction/StandardWallInteraction.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/PatchInteractionModel/StandardWallInteraction/StandardWallInteraction.H @@ -24,6 +24,9 @@ License Class Foam::StandardWallInteraction +Group + grpLagrangianIntermediatePatchInteractionSubModels + Description Wall interaction model. Three choices: - rebound - optionally specify elasticity and resitution coefficients diff --git a/src/lagrangian/intermediate/submodels/Kinematic/StochasticCollision/NoStochasticCollision/NoStochasticCollision.H b/src/lagrangian/intermediate/submodels/Kinematic/StochasticCollision/NoStochasticCollision/NoStochasticCollision.H index 81338611e3..31fd241595 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/StochasticCollision/NoStochasticCollision/NoStochasticCollision.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/StochasticCollision/NoStochasticCollision/NoStochasticCollision.H @@ -24,6 +24,9 @@ License Class Foam::NoStochasticCollision +Group + grpLagrangianIntermediateCollisionSubModels + Description Dummy collision model for 'none' diff --git a/src/lagrangian/intermediate/submodels/Kinematic/StochasticCollision/StochasticCollisionModel/StochasticCollisionModel.H b/src/lagrangian/intermediate/submodels/Kinematic/StochasticCollision/StochasticCollisionModel/StochasticCollisionModel.H index 140c9d310d..b05c19612e 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/StochasticCollision/StochasticCollisionModel/StochasticCollisionModel.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/StochasticCollision/StochasticCollisionModel/StochasticCollisionModel.H @@ -24,6 +24,9 @@ License Class Foam::StochasticCollisionModel +Group + grpLagrangianIntermediateCollisionSubModels + Description Templated stochastic collision model class diff --git a/src/lagrangian/intermediate/submodels/Kinematic/SurfaceFilmModel/NoSurfaceFilm/NoSurfaceFilm.H b/src/lagrangian/intermediate/submodels/Kinematic/SurfaceFilmModel/NoSurfaceFilm/NoSurfaceFilm.H index b2fd4e7cd2..3f090a39e9 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/SurfaceFilmModel/NoSurfaceFilm/NoSurfaceFilm.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/SurfaceFilmModel/NoSurfaceFilm/NoSurfaceFilm.H @@ -24,6 +24,9 @@ License Class Foam::NoSurfaceFilm +Group + grpLagrangianIntermediateSurfaceFilmSubModels + Description Place holder for 'none' option diff --git a/src/lagrangian/intermediate/submodels/Kinematic/SurfaceFilmModel/SurfaceFilmModel/SurfaceFilmModel.H b/src/lagrangian/intermediate/submodels/Kinematic/SurfaceFilmModel/SurfaceFilmModel/SurfaceFilmModel.H index 4f93dde527..3fd11d827a 100644 --- a/src/lagrangian/intermediate/submodels/Kinematic/SurfaceFilmModel/SurfaceFilmModel/SurfaceFilmModel.H +++ b/src/lagrangian/intermediate/submodels/Kinematic/SurfaceFilmModel/SurfaceFilmModel/SurfaceFilmModel.H @@ -24,6 +24,9 @@ License Class Foam::SurfaceFilmModel +Group + grpLagrangianIntermediateSurfaceFilmSubModels + Description Templated wall surface film model class. diff --git a/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/AveragingMethod/AveragingMethod.H b/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/AveragingMethod/AveragingMethod.H index dddcea6f1a..e4bd9a122c 100644 --- a/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/AveragingMethod/AveragingMethod.H +++ b/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/AveragingMethod/AveragingMethod.H @@ -24,6 +24,9 @@ License Class Foam::AveragingMethod +Group + grpLagrangianIntermediateMPPICAveragingMethods + Description Base class for lagrangian averaging methods. diff --git a/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/Basic/Basic.H b/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/Basic/Basic.H index 515e018c6c..55326f80c2 100644 --- a/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/Basic/Basic.H +++ b/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/Basic/Basic.H @@ -24,6 +24,9 @@ License Class Foam::AveragingMethods::Basic +Group + grpLagrangianIntermediateMPPICAveragingMethods + Description Basic lagrangian averaging procedure. diff --git a/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/Dual/Dual.H b/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/Dual/Dual.H index a3c7579e77..440d1da6e5 100644 --- a/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/Dual/Dual.H +++ b/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/Dual/Dual.H @@ -24,6 +24,9 @@ License Class Foam::AveragingMethods::Dual +Group + grpLagrangianIntermediateMPPICAveragingMethods + Description Dual-mesh lagrangian averaging procedure. diff --git a/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/Moment/Moment.H b/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/Moment/Moment.H index e429ed43ec..bee0baee24 100644 --- a/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/Moment/Moment.H +++ b/src/lagrangian/intermediate/submodels/MPPIC/AveragingMethods/Moment/Moment.H @@ -24,6 +24,9 @@ License Class Foam::AveragingMethods::Moment +Group + grpLagrangianIntermediateMPPICAveragingMethods + Description Moment lagrangian averaging procedure. diff --git a/src/lagrangian/intermediate/submodels/MPPIC/CorrectionLimitingMethods/CorrectionLimitingMethod/CorrectionLimitingMethod.H b/src/lagrangian/intermediate/submodels/MPPIC/CorrectionLimitingMethods/CorrectionLimitingMethod/CorrectionLimitingMethod.H index d82cbc8c5b..151bdd3384 100644 --- a/src/lagrangian/intermediate/submodels/MPPIC/CorrectionLimitingMethods/CorrectionLimitingMethod/CorrectionLimitingMethod.H +++ b/src/lagrangian/intermediate/submodels/MPPIC/CorrectionLimitingMethods/CorrectionLimitingMethod/CorrectionLimitingMethod.H @@ -24,6 +24,9 @@ License Class Foam::CorrectionLimitingMethod +Group + grpLagrangianIntermediateMPPICCorrectionLimitingMethods + Description Base class for correction limiting methods. diff --git a/src/lagrangian/intermediate/submodels/MPPIC/CorrectionLimitingMethods/absolute/absolute.H b/src/lagrangian/intermediate/submodels/MPPIC/CorrectionLimitingMethods/absolute/absolute.H index 742746b5e3..de1edb8cb9 100644 --- a/src/lagrangian/intermediate/submodels/MPPIC/CorrectionLimitingMethods/absolute/absolute.H +++ b/src/lagrangian/intermediate/submodels/MPPIC/CorrectionLimitingMethods/absolute/absolute.H @@ -24,6 +24,9 @@ License Class Foam::CorrectionLimitingMethods::absolute +Group + grpLagrangianIntermediateMPPICCorrectionLimitingMethods + Description Correction limiting method based on the absolute particle velocity. diff --git a/src/lagrangian/intermediate/submodels/MPPIC/CorrectionLimitingMethods/noCorrectionLimiting/noCorrectionLimiting.H b/src/lagrangian/intermediate/submodels/MPPIC/CorrectionLimitingMethods/noCorrectionLimiting/noCorrectionLimiting.H index f601491cea..242dbc2938 100644 --- a/src/lagrangian/intermediate/submodels/MPPIC/CorrectionLimitingMethods/noCorrectionLimiting/noCorrectionLimiting.H +++ b/src/lagrangian/intermediate/submodels/MPPIC/CorrectionLimitingMethods/noCorrectionLimiting/noCorrectionLimiting.H @@ -24,7 +24,11 @@ License Class Foam::CorrectionLimitingMethods::noCorrectionLimiting +Group + grpLagrangianIntermediateMPPICCorrectionLimitingMethods + Description + Place holder for the 'none' option SourceFiles noCorrectionLimiting.C diff --git a/src/lagrangian/intermediate/submodels/MPPIC/CorrectionLimitingMethods/relative/relative.H b/src/lagrangian/intermediate/submodels/MPPIC/CorrectionLimitingMethods/relative/relative.H index e7d9f2233f..86d3ec17b5 100644 --- a/src/lagrangian/intermediate/submodels/MPPIC/CorrectionLimitingMethods/relative/relative.H +++ b/src/lagrangian/intermediate/submodels/MPPIC/CorrectionLimitingMethods/relative/relative.H @@ -24,6 +24,9 @@ License Class Foam::CorrectionLimitingMethods::relative +Group + grpLagrangianIntermediateMPPICCorrectionLimitingMethods + Description Correction limiting method based on the relative particle velocity. diff --git a/src/lagrangian/intermediate/submodels/MPPIC/DampingModels/DampingModel/DampingModel.H b/src/lagrangian/intermediate/submodels/MPPIC/DampingModels/DampingModel/DampingModel.H index 9c8e142938..c5be1d8ee7 100644 --- a/src/lagrangian/intermediate/submodels/MPPIC/DampingModels/DampingModel/DampingModel.H +++ b/src/lagrangian/intermediate/submodels/MPPIC/DampingModels/DampingModel/DampingModel.H @@ -24,6 +24,9 @@ License Class Foam::DampingModel +Group + grpLagrangianIntermediateMPPICDampingSubModels + Description Base class for collisional damping models. diff --git a/src/lagrangian/intermediate/submodels/MPPIC/DampingModels/NoDamping/NoDamping.H b/src/lagrangian/intermediate/submodels/MPPIC/DampingModels/NoDamping/NoDamping.H index 34f2b9a967..bb31493f4c 100644 --- a/src/lagrangian/intermediate/submodels/MPPIC/DampingModels/NoDamping/NoDamping.H +++ b/src/lagrangian/intermediate/submodels/MPPIC/DampingModels/NoDamping/NoDamping.H @@ -24,7 +24,11 @@ License Class Foam::DampingModels::NoDamping +Group + grpLagrangianIntermediateMPPICDampingSubModels + Description + Place holder for the 'none' option SourceFiles NoDamping.C diff --git a/src/lagrangian/intermediate/submodels/MPPIC/DampingModels/Relaxation/Relaxation.H b/src/lagrangian/intermediate/submodels/MPPIC/DampingModels/Relaxation/Relaxation.H index d9f6e07e57..dce1fc005e 100644 --- a/src/lagrangian/intermediate/submodels/MPPIC/DampingModels/Relaxation/Relaxation.H +++ b/src/lagrangian/intermediate/submodels/MPPIC/DampingModels/Relaxation/Relaxation.H @@ -24,6 +24,9 @@ License Class Foam::DampingModels::Relaxation +Group + grpLagrangianIntermediateMPPICDampingSubModels + Description Relaxation collisional damping model. diff --git a/src/lagrangian/intermediate/submodels/MPPIC/IsotropyModels/IsotropyModel/IsotropyModel.H b/src/lagrangian/intermediate/submodels/MPPIC/IsotropyModels/IsotropyModel/IsotropyModel.H index 3523effa8f..cedebc8861 100644 --- a/src/lagrangian/intermediate/submodels/MPPIC/IsotropyModels/IsotropyModel/IsotropyModel.H +++ b/src/lagrangian/intermediate/submodels/MPPIC/IsotropyModels/IsotropyModel/IsotropyModel.H @@ -24,6 +24,9 @@ License Class Foam::IsotropyModel +Group + grpLagrangianIntermediateMPPICIsotropySubModels + Description Base class for collisional return-to-isotropy models. diff --git a/src/lagrangian/intermediate/submodels/MPPIC/IsotropyModels/NoIsotropy/NoIsotropy.H b/src/lagrangian/intermediate/submodels/MPPIC/IsotropyModels/NoIsotropy/NoIsotropy.H index 749b77ae78..8d8c686a5f 100644 --- a/src/lagrangian/intermediate/submodels/MPPIC/IsotropyModels/NoIsotropy/NoIsotropy.H +++ b/src/lagrangian/intermediate/submodels/MPPIC/IsotropyModels/NoIsotropy/NoIsotropy.H @@ -24,7 +24,11 @@ License Class Foam::IsotropyModels::NoIsotropy +Group + grpLagrangianIntermediateMPPICIsotropySubModels + Description + Place holder for the 'none' option SourceFiles NoIsotropy.C diff --git a/src/lagrangian/intermediate/submodels/MPPIC/IsotropyModels/Stochastic/Stochastic.H b/src/lagrangian/intermediate/submodels/MPPIC/IsotropyModels/Stochastic/Stochastic.H index f1e06f64de..058eb54ae6 100644 --- a/src/lagrangian/intermediate/submodels/MPPIC/IsotropyModels/Stochastic/Stochastic.H +++ b/src/lagrangian/intermediate/submodels/MPPIC/IsotropyModels/Stochastic/Stochastic.H @@ -24,6 +24,9 @@ License Class Foam::IsotropyModels::Stochastic +Group + grpLagrangianIntermediateMPPICIsotropySubModels + Description Stochastic return-to-isotropy model. diff --git a/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/Explicit/Explicit.H b/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/Explicit/Explicit.H index 15937ffb69..b928623284 100644 --- a/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/Explicit/Explicit.H +++ b/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/Explicit/Explicit.H @@ -24,6 +24,9 @@ License Class Foam::PackingModels::Explicit +Group + grpLagrangianIntermediateMPPICPackingSubModels + Description Explicit model for applying an inter-particle stress to the particles. diff --git a/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/Implicit/Implicit.H b/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/Implicit/Implicit.H index 566fd95654..eb64e09e2b 100644 --- a/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/Implicit/Implicit.H +++ b/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/Implicit/Implicit.H @@ -24,6 +24,9 @@ License Class Foam::PackingModels::Implicit +Group + grpLagrangianIntermediateMPPICPackingSubModels + Description Implicit model for applying an inter-particle stress to the particles. diff --git a/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/NoPacking/NoPacking.H b/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/NoPacking/NoPacking.H index 67bb37bf5d..202a1368e5 100644 --- a/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/NoPacking/NoPacking.H +++ b/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/NoPacking/NoPacking.H @@ -24,7 +24,11 @@ License Class Foam::PackingModel::NoPacking +Group + grpLagrangianIntermediateMPPICPackingSubModels + Description + Place holder for the 'none' option SourceFiles NoPacking.C diff --git a/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/PackingModel/PackingModel.H b/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/PackingModel/PackingModel.H index 4258773a49..3ff7572657 100644 --- a/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/PackingModel/PackingModel.H +++ b/src/lagrangian/intermediate/submodels/MPPIC/PackingModels/PackingModel/PackingModel.H @@ -24,6 +24,9 @@ License Class Foam::PackingModel +Group + grpLagrangianIntermediateMPPICPackingSubModels + Description Base class for packing models. diff --git a/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/HarrisCrighton/HarrisCrighton.H b/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/HarrisCrighton/HarrisCrighton.H index 9fe56cc954..ac5dfc1ad6 100644 --- a/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/HarrisCrighton/HarrisCrighton.H +++ b/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/HarrisCrighton/HarrisCrighton.H @@ -24,6 +24,9 @@ License Class Foam::ParticleStressModels::HarrisCrighton +Group + grpLagrangianIntermediateMPPICParticleStressSubModels + Description Inter-particle stress model of Harris and Crighton diff --git a/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/Lun/Lun.H b/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/Lun/Lun.H index 02e686c0bc..9a68d4a9ac 100644 --- a/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/Lun/Lun.H +++ b/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/Lun/Lun.H @@ -24,6 +24,9 @@ License Class Foam::ParticleStressModels::Lun +Group + grpLagrangianIntermediateMPPICParticleStressSubModels + Description Inter-particle stress model of Lun et al diff --git a/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/ParticleStressModel/ParticleStressModel.H b/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/ParticleStressModel/ParticleStressModel.H index 61b117c9f8..eb57f941fe 100644 --- a/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/ParticleStressModel/ParticleStressModel.H +++ b/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/ParticleStressModel/ParticleStressModel.H @@ -24,6 +24,9 @@ License Class Foam::ParticleStressModel +Group + grpLagrangianIntermediateMPPICParticleStressSubModels + Description Base class for inter-particle stress models. diff --git a/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/exponential/exponential.H b/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/exponential/exponential.H index 5d989622fe..229fa7d537 100644 --- a/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/exponential/exponential.H +++ b/src/lagrangian/intermediate/submodels/MPPIC/ParticleStressModels/exponential/exponential.H @@ -24,6 +24,9 @@ License Class Foam::ParticleStressModels::exponential +Group + grpLagrangianIntermediateMPPICParticleStressSubModels + Description Exponential inter-particle stress model of the same form as used in twoPhaseEulerFoam diff --git a/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/TimeScaleModel/TimeScaleModel.H b/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/TimeScaleModel/TimeScaleModel.H index 6a8e6bef50..1c55f01f58 100644 --- a/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/TimeScaleModel/TimeScaleModel.H +++ b/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/TimeScaleModel/TimeScaleModel.H @@ -24,6 +24,9 @@ License Class Foam::TimeScaleModel +Group + grpLagrangianIntermediateMPPICTimeScaleSubModels + Description Base class for time scale models. diff --git a/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/equilibrium/equilibrium.H b/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/equilibrium/equilibrium.H index a8036d2711..b6df911fb7 100644 --- a/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/equilibrium/equilibrium.H +++ b/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/equilibrium/equilibrium.H @@ -24,6 +24,9 @@ License Class Foam::TimeScaleModels::equilibrium +Group + grpLagrangianIntermediateMPPICTimeScaleSubModels + Description Equlibrium model for the time scale over which properties of a dispersed phase tend towards the mean value. diff --git a/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/isotropic/isotropic.H b/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/isotropic/isotropic.H index 31e0fc3ef1..8e542e7c0a 100644 --- a/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/isotropic/isotropic.H +++ b/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/isotropic/isotropic.H @@ -24,6 +24,9 @@ License Class Foam::TimeScaleModels::isotropic +Group + grpLagrangianIntermediateMPPICTimeScaleSubModels + Description Model for the time scale over which the velocity field of a dispersed phase tends towards an isotropic distribution. diff --git a/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/nonEquilibrium/nonEquilibrium.H b/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/nonEquilibrium/nonEquilibrium.H index 1c48f9bed1..2b9eb5a1a4 100644 --- a/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/nonEquilibrium/nonEquilibrium.H +++ b/src/lagrangian/intermediate/submodels/MPPIC/TimeScaleModels/nonEquilibrium/nonEquilibrium.H @@ -24,6 +24,9 @@ License Class Foam::TimeScaleModels::nonEquilibrium +Group + grpLagrangianIntermediateMPPICTimeScaleSubModels + Description Non-Equlibrium model for the time scale over which properties of a dispersed phase tend towards the mean value. diff --git a/src/lagrangian/intermediate/submodels/Reacting/CompositionModel/CompositionModel/CompositionModel.H b/src/lagrangian/intermediate/submodels/Reacting/CompositionModel/CompositionModel/CompositionModel.H index 97aa1c5c7c..4a2c1490ed 100644 --- a/src/lagrangian/intermediate/submodels/Reacting/CompositionModel/CompositionModel/CompositionModel.H +++ b/src/lagrangian/intermediate/submodels/Reacting/CompositionModel/CompositionModel/CompositionModel.H @@ -24,6 +24,9 @@ License Class Foam::CompositionModel +Group + grpLagrangianIntermediateCompositionSubModels + Description Templated reacting parcel composition model class Consists of carrier species (via thermo package), and additional liquids diff --git a/src/lagrangian/intermediate/submodels/Reacting/CompositionModel/NoComposition/NoComposition.H b/src/lagrangian/intermediate/submodels/Reacting/CompositionModel/NoComposition/NoComposition.H index 716352dc74..1ba5a5f4af 100644 --- a/src/lagrangian/intermediate/submodels/Reacting/CompositionModel/NoComposition/NoComposition.H +++ b/src/lagrangian/intermediate/submodels/Reacting/CompositionModel/NoComposition/NoComposition.H @@ -24,6 +24,9 @@ License Class Foam::NoComposition +Group + grpLagrangianIntermediateCompositionSubModels + Description Dummy class for 'none' option - will raise an error if any functions are called that require return values. diff --git a/src/lagrangian/intermediate/submodels/Reacting/CompositionModel/SingleMixtureFraction/SingleMixtureFraction.H b/src/lagrangian/intermediate/submodels/Reacting/CompositionModel/SingleMixtureFraction/SingleMixtureFraction.H index 1f2e1f8104..afd3348b43 100644 --- a/src/lagrangian/intermediate/submodels/Reacting/CompositionModel/SingleMixtureFraction/SingleMixtureFraction.H +++ b/src/lagrangian/intermediate/submodels/Reacting/CompositionModel/SingleMixtureFraction/SingleMixtureFraction.H @@ -24,6 +24,9 @@ License Class Foam::SingleMixtureFraction +Group + grpLagrangianIntermediateCompositionSubModels + Description Templated parcel multi-phase, multi-component class diff --git a/src/lagrangian/intermediate/submodels/Reacting/CompositionModel/SinglePhaseMixture/SinglePhaseMixture.H b/src/lagrangian/intermediate/submodels/Reacting/CompositionModel/SinglePhaseMixture/SinglePhaseMixture.H index 239384cfb2..8484421441 100644 --- a/src/lagrangian/intermediate/submodels/Reacting/CompositionModel/SinglePhaseMixture/SinglePhaseMixture.H +++ b/src/lagrangian/intermediate/submodels/Reacting/CompositionModel/SinglePhaseMixture/SinglePhaseMixture.H @@ -24,6 +24,9 @@ License Class Foam::SinglePhaseMixture +Group + grpLagrangianIntermediateCompositionSubModels + Description Templated parcel single phase, multi-component class diff --git a/src/lagrangian/intermediate/submodels/Reacting/InjectionModel/ReactingLookupTableInjection/ReactingLookupTableInjection.H b/src/lagrangian/intermediate/submodels/Reacting/InjectionModel/ReactingLookupTableInjection/ReactingLookupTableInjection.H index 654109c509..72f8a46e51 100644 --- a/src/lagrangian/intermediate/submodels/Reacting/InjectionModel/ReactingLookupTableInjection/ReactingLookupTableInjection.H +++ b/src/lagrangian/intermediate/submodels/Reacting/InjectionModel/ReactingLookupTableInjection/ReactingLookupTableInjection.H @@ -24,6 +24,9 @@ License Class Foam::ReactingLookupTableInjection +Group + grpLagrangianIntermediateInjectionSubModels + Description Particle injection sources read from look-up table. Each row corresponds to an injection site. diff --git a/src/lagrangian/intermediate/submodels/Reacting/PhaseChangeModel/LiquidEvaporation/LiquidEvaporation.H b/src/lagrangian/intermediate/submodels/Reacting/PhaseChangeModel/LiquidEvaporation/LiquidEvaporation.H index f1c3d95830..d6eaee171f 100644 --- a/src/lagrangian/intermediate/submodels/Reacting/PhaseChangeModel/LiquidEvaporation/LiquidEvaporation.H +++ b/src/lagrangian/intermediate/submodels/Reacting/PhaseChangeModel/LiquidEvaporation/LiquidEvaporation.H @@ -24,6 +24,9 @@ License Class Foam::LiquidEvaporation +Group + grpLagrangianIntermediatePhaseChangeSubModels + Description Liquid evaporation model - uses ideal gas assumption diff --git a/src/lagrangian/intermediate/submodels/Reacting/PhaseChangeModel/LiquidEvaporationBoil/LiquidEvaporationBoil.H b/src/lagrangian/intermediate/submodels/Reacting/PhaseChangeModel/LiquidEvaporationBoil/LiquidEvaporationBoil.H index f92af8147d..e59a589914 100644 --- a/src/lagrangian/intermediate/submodels/Reacting/PhaseChangeModel/LiquidEvaporationBoil/LiquidEvaporationBoil.H +++ b/src/lagrangian/intermediate/submodels/Reacting/PhaseChangeModel/LiquidEvaporationBoil/LiquidEvaporationBoil.H @@ -24,6 +24,9 @@ License Class Foam::LiquidEvaporationBoil +Group + grpLagrangianIntermediatePhaseChangeSubModels + Description Liquid evaporation model - uses ideal gas assumption diff --git a/src/lagrangian/intermediate/submodels/Reacting/PhaseChangeModel/NoPhaseChange/NoPhaseChange.H b/src/lagrangian/intermediate/submodels/Reacting/PhaseChangeModel/NoPhaseChange/NoPhaseChange.H index f0d3e459fd..9a4bbb23f3 100644 --- a/src/lagrangian/intermediate/submodels/Reacting/PhaseChangeModel/NoPhaseChange/NoPhaseChange.H +++ b/src/lagrangian/intermediate/submodels/Reacting/PhaseChangeModel/NoPhaseChange/NoPhaseChange.H @@ -24,6 +24,9 @@ License Class Foam::NoPhaseChange +Group + grpLagrangianIntermediatePhaseChangeSubModels + Description Dummy phase change model for 'none' diff --git a/src/lagrangian/intermediate/submodels/Reacting/PhaseChangeModel/PhaseChangeModel/PhaseChangeModel.H b/src/lagrangian/intermediate/submodels/Reacting/PhaseChangeModel/PhaseChangeModel/PhaseChangeModel.H index 6c6ebce20b..4a29b7da06 100644 --- a/src/lagrangian/intermediate/submodels/Reacting/PhaseChangeModel/PhaseChangeModel/PhaseChangeModel.H +++ b/src/lagrangian/intermediate/submodels/Reacting/PhaseChangeModel/PhaseChangeModel/PhaseChangeModel.H @@ -24,6 +24,9 @@ License Class Foam::PhaseChangeModel +Group + grpLagrangianIntermediatePhaseChangeSubModels + Description Templated phase change model class diff --git a/src/lagrangian/intermediate/submodels/ReactingMultiphase/DevolatilisationModel/ConstantRateDevolatilisation/ConstantRateDevolatilisation.H b/src/lagrangian/intermediate/submodels/ReactingMultiphase/DevolatilisationModel/ConstantRateDevolatilisation/ConstantRateDevolatilisation.H index 4b61de316d..79897b01fb 100644 --- a/src/lagrangian/intermediate/submodels/ReactingMultiphase/DevolatilisationModel/ConstantRateDevolatilisation/ConstantRateDevolatilisation.H +++ b/src/lagrangian/intermediate/submodels/ReactingMultiphase/DevolatilisationModel/ConstantRateDevolatilisation/ConstantRateDevolatilisation.H @@ -24,6 +24,9 @@ License Class Foam::ConstantRateDevolatilisation +Group + grpLagrangianIntermediateDevolatilisationSubModels + Description Constant rate devolatisation model - need to set vapourisation temperature to 600 K diff --git a/src/lagrangian/intermediate/submodels/ReactingMultiphase/DevolatilisationModel/DevolatilisationModel/DevolatilisationModel.H b/src/lagrangian/intermediate/submodels/ReactingMultiphase/DevolatilisationModel/DevolatilisationModel/DevolatilisationModel.H index 334d757b92..9200237ad1 100644 --- a/src/lagrangian/intermediate/submodels/ReactingMultiphase/DevolatilisationModel/DevolatilisationModel/DevolatilisationModel.H +++ b/src/lagrangian/intermediate/submodels/ReactingMultiphase/DevolatilisationModel/DevolatilisationModel/DevolatilisationModel.H @@ -24,6 +24,9 @@ License Class Foam::DevolatilisationModel +Group + grpLagrangianIntermediateDevolatilisationSubModels + Description Templated devolatilisation model class diff --git a/src/lagrangian/intermediate/submodels/ReactingMultiphase/DevolatilisationModel/NoDevolatilisation/NoDevolatilisation.H b/src/lagrangian/intermediate/submodels/ReactingMultiphase/DevolatilisationModel/NoDevolatilisation/NoDevolatilisation.H index dab9b47dab..b3fe2a9941 100644 --- a/src/lagrangian/intermediate/submodels/ReactingMultiphase/DevolatilisationModel/NoDevolatilisation/NoDevolatilisation.H +++ b/src/lagrangian/intermediate/submodels/ReactingMultiphase/DevolatilisationModel/NoDevolatilisation/NoDevolatilisation.H @@ -24,6 +24,9 @@ License Class Foam::NoDevolatilisation +Group + grpLagrangianIntermediateDevolatilisationSubModels + Description Dummy devolatilisation model for 'none' diff --git a/src/lagrangian/intermediate/submodels/ReactingMultiphase/DevolatilisationModel/SingleKineticRateDevolatilisation/SingleKineticRateDevolatilisation.H b/src/lagrangian/intermediate/submodels/ReactingMultiphase/DevolatilisationModel/SingleKineticRateDevolatilisation/SingleKineticRateDevolatilisation.H index 6b4802c8f6..f4609c7632 100644 --- a/src/lagrangian/intermediate/submodels/ReactingMultiphase/DevolatilisationModel/SingleKineticRateDevolatilisation/SingleKineticRateDevolatilisation.H +++ b/src/lagrangian/intermediate/submodels/ReactingMultiphase/DevolatilisationModel/SingleKineticRateDevolatilisation/SingleKineticRateDevolatilisation.H @@ -24,6 +24,9 @@ License Class Foam::SingleKineticRateDevolatilisation +Group + grpLagrangianIntermediateDevolatilisationSubModels + Description Single kinetic rate devolatisation model. - acts on a per-specie basis diff --git a/src/lagrangian/intermediate/submodels/ReactingMultiphase/InjectionModel/ReactingMultiphaseLookupTableInjection/ReactingMultiphaseLookupTableInjection.H b/src/lagrangian/intermediate/submodels/ReactingMultiphase/InjectionModel/ReactingMultiphaseLookupTableInjection/ReactingMultiphaseLookupTableInjection.H index 81f41d42de..da84f5df11 100644 --- a/src/lagrangian/intermediate/submodels/ReactingMultiphase/InjectionModel/ReactingMultiphaseLookupTableInjection/ReactingMultiphaseLookupTableInjection.H +++ b/src/lagrangian/intermediate/submodels/ReactingMultiphase/InjectionModel/ReactingMultiphaseLookupTableInjection/ReactingMultiphaseLookupTableInjection.H @@ -24,6 +24,9 @@ License Class Foam::ReactingMultiphaseLookupTableInjection +Group + grpLagrangianIntermediateInjectionSubModels + Description Particle injection sources read from look-up table. Each row corresponds to an injection site. diff --git a/src/lagrangian/intermediate/submodels/ReactingMultiphase/StochasticCollision/SuppressionCollision/SuppressionCollision.H b/src/lagrangian/intermediate/submodels/ReactingMultiphase/StochasticCollision/SuppressionCollision/SuppressionCollision.H index 5d02ad4843..7fb53b495e 100644 --- a/src/lagrangian/intermediate/submodels/ReactingMultiphase/StochasticCollision/SuppressionCollision/SuppressionCollision.H +++ b/src/lagrangian/intermediate/submodels/ReactingMultiphase/StochasticCollision/SuppressionCollision/SuppressionCollision.H @@ -24,6 +24,9 @@ License Class Foam::SuppressionCollision +Group + grpLagrangianIntermediateCollisionSubModels + Description Inter-cloud collision model, whereby the \c canReact flag can be used to inhibit devolatilisation and surface reactions diff --git a/src/lagrangian/intermediate/submodels/ReactingMultiphase/SurfaceReactionModel/NoSurfaceReaction/NoSurfaceReaction.H b/src/lagrangian/intermediate/submodels/ReactingMultiphase/SurfaceReactionModel/NoSurfaceReaction/NoSurfaceReaction.H index ae577e705b..fe6d29a9aa 100644 --- a/src/lagrangian/intermediate/submodels/ReactingMultiphase/SurfaceReactionModel/NoSurfaceReaction/NoSurfaceReaction.H +++ b/src/lagrangian/intermediate/submodels/ReactingMultiphase/SurfaceReactionModel/NoSurfaceReaction/NoSurfaceReaction.H @@ -24,6 +24,9 @@ License Class Foam::NoSurfaceReaction +Group + grpLagrangianIntermediateSurfaceReactionSubModels + Description Dummy surface reaction model for 'none' diff --git a/src/lagrangian/intermediate/submodels/ReactingMultiphase/SurfaceReactionModel/SurfaceReactionModel/SurfaceReactionModel.H b/src/lagrangian/intermediate/submodels/ReactingMultiphase/SurfaceReactionModel/SurfaceReactionModel/SurfaceReactionModel.H index a490a24323..1a6be236e5 100644 --- a/src/lagrangian/intermediate/submodels/ReactingMultiphase/SurfaceReactionModel/SurfaceReactionModel/SurfaceReactionModel.H +++ b/src/lagrangian/intermediate/submodels/ReactingMultiphase/SurfaceReactionModel/SurfaceReactionModel/SurfaceReactionModel.H @@ -24,6 +24,9 @@ License Class Foam::SurfaceReactionModel +Group + grpLagrangianIntermediateSurfaceReactionSubModels + Description Templated surface reaction model class diff --git a/src/lagrangian/intermediate/submodels/Thermodynamic/HeatTransferModel/HeatTransferModel/HeatTransferModel.H b/src/lagrangian/intermediate/submodels/Thermodynamic/HeatTransferModel/HeatTransferModel/HeatTransferModel.H index b2dc21c528..71df2946f8 100644 --- a/src/lagrangian/intermediate/submodels/Thermodynamic/HeatTransferModel/HeatTransferModel/HeatTransferModel.H +++ b/src/lagrangian/intermediate/submodels/Thermodynamic/HeatTransferModel/HeatTransferModel/HeatTransferModel.H @@ -24,6 +24,9 @@ License Class Foam::HeatTransferModel +Group + grpLagrangianIntermediateHeatTransferSubModels + Description Templated heat transfer model class diff --git a/src/lagrangian/intermediate/submodels/Thermodynamic/HeatTransferModel/NoHeatTransfer/NoHeatTransfer.H b/src/lagrangian/intermediate/submodels/Thermodynamic/HeatTransferModel/NoHeatTransfer/NoHeatTransfer.H index 6059489ab4..8ca7d5dd64 100644 --- a/src/lagrangian/intermediate/submodels/Thermodynamic/HeatTransferModel/NoHeatTransfer/NoHeatTransfer.H +++ b/src/lagrangian/intermediate/submodels/Thermodynamic/HeatTransferModel/NoHeatTransfer/NoHeatTransfer.H @@ -24,6 +24,9 @@ License Class Foam::NoHeatTransfer +Group + grpLagrangianIntermediateHeatTransferSubModels + Description Dummy heat transfer model for 'none' diff --git a/src/lagrangian/intermediate/submodels/Thermodynamic/HeatTransferModel/RanzMarshall/RanzMarshall.H b/src/lagrangian/intermediate/submodels/Thermodynamic/HeatTransferModel/RanzMarshall/RanzMarshall.H index d7669e4da6..0656d411a8 100644 --- a/src/lagrangian/intermediate/submodels/Thermodynamic/HeatTransferModel/RanzMarshall/RanzMarshall.H +++ b/src/lagrangian/intermediate/submodels/Thermodynamic/HeatTransferModel/RanzMarshall/RanzMarshall.H @@ -24,6 +24,9 @@ License Class Foam::RanzMarshall +Group + grpLagrangianIntermediateHeatTransferSubModels + Description The Ranz-Marshall correlation for heat transfer diff --git a/src/lagrangian/intermediate/submodels/Thermodynamic/InjectionModel/ThermoLookupTableInjection/ThermoLookupTableInjection.H b/src/lagrangian/intermediate/submodels/Thermodynamic/InjectionModel/ThermoLookupTableInjection/ThermoLookupTableInjection.H index 42c48f290d..0475d316d7 100644 --- a/src/lagrangian/intermediate/submodels/Thermodynamic/InjectionModel/ThermoLookupTableInjection/ThermoLookupTableInjection.H +++ b/src/lagrangian/intermediate/submodels/Thermodynamic/InjectionModel/ThermoLookupTableInjection/ThermoLookupTableInjection.H @@ -24,6 +24,9 @@ License Class Foam::ThermoLookupTableInjection +Group + grpLagrangianIntermediateInjectionSubModels + Description Particle injection sources read from look-up table. Each row corresponds to an injection site. diff --git a/src/lagrangian/intermediate/submodels/Thermodynamic/SurfaceFilmModel/ThermoSurfaceFilm/ThermoSurfaceFilm.H b/src/lagrangian/intermediate/submodels/Thermodynamic/SurfaceFilmModel/ThermoSurfaceFilm/ThermoSurfaceFilm.H index dd434f1b36..5112191bf4 100644 --- a/src/lagrangian/intermediate/submodels/Thermodynamic/SurfaceFilmModel/ThermoSurfaceFilm/ThermoSurfaceFilm.H +++ b/src/lagrangian/intermediate/submodels/Thermodynamic/SurfaceFilmModel/ThermoSurfaceFilm/ThermoSurfaceFilm.H @@ -24,6 +24,9 @@ License Class Foam::ThermoSurfaceFilm +Group + grpLagrangianIntermediateSurfaceFilmSubModels + Description Thermo parcel surface film model. diff --git a/src/lagrangian/spray/submodels/AtomizationModel/AtomizationModel/AtomizationModel.H b/src/lagrangian/spray/submodels/AtomizationModel/AtomizationModel/AtomizationModel.H index d0e8ecacbf..ed924d8ca9 100644 --- a/src/lagrangian/spray/submodels/AtomizationModel/AtomizationModel/AtomizationModel.H +++ b/src/lagrangian/spray/submodels/AtomizationModel/AtomizationModel/AtomizationModel.H @@ -24,6 +24,9 @@ License Class Foam::AtomizationModel +Group + grpLagrangianIntermediateAtomizationSubModels + Description Templated atomization model class diff --git a/src/lagrangian/spray/submodels/AtomizationModel/BlobsSheetAtomization/BlobsSheetAtomization.H b/src/lagrangian/spray/submodels/AtomizationModel/BlobsSheetAtomization/BlobsSheetAtomization.H index f6a2af7093..081123a9c3 100644 --- a/src/lagrangian/spray/submodels/AtomizationModel/BlobsSheetAtomization/BlobsSheetAtomization.H +++ b/src/lagrangian/spray/submodels/AtomizationModel/BlobsSheetAtomization/BlobsSheetAtomization.H @@ -24,6 +24,9 @@ License Class Foam::BlobsSheetAtomization +Group + grpLagrangianIntermediateAtomizationSubModels + Description Primary Breakup Model for pressure swirl atomizers. diff --git a/src/lagrangian/spray/submodels/AtomizationModel/LISAAtomization/LISAAtomization.H b/src/lagrangian/spray/submodels/AtomizationModel/LISAAtomization/LISAAtomization.H index a993c3e911..2840830083 100644 --- a/src/lagrangian/spray/submodels/AtomizationModel/LISAAtomization/LISAAtomization.H +++ b/src/lagrangian/spray/submodels/AtomizationModel/LISAAtomization/LISAAtomization.H @@ -24,6 +24,9 @@ License Class Foam::LISAAtomization +Group + grpLagrangianIntermediateAtomizationSubModels + Description Primary Breakup Model for pressure swirl atomizers. diff --git a/src/lagrangian/spray/submodels/AtomizationModel/NoAtomization/NoAtomization.H b/src/lagrangian/spray/submodels/AtomizationModel/NoAtomization/NoAtomization.H index 077f544d12..d75f2bd83c 100644 --- a/src/lagrangian/spray/submodels/AtomizationModel/NoAtomization/NoAtomization.H +++ b/src/lagrangian/spray/submodels/AtomizationModel/NoAtomization/NoAtomization.H @@ -24,6 +24,9 @@ License Class Foam::NoAtomization +Group + grpLagrangianIntermediateAtomizationSubModels + Description Dummy phase change model for 'none' diff --git a/src/lagrangian/spray/submodels/BreakupModel/BreakupModel/BreakupModel.H b/src/lagrangian/spray/submodels/BreakupModel/BreakupModel/BreakupModel.H index 6300a8fcfa..860fa5a328 100644 --- a/src/lagrangian/spray/submodels/BreakupModel/BreakupModel/BreakupModel.H +++ b/src/lagrangian/spray/submodels/BreakupModel/BreakupModel/BreakupModel.H @@ -24,6 +24,9 @@ License Class Foam::BreakupModel +Group + grpLagrangianIntermediateBreakupSubModels + Description Templated break-up model class diff --git a/src/lagrangian/spray/submodels/BreakupModel/ETAB/ETAB.H b/src/lagrangian/spray/submodels/BreakupModel/ETAB/ETAB.H index 7a681c8dbe..c9b0243f93 100644 --- a/src/lagrangian/spray/submodels/BreakupModel/ETAB/ETAB.H +++ b/src/lagrangian/spray/submodels/BreakupModel/ETAB/ETAB.H @@ -24,6 +24,9 @@ License Class Foam::ETAB +Group + grpLagrangianIntermediateBreakupSubModels + Description The Enhanced TAB model. diff --git a/src/lagrangian/spray/submodels/BreakupModel/NoBreakup/NoBreakup.H b/src/lagrangian/spray/submodels/BreakupModel/NoBreakup/NoBreakup.H index 6371570638..35edb91ceb 100644 --- a/src/lagrangian/spray/submodels/BreakupModel/NoBreakup/NoBreakup.H +++ b/src/lagrangian/spray/submodels/BreakupModel/NoBreakup/NoBreakup.H @@ -24,6 +24,9 @@ License Class Foam::NoBreakup +Group + grpLagrangianIntermediateBreakupSubModels + Description Dummy breakup model for 'none' diff --git a/src/lagrangian/spray/submodels/BreakupModel/PilchErdman/PilchErdman.H b/src/lagrangian/spray/submodels/BreakupModel/PilchErdman/PilchErdman.H index 235c9d76c0..859d0a8428 100644 --- a/src/lagrangian/spray/submodels/BreakupModel/PilchErdman/PilchErdman.H +++ b/src/lagrangian/spray/submodels/BreakupModel/PilchErdman/PilchErdman.H @@ -24,6 +24,9 @@ License Class Foam::PilchErdman +Group + grpLagrangianIntermediateBreakupSubModels + Description Particle secondary breakup model, based on the reference: diff --git a/src/lagrangian/spray/submodels/BreakupModel/ReitzDiwakar/ReitzDiwakar.H b/src/lagrangian/spray/submodels/BreakupModel/ReitzDiwakar/ReitzDiwakar.H index 9d9081ab34..e8cdac1055 100644 --- a/src/lagrangian/spray/submodels/BreakupModel/ReitzDiwakar/ReitzDiwakar.H +++ b/src/lagrangian/spray/submodels/BreakupModel/ReitzDiwakar/ReitzDiwakar.H @@ -24,6 +24,9 @@ License Class Foam::ReitzDiwakar +Group + grpLagrangianIntermediateBreakupSubModels + Description secondary breakup model diff --git a/src/lagrangian/spray/submodels/BreakupModel/ReitzKHRT/ReitzKHRT.H b/src/lagrangian/spray/submodels/BreakupModel/ReitzKHRT/ReitzKHRT.H index 0cc56e8753..4cecd1056e 100644 --- a/src/lagrangian/spray/submodels/BreakupModel/ReitzKHRT/ReitzKHRT.H +++ b/src/lagrangian/spray/submodels/BreakupModel/ReitzKHRT/ReitzKHRT.H @@ -24,8 +24,11 @@ License Class Foam::ReitzKHRT +Group + grpLagrangianIntermediateBreakupSubModels + Description - secondary breakup model which uses the Kelvin-Helmholtz + Secondary breakup model which uses the Kelvin-Helmholtz instability theory to predict the 'stripped' droplets... and the Raleigh-Taylor instability as well. diff --git a/src/lagrangian/spray/submodels/BreakupModel/SHF/SHF.H b/src/lagrangian/spray/submodels/BreakupModel/SHF/SHF.H index 94456c64a8..4f099c9cec 100644 --- a/src/lagrangian/spray/submodels/BreakupModel/SHF/SHF.H +++ b/src/lagrangian/spray/submodels/BreakupModel/SHF/SHF.H @@ -24,6 +24,9 @@ License Class Foam::SHF +Group + grpLagrangianIntermediateBreakupSubModels + Description Secondary Breakup Model to take account of the different breakup regimes, bag, molutimode, shear.... diff --git a/src/lagrangian/spray/submodels/BreakupModel/TAB/TAB.H b/src/lagrangian/spray/submodels/BreakupModel/TAB/TAB.H index f5f6b73c71..004a0ee94f 100644 --- a/src/lagrangian/spray/submodels/BreakupModel/TAB/TAB.H +++ b/src/lagrangian/spray/submodels/BreakupModel/TAB/TAB.H @@ -24,6 +24,9 @@ License Class Foam::TAB +Group + grpLagrangianIntermediateBreakupSubModels + Description The TAB Method for Numerical Calculation of Spray Droplet Breakup. diff --git a/src/thermophysicalModels/basic/doc/basicThermoDoc.H b/src/thermophysicalModels/basic/doc/basicThermoDoc.H new file mode 100644 index 0000000000..43b8857277 --- /dev/null +++ b/src/thermophysicalModels/basic/doc/basicThermoDoc.H @@ -0,0 +1,38 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2016 OpenCFD Ltd. + \\/ 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 grpRhoThermo Density-based thermophysical models +@{ + \ingroup grpThermophysicalModels + This group contains density-based thermophysical models +@} + +\defgroup grpPsiThermo Compressibility-based thermophysical models +@{ + \ingroup grpThermophysicalModels + This group contains compressibility-based thermophysical models +@} + +\*---------------------------------------------------------------------------*/ diff --git a/src/thermophysicalModels/basic/psiThermo/psiThermo.H b/src/thermophysicalModels/basic/psiThermo/psiThermo.H index f39700df56..76404a026b 100644 --- a/src/thermophysicalModels/basic/psiThermo/psiThermo.H +++ b/src/thermophysicalModels/basic/psiThermo/psiThermo.H @@ -24,6 +24,9 @@ License Class Foam::psiThermo +Group + grpPsiThermo + Description Basic thermodynamic properties based on compressibility diff --git a/src/thermophysicalModels/basic/rhoThermo/rhoThermo.H b/src/thermophysicalModels/basic/rhoThermo/rhoThermo.H index 5f1675edfa..680094b90f 100644 --- a/src/thermophysicalModels/basic/rhoThermo/rhoThermo.H +++ b/src/thermophysicalModels/basic/rhoThermo/rhoThermo.H @@ -24,6 +24,9 @@ License Class Foam::rhoThermo +Group + grpRhoThermo + Description Basic thermodynamic properties based on density diff --git a/src/thermophysicalModels/doc/thermophysicalModelsDoc.H b/src/thermophysicalModels/doc/thermophysicalModelsDoc.H new file mode 100644 index 0000000000..a6bf6cf927 --- /dev/null +++ b/src/thermophysicalModels/doc/thermophysicalModelsDoc.H @@ -0,0 +1,32 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2016 OpenCFD Ltd. + \\/ 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 grpThermophysicalModels Thermophysical models +@{ + This group contains thermophysical models +@} + + +\*---------------------------------------------------------------------------*/ diff --git a/src/thermophysicalModels/radiation/doc/radiationModelsDoc.H b/src/thermophysicalModels/radiation/doc/radiationModelsDoc.H new file mode 100644 index 0000000000..e192421c2f --- /dev/null +++ b/src/thermophysicalModels/radiation/doc/radiationModelsDoc.H @@ -0,0 +1,38 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2016 OpenCFD Ltd. + \\/ 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 grpRadiationModels Radiation models +@{ + \ingroup grpThermophysicalModels + This group contains radiation models +@} + +\defgroup grpRadiationSubModels Radiation sub-models +@{ + \ingroup grpRadiationModels + This group contains radiation sub-models +@} + +\*---------------------------------------------------------------------------*/ diff --git a/src/thermophysicalModels/radiation/radiationModels/P1/P1.H b/src/thermophysicalModels/radiation/radiationModels/P1/P1.H index 9a060f7017..af41a18446 100644 --- a/src/thermophysicalModels/radiation/radiationModels/P1/P1.H +++ b/src/thermophysicalModels/radiation/radiationModels/P1/P1.H @@ -24,6 +24,9 @@ License Class Foam::radiation::P1 +Group + grpRadiationModels + Description Works well for combustion applications where optical thickness, tau is large, i.e. tau = a*L > 3 (L = distance between objects) diff --git a/src/thermophysicalModels/radiation/radiationModels/fvDOM/fvDOM/fvDOM.H b/src/thermophysicalModels/radiation/radiationModels/fvDOM/fvDOM/fvDOM.H index 7d11396b32..aa6021f726 100644 --- a/src/thermophysicalModels/radiation/radiationModels/fvDOM/fvDOM/fvDOM.H +++ b/src/thermophysicalModels/radiation/radiationModels/fvDOM/fvDOM/fvDOM.H @@ -24,6 +24,9 @@ License Class Foam::radiation::fvDOM +Group + grpRadiationModels + Description Finite Volume Discrete Ordinates Method. Solves the RTE equation for n diff --git a/src/thermophysicalModels/radiation/radiationModels/noRadiation/noRadiation.H b/src/thermophysicalModels/radiation/radiationModels/noRadiation/noRadiation.H index 75ab459d6b..3fe4aa7d17 100644 --- a/src/thermophysicalModels/radiation/radiationModels/noRadiation/noRadiation.H +++ b/src/thermophysicalModels/radiation/radiationModels/noRadiation/noRadiation.H @@ -24,6 +24,9 @@ License Class Foam::radiation::noRadiation +Group + grpRadiationModels + Description No radiation - does nothing to energy equation source terms (returns zeros) diff --git a/src/thermophysicalModels/radiation/radiationModels/opaqueSolid/opaqueSolid.H b/src/thermophysicalModels/radiation/radiationModels/opaqueSolid/opaqueSolid.H index f2f0ea8934..72f568060b 100644 --- a/src/thermophysicalModels/radiation/radiationModels/opaqueSolid/opaqueSolid.H +++ b/src/thermophysicalModels/radiation/radiationModels/opaqueSolid/opaqueSolid.H @@ -24,6 +24,9 @@ License Class Foam::radiation::opaqueSolid +Group + grpRadiationModels + Description Radiation for solid opaque solids - does nothing to energy equation source terms (returns zeros) but creates absorptionEmissionModel and diff --git a/src/thermophysicalModels/radiation/radiationModels/solarLoad/solarLoad.H b/src/thermophysicalModels/radiation/radiationModels/solarLoad/solarLoad.H index ee24701171..56911bab14 100644 --- a/src/thermophysicalModels/radiation/radiationModels/solarLoad/solarLoad.H +++ b/src/thermophysicalModels/radiation/radiationModels/solarLoad/solarLoad.H @@ -24,6 +24,9 @@ License Class Foam::radiation::solarLoad +Group + grpRadiationModels + Description The solar load radiation model includes Sun primary hits, their diff --git a/src/thermophysicalModels/radiation/radiationModels/viewFactor/viewFactor.H b/src/thermophysicalModels/radiation/radiationModels/viewFactor/viewFactor.H index bbeb69b7ed..29b720faa6 100644 --- a/src/thermophysicalModels/radiation/radiationModels/viewFactor/viewFactor.H +++ b/src/thermophysicalModels/radiation/radiationModels/viewFactor/viewFactor.H @@ -24,6 +24,9 @@ License Class Foam::radiation::viewFactor +Group + grpRadiationModels + Description View factor radiation model. The system solved is: C q = b where: diff --git a/src/thermophysicalModels/radiation/submodels/absorptionEmissionModel/binaryAbsorptionEmission/binaryAbsorptionEmission.H b/src/thermophysicalModels/radiation/submodels/absorptionEmissionModel/binaryAbsorptionEmission/binaryAbsorptionEmission.H index b45c26d538..2771f938b6 100644 --- a/src/thermophysicalModels/radiation/submodels/absorptionEmissionModel/binaryAbsorptionEmission/binaryAbsorptionEmission.H +++ b/src/thermophysicalModels/radiation/submodels/absorptionEmissionModel/binaryAbsorptionEmission/binaryAbsorptionEmission.H @@ -24,6 +24,9 @@ License Class Foam::radiation::binaryAbsorptionEmission +Group + grpRadiationAbsorptionEmissionSubModels + Description Radiation coefficient based on two absorption models diff --git a/src/thermophysicalModels/radiation/submodels/absorptionEmissionModel/constantAbsorptionEmission/constantAbsorptionEmission.H b/src/thermophysicalModels/radiation/submodels/absorptionEmissionModel/constantAbsorptionEmission/constantAbsorptionEmission.H index bfe44a89b8..357a31d2ba 100644 --- a/src/thermophysicalModels/radiation/submodels/absorptionEmissionModel/constantAbsorptionEmission/constantAbsorptionEmission.H +++ b/src/thermophysicalModels/radiation/submodels/absorptionEmissionModel/constantAbsorptionEmission/constantAbsorptionEmission.H @@ -24,6 +24,9 @@ License Class Foam::radiation::constantAbsorptionEmission +Group + grpRadiationAbsorptionEmissionSubModels + Description Constant radiation absorption and emission coefficients for continuous phase diff --git a/src/thermophysicalModels/radiation/submodels/absorptionEmissionModel/greyMeanAbsorptionEmission/greyMeanAbsorptionEmission.H b/src/thermophysicalModels/radiation/submodels/absorptionEmissionModel/greyMeanAbsorptionEmission/greyMeanAbsorptionEmission.H index b5f74bfd70..e732343797 100644 --- a/src/thermophysicalModels/radiation/submodels/absorptionEmissionModel/greyMeanAbsorptionEmission/greyMeanAbsorptionEmission.H +++ b/src/thermophysicalModels/radiation/submodels/absorptionEmissionModel/greyMeanAbsorptionEmission/greyMeanAbsorptionEmission.H @@ -24,6 +24,9 @@ License Class Foam::radiation::greyMeanAbsorptionEmission +Group + grpRadiationAbsorptionEmissionSubModels + Description greyMeanAbsorptionEmission radiation absorption and emission coefficients for continuous phase diff --git a/src/thermophysicalModels/radiation/submodels/absorptionEmissionModel/greyMeanSolidAbsorptionEmission/greyMeanSolidAbsorptionEmission.H b/src/thermophysicalModels/radiation/submodels/absorptionEmissionModel/greyMeanSolidAbsorptionEmission/greyMeanSolidAbsorptionEmission.H index 4ea4d1e5f5..5c40a0e229 100644 --- a/src/thermophysicalModels/radiation/submodels/absorptionEmissionModel/greyMeanSolidAbsorptionEmission/greyMeanSolidAbsorptionEmission.H +++ b/src/thermophysicalModels/radiation/submodels/absorptionEmissionModel/greyMeanSolidAbsorptionEmission/greyMeanSolidAbsorptionEmission.H @@ -24,6 +24,9 @@ License Class Foam::radiation::greyMeanSolidAbsorptionEmission +Group + grpRadiationAbsorptionEmissionSubModels + Description greyMeanSolidAbsorptionEmission radiation absorption and emission coefficients for solid mixture diff --git a/src/thermophysicalModels/radiation/submodels/absorptionEmissionModel/multiBandSolidAbsorptionEmission/multiBandSolidAbsorptionEmission.H b/src/thermophysicalModels/radiation/submodels/absorptionEmissionModel/multiBandSolidAbsorptionEmission/multiBandSolidAbsorptionEmission.H index 3a439a36b3..2c1797a1a0 100644 --- a/src/thermophysicalModels/radiation/submodels/absorptionEmissionModel/multiBandSolidAbsorptionEmission/multiBandSolidAbsorptionEmission.H +++ b/src/thermophysicalModels/radiation/submodels/absorptionEmissionModel/multiBandSolidAbsorptionEmission/multiBandSolidAbsorptionEmission.H @@ -24,6 +24,9 @@ License Class Foam::radiation::multiBandSolidAbsorptionEmission +Group + grpRadiationAbsorptionEmissionSubModels + Description multiBandSolidAbsorptionEmission radiation absorption/emission for solids. diff --git a/src/thermophysicalModels/radiation/submodels/absorptionEmissionModel/noAbsorptionEmission/noAbsorptionEmission.H b/src/thermophysicalModels/radiation/submodels/absorptionEmissionModel/noAbsorptionEmission/noAbsorptionEmission.H index 903e3ce438..011df68dbb 100644 --- a/src/thermophysicalModels/radiation/submodels/absorptionEmissionModel/noAbsorptionEmission/noAbsorptionEmission.H +++ b/src/thermophysicalModels/radiation/submodels/absorptionEmissionModel/noAbsorptionEmission/noAbsorptionEmission.H @@ -24,6 +24,9 @@ License Class Foam::radiation::noAbsorptionEmission +Group + grpRadiationAbsorptionEmissionSubModels + Description Dummy absorption-emission model for 'none' diff --git a/src/thermophysicalModels/radiation/submodels/absorptionEmissionModel/wideBandAbsorptionEmission/wideBandAbsorptionEmission.H b/src/thermophysicalModels/radiation/submodels/absorptionEmissionModel/wideBandAbsorptionEmission/wideBandAbsorptionEmission.H index e1fb10cf09..4149f25f58 100644 --- a/src/thermophysicalModels/radiation/submodels/absorptionEmissionModel/wideBandAbsorptionEmission/wideBandAbsorptionEmission.H +++ b/src/thermophysicalModels/radiation/submodels/absorptionEmissionModel/wideBandAbsorptionEmission/wideBandAbsorptionEmission.H @@ -24,6 +24,9 @@ License Class Foam::radiation::wideBandAbsorptionEmission +Group + grpRadiationAbsorptionEmissionSubModels + Description wideBandAbsorptionEmission radiation absorption and emission coefficients diff --git a/src/thermophysicalModels/radiation/submodels/doc/radiationSubModels.H b/src/thermophysicalModels/radiation/submodels/doc/radiationSubModels.H new file mode 100644 index 0000000000..60a6bff5f4 --- /dev/null +++ b/src/thermophysicalModels/radiation/submodels/doc/radiationSubModels.H @@ -0,0 +1,51 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2016 OpenCFD Ltd. + \\/ 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 grpRadiationAbsorptionEmissionSubModels Absorption and emission sub-models +@{ + \ingroup grpRadiationSubModels + This group contains radiation absorption and emission sub-models +@} + +\defgroup grpRadiationScatterSubModels Scatter sub-models +@{ + \ingroup grpRadiationSubModels + This group contains radiation scatter sub-models +@} + +\defgroup grpRadiationSootSubModels Soot sub-models +@{ + \ingroup grpRadiationSubModels + This group contains radiation soot sub-models +@} + +\defgroup grpRadiationTransmissivitySubModels Transmissivity sub-models +@{ + \ingroup grpRadiationSubModels + This group contains radiation transmissivity sub-models +@} + + +\*---------------------------------------------------------------------------*/ diff --git a/src/thermophysicalModels/radiation/submodels/scatterModel/constantScatter/constantScatter.H b/src/thermophysicalModels/radiation/submodels/scatterModel/constantScatter/constantScatter.H index 3f108e977f..ac6357c355 100644 --- a/src/thermophysicalModels/radiation/submodels/scatterModel/constantScatter/constantScatter.H +++ b/src/thermophysicalModels/radiation/submodels/scatterModel/constantScatter/constantScatter.H @@ -24,6 +24,9 @@ License Class Foam::radiation::constantScatter +Group + grpRadiationScatterSubModels + Description Constant radiation scatter coefficient diff --git a/src/thermophysicalModels/radiation/submodels/scatterModel/noScatter/noScatter.H b/src/thermophysicalModels/radiation/submodels/scatterModel/noScatter/noScatter.H index 19b629adc2..5590ae2254 100644 --- a/src/thermophysicalModels/radiation/submodels/scatterModel/noScatter/noScatter.H +++ b/src/thermophysicalModels/radiation/submodels/scatterModel/noScatter/noScatter.H @@ -24,6 +24,9 @@ License Class Foam::radiation::noScatter +Group + grpRadiationScatterSubModels + Description Dummy scatter model for 'none' diff --git a/src/thermophysicalModels/radiation/submodels/sootModel/mixtureFractionSoot/mixtureFractionSoot.H b/src/thermophysicalModels/radiation/submodels/sootModel/mixtureFractionSoot/mixtureFractionSoot.H index 6c8eb065cb..9a386aad94 100644 --- a/src/thermophysicalModels/radiation/submodels/sootModel/mixtureFractionSoot/mixtureFractionSoot.H +++ b/src/thermophysicalModels/radiation/submodels/sootModel/mixtureFractionSoot/mixtureFractionSoot.H @@ -24,6 +24,9 @@ License Class Foam::radiation::mixtureFractionSoot +Group + grpRadiationSootSubModels + Description This soot model is purely an state model. The ammount of soot produced is determined by a single step chemistry as : diff --git a/src/thermophysicalModels/radiation/submodels/sootModel/noSoot/noSoot.H b/src/thermophysicalModels/radiation/submodels/sootModel/noSoot/noSoot.H index afcf096194..f2c4bda7da 100644 --- a/src/thermophysicalModels/radiation/submodels/sootModel/noSoot/noSoot.H +++ b/src/thermophysicalModels/radiation/submodels/sootModel/noSoot/noSoot.H @@ -24,10 +24,12 @@ License Class Foam::radiation::noSoot +Group + grpRadiationSootSubModels + Description noSoot - SourceFiles noSoot.C diff --git a/src/thermophysicalModels/radiation/submodels/transmissivityModel/constantTransmissivity/constantTransmissivity.H b/src/thermophysicalModels/radiation/submodels/transmissivityModel/constantTransmissivity/constantTransmissivity.H index 7f2d2bfb87..f195f526c3 100644 --- a/src/thermophysicalModels/radiation/submodels/transmissivityModel/constantTransmissivity/constantTransmissivity.H +++ b/src/thermophysicalModels/radiation/submodels/transmissivityModel/constantTransmissivity/constantTransmissivity.H @@ -24,8 +24,11 @@ License Class Foam::radiation::constantTransmissivity +Group + grpRadiationTransmissivitySubModels + Description - Constant radiation scatter coefficient + Constant radiation transmissivity coefficient SourceFiles constantTransmissivity.C @@ -45,7 +48,7 @@ namespace radiation { /*---------------------------------------------------------------------------*\ - Class constantTransmissivity Declaration + Class constantTransmissivity Declaration \*---------------------------------------------------------------------------*/ class constantTransmissivity diff --git a/src/thermophysicalModels/radiation/submodels/transmissivityModel/multiBandSolidTransmissivity/multiBandSolidTransmissivity.H b/src/thermophysicalModels/radiation/submodels/transmissivityModel/multiBandSolidTransmissivity/multiBandSolidTransmissivity.H index 85e0a589e6..bae7831153 100644 --- a/src/thermophysicalModels/radiation/submodels/transmissivityModel/multiBandSolidTransmissivity/multiBandSolidTransmissivity.H +++ b/src/thermophysicalModels/radiation/submodels/transmissivityModel/multiBandSolidTransmissivity/multiBandSolidTransmissivity.H @@ -24,11 +24,12 @@ License Class Foam::radiation::multiBandSolidTransmissivity +Group + grpRadiationTransmissivitySubModels + Description - multiBandSolidTransmissivity radiation transmissivity for solids. - SourceFiles multiBandSolidTransmissivity.C diff --git a/src/thermophysicalModels/radiation/submodels/transmissivityModel/noTransmissivity/noTransmissivity.H b/src/thermophysicalModels/radiation/submodels/transmissivityModel/noTransmissivity/noTransmissivity.H index 3d0be9b1a7..a48f4017ba 100644 --- a/src/thermophysicalModels/radiation/submodels/transmissivityModel/noTransmissivity/noTransmissivity.H +++ b/src/thermophysicalModels/radiation/submodels/transmissivityModel/noTransmissivity/noTransmissivity.H @@ -24,6 +24,9 @@ License Class Foam::radiation::noTransmissivity +Group + grpRadiationTransmissivitySubModels + Description Dummy transmissivity model for 'none' diff --git a/src/thermophysicalModels/reactionThermo/psiReactionThermo/psiReactionThermo.H b/src/thermophysicalModels/reactionThermo/psiReactionThermo/psiReactionThermo.H index 12a1a509e5..300b0c5362 100644 --- a/src/thermophysicalModels/reactionThermo/psiReactionThermo/psiReactionThermo.H +++ b/src/thermophysicalModels/reactionThermo/psiReactionThermo/psiReactionThermo.H @@ -24,6 +24,9 @@ License Class Foam::psiReactionThermo +Group + grpPsiThermo + Description Foam::psiReactionThermo diff --git a/src/thermophysicalModels/reactionThermo/psiuReactionThermo/psiuReactionThermo.H b/src/thermophysicalModels/reactionThermo/psiuReactionThermo/psiuReactionThermo.H index 0a0b3bcfa4..665379d9a1 100644 --- a/src/thermophysicalModels/reactionThermo/psiuReactionThermo/psiuReactionThermo.H +++ b/src/thermophysicalModels/reactionThermo/psiuReactionThermo/psiuReactionThermo.H @@ -24,6 +24,9 @@ License Class Foam::psiuReactionThermo +Group + grpPsiThermo + Description Foam::psiuReactionThermo @@ -44,7 +47,7 @@ namespace Foam { /*---------------------------------------------------------------------------*\ - Class psiuReactionThermo Declaration + Class psiuReactionThermo Declaration \*---------------------------------------------------------------------------*/ class psiuReactionThermo diff --git a/src/thermophysicalModels/reactionThermo/rhoReactionThermo/rhoReactionThermo.H b/src/thermophysicalModels/reactionThermo/rhoReactionThermo/rhoReactionThermo.H index 2dd5e125d8..21cb450788 100644 --- a/src/thermophysicalModels/reactionThermo/rhoReactionThermo/rhoReactionThermo.H +++ b/src/thermophysicalModels/reactionThermo/rhoReactionThermo/rhoReactionThermo.H @@ -24,6 +24,9 @@ License Class Foam::rhoReactionThermo +Group + grpRhoThermo + Description Foam::rhoReactionThermo diff --git a/src/thermophysicalModels/specie/doc/specieDoc.H b/src/thermophysicalModels/specie/doc/specieDoc.H new file mode 100644 index 0000000000..b7b19ba59b --- /dev/null +++ b/src/thermophysicalModels/specie/doc/specieDoc.H @@ -0,0 +1,57 @@ +/*---------------------------------------------------------------------------*\ + ========= | + \\ / F ield | OpenFOAM: The Open Source CFD Toolbox + \\ / O peration | + \\ / A nd | Copyright (C) 2016 OpenCFD Ltd. + \\/ 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 grpSpecie Specie +@{ + \ingroup grpThermophysicalModels + This group contains specie modelling. +@} + +\defgroup grpSpecieEquationOfState Equation of state +@{ + \ingroup grpSpecie + This group contains equation of state modelling. +@} + +\defgroup grpSpecieThermo Thermodynamics +@{ + \ingroup grpSpecie + This group contains thermodynamics modelling. +@} + +\defgroup grpSpecieTransport Transport +@{ + \ingroup grpSpecie + This group contains transport modelling. +@} + +\defgroup grpSpecieReactions Reactions +@{ + \ingroup grpSpecie + This group contains reactions modelling. +@} + + +\*---------------------------------------------------------------------------*/ diff --git a/src/thermophysicalModels/specie/equationOfState/Boussinesq/Boussinesq.H b/src/thermophysicalModels/specie/equationOfState/Boussinesq/Boussinesq.H index fd64b7fcdb..7e09c8cef0 100644 --- a/src/thermophysicalModels/specie/equationOfState/Boussinesq/Boussinesq.H +++ b/src/thermophysicalModels/specie/equationOfState/Boussinesq/Boussinesq.H @@ -24,6 +24,9 @@ License Class Foam::Boussinesq +Group + grpSpecieEquationOfState + Description Incompressible gas equation of state using the Boussinesq approximation for the density as a function of temperature only: diff --git a/src/thermophysicalModels/specie/equationOfState/PengRobinsonGas/PengRobinsonGas.H b/src/thermophysicalModels/specie/equationOfState/PengRobinsonGas/PengRobinsonGas.H index 8a24f6e104..36bef73fba 100644 --- a/src/thermophysicalModels/specie/equationOfState/PengRobinsonGas/PengRobinsonGas.H +++ b/src/thermophysicalModels/specie/equationOfState/PengRobinsonGas/PengRobinsonGas.H @@ -24,6 +24,9 @@ License Class Foam::PengRobinsonGas +Group + grpSpecieEquationOfState + Description PengRobinsonGas gas equation of state. diff --git a/src/thermophysicalModels/specie/equationOfState/adiabaticPerfectFluid/adiabaticPerfectFluid.H b/src/thermophysicalModels/specie/equationOfState/adiabaticPerfectFluid/adiabaticPerfectFluid.H index 3b391410ce..f32a63f9f5 100644 --- a/src/thermophysicalModels/specie/equationOfState/adiabaticPerfectFluid/adiabaticPerfectFluid.H +++ b/src/thermophysicalModels/specie/equationOfState/adiabaticPerfectFluid/adiabaticPerfectFluid.H @@ -24,6 +24,9 @@ License Class Foam::adiabaticPerfectFluid +Group + grpSpecieEquationOfState + Description AdiabaticPerfect gas equation of state. diff --git a/src/thermophysicalModels/specie/equationOfState/icoPolynomial/icoPolynomial.H b/src/thermophysicalModels/specie/equationOfState/icoPolynomial/icoPolynomial.H index e2dde3e35a..88141d5931 100644 --- a/src/thermophysicalModels/specie/equationOfState/icoPolynomial/icoPolynomial.H +++ b/src/thermophysicalModels/specie/equationOfState/icoPolynomial/icoPolynomial.H @@ -24,6 +24,9 @@ License Class Foam::icoPolynomial +Group + grpSpecieEquationOfState + Description Incompressible, polynomial form of equation of state, using a polynomial function for density. diff --git a/src/thermophysicalModels/specie/equationOfState/incompressiblePerfectGas/incompressiblePerfectGas.H b/src/thermophysicalModels/specie/equationOfState/incompressiblePerfectGas/incompressiblePerfectGas.H index 0beacf03e5..9b25d79dc5 100644 --- a/src/thermophysicalModels/specie/equationOfState/incompressiblePerfectGas/incompressiblePerfectGas.H +++ b/src/thermophysicalModels/specie/equationOfState/incompressiblePerfectGas/incompressiblePerfectGas.H @@ -24,6 +24,9 @@ License Class Foam::incompressiblePerfectGas +Group + grpSpecieEquationOfState + Description Incompressible gas equation of state using a constant reference pressure in the perfect gas equation of state rather than the local pressure so that the diff --git a/src/thermophysicalModels/specie/equationOfState/linear/linear.H b/src/thermophysicalModels/specie/equationOfState/linear/linear.H index acdbda0134..228a345ac8 100644 --- a/src/thermophysicalModels/specie/equationOfState/linear/linear.H +++ b/src/thermophysicalModels/specie/equationOfState/linear/linear.H @@ -24,6 +24,9 @@ License Class Foam::linear +Group + grpSpecieEquationOfState + Description Linear equation of state with constant compressibility @@ -37,8 +40,8 @@ SourceFiles \*---------------------------------------------------------------------------*/ -#ifndef linear_H -#define linear_H +#ifndef linearEOS_H +#define linearEOS_H #include "autoPtr.H" diff --git a/src/thermophysicalModels/specie/equationOfState/perfectFluid/perfectFluid.H b/src/thermophysicalModels/specie/equationOfState/perfectFluid/perfectFluid.H index fcd1b373f3..519056e61d 100644 --- a/src/thermophysicalModels/specie/equationOfState/perfectFluid/perfectFluid.H +++ b/src/thermophysicalModels/specie/equationOfState/perfectFluid/perfectFluid.H @@ -24,6 +24,9 @@ License Class Foam::perfectFluid +Group + grpSpecieEquationOfState + Description Perfect gas equation of state. diff --git a/src/thermophysicalModels/specie/equationOfState/perfectGas/perfectGas.H b/src/thermophysicalModels/specie/equationOfState/perfectGas/perfectGas.H index 986eecce70..3439d8f8a0 100644 --- a/src/thermophysicalModels/specie/equationOfState/perfectGas/perfectGas.H +++ b/src/thermophysicalModels/specie/equationOfState/perfectGas/perfectGas.H @@ -24,6 +24,9 @@ License Class Foam::perfectGas +Group + grpSpecieEquationOfState + Description Perfect gas equation of state. diff --git a/src/thermophysicalModels/specie/equationOfState/rhoConst/rhoConst.H b/src/thermophysicalModels/specie/equationOfState/rhoConst/rhoConst.H index 98f2547123..415fbec13a 100644 --- a/src/thermophysicalModels/specie/equationOfState/rhoConst/rhoConst.H +++ b/src/thermophysicalModels/specie/equationOfState/rhoConst/rhoConst.H @@ -24,6 +24,9 @@ License Class Foam::rhoConst +Group + grpSpecieEquationOfState + Description RhoConst (rho = const) of state. diff --git a/src/thermophysicalModels/specie/reaction/Reactions/IrreversibleReaction/IrreversibleReaction.H b/src/thermophysicalModels/specie/reaction/Reactions/IrreversibleReaction/IrreversibleReaction.H index 9ab0ec7b73..b52808e57d 100644 --- a/src/thermophysicalModels/specie/reaction/Reactions/IrreversibleReaction/IrreversibleReaction.H +++ b/src/thermophysicalModels/specie/reaction/Reactions/IrreversibleReaction/IrreversibleReaction.H @@ -24,6 +24,9 @@ License Class Foam::IrreversibleReaction +Group + grpSpecieReactions + Description Simple extension of Reaction to handle reversible reactions using equilibrium thermodynamics. diff --git a/src/thermophysicalModels/specie/reaction/Reactions/NonEquilibriumReversibleReaction/NonEquilibriumReversibleReaction.H b/src/thermophysicalModels/specie/reaction/Reactions/NonEquilibriumReversibleReaction/NonEquilibriumReversibleReaction.H index 43a1a43be4..8f2bf8d2df 100644 --- a/src/thermophysicalModels/specie/reaction/Reactions/NonEquilibriumReversibleReaction/NonEquilibriumReversibleReaction.H +++ b/src/thermophysicalModels/specie/reaction/Reactions/NonEquilibriumReversibleReaction/NonEquilibriumReversibleReaction.H @@ -24,6 +24,9 @@ License Class Foam::NonEquilibriumReversibleReaction +Group + grpSpecieReactions + Description Simple extension of Reaction to handle reversible reactions using equilibrium thermodynamics. diff --git a/src/thermophysicalModels/specie/reaction/Reactions/ReversibleReaction/ReversibleReaction.H b/src/thermophysicalModels/specie/reaction/Reactions/ReversibleReaction/ReversibleReaction.H index b0e16bdcca..5655d47a0f 100644 --- a/src/thermophysicalModels/specie/reaction/Reactions/ReversibleReaction/ReversibleReaction.H +++ b/src/thermophysicalModels/specie/reaction/Reactions/ReversibleReaction/ReversibleReaction.H @@ -24,6 +24,9 @@ License Class Foam::ReversibleReaction +Group + grpSpecieReactions + Description Simple extension of Reaction to handle reversible reactions using equilibrium thermodynamics. diff --git a/src/thermophysicalModels/specie/thermo/absoluteEnthalpy/absoluteEnthalpy.H b/src/thermophysicalModels/specie/thermo/absoluteEnthalpy/absoluteEnthalpy.H index 98bf51e03f..0ea7f17d06 100644 --- a/src/thermophysicalModels/specie/thermo/absoluteEnthalpy/absoluteEnthalpy.H +++ b/src/thermophysicalModels/specie/thermo/absoluteEnthalpy/absoluteEnthalpy.H @@ -24,6 +24,9 @@ License Class Foam::absoluteEnthalpy +Group + grpSpecieThermo + Description Thermodynamics mapping class to expose the absolute enthalpy function as the standard enthalpy function h(T). diff --git a/src/thermophysicalModels/specie/thermo/absoluteInternalEnergy/absoluteInternalEnergy.H b/src/thermophysicalModels/specie/thermo/absoluteInternalEnergy/absoluteInternalEnergy.H index 6ea5df7dc2..2d88a07a26 100644 --- a/src/thermophysicalModels/specie/thermo/absoluteInternalEnergy/absoluteInternalEnergy.H +++ b/src/thermophysicalModels/specie/thermo/absoluteInternalEnergy/absoluteInternalEnergy.H @@ -24,6 +24,9 @@ License Class Foam::absoluteInternalEnergy +Group + grpSpecieThermo + Description Thermodynamics mapping class to expose the absolute internal energy function as the standard internal energy function e(T). diff --git a/src/thermophysicalModels/specie/thermo/eConst/eConstThermo.H b/src/thermophysicalModels/specie/thermo/eConst/eConstThermo.H index fea19e2cc6..e74f2bd936 100644 --- a/src/thermophysicalModels/specie/thermo/eConst/eConstThermo.H +++ b/src/thermophysicalModels/specie/thermo/eConst/eConstThermo.H @@ -24,6 +24,9 @@ License Class Foam::eConstThermo +Group + grpSpecieThermo + Description Constant properties thermodynamics package templated on an equation of state diff --git a/src/thermophysicalModels/specie/thermo/hConst/hConstThermo.H b/src/thermophysicalModels/specie/thermo/hConst/hConstThermo.H index ef33aeaf4c..56dfa629dc 100644 --- a/src/thermophysicalModels/specie/thermo/hConst/hConstThermo.H +++ b/src/thermophysicalModels/specie/thermo/hConst/hConstThermo.H @@ -24,6 +24,9 @@ License Class Foam::hConstThermo +Group + grpSpecieThermo + Description Constant properties thermodynamics package templated into the EquationOfState. diff --git a/src/thermophysicalModels/specie/thermo/hPolynomial/hPolynomialThermo.H b/src/thermophysicalModels/specie/thermo/hPolynomial/hPolynomialThermo.H index a0b557f215..fed366542a 100644 --- a/src/thermophysicalModels/specie/thermo/hPolynomial/hPolynomialThermo.H +++ b/src/thermophysicalModels/specie/thermo/hPolynomial/hPolynomialThermo.H @@ -24,6 +24,9 @@ License Class Foam::hPolynomialThermo +Group + grpSpecieThermo + Description Thermodynamics package templated on the equation of state, using polynomial functions for cp, h and s diff --git a/src/thermophysicalModels/specie/thermo/hPower/hPowerThermo.H b/src/thermophysicalModels/specie/thermo/hPower/hPowerThermo.H index 8285262765..367ef24da1 100644 --- a/src/thermophysicalModels/specie/thermo/hPower/hPowerThermo.H +++ b/src/thermophysicalModels/specie/thermo/hPower/hPowerThermo.H @@ -24,6 +24,9 @@ License Class Foam::hPowerThermo +Group + grpSpecieThermo + Description Power-function based thermodynamics package templated on EquationOfState. diff --git a/src/thermophysicalModels/specie/thermo/hRefConst/hRefConstThermo.H b/src/thermophysicalModels/specie/thermo/hRefConst/hRefConstThermo.H index 9a62231d9c..4f5924ba2a 100644 --- a/src/thermophysicalModels/specie/thermo/hRefConst/hRefConstThermo.H +++ b/src/thermophysicalModels/specie/thermo/hRefConst/hRefConstThermo.H @@ -24,6 +24,9 @@ License Class Foam::hRefConstThermo +Group + grpSpecieThermo + Description Constant properties thermodynamics package templated into the EquationOfState. diff --git a/src/thermophysicalModels/specie/thermo/janaf/janafThermo.H b/src/thermophysicalModels/specie/thermo/janaf/janafThermo.H index e3e4c1657f..27831f9ffd 100644 --- a/src/thermophysicalModels/specie/thermo/janaf/janafThermo.H +++ b/src/thermophysicalModels/specie/thermo/janaf/janafThermo.H @@ -24,6 +24,9 @@ License Class Foam::janafThermo +Group + grpSpecieThermo + Description JANAF tables based thermodynamics package templated into the equation of state. diff --git a/src/thermophysicalModels/specie/thermo/sensibleEnthalpy/sensibleEnthalpy.H b/src/thermophysicalModels/specie/thermo/sensibleEnthalpy/sensibleEnthalpy.H index 07cf5a2765..9e0fd32a8a 100644 --- a/src/thermophysicalModels/specie/thermo/sensibleEnthalpy/sensibleEnthalpy.H +++ b/src/thermophysicalModels/specie/thermo/sensibleEnthalpy/sensibleEnthalpy.H @@ -24,6 +24,9 @@ License Class Foam::sensibleEnthalpy +Group + grpSpecieThermo + Description Thermodynamics mapping class to expose the sensible enthalpy function as the standard enthalpy function h(T). diff --git a/src/thermophysicalModels/specie/thermo/sensibleInternalEnergy/sensibleInternalEnergy.H b/src/thermophysicalModels/specie/thermo/sensibleInternalEnergy/sensibleInternalEnergy.H index b6b5889ff5..3f4386c282 100644 --- a/src/thermophysicalModels/specie/thermo/sensibleInternalEnergy/sensibleInternalEnergy.H +++ b/src/thermophysicalModels/specie/thermo/sensibleInternalEnergy/sensibleInternalEnergy.H @@ -24,6 +24,9 @@ License Class Foam::sensibleInternalEnergy +Group + grpSpecieThermo + Description Thermodynamics mapping class to expose the sensible internal energy function as the standard internal energy function e(T). diff --git a/src/thermophysicalModels/specie/transport/const/constTransport.H b/src/thermophysicalModels/specie/transport/const/constTransport.H index 65cd3c8a41..ba00bbf94b 100644 --- a/src/thermophysicalModels/specie/transport/const/constTransport.H +++ b/src/thermophysicalModels/specie/transport/const/constTransport.H @@ -24,6 +24,9 @@ License Class Foam::constTransport +Group + grpSpecieTransport + Description Constant properties Transport package. Templated into a given thermodynamics package (needed for thermal diff --git a/src/thermophysicalModels/specie/transport/polynomial/polynomialTransport.H b/src/thermophysicalModels/specie/transport/polynomial/polynomialTransport.H index 85ec167256..78d0e1ad57 100644 --- a/src/thermophysicalModels/specie/transport/polynomial/polynomialTransport.H +++ b/src/thermophysicalModels/specie/transport/polynomial/polynomialTransport.H @@ -24,6 +24,9 @@ License Class Foam::polynomialTransport +Group + grpSpecieTransport + Description Transport package using polynomial functions for mu and kappa diff --git a/src/thermophysicalModels/specie/transport/sutherland/sutherlandTransport.H b/src/thermophysicalModels/specie/transport/sutherland/sutherlandTransport.H index e7da7b9a5f..e530cb622b 100644 --- a/src/thermophysicalModels/specie/transport/sutherland/sutherlandTransport.H +++ b/src/thermophysicalModels/specie/transport/sutherland/sutherlandTransport.H @@ -24,6 +24,9 @@ License Class Foam::sutherlandTransport +Group + grpSpecieTransport + Description Transport package using Sutherland's formula.