RTOp Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
RTOpPack_ROpGetElement.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // RTOp: Interfaces and Support Software for Vector Reduction Transformation
5 // Operations
6 // Copyright (2006) Sandia Corporation
7 //
8 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
9 // license for use of this work by or on behalf of the U.S. Government.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
39 //
40 // ***********************************************************************
41 // @HEADER
42 
43 #ifndef RTOPPACK_ROP_GET_ELEMENT_HPP
44 #define RTOPPACK_ROP_GET_ELEMENT_HPP
45 
46 #include "RTOpPack_RTOpTHelpers.hpp"
47 
48 
49 namespace RTOpPack {
50 
51 
53 template<class Scalar>
55 public:
57  ROpGetElementEleWiseReductionOp(const Ordinal &global_i_in = -1)
58  :global_i_(global_i_in)
59  {}
61  Ordinal global_i() const
62  {
63  return global_i_;
64  }
66  void operator()(const index_type i, const Scalar &v0, Scalar &reduct) const
67  {
68  if (i == global_i_) {
69  reduct = v0;
70  }
71  }
72 private:
74 };
75 
76 
81 template<class Scalar>
84  Scalar,
85  Scalar,
86  ROpGetElementEleWiseReductionOp<Scalar>
87  >
88 {
89 public:
91  ROpGetElement(const Ordinal &global_i)
92  {
93  this->setOpNameBase("ROpGetElement");
94  this->initialize(global_i);
95  this->initReductObjValue(ScalarTraits<Scalar>::zero());
96  }
98  void initialize(const Ordinal &global_i)
99  {
101  }
103  Scalar operator()(const ReductTarget& reduct_obj ) const
104  {
105  return this->getRawVal(reduct_obj);
106  }
107 protected:
109  virtual Range1D range_impl() const
110  {
111  const Ordinal i = this->getEleWiseReduction().global_i();
112  return Range1D(i, i);
113  }
114 
115 };
116 
117 
118 } // namespace RTOpPack
119 
120 
121 #endif // RTOPPACK_ROP_GET_ELEMENT_HPP
Base class for coordinate-variant scalar reduction RTOps with one input vector.
void initialize(const Ordinal &global_i)
ROpGetElementEleWiseReductionOp(const Ordinal &global_i_in=-1)
Teuchos_Ordinal index_type
ROpGetElement(const Ordinal &global_i)
Returns the value of the element at index global_i.
Scalar operator()(const ReductTarget &reduct_obj) const
Abstract base class for all reduction objects.
void setOpNameBase(const std::string &op_name_base)
Just set the operator name.
void operator()(const index_type i, const Scalar &v0, Scalar &reduct) const
virtual Range1D range_impl() const
Teuchos_Ordinal Ordinal