FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

parRun.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software: you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::ParRunControl
00026 
00027 Description
00028     Helper class for initializing parallel jobs from the command arguments.
00029 
00030 \*---------------------------------------------------------------------------*/
00031 
00032 #ifndef parRun_H
00033 #define parRun_H
00034 
00035 #include <OpenFOAM/OPstream.H>
00036 #include <OpenFOAM/IPstream.H>
00037 #include <OpenFOAM/IOstreams.H>
00038 
00039 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00040 
00041 namespace Foam
00042 {
00043 
00044 /*---------------------------------------------------------------------------*\
00045                            Class ParRunControl Declaration
00046 \*---------------------------------------------------------------------------*/
00047 
00048 class ParRunControl
00049 {
00050     bool RunPar;
00051 
00052 public:
00053 
00054     ParRunControl()
00055     :
00056         RunPar(false)
00057     {}
00058 
00059     ~ParRunControl()
00060     {
00061         if (RunPar)
00062         {
00063             Info<< "Finalising parallel run" << endl;
00064             Pstream::exit(0);
00065         }
00066     }
00067 
00068     void runPar(int& argc, char**& argv)
00069     {
00070         RunPar = true;
00071 
00072         if (!Pstream::init(argc, argv))
00073         {
00074             Info<< "Failed to start parallel run" << endl;
00075             Pstream::exit(1);
00076         }
00077     }
00078 
00079     bool parRun() const
00080     {
00081         return RunPar;
00082     }
00083 };
00084 
00085 
00086 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00087 
00088 } // End namespace Foam
00089 
00090 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00091 
00092 #endif
00093 
00094 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines