ROL
ROL_TeuchosBatchManager.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ************************************************************************
3 //
4 // Rapid Optimization Library (ROL) Package
5 // Copyright (2014) 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 lead developers:
38 // Drew Kouri (dpkouri@sandia.gov) and
39 // Denis Ridzal (dridzal@sandia.gov)
40 //
41 // ************************************************************************
42 // @HEADER
43 
44 #ifndef ROLTEUCHOSBATCHMANAGER_HPP
45 #define ROLTEUCHOSBATCHMANAGER_HPP
46 
47 #include "ROL_BatchManager.hpp"
48 #include "Teuchos_RCP.hpp"
49 #include "Teuchos_Comm.hpp"
50 #include "Teuchos_CommHelpers.hpp"
51 
52 namespace ROL {
53 
54 template<class Real, class Ordinal>
55 class TeuchosBatchManager : public BatchManager<Real> {
56 private:
57  Teuchos::RCP<const Teuchos::Comm<Ordinal> > comm_;
58 
59 public:
60  TeuchosBatchManager(const Teuchos::RCP<const Teuchos::Comm<Ordinal> > &comm)
61  : comm_(comm) {}
62 
63  int batchID(void) {
64  return Teuchos::rank<Ordinal>(*comm_);
65  }
66 
67  int numBatches(void) {
68  return Teuchos::size<Ordinal>(*comm_);
69  }
70 
71  void reduceAll(Real* input, Real* output,
72  const Elementwise::ReductionOp<Real> &r) {
73  int nB = this->numBatches();
74  std::vector<Real> receiveBuffer(nB);
75  Teuchos::gather<Ordinal,Real>(input,1,&receiveBuffer[0],1,0,*comm_);
76  output[0] = 0;
77  for (int i = 0; i < nB; i++) {
78  r.reduce(receiveBuffer[i],output[0]);
79  }
80  Teuchos::broadcast<Ordinal,Real>(*comm_,0,1,output);
81  }
82 
83  void minAll(Real* input, Real* output, int dim) {
84  Teuchos::reduceAll<Ordinal,Real>(*comm_,Teuchos::REDUCE_MIN,
85  dim, input, output);
86  }
87 
88  void maxAll(Real* input, Real* output, int dim) {
89  Teuchos::reduceAll<Ordinal,Real>(*comm_,Teuchos::REDUCE_MAX,
90  dim, input, output);
91  }
92 
93  void sumAll(Real* input, Real* output, int dim) {
94  Teuchos::reduceAll<Ordinal,Real>(*comm_,Teuchos::REDUCE_SUM,
95  dim, input, output);
96  }
97 
98  virtual void sumAll(Vector<Real> &input, Vector<Real> &output) {
99  TEUCHOS_TEST_FOR_EXCEPTION( true, std::invalid_argument,
100  ">>> ERROR (ROL::TeuchosBatchManager): sumAll(Vector<Real> &input, Vector<Real> &output) is not implemented");
101  }
102 
103  void barrier(void) {
104  Teuchos::barrier<Ordinal>(*comm_);
105  }
106 };
107 
108 }
109 
110 #endif
void minAll(Real *input, Real *output, int dim)
void maxAll(Real *input, Real *output, int dim)
virtual void sumAll(Vector< Real > &input, Vector< Real > &output)
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:74
void reduceAll(Real *input, Real *output, const Elementwise::ReductionOp< Real > &r)
void sumAll(Real *input, Real *output, int dim)
TeuchosBatchManager(const Teuchos::RCP< const Teuchos::Comm< Ordinal > > &comm)
Teuchos::RCP< const Teuchos::Comm< Ordinal > > comm_