Commit d31adaeb 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
......
......@@ -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
......
......@@ -25,6 +25,7 @@ License
\defgroup grpFvSchemes Finite volume numerical schemes
@{
\ingroup grpNumerics
This group contains finite volume numerical schemes
@}
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment