File size: 11,434 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2026 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::GAMGSolver
Description
Geometric agglomerated algebraic multigrid solver.
Characteristics:
- Requires positive definite, diagonally dominant matrix.
- Agglomeration algorithm: selectable and optionally cached.
- Restriction operator: summation.
- Prolongation operator: injection.
- Smoother: Gauss-Seidel.
- Coarse matrix creation: central coefficient: summation of fine grid
central coefficients with the removal of intra-cluster face;
off-diagonal coefficient: summation of off-diagonal faces.
- Coarse matrix scaling: performed by correction scaling, using steepest
descent optimisation.
- Type of cycle: V-cycle with optional pre-smoothing.
- Coarsest-level matrix solved using PCG or PBiCGStab.
SourceFiles
GAMGSolver.C
GAMGSolverAgglomerateMatrix.C
GAMGSolverInterpolate.C
GAMGSolverScale.C
GAMGSolverSolve.C
\*---------------------------------------------------------------------------*/
#ifndef GAMGSolver_H
#define GAMGSolver_H
#include "GAMGAgglomeration.H"
#include "lduMatrix.H"
#include "labelField.H"
#include "primitiveFields.H"
#include "LUscalarMatrix.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class GAMGSolver Declaration
\*---------------------------------------------------------------------------*/
class GAMGSolver
:
public lduMatrix::solver
{
// Private Data
bool cacheAgglomeration_;
//- Number of pre-smoothing sweeps
label nPreSweeps_;
//- Lever multiplier for the number of pre-smoothing sweeps
label preSweepsLevelMultiplier_;
//- Maximum number of pre-smoothing sweeps
label maxPreSweeps_;
//- Number of post-smoothing sweeps
label nPostSweeps_;
//- Lever multiplier for the number of post-smoothing sweeps
label postSweepsLevelMultiplier_;
//- Maximum number of post-smoothing sweeps
label maxPostSweeps_;
//- Number of smoothing sweeps on finest mesh
label nFinestSweeps_;
//- Choose if the corrections should be interpolated after injection.
// By default corrections are not interpolated.
bool interpolateCorrection_;
//- Choose if the corrections should be scaled.
// By default corrections for symmetric matrices are scaled
// but not for asymmetric matrices.
bool scaleCorrection_;
//- Direct or iteratively solve the coarsest level
bool directSolveCoarsest_;
//- The agglomeration
const GAMGAgglomeration& agglomeration_;
//- Hierarchy of matrix levels
PtrList<lduMatrix> matrixLevels_;
//- Hierarchy of interfaces.
PtrList<PtrList<lduInterfaceField>> primitiveInterfaceLevels_;
//- Hierarchy of interfaces in lduInterfaceFieldPtrs form
PtrList<lduInterfaceFieldPtrsList> interfaceLevels_;
//- Hierarchy of interface boundary coefficients
PtrList<Field<Field<scalar>>> interfaceLevelsBouCoeffs_;
//- Hierarchy of interface internal coefficients
PtrList<Field<Field<scalar>>> interfaceLevelsIntCoeffs_;
//- LU decomposed coarsest matrix for direct solution on the master
autoPtr<LUscalarMatrix> coarsestLUMatrixPtr_;
//- Coarsest matrix solver for iterative solution
autoPtr<lduMatrix::solver> coarsestSolverPtr_;
// Private Member Functions
//- Read control parameters from the control dictionary
virtual void readControls();
//- Simplified access to interface level
const lduInterfaceFieldPtrsList& interfaceLevel
(
const label i
) const;
//- Simplified access to matrix level
const lduMatrix& matrixLevel(const label i) const;
//- Simplified access to interface boundary coeffs level
const Field<Field<scalar>>& interfaceBouCoeffsLevel
(
const label i
) const;
//- Simplified access to interface internal coeffs level
const Field<Field<scalar>>& interfaceIntCoeffsLevel
(
const label i
) const;
//- Agglomerate coarse matrix. Supply mesh to use - so we can
// construct temporary matrix on the fine mesh (instead of the coarse
// mesh)
void agglomerateMatrix
(
const label fineLevelIndex,
const lduMesh& coarseMesh,
const lduInterfacePtrsList& coarseMeshInterfaces
);
//- Agglomerate coarse interface coefficients
void agglomerateInterfaceCoefficients
(
const label fineLevelIndex,
const lduInterfacePtrsList& coarseMeshInterfaces,
PtrList<lduInterfaceField>& coarsePrimInterfaces,
lduInterfaceFieldPtrsList& coarseInterfaces,
Field<Field<scalar>>& coarseInterfaceBouCoeffs,
Field<Field<scalar>>& coarseInterfaceIntCoeffs
) const;
//- Collect matrices from other processors
void gatherMatrices
(
const labelList& procIDs,
const lduMesh& dummyMesh,
const label meshComm,
const lduMatrix& mat,
const Field<Field<scalar>>& interfaceBouCoeffs,
const Field<Field<scalar>>& interfaceIntCoeffs,
const lduInterfaceFieldPtrsList& interfaces,
PtrList<lduMatrix>& otherMats,
PtrList<Field<Field<scalar>>>& otherBouCoeffs,
PtrList<Field<Field<scalar>>>& otherIntCoeffs,
List<boolList>& otherTransforms,
List<List<label>>& otherRanks
) const;
//- Agglomerate processor matrices
void procAgglomerateMatrix
(
// Agglomeration information
const labelList& procAgglomMap,
const List<label>& agglomProcIDs,
const label levelI,
// Resulting matrix
autoPtr<lduMatrix>& allMatrixPtr,
Field<Field<scalar>>& allInterfaceBouCoeffs,
Field<Field<scalar>>& allInterfaceIntCoeffs,
PtrList<lduInterfaceField>& allPrimitiveInterfaces,
lduInterfaceFieldPtrsList& allInterfaces
) const;
//- Agglomerate processor matrices
void procAgglomerateMatrix
(
const labelList& procAgglomMap,
const List<label>& agglomProcIDs,
const label levelI
);
//- Interpolate the correction after injected prolongation
void interpolate
(
scalarField& psi,
scalarField& Apsi,
const lduMatrix& m,
const Field<Field<scalar>>& interfaceBouCoeffs,
const lduInterfaceFieldPtrsList& interfaces,
const direction cmpt
) const;
//- Interpolate the correction after injected prolongation and
// re-normalise
void interpolate
(
scalarField& psi,
scalarField& Apsi,
const lduMatrix& m,
const Field<Field<scalar>>& interfaceBouCoeffs,
const lduInterfaceFieldPtrsList& interfaces,
const labelList& restrictAddressing,
const scalarField& psiC,
const direction cmpt
) const;
//- Calculate and apply the scaling factor from Acf, coarseSource
// and coarseField.
// At the same time do a Jacobi iteration on the coarseField using
// the Acf provided after the coarseField values are used for the
// scaling factor.
void scale
(
scalarField& field,
scalarField& Acf,
const lduMatrix& A,
const Field<Field<scalar>>& interfaceLevelBouCoeffs,
const lduInterfaceFieldPtrsList& interfaceLevel,
const scalarField& source,
const direction cmpt
) const;
//- Initialise the data structures for the V-cycle
void initVcycle
(
PtrList<scalarField>& coarseCorrFields,
PtrList<scalarField>& coarseSources,
PtrList<lduMatrix::smoother>& smoothers,
scalarField& scratch1,
scalarField& scratch2
) const;
//- Perform a single GAMG V-cycle with pre, post and finest smoothing.
void Vcycle
(
const PtrList<lduMatrix::smoother>& smoothers,
scalarField& psi,
const scalarField& source,
scalarField& Apsi,
scalarField& finestCorrection,
scalarField& finestResidual,
scalarField& scratch1,
scalarField& scratch2,
PtrList<scalarField>& coarseCorrFields,
PtrList<scalarField>& coarseSources,
const direction cmpt=0
) const;
//- Solve the coarsest level with either an iterative or direct solver
void solveCoarsestLevel
(
scalarField& coarsestCorrField,
const scalarField& coarsestSource
) const;
public:
friend class GAMGPreconditioner;
//- Runtime type information
TypeName("GAMG");
// Constructors
//- Construct from lduMatrix and solver controls
GAMGSolver
(
const word& fieldName,
const lduMatrix& matrix,
const Field<Field<scalar>>& interfaceBouCoeffs,
const Field<Field<scalar>>& interfaceIntCoeffs,
const lduInterfaceFieldPtrsList& interfaces,
const dictionary& solverControls
);
//- Destructor
virtual ~GAMGSolver();
// Member Functions
//- Solve
virtual solverPerformance solve
(
scalarField& psi,
const scalarField& source,
const direction cmpt=0
) const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|