OpenFOAM logo
Open Source CFD Toolkit

PstreamCombineReduceOps.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     Pstream
00027 
00028 Description
00029     Combination-Reduction operation for a parallel run.  The
00030     information from all nodes is collected on the master node,
00031     combined using the given combination function and the result is
00032     broadcast to all nodes
00033 
00034 
00035 \*---------------------------------------------------------------------------*/
00036 
00037 #ifndef PstreamCombineReduceOps_H
00038 #define PstreamCombineReduceOps_H
00039 
00040 #include "Pstream.H"
00041 #include "ops.H"
00042 
00043 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00044 
00045 namespace Foam
00046 {
00047 
00048 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00049 
00050 template <class T, class CombineOp>
00051 void combineReduce
00052 (
00053     const List<Pstream::commsStruct>& comms,
00054     T& Value,
00055     const CombineOp& cop
00056 )
00057 {
00058     Pstream::combineGather(comms, Value, cop);
00059     Pstream::combineScatter(comms, Value);
00060 }
00061 
00062 
00063 template <class T, class CombineOp>
00064 void combineReduce(T& Value, const CombineOp& cop)
00065 {
00066     if (Pstream::nProcs() < Pstream::nProcsSimpleSum)
00067     {
00068         Pstream::combineGather(Pstream::linearCommunication(), Value, cop);
00069         Pstream::combineScatter(Pstream::linearCommunication(), Value);
00070     }
00071     else
00072     {
00073         Pstream::combineGather(Pstream::treeCommunication(), Value, cop);
00074         Pstream::combineScatter(Pstream::treeCommunication(), Value);
00075     }
00076 }
00077 
00078 
00079 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00080 
00081 } // End namespace Foam
00082 
00083 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00084 
00085 #endif
00086 
00087 // ************************************************************************* //
For further information go to www.openfoam.org