FreeFOAM The Cross-Platform CFD Toolkit
PstreamCombineReduceOps.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-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::Pstream
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 "Pstream.H"
40 #include <OpenFOAM/ops.H>
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
48 
49 template <class T, class CombineOp>
50 void combineReduce
51 (
52  const List<Pstream::commsStruct>& comms,
53  T& Value,
54  const CombineOp& cop
55 )
56 {
57  Pstream::combineGather(comms, Value, cop);
58  Pstream::combineScatter(comms, Value);
59 }
60 
61 
62 template <class T, class CombineOp>
63 void combineReduce(T& Value, const CombineOp& cop)
64 {
66  {
69  }
70  else
71  {
74  }
75 }
76 
77 
78 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
79 
80 } // End namespace Foam
81 
82 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
83 
84 #endif
85 
86 // ************************ vim: set sw=4 sts=4 et: ************************ //