src/OpenFOAM/db/IOstreams/Pstreams/PstreamCombineReduceOps.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 InClass
  26     Foam::Pstream
  27
  28 Description
  29     Combination-Reduction operation for a parallel run.  The
  30     information from all nodes is collected on the master node,
  31     combined using the given combination function and the result is
  32     broadcast to all nodes
  33
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef PstreamCombineReduceOps_H
  38 #define PstreamCombineReduceOps_H
  39
  40 #include "Pstream.H"
  41 #include "ops.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  49
  50 template <class T, class CombineOp>
  51 void combineReduce
  52 (
  53     const List<Pstream::commsStruct>& comms,
  54     T& Value,
  55     const CombineOp& cop
  56 )
  57 {
  58     Pstream::combineGather(comms, Value, cop);
  59     Pstream::combineScatter(comms, Value);
  60 }
  61
  62
  63 template <class T, class CombineOp>
  64 void combineReduce(T& Value, const CombineOp& cop)
  65 {
  66     if (Pstream::nProcs() < Pstream::nProcsSimpleSum)
  67     {
  68         Pstream::combineGather(Pstream::linearCommunication(), Value, cop);
  69         Pstream::combineScatter(Pstream::linearCommunication(), Value);
  70     }
  71     else
  72     {
  73         Pstream::combineGather(Pstream::treeCommunication(), Value, cop);
  74         Pstream::combineScatter(Pstream::treeCommunication(), Value);
  75     }
  76 }
  77
  78
  79 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  80
  81 } // End namespace Foam
  82
  83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  84
  85 #endif
  86
  87 // ************************************************************************* //