Commit 86cb17b4 authored by Andrew Heather's avatar Andrew Heather
Browse files

ENH: Doxygen documentation updates for module support

parent 49b67312
......@@ -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;
}
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::boundedConvectionScheme
Group
grpFvConvectionSchemes
Description
Bounded form of the selected convection scheme.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::convectionScheme
Group
grpFvConvectionSchemes
Description
Abstract base class for convection schemes.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::gaussConvectionScheme
Group
grpFvConvectionSchemes
Description
Basic second-order convection using face-gradients and Gauss' theorem.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::multivariateGaussConvectionScheme
Group
grpFvConvectionSchemes
Description
Basic second-order convection using face-gradients and Gauss' theorem.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::CoEulerDdtScheme
Group
grpFvDdtSchemes
Description
Courant number limited first-order Euler implicit/explicit ddt.
......
......@@ -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.
......
......@@ -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.
......
......@@ -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
......
......@@ -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.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::boundedDdtScheme
Group
grpFvDdtSchemes
Description
Bounded form of the selected ddt scheme.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::ddtScheme
Group
grpFvDdtSchemes
Description
Abstract base class for ddt schemes.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::localEulerDdtScheme
Group
grpFvDdtSchemes
Description
Local time-step first-order Euler implicit/explicit ddt.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::steadyStateDdtScheme
Group
grpFvDdtSchemes
Description
SteadyState implicit/explicit ddt which returns 0.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::divScheme
Group
grpFvDivSchemes
Description
Abstract base class for div schemes.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::gaussDivScheme
Group
grpFvDivSchemes
Description
Basic second-order div using face-gradients and Gauss' theorem.
......
/*---------------------------------------------------------------------------*\
========= |
\\ / 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 <http://www.gnu.org/licenses/>.
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
\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
@}
\*---------------------------------------------------------------------------*/
......@@ -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
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::fourthGrad
Group
grpFvGradSchemes
Description
Second-order gradient scheme using least-squares.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::gaussGrad
Group
grpFvGradSchemes
Description
Basic second-order gradient scheme using face-interpolation
and Gauss' theorem.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::leastSquaresGrad
Group
grpFvGradSchemes
Description
Second-order gradient scheme using least-squares.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::cellLimitedGrad
Group
grpFvGradSchemes
Description
cellLimitedGrad gradient scheme applied to a runTime selected base gradient
scheme.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::cellMDLimitedGrad
Group
grpFvGradSchemes
Description
cellMDLimitedGrad gradient scheme applied to a runTime selected base
gradient scheme.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::faceLimitedGrad
Group
grpFvGradSchemes
Description
faceLimitedGrad gradient scheme applied to a runTime selected base gradient
scheme.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::faceMDLimitedGrad
Group
grpFvGradSchemes
Description
faceMDLimitedGrad gradient scheme applied to a runTime selected
base gradient scheme.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::gaussLaplacianScheme
Group
grpFvLaplacianSchemes
Description
Basic second-order laplacian using face-gradients and Gauss' theorem.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::laplacianScheme
Group
grpFvLaplacianSchemes
Description
Abstract base class for laplacian schemes.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::CentredFitSnGradScheme
Group
grpFvSnGradSchemes
Description
Centred fit snGrad scheme which applies an explicit correction to snGrad
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::correctedSnGrad
Group
grpFvSnGradSchemes
Description
Simple central-difference snGrad scheme with non-orthogonal correction.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::faceCorrectedSnGrad
Group
grpFvSnGradSchemes
Description
Simple central-difference snGrad scheme with non-orthogonal correction.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::limitedSnGrad
Group
grpFvSnGradSchemes
Description
Run-time selected snGrad scheme with limited non-orthogonal correction.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::orthogonalSnGrad
Group
grpFvSnGradSchemes
Description
Simple central-difference snGrad scheme without non-orthogonal correction.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::snGradScheme
Group
grpFvSnGradSchemes
Description
Abstract base class for snGrad schemes.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::uncorrectedSnGrad
Group
grpFvSnGradSchemes
Description
Simple central-difference snGrad scheme without non-orthogonal correction.
......
......@@ -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
......
......@@ -24,6 +24,9 @@ License
Class
Foam::LimitedLimiter
Group
grpFvLimitedSurfaceInterpolationSchemes
Description
Foam::LimitedLimiter
......
......@@ -24,6 +24,9 @@ License
Class
Foam::Limited01Limiter
Group
grpFvLimitedSurfaceInterpolationSchemes
Description
A LimitedLimiter with the range 0-1
......
......@@ -24,6 +24,9 @@ License
Class
Foam::LimitedScheme
Group
grpFvLimitedSurfaceInterpolationSchemes
Description
Class to create NVD/TVD limited weighting-factors.
......
......@@ -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.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::MinmodLimiter
Group
grpFvLimitedSurfaceInterpolationSchemes
Description
Class with limiter function which returns the limiter for the
Minmod differencing scheme.
......
......@@ -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
......
......@@ -24,6 +24,9 @@ License
Class
Foam::PhiLimiter
Group
grpFvLimitedSurfaceInterpolationSchemes
Description
Class with limiter function which returns the limiter for the
Phi differencing scheme.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::PhiScheme
Group
grpFvLimitedSurfaceInterpolationSchemes
Description
Class to create the weighting-factors based on the face-flux.
......
......@@ -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.
......