src/Pstream/gamma/gammaPstreamImpl.H

   1 /*----------------------------------------------------------------------------*\
   2                  ______             ______ ____          __  __
   3                 |  ____|           |  ____/ __ \   /\   |  \/  |
   4                 | |__ _ __ ___  ___| |__ | |  | | /  \  | \  / |
   5                 |  __| '__/ _ \/ _ \  __|| |  | |/ /\ \ | |\/| |
   6                 | |  | | |  __/  __/ |   | |__| / ____ \| |  | |
   7                 |_|  |_|  \___|\___|_|    \____/_/    \_\_|  |_|
   8
   9                     FreeFOAM: The Cross-Platform CFD Toolkit
  10
  11   Copyright (C) 2008-2009 Michael Wild <themiwi@users.sf.net>
  12                           Gerber van der Graaf <gerber_graaf@users.sf.net>
  13 --------------------------------------------------------------------------------
  14 License
  15     This file is part of FreeFOAM.
  16
  17     FreeFOAM is free software; you can redistribute it and/or modify it
  18     under the terms of the GNU General Public License as published by the
  19     Free Software Foundation; either version 2 of the License, or (at your
  20     option) any later version.
  21
  22     FreeFOAM is distributed in the hope that it will be useful, but WITHOUT
  23     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  24     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  25     for more details.
  26
  27     You should have received a copy of the GNU General Public License
  28     along with FreeFOAM; if not, write to the Free Software Foundation,
  29     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  30
  31 Class
  32     Foam::gammaPstreamImpl
  33
  34 Description
  35     GAMMA implementation of the PstreamImpl abstract base class.
  36
  37 SourceFiles
  38     gammaPstreamImpl.C
  39
  40 \*----------------------------------------------------------------------------*/
  41
  42 #ifndef gammaPstreamImpl_H
  43 #define gammaPstreamImpl_H
  44
  45 #include <OpenFOAM/PstreamImpl.H>
  46
  47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  48
  49 namespace Foam
  50 {
  51
  52 /*---------------------------------------------------------------------------*\
  53                            Class gammaPstreamImpl Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class gammaPstreamImpl
  57 :
  58     public PstreamImpl
  59 {
  60     // Private Member Functions
  61
  62         //- Disallow default bitwise copy construct
  63         gammaPstreamImpl(const gammaPstreamImpl&);
  64
  65         //- Disallow default bitwise assignment
  66         void operator=(const gammaPstreamImpl&);
  67
  68 public:
  69
  70     // Declare name of the class and its debug switch
  71     TypeName("gammaPstreamImpl");
  72
  73     // Constructors
  74
  75         //- Construct null
  76         gammaPstreamImpl(){}
  77
  78     // Member Functions
  79
  80         //- Add the valid option this type of communications library
  81         //  adds/requires on the command line
  82         virtual void addValidParOptions(HashTable<string>& validParOptions);
  83
  84         //- Initialisation function called from main
  85         //  Spawns slave processes and initialises inter-communication
  86         virtual bool init(int& argc, char**& argv, int& myProcNo_, List<int>& procIDs_, bool& isParallel);
  87
  88         //- Exit program
  89         virtual void exit(int errnum);
  90
  91         //- Abort program
  92         virtual void abort();
  93
  94         //- Reduce implementation for scalars (@sa PstreamReduceOps.H)
  95         void reduce(scalar& Value, const sumOp<scalar>& bop);
  96
  97 };
  98
  99
 100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 101
 102 } // End namespace Foam
 103
 104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 105
 106 #endif
 107
 108 // ************************ vim: set sw=4 sts=4 et: ************************ //