src/foam/matrices/solution/solution.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  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 #include "debugSwitch.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 debug::debugSwitch 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 true if the relaxation factor is given for the field
  95             bool relax(const word& name) const;
  96
  97             //- Return the relaxation factor for the given field
  98             scalar relaxationFactor(const word& name) const;
  99
 100             //- Return the solver controls dictionary for the given field
 101             const dictionary& solverDict(const word& name) const;
 102
 103             //- Return the solver controls dictionary for the given field
 104             const dictionary& solver(const word& name) const;
 105
 106
 107         // Edit
 108
 109             //- Return access to relaxation factors dictionary
 110             dictionary& relaxationFactors()
 111             {
 112                 return relaxationFactors_;
 113             }
 114
 115             //- Return access to solvers dictionary
 116             dictionary& solvers()
 117             {
 118                 return solvers_;
 119             }
 120
 121
 122         // Read
 123
 124             //- Read the solution dictionary
 125             bool read();
 126
 127
 128         // Write
 129
 130             //- WriteData function required for regIOobject write operation
 131             virtual bool writeData(Ostream&) const;
 132 };
 133
 134
 135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 136
 137 } // End namespace Foam
 138
 139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 140
 141 #endif
 142
 143 // ************************************************************************* //