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-2010 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
  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::solution
  26
  27 Description
  28     Selector class for relaxation factors, solver type and solution.
  29
  30 SourceFiles
  31     solution.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef solution_H
  36 #define solution_H
  37
  38 #include <OpenFOAM/IOdictionary.H>
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                           Class solution Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 class solution
  50 :
  51     public IOdictionary
  52 {
  53     // Private data
  54
  55         //- Dictionary of relaxation factors for all the fields
  56         dictionary relaxationFactors_;
  57
  58         //- Optional default relaxation factor for all the fields
  59         scalar defaultRelaxationFactor_;
  60
  61         //- Dictionary of solver parameters for all the fields
  62         dictionary solvers_;
  63
  64     // Private Member Functions
  65
  66         //- Disallow default bitwise copy construct and assignment
  67         solution(const solution&);
  68         void operator=(const solution&);
  69
  70
  71 public:
  72
  73     //- Update from older solver controls syntax
  74     //  Usually verbose, since we want to know about the changes
  75     //  Returns the number of settings changed
  76     static label upgradeSolverDict(dictionary& dict, const bool verbose=true);
  77
  78     //- Debug switch
  79     static int debug;
  80
  81
  82     // Constructors
  83
  84         //- Construct for given objectRegistry and dictionary
  85         solution(const objectRegistry& obr, const fileName& dictName);
  86
  87
  88     // Member Functions
  89
  90         // Access
  91
  92             //- Return the selected sub-dictionary of solvers if the "select"
  93             //  keyword is given, otherwise return the complete dictionary
  94             const dictionary& solutionDict() const;
  95
  96             //- Return true if the relaxation factor is given for the field
  97             bool relax(const word& name) const;
  98
  99             //- Return the relaxation factor for the given field
 100             scalar relaxationFactor(const word& name) const;
 101
 102             //- Return the solver controls dictionary for the given field
 103             const dictionary& solverDict(const word& name) const;
 104
 105             //- Return the solver controls dictionary for the given field
 106             const dictionary& solver(const word& name) const;
 107
 108         // Read
 109
 110             //- Read the solution dictionary
 111             bool read();
 112 };
 113
 114
 115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 116
 117 } // End namespace Foam
 118
 119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 120
 121 #endif
 122
 123 // ************************ vim: set sw=4 sts=4 et: ************************ //