Thyra Version of the Day
Thyra_UniversalMultiVectorRandomizer.hpp
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 //    Thyra: Interfaces and Support for Abstract Numerical Algorithms
00005 //                 Copyright (2004) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef THYRA_UNIVERSAL_MULTI_VECTOR_RANDOMIZER_HPP
00043 #define THYRA_UNIVERSAL_MULTI_VECTOR_RANDOMIZER_HPP
00044 
00045 
00046 #include "Thyra_MultiVectorRandomizerBase.hpp"
00047 #include "Thyra_MultiVectorStdOps.hpp"
00048 
00049 
00050 namespace Thyra {
00051 
00052 
00061 template<class Scalar>
00062 class UniversalMultiVectorRandomizer : public MultiVectorRandomizerBase<Scalar> {
00063 public:
00064 
00067 
00069   bool isCompatible( const VectorSpaceBase<Scalar> &space ) const;
00070 
00072 
00073 private:
00074 
00077 
00079   void randomizeImpl(const Ptr<MultiVectorBase<Scalar> > &mv);
00080 
00082   
00083 };
00084 
00085 
00090 template<class Scalar>
00091 RCP<UniversalMultiVectorRandomizer<Scalar> >
00092 universalMultiVectorRandomizer()
00093 {
00094   return Teuchos::rcp(new UniversalMultiVectorRandomizer<Scalar>());
00095 }
00096 
00097 
00098 // //////////////////////////////
00099 // Definitions
00100 
00101 
00102 template<class Scalar>
00103 bool UniversalMultiVectorRandomizer<Scalar>::isCompatible( const VectorSpaceBase<Scalar> &space ) const
00104 {
00105   return true;
00106 }
00107 
00108 
00109 // Overridded private functions
00110 
00111 
00112 template<class Scalar>
00113 void UniversalMultiVectorRandomizer<Scalar>::randomizeImpl(
00114   const Ptr<MultiVectorBase<Scalar> > &mv )
00115 {
00116   using Teuchos::as;
00117   typedef Teuchos::ScalarTraits<Scalar> ST;
00118   Thyra::randomize(as<Scalar>(-ST::one()), as<Scalar>(+ST::one()), mv);
00119 }
00120 
00121 
00122 } // namespace Thyra
00123 
00124 
00125 #endif // THYRA_UNIVERSAL_MULTI_VECTOR_RANDOMIZER_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines