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

PstreamReduceOps.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 \*---------------------------------------------------------------------------*/
00025 
00026 #ifndef PstreamReduceOps_H
00027 #define PstreamReduceOps_H
00028 
00029 #include "Pstream.H"
00030 #include <OpenFOAM/ops.H>
00031 
00032 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00033 
00034 namespace Foam
00035 {
00036 
00037 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00038 
00039 // Reduce operation with user specified communication schedule
00040 template <class T, class BinaryOp>
00041 void reduce
00042 (
00043     const List<Pstream::commsStruct>& comms,
00044     T& Value,
00045     const BinaryOp& bop
00046 )
00047 {
00048     Pstream::gather(comms, Value, bop);
00049     Pstream::scatter(comms, Value);
00050 }
00051 
00052 
00053 // Reduce using either linear or tree communication schedule
00054 template <class T, class BinaryOp>
00055 void reduce
00056 (
00057     T& Value,
00058     const BinaryOp& bop
00059 )
00060 {
00061     if (Pstream::nProcs() < Pstream::nProcsSimpleSum)
00062     {
00063         reduce(Pstream::linearCommunication(), Value, bop);
00064     }
00065     else
00066     {
00067         reduce(Pstream::treeCommunication(), Value, bop);
00068     }
00069 }
00070 
00071 
00072 // Reduce using either linear or tree communication schedule
00073 template <class T, class BinaryOp>
00074 T returnReduce
00075 (
00076     const T& Value,
00077     const BinaryOp& bop
00078 )
00079 {
00080     T WorkValue(Value);
00081 
00082     if (Pstream::nProcs() < Pstream::nProcsSimpleSum)
00083     {
00084         reduce(Pstream::linearCommunication(), WorkValue, bop);
00085     }
00086     else
00087     {
00088         reduce(Pstream::treeCommunication(), WorkValue, bop);
00089     }
00090 
00091     return WorkValue;
00092 }
00093 
00094 
00095 // Insist there is a specialisation for the reduction of a scalar
00096 // and implement it in PstreamImpl
00097 inline void reduce(scalar& Value, const sumOp<scalar>& bop)
00098 {
00099     Pstream::impl()->reduce(Value, bop);
00100 }
00101 
00102 
00103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00104 
00105 } // End namespace Foam
00106 
00107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00108 
00109 #endif
00110 
00111 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines