src/cudaSolvers/cudaCG/cudaCG.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     |
   5     \\  /    A nd           | For copyright notice see file Copyright
   6      \\/     M anipulation  |
   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     cudaCG
  26
  27 Description
  28     Preconditioned Conjugate Gradient solver with run-time selectable
  29     preconditioning for use with GPU
  30
  31 Author
  32     Dominik Christ, Wikki Ltd.
  33     Based on Cufflink library by Daniel P. Combest
  34
  35 SourceFiles
  36     cudaCG.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef cudaCG_H
  41 #define cudaCG_H
  42
  43 #include "cudaSolver.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                              Class cudaCG Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class cudaCG
  55 :
  56     public cudaSolver
  57 {
  58     // Private Member Functions
  59
  60         //- Disallow default bitwise copy construct
  61         cudaCG(const cudaCG&);
  62
  63         //- Disallow default bitwise assignment
  64         void operator=(const cudaCG&);
  65
  66
  67 public:
  68
  69     //- Runtime type information
  70     TypeName("cudaCG");
  71
  72
  73     // Constructors
  74
  75         //- Construct from matrix components and solver data stream
  76         cudaCG
  77         (
  78             const word& fieldName,
  79             const lduMatrix& matrix,
  80             const FieldField<Field, scalar>& coupleBouCoeffs,
  81             const FieldField<Field, scalar>& coupleIntCoeffs,
  82             const lduInterfaceFieldPtrsList& interfaces,
  83             const dictionary& dict
  84         );
  85
  86
  87     // Destructor
  88
  89         virtual ~cudaCG()
  90         {}
  91
  92
  93     // Member Functions
  94
  95         //- Solve the matrix with this solver
  96         virtual lduSolverPerformance solve
  97         (
  98             scalarField& x,
  99             const scalarField& b,
 100             const direction cmpt = 0
 101         ) const;
 102 };
 103
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 } // End namespace Foam
 108
 109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 110
 111 #endif
 112
 113 // ************************************************************************* //