Commit e57a0e68 authored by Andrew Heather's avatar Andrew Heather
Browse files

ENH: (further) Doxygen documentation updates for module support

parent b6ad46e1
......@@ -578,7 +578,7 @@ SORT_MEMBERS_CTORS_1ST = NO
# appear in their defined order.
# The default value is: NO.
SORT_GROUP_NAMES = NO
SORT_GROUP_NAMES = YES
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
# fully-qualified names, including namespaces. If set to NO, the class list will
......
......@@ -3,7 +3,7 @@
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2015 OpenFOAM Foundation
\\/ M anipulation |
\\/ M anipulation | Copyright (C) 2016 OpenCFD Ltd.
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
......@@ -56,8 +56,22 @@ License
\section usingTheCode Using the code
Solvers
- \subpage pageSolvers
Modelling
- \subpage pageThermophsyicalModels
- \subpage pageTurbulenceModelling
- \subpage pageLagrangianIntermediate
Boundary conditions
- \subpage pageBoundaryConditions
Numerics
- \subpage pageFiniteVolumeSchemes
- \subpage pageMatrixSolvers
Post-processing
- \subpage pagePostProcessing
......
/*---------------------------------------------------------------------------*\
========= |
\\ / 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/>.
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
\page pageMatrixSolvers Matrix solvers
\section secSchemes Overview
The available matrix solvers are grouped into the following categories:
- \ref grpLduMatrix
- \ref grpLduMatrixPreconditioners
- \ref grpLduMatrixSmoothers
- \ref grpLduMatrixSolvers
\*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*\
========= |
\\ / 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 grpNumerics Numerics
@{
This group contains numerics
@}
\defgroup grpLduMatrix Matrix manipulation and solvers
@{
\ingroup grpNumerics
This group contains matrices
@}
\defgroup grpLduMatrixPreconditioners Preconditioners
@{
\ingroup grpLduMatrix
This group contains matrix preconditioners
@}
\defgroup grpLduMatrixSmoothers Smoothers
@{
\ingroup grpLduMatrix
This group contains matrix smoothers
@}
\defgroup grpLduMatrixSolvers Solvers
@{
\ingroup grpLduMatrix
This group contains matrix solvers
@}
\*---------------------------------------------------------------------------*/
......@@ -24,6 +24,9 @@ License
Class
Foam::DICPreconditioner
Group
grpLduMatrixPreconditioners
Description
Simplified diagonal-based incomplete Cholesky preconditioner for symmetric
matrices (symmetric equivalent of DILU). The reciprocal of the
......
......@@ -24,6 +24,9 @@ License
Class
Foam::DILUPreconditioner
Group
grpLduMatrixPreconditioners
Description
Simplified diagonal-based incomplete LU preconditioner for asymmetric
matrices. The reciprocal of the preconditioned diagonal is calculated
......
......@@ -24,6 +24,9 @@ License
Class
Foam::FDICPreconditioner
Group
grpLduMatrixPreconditioners
Description
Faster version of the DICPreconditioner diagonal-based incomplete
Cholesky preconditioner for symmetric matrices
......
......@@ -24,6 +24,9 @@ License
Class
Foam::GAMGPreconditioner
Group
grpLduMatrixPreconditioners
Description
Geometric agglomerated algebraic multigrid preconditioner.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::diagonalPreconditioner
Group
grpLduMatrixPreconditioners
Description
Diagonal preconditioner for both symmetric and asymmetric matrices.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::noPreconditioner
Group
grpLduMatrixPreconditioners
Description
Null preconditioner for both symmetric and asymmetric matrices.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::DICSmoother
Group
grpLduMatrixSmoothers
Description
Simplified diagonal-based incomplete Cholesky smoother for symmetric
matrices.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::DICGaussSeidelSmoother
Group
grpLduMatrixSmoothers
Description
Combined DIC/GaussSeidel smoother for symmetric matrices in which DIC
smoothing is followed by GaussSeidel to ensure that any "spikes" created
......
......@@ -24,6 +24,9 @@ License
Class
Foam::DILUSmoother
Group
grpLduMatrixSmoothers
Description
Simplified diagonal-based incomplete LU smoother for asymmetric matrices.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::GaussSeidelSmoother
Group
grpLduMatrixSmoothers
Description
A lduMatrix::smoother for Gauss-Seidel
......
......@@ -24,6 +24,9 @@ License
Class
Foam::nonBlockingGaussSeidelSmoother
Group
grpLduMatrixSmoothers
Description
Variant of gaussSeidelSmoother that expects processor boundary
cells to be sorted last and so can block later. Only when the
......
......@@ -24,6 +24,9 @@ License
Class
Foam::symGaussSeidelSmoother
Group
grpLduMatrixSmoothers
Description
A lduMatrix::smoother for symmetric Gauss-Seidel
......
......@@ -24,6 +24,9 @@ License
Class
Foam::BICCG
Group
grpLduMatrixSolvers
Description
Diagonal incomplete LU preconditioned BiCG solver derived from the general
preconditioned BiCG solver PBiCG but with the choice of preconditioner
......@@ -49,7 +52,7 @@ namespace Foam
{
/*---------------------------------------------------------------------------*\
Class BICCG Declaration
Class BICCG Declaration
\*---------------------------------------------------------------------------*/
class BICCG
......@@ -64,6 +67,7 @@ class BICCG
//- Disallow default bitwise assignment
void operator=(const BICCG&);
public:
//- Return the dictionary constructed from the components.
......@@ -112,7 +116,6 @@ public:
//- Destructor
virtual ~BICCG()
{}
};
......
......@@ -24,10 +24,13 @@ License
Class
Foam::GAMGSolver
Group
grpLduMatrixSolvers
Description
Geometric agglomerated algebraic multigrid solver.
Characteristics:
Characteristics:
- Requires positive definite, diagonally dominant matrix.
- Agglomeration algorithm: selectable and optionally cached.
- Restriction operator: summation.
......@@ -65,7 +68,7 @@ namespace Foam
{
/*---------------------------------------------------------------------------*\
Class GAMGSolver Declaration
Class GAMGSolver Declaration
\*---------------------------------------------------------------------------*/
class GAMGSolver
......
......@@ -24,6 +24,9 @@ License
Class
Foam::ICCG
Group
grpLduMatrixSolvers
Description
Incomplete Cholesky preconditioned CG solver derived from the general
preconditioned CG solver PCG but with the choice of preconditioner
......@@ -64,6 +67,7 @@ class ICCG
//- Disallow default bitwise assignment
void operator=(const ICCG&);
public:
//- Return the dictionary constructed from the components.
......@@ -111,7 +115,6 @@ public:
//- Destructor
virtual ~ICCG()
{}
};
......
......@@ -24,6 +24,9 @@ License
Class
Foam::PCG
Group
grpLduMatrixSolvers
Description
Preconditioned conjugate gradient solver for symmetric lduMatrices
using a run-time selectable preconditioner.
......@@ -44,7 +47,7 @@ namespace Foam
{
/*---------------------------------------------------------------------------*\
Class PCG Declaration
Class PCG Declaration
\*---------------------------------------------------------------------------*/
class PCG
......
......@@ -24,6 +24,9 @@ License
Class
Foam::diagonalSolver
Group
grpLduMatrixSolvers
Description
Foam::diagonalSolver
......@@ -43,7 +46,7 @@ namespace Foam
{
/*---------------------------------------------------------------------------*\
Class diagonalSolver Declaration
Class diagonalSolver Declaration
\*---------------------------------------------------------------------------*/
class diagonalSolver
......
......@@ -24,6 +24,9 @@ License
Class
Foam::smoothSolver
Group
grpLduMatrixSolvers
Description
Iterative solver for symmetric and asymetric matrices which uses a
run-time selected smoother e.g. GaussSeidel to converge the solution to
......@@ -65,6 +68,7 @@ protected:
//- Read the control parameters from the controlDict_
virtual void readControls();
public:
//- Runtime type information
......
/*---------------------------------------------------------------------------*\
========= |
\\ / 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/>.
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
\page pageTurbulenceModelling Turbulence modelling
\section secSchemes Overview
The available turbulence models are grouped into the following categories:
- \ref grpTurbulence
- \ref grpRASTurbulence
- \ref grpDESTurbulence
- \ref grpLESTurbulence
\*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*\
========= |
\\ / 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/>.
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
\page pageFiniteVolumeSchemes Numerical schemes
\section secSchemes Overview
The available numerical schemes are grouped into the following categories:
- \ref grpFvGradSchemes
- \ref grpFvSnGradSchemes
- \ref grpFvDivSchemes
- \ref grpFvLaplacianSchemes
- \ref grpFvDdtSchemes
- \ref grpFvConvectionSchemes
- \ref grpFvSurfaceInterpolationSchemes
- \ref grpFvLimitedSurfaceInterpolationSchemes
\*---------------------------------------------------------------------------*/
......@@ -25,6 +25,7 @@ License
\defgroup grpFvSchemes Finite volume numerical schemes
@{
\ingroup grpNumerics
This group contains finite volume numerical schemes
@}
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::fixedTemperatureConstraint
Group
grpFvOptionsConstraints
Description
Fixed temperature equation constraint
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::velocityDampingConstraint
Group
grpFvOptionsConstraints
Description
Constraint for velocity to dampen velocity fluctuations in
steady simulations
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::explicitSetValue
Group
grpFvOptionsConstraints
Description
Set values field values explicity.
......
......@@ -24,6 +24,9 @@ License
Class
Foam::fv::limitTemperature
Group
grpFvOptionsCorrections
Description
Correction for temperature to apply limits between minimum and maximum
values
......
/*---------------------------------------------------------------------------*\
========= |
\\ / 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 grpFvOptions Finite volume Options
@{
\ingroup grpNumerics
This group contains finite volume options
@}
\defgroup grpFvOptionsSources Sources
@{
\ingroup grpFvOptions
This group contains finite volume sources
@}
\defgroup grpFvOptionsCorrections Corrections
@{
\ingroup grpFvOptions
This group contains finite volume corrections
@}
\defgroup grpFvOptionsConstraints Constraints
@{
\ingroup grpFvOptions
This group contains finite volume constraints
@}