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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2013 OpenFOAM Foundation
9  Copyright (C) 2022 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM, distributed under GPL-3.0-or-later.
13 
14 Description
15  Compatibility include (AUG-2022).
16  Foam::combineReduce wrapper for Pstream::combineReduce
17 
18 \*---------------------------------------------------------------------------*/
19 
20 #ifndef FoamCompat_PstreamCombineReduceOps_H
21 #define FoamCompat_PstreamCombineReduceOps_H
22 
23 #warning Deprecated header
24 
25 #include "Pstream.H"
26 #include "ops.H"
27 
28 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
29 
30 namespace Foam
31 {
32 
33 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
34 
35 //- Compatibility wrapper for Pstream::combineReduce
36 template<class T, class CombineOp>
37 FOAM_DEPRECATED_FOR(2022-08, "Pstream::combineReduce()")
38 void combineReduce
39 (
40  T& value,
41  const CombineOp& cop,
42  const int tag = UPstream::msgType(),
43  const int comm = UPstream::worldComm
44 )
45 {
46  Pstream::combineReduce(value, cop, tag, comm);
47 }
48 
49 
50 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
51 
52 } // End namespace Foam
53 
54 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
55 
56 #endif
57 
58 // ************************************************************************* //
Foam::combineReduce
void combineReduce(T &value, const CombineOp &cop, const int tag=UPstream::msgType(), const int comm=UPstream::worldComm)
Compatibility wrapper for Pstream::combineReduce.
Definition: PstreamCombineReduceOps.H:43
ops.H
Various functors for unary and binary operations. Can be used for parallel combine-reduce operations ...
Foam::FOAM_DEPRECATED_FOR
class FOAM_DEPRECATED_FOR(2017-05, "Foam::Enum") NamedEnum
Definition: NamedEnum.H:66
Foam::T
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
Definition: FieldFieldFunctions.C:53
Foam::Pstream::combineReduce
static void combineReduce(T &value, CombineOp cop, const int tag=UPstream::msgType(), const int communicator=UPstream::worldComm)
Reduce inplace (cf. MPI Allreduce) applying cop to inplace combine value from different processors...
Foam::UPstream
Inter-processor communications stream.
Definition: UPstream.H:69
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:26