OpenFOAM logo
Open Source CFD Toolkit

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-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 
00030 \*---------------------------------------------------------------------------*/
00031 
00032 #ifndef PstreamReduceOps_H
00033 #define PstreamReduceOps_H
00034 
00035 #include "Pstream.H"
00036 #include "ops.H"
00037 
00038 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00039 
00040 namespace Foam
00041 {
00042 
00043 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00044 
00045 // Reduce operation with user specified communication schedule
00046 template <class T, class BinaryOp>
00047 void reduce
00048 (
00049     const List<Pstream::commsStruct>& comms,
00050     T& Value,
00051     const BinaryOp& bop
00052 )
00053 {
00054     Pstream::gather(comms, Value, bop);
00055     Pstream::scatter(comms, Value);
00056 }    
00057 
00058 
00059 // Reduce using either linear or tree communication schedule
00060 template <class T, class BinaryOp>
00061 void reduce
00062 (
00063     T& Value,
00064     const BinaryOp& bop
00065 )
00066 {
00067     if (Pstream::nProcs() < Pstream::nProcsSimpleSum)
00068     {
00069         reduce(Pstream::linearCommunication(), Value, bop);
00070     }
00071     else
00072     {
00073         reduce(Pstream::treeCommunication(), Value, bop);
00074     }
00075 }    
00076 
00077 
00078 // Insist there is a specialisation for the reduction of a scalar
00079 void reduce(scalar& Value, const sumOp<scalar>& bop);
00080 
00081 
00082 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00083 
00084 } // End namespace Foam
00085 
00086 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00087 
00088 #endif
00089 
00090 // ************************************************************************* //
For further information go to www.openfoam.org