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