src/OpenFOAM/matrices/blockLduMatrix/BlockLduSolvers/BlockDiagonal/BlockDiagonalSolver.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-6 H. Jasak All rights reserved
   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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  24
  25 Class
  26     BlockDiagonalSolver
  27
  28 Description
  29     Solver for diagonal matrices
  30
  31 Author
  32     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  33
  34 SourceFiles
  35     BlockDiagonalSolver.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef BlockDiagonalSolver_H
  40 #define BlockDiagonalSolver_H
  41
  42 #include "Field.H"
  43 #include "typeInfo.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 template<class Type>
  51 class BlockLduMatrix;
  52
  53 template<class Type>
  54 class BlockLduSolver;
  55
  56 template<class Type>
  57 class BlockSolverPerformance;
  58
  59 /*---------------------------------------------------------------------------*\
  60                       Class BlockDiagonalSolver Declaration
  61 \*---------------------------------------------------------------------------*/
  62
  63 template<class Type>
  64 class BlockDiagonalSolver
  65 :
  66     public BlockLduSolver<Type>
  67 {
  68     // Private Member Functions
  69
  70         //- Disallow default bitwise copy construct
  71         BlockDiagonalSolver(const BlockDiagonalSolver<Type>&);
  72
  73         //- Disallow default bitwise assignment
  74         void operator=(const BlockDiagonalSolver<Type>&);
  75
  76
  77 public:
  78
  79     //- Runtime type information
  80     TypeName("Diagonal");
  81
  82
  83     // Constructors
  84
  85         //- Construct from matrix
  86         BlockDiagonalSolver
  87         (
  88             const word& fieldName,
  89             const BlockLduMatrix<Type>& matrix,
  90             const dictionary& dict
  91         );
  92
  93
  94     // Member Functions
  95
  96         //- Solve the matrix with this solver
  97         virtual BlockSolverPerformance<Type> solve
  98         (
  99             Field<Type>& x,
 100             const Field<Type>& b
 101         );
 102 };
 103
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 } // End namespace Foam
 108
 109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 110
 111 #ifdef NoRepository
 112 #   include "BlockDiagonalSolver.C"
 113 #endif
 114
 115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 116
 117 #endif
 118
 119 // ************************************************************************* //