FreeFOAM The Cross-Platform CFD Toolkit
parRun.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::ParRunControl
26 
27 Description
28  Helper class for initializing parallel jobs from the command arguments.
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef parRun_H
33 #define parRun_H
34 
35 #include <OpenFOAM/OPstream.H>
36 #include <OpenFOAM/IPstream.H>
37 #include <OpenFOAM/IOstreams.H>
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43 
44 /*---------------------------------------------------------------------------*\
45  Class ParRunControl Declaration
46 \*---------------------------------------------------------------------------*/
47 
49 {
50  bool RunPar;
51 
52 public:
53 
55  :
56  RunPar(false)
57  {}
58 
60  {
61  if (RunPar)
62  {
63  Info<< "Finalising parallel run" << endl;
64  Pstream::exit(0);
65  }
66  }
67 
68  void runPar(int& argc, char**& argv)
69  {
70  RunPar = true;
71 
72  if (!Pstream::init(argc, argv))
73  {
74  Info<< "Failed to start parallel run" << endl;
75  Pstream::exit(1);
76  }
77  }
78 
79  bool parRun() const
80  {
81  return RunPar;
82  }
83 };
84 
85 
86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87 
88 } // End namespace Foam
89 
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91 
92 #endif
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //