Thyra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Thyra_SpmdVectorSpaceUtilities.cpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Thyra: Interfaces and Support for Abstract Numerical Algorithms
5 // Copyright (2004) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #include "Thyra_SpmdVectorSpaceUtilities.hpp"
43 #include "Teuchos_CommHelpers.hpp"
44 
45 
46 namespace Thyra {
47 
48 
49 Ordinal SpmdVectorSpaceUtilities::computeMapCode(
50  const Teuchos::Comm<Ordinal> &comm, const Ordinal localSubDim
51  )
52 {
53  using Teuchos::outArg;
54  using Teuchos::REDUCE_SUM;
55  using Teuchos::reduceAll;
56  //
57  // Here we will make a map code out of just the local sub-dimension on each
58  // processor. If each processor has the same number of local elements, then
59  // the map codes will be the same and this is all you need for RTOp
60  // compatibility.
61  //
62  const int procRank = comm.getSize ();
63  Ordinal mapCode = -1;
64  Ordinal localCode = localSubDim % (procRank+1) + localSubDim;
65  reduceAll<Ordinal, Ordinal> (comm, REDUCE_SUM, localCode, outArg (mapCode));
66  return mapCode;
67 }
68 
69 
70 Ordinal SpmdVectorSpaceUtilities::computeLocalOffset(
71  const Teuchos::Comm<Ordinal> &comm, const Ordinal localSubDim
72  )
73 {
74  using Teuchos::outArg;
75  using Teuchos::REDUCE_SUM;
76  using Teuchos::scan;
77 
78  Ordinal localOffset;
79  const Ordinal _localOffset = localSubDim;
80  scan<Ordinal, Ordinal> (comm, REDUCE_SUM, _localOffset, outArg (localOffset));
81  localOffset -= localSubDim;
82  return localOffset;
83 }
84 
85 
86 Ordinal SpmdVectorSpaceUtilities::computeGlobalDim(
87  const Teuchos::Comm<Ordinal> &comm, const Ordinal localSubDim
88  )
89 {
90  using Teuchos::outArg;
91  using Teuchos::REDUCE_SUM;
92  using Teuchos::reduceAll;
93 
94  Ordinal globalDim = -1;
95  reduceAll<Ordinal, Ordinal> (comm, REDUCE_SUM, localSubDim, outArg (globalDim));
96  return globalDim;
97 }
98 
99 
100 } // namespace Thyra
virtual int getSize() const =0
Teuchos::Ordinal Ordinal
Type for the dimension of a vector space. `*.
TEUCHOS_DEPRECATED void scan(const Comm< Ordinal > &comm, const EReductionType reductType, const Packet &send, Packet *scanReduct)
TEUCHOS_DEPRECATED void reduceAll(const Comm< Ordinal > &comm, const EReductionType reductType, const Packet &send, Packet *globalReduct)