src/OpenFOAM/matrices/solution/solution.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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::solution
  27
  28 Description
  29     Selector class for relaxation factors, solver type and solution.
  30
  31 SourceFiles
  32     solution.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef solution_H
  37 #define solution_H
  38
  39 #include "IOdictionary.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class solution Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class solution
  51 :
  52     public IOdictionary
  53 {
  54     // Private data
  55
  56         //- Dictionary of relaxation factors for all the fields
  57         dictionary relaxationFactors_;
  58
  59         //- Dictionary of solver parameters for all the fields
  60         dictionary solvers_;
  61
  62
  63     // Private Member Functions
  64
  65         //- Disallow default bitwise copy construct and assignment
  66         solution(const solution&);
  67         void operator=(const solution&);
  68
  69
  70 public:
  71
  72     //- Debug switch
  73     static int debug;
  74
  75
  76     // Constructors
  77
  78         //- Construct for given objectRegistry and dictionary
  79         solution(const objectRegistry& obr, const fileName& dictName);
  80
  81
  82     // Member Functions
  83
  84         // Access
  85
  86             //- Return the selected sub-dictionary of solvers if the "select"
  87             //  keyword is given othewise return the complete dictionary
  88             const dictionary& solutionDict() const;
  89
  90             //- Return true if the relaxation factor is given for the field
  91             bool relax(const word& name) const;
  92
  93             //- Return the relaxation factor for the given field
  94             scalar relaxationFactor(const word& name) const;
  95
  96             //- Return the dictionary of solver parameters for the given field
  97             const dictionary& solverDict(const word& name) const;
  98
  99             //- Return the stream of solver parameters for the given field
 100             //  @deprecated Backward compatibility only - should use solverDict
 101             ITstream& solver(const word& name) const;
 102
 103
 104         // Read
 105
 106             //- Read the solution dictionary
 107             bool read();
 108 };
 109
 110
 111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 112
 113 } // End namespace Foam
 114
 115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 116
 117 #endif
 118
 119 // ************************************************************************* //