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

mpiPstreamImpl.H

Go to the documentation of this file.
00001 /*----------------------------------------------------------------------------*\
00002                 ______                _     ____          __  __
00003                |  ____|             _| |_  / __ \   /\   |  \/  |
00004                | |__ _ __ ___  ___ /     \| |  | | /  \  | \  / |
00005                |  __| '__/ _ \/ _ ( (| |) ) |  | |/ /\ \ | |\/| |
00006                | |  | | |  __/  __/\_   _/| |__| / ____ \| |  | |
00007                |_|  |_|  \___|\___|  |_|   \____/_/    \_\_|  |_|
00008 
00009                     FreeFOAM: The Cross-Platform CFD Toolkit
00010 
00011   Copyright (C) 2008-2012 Michael Wild <themiwi@users.sf.net>
00012                           Gerber van der Graaf <gerber_graaf@users.sf.net>
00013 --------------------------------------------------------------------------------
00014 License
00015     This file is part of FreeFOAM.
00016 
00017     FreeFOAM is free software: you can redistribute it and/or modify it
00018     under the terms of the GNU General Public License as published by the
00019     Free Software Foundation, either version 3 of the License, or (at your
00020     option) any later version.
00021 
00022     FreeFOAM is distributed in the hope that it will be useful, but WITHOUT
00023     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00024     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00025     for more details.
00026 
00027     You should have received a copy of the GNU General Public License
00028     along with FreeFOAM.  If not, see <http://www.gnu.org/licenses/>.
00029 
00030 Class
00031     Foam::mpiPstreamImpl
00032 
00033 Description
00034     MPI implementation of the PstreamImpl abstract base class.
00035 
00036 SourceFiles
00037     mpiPstreamImpl.C
00038 
00039 \*----------------------------------------------------------------------------*/
00040 
00041 #ifndef mpiPstreamImpl_H
00042 #define mpiPstreamImpl_H
00043 
00044 #include <OpenFOAM/PstreamImpl.H>
00045 
00046 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00047 
00048 namespace Foam
00049 {
00050 
00051 /*---------------------------------------------------------------------------*\
00052                            Class mpiPstreamImpl Declaration
00053 \*---------------------------------------------------------------------------*/
00054 
00055 class mpiPstreamImpl
00056 :
00057     public PstreamImpl
00058 {
00059     // Private Member Functions
00060 
00061         //- Disallow default bitwise copy construct
00062         mpiPstreamImpl(const mpiPstreamImpl&);
00063 
00064         //- Disallow default bitwise assignment
00065         void operator=(const mpiPstreamImpl&);
00066 
00067 public:
00068 
00069     // Declare name of the class and its debug switch
00070     TypeName("mpiPstreamImpl");
00071 
00072     // Constructors
00073 
00074         //- Construct null
00075         mpiPstreamImpl(){}
00076 
00077     // Member Functions
00078 
00079         //- Add the valid option this type of communications library
00080         //  adds/requires on the command line
00081         virtual void addValidParOptions(HashTable<string>& validParOptions);
00082 
00083         //- Initialisation function called from main
00084         //  Spawns slave processes and initialises inter-communication
00085         virtual bool init(int& argc, char**& argv, int& myProcNo_, List<int>& procIDs_, bool& isParallel);
00086 
00087         //- Exit program
00088         virtual void exit(int errnum);
00089 
00090         //- Abort program
00091         virtual void abort();
00092 
00093         //- Reduce implementation for scalars (@sa PstreamReduceOps.H)
00094         void reduce(scalar& Value, const sumOp<scalar>& bop);
00095 
00096 };
00097 
00098 
00099 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00100 
00101 } // End namespace Foam
00102 
00103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00104 
00105 #endif
00106 
00107 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines