src/OpenFOAM/global/argList/parRun.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::ParRunControl
  27
  28 Description
  29     Helper class for initializing parallel jobs from the command arguments.
  30
  31 \*---------------------------------------------------------------------------*/
  32
  33 #ifndef parRun_H
  34 #define parRun_H
  35
  36 #include "OPstream.H"
  37 #include "IPstream.H"
  38 #include "IOstreams.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                            Class ParRunControl Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 class ParRunControl
  50 {
  51     bool RunPar;
  52
  53 public:
  54
  55     ParRunControl()
  56     :
  57         RunPar(false)
  58     {}
  59
  60     ~ParRunControl()
  61     {
  62         if (RunPar)
  63         {
  64             Info<< "Finalising parallel run" << endl;
  65             Pstream::exit(0);
  66         }
  67     }
  68
  69     void runPar(int& argc, char**& argv)
  70     {
  71         RunPar = true;
  72
  73         if (!Pstream::init(argc, argv))
  74         {
  75             Info<< "Failed to start parallel run" << endl;
  76             Pstream::exit(1);
  77         }
  78     }
  79
  80     bool parRun() const
  81     {
  82         return RunPar;
  83     }
  84 };
  85
  86
  87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  88
  89 } // End namespace Foam
  90
  91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  92
  93 #endif
  94
  95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //