src/OpenFOAM/db/functionObjects/outputFilterOutputControl/outputFilterOutputControl.H

   1 /*---------------------------------------------------------------------------* \
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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 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::outputFilterOutputControl
  27
  28 Description
  29
  30 SourceFiles
  31     outputFilterOutputControl.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef outputFilterOutputControl_H
  36 #define outputFilterOutputControl_H
  37
  38 #include "dictionary.H"
  39 #include "Time.H"
  40 #include "NamedEnum.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                   Class outputFilterOutputControl Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class outputFilterOutputControl
  52 {
  53 public:
  54
  55     enum outputControls
  56     {
  57         ocTimeStep,
  58         ocOutputTime
  59     };
  60
  61
  62 private:
  63
  64     // Private data
  65
  66         //- Time object
  67         const Time& time_;
  68
  69         //- String representation of outputControls enums
  70         static const NamedEnum<outputControls, 2> outputControlNames_;
  71
  72         //- Type of output
  73         outputControls outputControl_;
  74
  75         //- The execution interval (in time steps) when using TIMESTEP mode
  76         //  a value <= 1 means execute at every time step
  77         label outputInterval_;
  78
  79
  80     // Private Member Functions
  81
  82         //- Disallow default bitwise copy construct and assignment
  83         outputFilterOutputControl(const outputFilterOutputControl&);
  84         void operator=(const outputFilterOutputControl&);
  85
  86
  87 public:
  88
  89     // Constructors
  90
  91         //- Construct from Time object and dictionary
  92         outputFilterOutputControl(const Time&, const dictionary&);
  93
  94
  95     // Destructor
  96         ~outputFilterOutputControl();
  97
  98
  99     // Member Functions
 100
 101         //- Read from dictionary
 102         void read(const dictionary&);
 103
 104         //- Return const access to the Time object
 105         const Time& time() const
 106         {
 107             return time_;
 108         }
 109
 110         //- Flag to indicate whether to output
 111         bool output() const;
 112 };
 113
 114
 115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 116
 117 } // End namespace Foam
 118
 119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 120
 121 #endif
 122
 123 // ************************************************************************* //