src/foam/meshes/data/data.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::data
  26
  27 Description
  28     Database for solution data, solver performance and other reduced data.
  29
  30     fvMesh is derived from data so that all fields have access to the data from
  31     the mesh reference they hold.
  32
  33 SourceFiles
  34     data.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef data_H
  39 #define data_H
  40
  41 #include "IOdictionary.H"
  42 #include "solverPerformance.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                             Class data Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class data
  54 :
  55     public IOdictionary
  56 {
  57     // Private data
  58
  59         //- Previously used time-index, used for reset between iterations
  60         mutable label prevTimeIndex_;
  61
  62
  63     // Private Member Functions
  64
  65         //- Disallow default bitwise copy construct
  66         data(const data&);
  67
  68         //- Disallow default bitwise assignment
  69         void operator=(const data&);
  70
  71
  72 public:
  73
  74     //- Debug switch
  75     static int debug;
  76
  77
  78     // Constructors
  79
  80         //- Construct for objectRegistry
  81         data(const objectRegistry& obr);
  82
  83
  84     // Member Functions
  85
  86         // Access
  87
  88             //- Return the dictionary of solver performance data
  89             //  which includes initial and final residuals for convergence
  90             //  checking
  91             const dictionary& solverPerformanceDict() const;
  92
  93             //- Add/set the solverPerformance entry for the named field
  94             template<class Type>
  95             void setSolverPerformance
  96             (
  97                 const word& name,
  98                 const SolverPerformance<Type>&
  99             ) const;
 100
 101             //- Add/set the solverPerformance entry, using its fieldName
 102             template<class Type>
 103             void setSolverPerformance
 104             (
 105                 const SolverPerformance<Type>&
 106             ) const;
 107 };
 108
 109
 110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 111
 112 } // End namespace Foam
 113
 114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 115
 116 #ifdef NoRepository
 117 #   include "dataTemplates.C"
 118 #endif
 119
 120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 121
 122 #endif
 123
 124 // ************************************************************************* //