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) 2004-2010 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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 InClass
  25     Foam
  26
  27 Description
  28     Combination-Reduction operation for a parallel run.  The
  29     information from all nodes is collected on the master node,
  30     combined using the given combination function and the result is
  31     broadcast to all nodes
  32
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef PstreamCombineReduceOps_H
  37 #define PstreamCombineReduceOps_H
  38
  39 #include "UPstream.H"
  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<UPstream::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 (UPstream::nProcs() < UPstream::nProcsSimpleSum)
  67     {
  68         Pstream::combineGather(UPstream::linearCommunication(), Value, cop);
  69         Pstream::combineScatter(UPstream::linearCommunication(), Value);
  70     }
  71     else
  72     {
  73         Pstream::combineGather(UPstream::treeCommunication(), Value, cop);
  74         Pstream::combineScatter(UPstream::treeCommunication(), Value);
  75     }
  76 }
  77
  78
  79 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  80
  81 } // End namespace Foam
  82
  83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  84
  85 #endif
  86
  87 // ************************************************************************* //