src/foam/matrices/lduMatrix/preconditioners/GAMGPreconditioner/GAMGPreconditioner.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation, either version 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 \*---------------------------------------------------------------------------*/
  25
  26 #include "GAMGPreconditioner.H"
  27
  28 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  29
  30 namespace Foam
  31 {
  32     defineTypeNameAndDebug(GAMGPreconditioner, 0);
  33
  34     lduPreconditioner::addsymMatrixConstructorToTable
  35     <GAMGPreconditioner> addGAMGPreconditionerSymMatrixConstructorToTable_;
  36
  37     lduPreconditioner::addasymMatrixConstructorToTable
  38     <GAMGPreconditioner> addGAMGPreconditionerAsymMatrixConstructorToTable_;
  39 }
  40
  41
  42 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  43
  44 Foam::GAMGPreconditioner::GAMGPreconditioner
  45 (
  46     const lduMatrix& matrix,
  47     const FieldField<Field, scalar>& coupleBouCoeffs,
  48     const FieldField<Field, scalar>& coupleIntCoeffs,
  49     const lduInterfaceFieldPtrsList& interfaces,
  50     const dictionary& dict
  51 )
  52 :
  53     lduPreconditioner
  54     (
  55         matrix,
  56         coupleBouCoeffs,
  57         coupleIntCoeffs,
  58         interfaces
  59     ),
  60     GAMG_
  61     (
  62         "dummy",
  63         matrix,
  64         coupleBouCoeffs,
  65         coupleIntCoeffs,
  66         interfaces,
  67         dict
  68     ),
  69     nVcycles_(2)
  70 {
  71     readControls();
  72 }
  73
  74
  75 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
  76
  77 Foam::GAMGPreconditioner::~GAMGPreconditioner()
  78 {}
  79
  80
  81 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  82
  83 void Foam::GAMGPreconditioner::readControls()
  84 {
  85     GAMG_.readControls();
  86     nVcycles_ = GAMG_.dict().lookupOrDefault<label>("nVcycles", 2);
  87 }
  88
  89
  90 void Foam::GAMGPreconditioner::precondition
  91 (
  92     scalarField& wA,
  93     const scalarField& rA,
  94     const direction cmpt
  95 ) const
  96 {
  97     wA = 0.0;
  98     scalarField AwA(wA.size());
  99     scalarField finestCorrection(wA.size());
 100     scalarField finestResidual(rA);
 101
 102     // Create coarse grid correction fields
 103     PtrList<scalarField> coarseCorrX;
 104
 105     // Create coarse grid sources
 106     PtrList<scalarField> coarseB;
 107
 108     // Create the smoothers for all levels
 109     PtrList<lduSmoother> smoothers;
 110
 111     // Initialise the above data structures
 112     GAMG_.initVcycle(coarseCorrX, coarseB, smoothers);
 113
 114     for (label cycle=0; cycle<nVcycles_; cycle++)
 115     {
 116         GAMG_.Vcycle
 117         (
 118             smoothers,
 119             wA,
 120             rA,
 121             AwA,
 122             finestCorrection,
 123             finestResidual,
 124             coarseCorrX,
 125             coarseB,
 126             cmpt
 127         );
 128
 129         if (cycle < nVcycles_ - 1)
 130         {
 131             // Calculate finest level residual field
 132             matrix_.Amul(AwA, wA, coupleBouCoeffs_, interfaces_, cmpt);
 133             finestResidual = rA;
 134             finestResidual -= AwA;
 135         }
 136     }
 137 }
 138
 139
 140 // ************************************************************************* //