RTOp Package Browser (Single Doxygen Collection) Version of the Day
RTOpPack_ROpNorm2.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 // RTOp: Interfaces and Support Software for Vector Reduction Transformation
00005 //       Operations
00006 //                Copyright (2006) Sandia Corporation
00007 // 
00008 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00009 // license for use of this work by or on behalf of the U.S. Government.
00010 // 
00011 // This library is free software; you can redistribute it and/or modify
00012 // it under the terms of the GNU Lesser General Public License as
00013 // published by the Free Software Foundation; either version 2.1 of the
00014 // License, or (at your option) any later version.
00015 //  
00016 // This library is distributed in the hope that it will be useful, but
00017 // WITHOUT ANY WARRANTY; without even the implied warranty of
00018 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00019 // Lesser General Public License for more details.
00020 //  
00021 // You should have received a copy of the GNU Lesser General Public
00022 // License along with this library; if not, write to the Free Software
00023 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00024 // USA
00025 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00026 // 
00027 // ***********************************************************************
00028 // @HEADER
00029 
00030 #ifndef RTOPPACK_ROP_NORM2_HPP
00031 #define RTOPPACK_ROP_NORM2_HPP
00032 
00033 #include "RTOpPack_RTOpTHelpers.hpp"
00034 
00035 
00036 namespace RTOpPack {
00037 
00038 
00040 template<class Scalar>
00041 class ROpNorm2EleWiseReduction
00042 {
00043 public:
00044   void operator()( const Scalar &v0, Scalar &reduct ) const
00045     {
00046       reduct += ScalarTraits<Scalar>::conjugate(v0)*v0;
00047     }
00048 };
00049 
00050 
00054 template<class Scalar>
00055 class ROpNorm2
00056   : public ROp_1_ScalarReduction<Scalar, Scalar, ROpNorm2EleWiseReduction<Scalar> >
00057 {
00058 public:
00060   typedef Teuchos::ScalarTraits<Scalar> ST;
00062   ROpNorm2()
00063     {
00064       this->setOpNameBase("ROpNorm2");
00065     }
00067   typename ST::magnitudeType operator()(const ReductTarget& reduct_obj) const
00068     {
00069       const Scalar sqrt_reduct = ST::squareroot(this->getRawVal(reduct_obj));
00070       return ST::magnitude(sqrt_reduct);
00071     }
00072 };
00073 
00074 
00075 } // namespace RTOpPack
00076 
00077 
00078 #endif // RTOPPACK_ROP_NORM2_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines