sigStopAtWriteNow.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) 2011-2015 OpenFOAM Foundation
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::sigStopAtWriteNow
26 
27 Description
28  Signal handler for interupt defined by
29  OptimisationSwitches::stopAtWriteNowSignal
30 
31  Write and stop the job.
32 
33 SourceFiles
34  sigStopAtWriteNow.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef sigStopAtWriteNow_H
39 #define sigStopAtWriteNow_H
40 
41 #include <signal.h>
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 class Time;
49 
50 /*---------------------------------------------------------------------------*\
51  Class sigStopAtWriteNow Declaration
52 \*---------------------------------------------------------------------------*/
53 
55 {
56  // Private data
57 
58  //- Number of signal to use
59  static int signal_;
60 
61  //- Saved old signal trapping setting
62  static struct sigaction oldAction_;
63 
64  // Private Member Functions
65 
66  static void sigHandler(int);
67 
68 
69 public:
70 
71  //- wip. Have setter have access to signal_
72  friend class addstopAtWriteNowSignalToOpt;
73 
74  // Constructors
75 
76  //- Construct null
78 
79  //- Construct from components
80  sigStopAtWriteNow(const bool verbose, const Time& runTime);
81 
82 
83  //- Destructor
85 
86 
87  // Member functions
88 
89  //- (re)set signal catcher
90  static void set(const bool verbose);
91 
92  //- Is active?
93  bool active() const;
94 };
95 
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 } // End namespace Foam
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 #endif
104 
105 // ************************************************************************* //
sigStopAtWriteNow()
Construct null.
Namespace for OpenFOAM.
bool active() const
Is active?
Class to control time during OpenFOAM simulations that is also the top-level objectRegistry.
Definition: Time.H:68
Signal handler for interupt defined by OptimisationSwitches::stopAtWriteNowSignal.
~sigStopAtWriteNow()
Destructor.