RTOp Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
RTOpPack_TOpSetElement.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_TOP_SET_ELEMENT_HPP
44 #define RTOPPACK_TOP_SET_ELEMENT_HPP
45 
46 #include "RTOpPack_RTOpTHelpers.hpp"
47 #include "Teuchos_as.hpp"
48 
49 
50 namespace RTOpPack {
51 
52 
54 template<class Scalar>
56 {
57 public:
59  TOpSetElementEleWiseTransformation( const Ordinal &global_i_in = -1,
60  const Scalar &val_i_in = static_cast<Scalar>(0.0) )
61  :global_i_(global_i_in), val_i_(val_i_in)
62  {}
64  Ordinal global_i() const
65  {
66  return global_i_;
67  }
69  void operator()( const Ordinal global_i_in, Scalar &z0 ) const
70  {
71  if (global_i_in == global_i_) {
72  z0 = val_i_;
73  }
74  }
75 private:
77  Scalar val_i_;
78 };
79 
80 
83 template<class Scalar>
85  : public TOp_0_1_CoordVariantBase<Scalar, TOpSetElementEleWiseTransformation<Scalar> >
86 {
87 public:
89  TOpSetElement(const Ordinal &global_i_in = -1,
90  const Scalar &val_i_in = static_cast<Scalar>(0.0))
91  {
92  this->setOpNameBase("TOpSetElement");
94  TOpSetElementEleWiseTransformation<Scalar>(global_i_in, val_i_in));
95  }
97  void initialize(const Ordinal &global_i_in, const Scalar &val_i_in)
98  {
100  TOpSetElementEleWiseTransformation<Scalar>(global_i_in, val_i_in));
101  }
102 protected:
104  virtual Range1D range_impl() const
105  {
106  const Ordinal i = this->getEleWiseTransformation().global_i();
107  return Range1D(i, i);
108  }
109 };
110 
111 
112 } // namespace RTOpPack
113 
114 
115 #endif // RTOPPACK_TOP_SET_ELEMENT_HPP
Element-wise transformation for TOpSetElement.
void operator()(const Ordinal global_i_in, Scalar &z0) const
Base class for coordinate variant transformations for 0 input and 1 output vector.
TOpSetElementEleWiseTransformation(const Ordinal &global_i_in=-1, const Scalar &val_i_in=static_cast< Scalar >(0.0))
virtual Range1D range_impl() const
void initialize(const Ordinal &global_i_in, const Scalar &val_i_in)
void setEleWiseTransformation(TOpSetElementEleWiseTransformation< Scalar >eleWiseTransformation)
void setOpNameBase(const std::string &op_name_base)
Just set the operator name.
TOpSetElement(const Ordinal &global_i_in=-1, const Scalar &val_i_in=static_cast< Scalar >(0.0))
Set the elements of a vector to: z0[i] = i+global_i+1, i=0...n-1.
Teuchos_Ordinal Ordinal