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