src/coupledMatrix/coupledLduSolver/cgSolver/coupledCgSolver.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     coupledCgSolver
  26
  27 Description
  28     Preconditioned Conjugate Gradient solver for coupled matrices with
  29     run-time selectable preconditioning.
  30
  31 Author
  32     Hrvoje Jasak, Wikki Ltd.  All rights reserved.
  33
  34 SourceFiles
  35     coupledCgSolver.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef coupledCgSolver_H
  40 #define coupledCgSolver_H
  41
  42 #include "coupledIterativeSolver.H"
  43 #include "coupledLduPrecon.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                       Class coupledCgSolver Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class coupledCgSolver
  55 :
  56     public coupledIterativeSolver
  57 {
  58     // Private Data
  59
  60         // Preconditioner
  61         autoPtr<coupledLduPrecon> preconPtr_;
  62
  63
  64     // Private Member Functions
  65
  66         //- Disallow default bitwise copy construct
  67         coupledCgSolver(const coupledCgSolver&);
  68
  69         //- Disallow default bitwise assignment
  70         void operator=(const coupledCgSolver&);
  71
  72
  73 public:
  74
  75     //- Runtime type information
  76     TypeName("CG");
  77
  78
  79     // Constructors
  80
  81         //- Construct from matrix
  82         coupledCgSolver
  83         (
  84             const word& fieldName,
  85             const coupledLduMatrix& matrix,
  86             const PtrList<FieldField<Field, scalar> >& bouCoeffs,
  87             const PtrList<FieldField<Field, scalar> >& intCoeffs,
  88             const lduInterfaceFieldPtrsListList& interfaces,
  89             const dictionary& solverData
  90         );
  91
  92
  93     // Destructor
  94
  95         virtual ~coupledCgSolver()
  96         {}
  97
  98
  99     // Member Functions
 100
 101         //- Solve the matrix with this solver
 102         virtual coupledSolverPerformance solve
 103         (
 104             FieldField<Field, scalar>& x,
 105             const FieldField<Field, scalar>& b,
 106             const direction cmpt = 0
 107         ) const;
 108 };
 109
 110
 111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 112
 113 } // End namespace Foam
 114
 115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 116
 117 #endif
 118
 119 // ************************************************************************* //