src/OpenFOAM/matrices/solution/solution.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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         //- Optional default relaxation factor for all the fields
  60         scalar defaultRelaxationFactor_;
  61
  62         //- Dictionary of solver parameters for all the fields
  63         dictionary solvers_;
  64
  65
  66     // Private Member Functions
  67
  68         //- Disallow default bitwise copy construct and assignment
  69         solution(const solution&);
  70         void operator=(const solution&);
  71
  72
  73 public:
  74
  75     //- Update from older solver controls syntax
  76     //  Usually verbose, since we want to know about the changes
  77     //  Returns the number of settings changed
  78     static label upgradeSolverDict(dictionary& dict, const bool verbose=true);
  79
  80     //- Debug switch
  81     static int debug;
  82
  83
  84     // Constructors
  85
  86         //- Construct for given objectRegistry and dictionary
  87         solution(const objectRegistry& obr, const fileName& dictName);
  88
  89
  90     // Member Functions
  91
  92         // Access
  93
  94             //- Return the selected sub-dictionary of solvers if the "select"
  95             //  keyword is given, otherwise return the complete dictionary
  96             const dictionary& solutionDict() const;
  97
  98             //- Return true if the relaxation factor is given for the field
  99             bool relax(const word& name) const;
 100
 101             //- Return the relaxation factor for the given field
 102             scalar relaxationFactor(const word& name) const;
 103
 104             //- Return the solver controls dictionary for the given field
 105             const dictionary& solverDict(const word& name) const;
 106
 107             //- Return the solver controls dictionary for the given field
 108             const dictionary& solver(const word& name) const;
 109
 110
 111         // Edit
 112
 113             //- Return access to relaxation factors dictionary
 114             dictionary& relaxationFactors()
 115             {
 116                 return relaxationFactors_;
 117             }
 118
 119             //- Return access to solvers dictionary
 120             dictionary& solvers()
 121             {
 122                 return solvers_;
 123             }
 124
 125
 126         // Read
 127
 128             //- Read the solution dictionary
 129             bool read();
 130
 131
 132         // Write
 133
 134             //- WriteData function required for regIOobject write operation
 135             virtual bool writeData(Ostream&) const;
 136 };
 137
 138
 139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 140
 141 } // End namespace Foam
 142
 143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 144
 145 #endif
 146
 147 // ************************************************************************* //