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) 2004-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 "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 temporary fields to cache
  56         dictionary cache_;
  57
  58         //- Switch for the caching mechanism
  59         bool caching_;
  60
  61         //- Dictionary of relaxation factors for all the fields
  62         dictionary relaxationFactors_;
  63
  64         //- Optional default relaxation factor for all the fields
  65         scalar defaultRelaxationFactor_;
  66
  67         //- Dictionary of solver parameters for all the fields
  68         dictionary solvers_;
  69
  70
  71     // Private Member Functions
  72
  73         //- Read settings from the dictionary
  74         void read(const dictionary&);
  75
  76         //- Disallow default bitwise copy construct and assignment
  77         solution(const solution&);
  78         void operator=(const solution&);
  79
  80
  81 public:
  82
  83     //- Update from older solver controls syntax
  84     //  Usually verbose, since we want to know about the changes
  85     //  Returns the number of settings changed
  86     static label upgradeSolverDict(dictionary& dict, const bool verbose=true);
  87
  88     //- Debug switch
  89     static int debug;
  90
  91
  92     // Constructors
  93
  94         //- Construct for given objectRegistry and dictionary
  95         solution
  96         (
  97             const objectRegistry& obr,
  98             const fileName& dictName
  99         );
 100
 101
 102     // Member Functions
 103
 104         // Access
 105
 106             //- Return true if the given field should be cached
 107             bool cache(const word& name) const;
 108
 109             //- Return true if the relaxation factor is given for the field
 110             bool relax(const word& name) const;
 111
 112             //- Return the relaxation factor for the given field
 113             scalar relaxationFactor(const word& name) const;
 114
 115             //- Return the selected sub-dictionary of solvers if the "select"
 116             //  keyword is given, otherwise return the complete dictionary
 117             const dictionary& solutionDict() const;
 118
 119             //- Return the solver controls dictionary for the given field
 120             const dictionary& solverDict(const word& name) const;
 121
 122             //- Return the solver controls dictionary for the given field
 123             const dictionary& solver(const word& name) const;
 124
 125         // Read
 126
 127             //- Read the solution dictionary
 128             bool read();
 129 };
 130
 131
 132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 133
 134 } // End namespace Foam
 135
 136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 137
 138 #endif
 139
 140 // ************************************************************************* //