FreeFOAM The Cross-Platform CFD Toolkit
outputFilterOutputControl.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-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 \*---------------------------------------------------------------------------*/
25 
27 
28 // * * * * * * * * * * * * * Static Member Data * * * * * * * * * * * * * * //
29 
30 template<>
31 const char* Foam::NamedEnum
32 <
34  2
35 >::names[] =
36 {
37  "timeStep",
38  "outputTime"
39 };
40 
42  Foam::outputFilterOutputControl::outputControlNames_;
43 
44 
45 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
46 
47 Foam::outputFilterOutputControl::outputFilterOutputControl
48 (
49  const Time& t,
50  const dictionary& dict
51 )
52 :
53  time_(t),
54  outputControl_(ocTimeStep),
55  outputInterval_(0)
56 {
57  read(dict);
58 }
59 
60 
61 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
62 
64 {}
65 
66 
67 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
68 
70 {
71  outputControl_ = outputControlNames_.read(dict.lookup("outputControl"));
72 
73  switch (outputControl_)
74  {
75  case ocTimeStep:
76  {
77  dict.lookup("outputInterval") >> outputInterval_;
78  }
79  default:
80  {
81  // do nothing
82  }
83  }
84 }
85 
86 
88 {
89  switch (outputControl_)
90  {
91  case ocTimeStep:
92  {
93  return
94  (
95  (outputInterval_ <= 1)
96  || !(time_.timeIndex() % outputInterval_)
97  );
98  break;
99  }
100  case ocOutputTime:
101  {
102  return time_.outputTime();
103  break;
104  }
105  default:
106  {
107  FatalErrorIn("bool Foam::outputFilterOutputControl::output()")
108  << "Unknown output control: "
109  << outputControlNames_[outputControl_] << nl
110  << abort(FatalError);
111  }
112  }
113 
114  return false;
115 }
116 
117 
118 // ************************ vim: set sw=4 sts=4 et: ************************ //