src/OpenFOAM/matrices/blockLduMatrix/BlockLduSolvers/Segregated/SegregatedSolver.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     SegregatedSolver
  27
  28 Description
  29     Segregated solver for block matrices.  Segregation decouples block
  30     coefficients and calls a scalar solver for each component separately.
  31     Cross-component coupling is lagged in rhs.
  32
  33 Author
  34     Hrvoje Jasak, Wikki Ltd.  All rights reserved
  35
  36 SourceFiles
  37     SegregatedSolver.C
  38
  39 \*---------------------------------------------------------------------------*/
  40
  41 #ifndef SegregatedSolver_H
  42 #define SegregatedSolver_H
  43
  44 #include "blockLduSolvers.H"
  45 #include "BlockIterativeSolver.H"
  46
  47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  48
  49 namespace Foam
  50 {
  51
  52 /*---------------------------------------------------------------------------*\
  53                        Class SegregatedSolver Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 template<class Type>
  57 class SegregatedSolver
  58 :
  59     public BlockLduSolver<Type>
  60 {
  61     // Private data
  62
  63         //- Scalar x
  64         scalarField scalarX_;
  65
  66         //- Scalar matrix
  67         blockScalarMatrix scalarMatrix_;
  68
  69         //- Scalar b
  70         scalarField scalarB_;
  71
  72
  73     // Private Member Functions
  74
  75         //- Disallow default bitwise copy construct
  76         SegregatedSolver(const SegregatedSolver<Type>&);
  77
  78         //- Disallow default bitwise assignment
  79         void operator=(const SegregatedSolver<Type>&);
  80
  81
  82 public:
  83
  84     //- Runtime type information
  85     TypeName("Segregated");
  86
  87
  88     // Constructors
  89
  90         //- Construct from matrix components and solver data stream
  91         SegregatedSolver
  92         (
  93             const word& fieldName,
  94             const BlockLduMatrix<Type>& matrix,
  95             const dictionary& dict
  96         );
  97
  98
  99         // Destructor
 100
 101             virtual ~SegregatedSolver()
 102             {}
 103
 104
 105     // Member Functions
 106
 107         //- Solve the matrix with this solver
 108         virtual BlockSolverPerformance<Type> solve
 109         (
 110             Field<Type>& x,
 111             const Field<Type>& b
 112         );
 113
 114 };
 115
 116
 117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 118
 119 } // End namespace Foam
 120
 121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 122
 123 #ifdef NoRepository
 124 #   include "SegregatedSolver.C"
 125 #endif
 126
 127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 128
 129 #endif
 130
 131 // ************************************************************************* //