Home
Downloads
Documentation
Installation
User Guide
man-pages
API Documentation
README
Release Notes
Changes
License
Support
SourceForge Project
Main Page
Related Pages
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Pages
src
OpenFOAM
db
functionObjects
outputFilterOutputControl
outputFilterOutputControl.H
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
Class
25
Foam::outputFilterOutputControl
26
27
Description
28
29
SourceFiles
30
outputFilterOutputControl.C
31
32
\*---------------------------------------------------------------------------*/
33
34
#ifndef outputFilterOutputControl_H
35
#define outputFilterOutputControl_H
36
37
#include <
OpenFOAM/dictionary.H
>
38
#include <
OpenFOAM/Time.H
>
39
#include <
OpenFOAM/NamedEnum.H
>
40
41
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42
43
namespace
Foam
44
{
45
46
/*---------------------------------------------------------------------------*\
47
Class outputFilterOutputControl Declaration
48
\*---------------------------------------------------------------------------*/
49
50
class
outputFilterOutputControl
51
{
52
public
:
53
54
enum
outputControls
55
{
56
ocTimeStep
,
57
ocOutputTime
58
};
59
60
61
private
:
62
63
// Private data
64
65
//- Time object
66
const
Time
& time_;
67
68
//- String representation of outputControls enums
69
static
const
NamedEnum<outputControls, 2>
outputControlNames_;
70
71
//- Type of output
72
outputControls
outputControl_;
73
74
//- The execution interval (in time steps) when using TIMESTEP mode
75
// a value <= 1 means execute at every time step
76
label outputInterval_;
77
78
79
// Private Member Functions
80
81
//- Disallow default bitwise copy construct and assignment
82
outputFilterOutputControl
(
const
outputFilterOutputControl
&);
83
void
operator=(
const
outputFilterOutputControl
&);
84
85
86
public
:
87
88
// Constructors
89
90
//- Construct from Time object and dictionary
91
outputFilterOutputControl
(
const
Time
&,
const
dictionary
&);
92
93
94
// Destructor
95
~outputFilterOutputControl
();
96
97
98
// Member Functions
99
100
//- Read from dictionary
101
void
read
(
const
dictionary
&);
102
103
//- Return const access to the Time object
104
const
Time
&
time
()
const
105
{
106
return
time_;
107
}
108
109
//- Flag to indicate whether to output
110
bool
output
()
const
;
111
};
112
113
114
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115
116
}
// End namespace Foam
117
118
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119
120
#endif
121
122
// ************************ vim: set sw=4 sts=4 et: ************************ //