src/lduSolvers/lduSolver/cgSolver/cgSolver.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM 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 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     cgSolver
  27
  28 Description
  29     Preconditioned Conjugate Gradient solver with run-time selectable
  30     preconditioning.
  31
  32 Author
  33     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  34
  35 SourceFiles
  36     cgSolver.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef cgSolver_H
  41 #define cgSolver_H
  42
  43 #include "lduMatrix.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                              Class cgSolver Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class cgSolver
  55 :
  56     public lduSolver
  57 {
  58     // Private Data
  59
  60         //- Preconditioner
  61         autoPtr<lduPreconditioner> preconPtr_;
  62
  63
  64     // Private Member Functions
  65
  66         //- Disallow default bitwise copy construct
  67         cgSolver(const cgSolver&);
  68
  69         //- Disallow default bitwise assignment
  70         void operator=(const cgSolver&);
  71
  72
  73 public:
  74
  75     //- Runtime type information
  76     TypeName("CG");
  77
  78
  79     // Constructors
  80
  81         //- Construct from matrix components and solver data stream
  82         cgSolver
  83         (
  84             const word& fieldName,
  85             const lduMatrix& matrix,
  86             const FieldField<Field, scalar>& coupleBouCoeffs,
  87             const FieldField<Field, scalar>& coupleIntCoeffs,
  88             const lduInterfaceFieldPtrsList& interfaces,
  89             const dictionary& dict
  90         );
  91
  92
  93     // Destructor
  94
  95         virtual ~cgSolver()
  96         {}
  97
  98
  99     // Member Functions
 100
 101         //- Solve the matrix with this solver
 102         virtual lduSolverPerformance solve
 103         (
 104             scalarField& x,
 105             const scalarField& b,
 106             const direction cmpt = 0
 107         ) const;
 108 };
 109
 110
 111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 112
 113 } // End namespace Foam
 114
 115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 116
 117 #endif
 118
 119 // ************************************************************************* //