src/OpenFOAM/matrices/lduMatrix/solvers/diagonalSolver/diagonalSolver.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   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     Foam::diagonalSolver
  27
  28 Description
  29     Foam::diagonalSolver
  30
  31 SourceFiles
  32     diagonalSolver.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef diagonalSolver_H
  37 #define diagonalSolver_H
  38
  39 #include "lduMatrix.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class diagonalSolver Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class diagonalSolver
  51 :
  52     public lduMatrix::solver
  53 {
  54     // Private Member Functions
  55
  56         //- Disallow default bitwise copy construct
  57         diagonalSolver(const diagonalSolver&);
  58
  59         //- Disallow default bitwise assignment
  60         void operator=(const diagonalSolver&);
  61
  62
  63 public:
  64
  65     //- Runtime type information
  66     TypeName("diagonal");
  67
  68
  69     // Constructors
  70
  71         //- Construct from matrix and solver controls
  72         diagonalSolver
  73         (
  74             const word& fieldName,
  75             const lduMatrix& matrix,
  76             const FieldField<Field, scalar>& interfaceBouCoeffs,
  77             const FieldField<Field, scalar>& interfaceIntCoeffs,
  78             const lduInterfaceFieldPtrsList& interfaces,
  79             const dictionary& solverControls
  80         );
  81
  82
  83     // Member Functions
  84
  85         //- Read and reset the solver parameters from the given stream
  86         void read(const dictionary&)
  87         {}
  88
  89         //- Solve the matrix with this solver
  90         lduMatrix::solverPerformance solve
  91         (
  92             scalarField& psi,
  93             const scalarField& source,
  94             const direction cmpt=0
  95         ) const;
  96 };
  97
  98
  99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 100
 101 } // End namespace Foam
 102
 103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 104
 105 #endif
 106
 107 // ************************************************************************* //