FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

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-2010 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
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your 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, see <http://www.gnu.org/licenses/>.
00023 
00024 InClass
00025     Foam::Pstream
00026 
00027 Description
00028     Combination-Reduction operation for a parallel run.  The
00029     information from all nodes is collected on the master node,
00030     combined using the given combination function and the result is
00031     broadcast to all nodes
00032 
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef PstreamCombineReduceOps_H
00037 #define PstreamCombineReduceOps_H
00038 
00039 #include "Pstream.H"
00040 #include <OpenFOAM/ops.H>
00041 
00042 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00043 
00044 namespace Foam
00045 {
00046 
00047 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00048 
00049 template <class T, class CombineOp>
00050 void combineReduce
00051 (
00052     const List<Pstream::commsStruct>& comms,
00053     T& Value,
00054     const CombineOp& cop
00055 )
00056 {
00057     Pstream::combineGather(comms, Value, cop);
00058     Pstream::combineScatter(comms, Value);
00059 }
00060 
00061 
00062 template <class T, class CombineOp>
00063 void combineReduce(T& Value, const CombineOp& cop)
00064 {
00065     if (Pstream::nProcs() < Pstream::nProcsSimpleSum)
00066     {
00067         Pstream::combineGather(Pstream::linearCommunication(), Value, cop);
00068         Pstream::combineScatter(Pstream::linearCommunication(), Value);
00069     }
00070     else
00071     {
00072         Pstream::combineGather(Pstream::treeCommunication(), Value, cop);
00073         Pstream::combineScatter(Pstream::treeCommunication(), Value);
00074     }
00075 }
00076 
00077 
00078 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00079 
00080 } // End namespace Foam
00081 
00082 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00083 
00084 #endif
00085 
00086 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines