src/lduSolvers/amg/amgPolicy/amgPolicy.H

   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 Class
  25     amgPolicy
  26
  27 Description
  28     Virtual base class for AMG coarsening policy
  29
  30 Author
  31     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  32
  33 SourceFiles
  34     amgPolicy.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef amgPolicy_H
  39 #define amgPolicy_H
  40
  41 #include "runTimeSelectionTables.H"
  42 #include "primitiveFieldsFwd.H"
  43 #include "FieldFields.H"
  44 #include "lduInterfaceFieldPtrsList.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 class lduMatrix;
  52 class amgMatrix;
  53
  54 /*---------------------------------------------------------------------------*\
  55                            Class amgPolicy Declaration
  56 \*---------------------------------------------------------------------------*/
  57
  58 class amgPolicy
  59 {
  60     // Private Data
  61
  62         //- Group size
  63         label groupSize_;
  64
  65         //- Minimum number of coarse level equations
  66         label minCoarseEqns_;
  67
  68
  69     // Private Member Functions
  70
  71         //- Disallow default bitwise copy construct
  72         amgPolicy(const amgPolicy&);
  73
  74         //- Disallow default bitwise assignment
  75         void operator=(const amgPolicy&);
  76
  77
  78 public:
  79
  80         //- Runtime type information
  81         virtual const word& type() const = 0;
  82
  83
  84         // Declare run-time constructor selection tables
  85
  86             declareRunTimeSelectionTable
  87             (
  88                 autoPtr,
  89                 amgPolicy,
  90                 matrix,
  91                 (
  92                     const lduMatrix& matrix,
  93                     const label groupSize,
  94                     const label minCoarseEqns
  95                 ),
  96                 (matrix, groupSize, minCoarseEqns)
  97             );
  98
  99
 100     // Selectors
 101
 102         //- Select given name, group size and matrix
 103         static autoPtr<amgPolicy> New
 104         (
 105             const word& policyType,
 106             const lduMatrix& matrix,
 107             const label groupSize,
 108             const label minCoarseEqns
 109         );
 110
 111
 112     // Constructors
 113
 114         //- Construct from components
 115         amgPolicy
 116         (
 117             const label groupSize,
 118             const label minCoarseEqns
 119         )
 120         :
 121             groupSize_(groupSize),
 122             minCoarseEqns_(minCoarseEqns)
 123         {}
 124
 125
 126     // Destructor
 127
 128         virtual ~amgPolicy()
 129         {}
 130
 131
 132     // Member Functions
 133
 134         //- Return group size
 135         label groupSize() const
 136         {
 137             return groupSize_;
 138         }
 139
 140         //- Return minimum number of coarse level equations
 141         label minCoarseEqns() const
 142         {
 143             return minCoarseEqns_;
 144         }
 145
 146         //- Can a coarse level be constructed?
 147         virtual bool coarsen() const = 0;
 148
 149         //- Restrict matrix
 150         virtual autoPtr<amgMatrix> restrictMatrix
 151         (
 152             const FieldField<Field, scalar>& bouCoeffs,
 153             const FieldField<Field, scalar>& intCoeffs,
 154             const lduInterfaceFieldPtrsList& interfaces
 155         ) const = 0;
 156
 157         //- Restrict residual
 158         virtual void restrictResidual
 159         (
 160             const scalarField& res,
 161             scalarField& coarseRes
 162         ) const = 0;
 163
 164         //- Prolongate correction
 165         virtual void prolongateCorrection
 166         (
 167             scalarField& x,
 168             const scalarField& coarseX
 169         ) const = 0;
 170 };
 171
 172
 173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 174
 175 } // End namespace Foam
 176
 177 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 178
 179 #endif
 180
 181 // ************************************************************************* //