Thyra Version of the Day
Thyra_ListedMultiVectorRandomizer.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 Michael A. Heroux (maherou@sandia.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef THYRA_LISTED_MULTI_VECTOR_RANDOMIZER_HPP
00043 #define THYRA_LISTED_MULTI_VECTOR_RANDOMIZER_HPP
00044 
00045 #include "Thyra_MultiVectorRandomizerBase.hpp"
00046 #include "Thyra_MultiVectorStdOps.hpp"
00047 
00048 namespace Thyra {
00049 
00059 template<class Scalar>
00060 class ListedMultiVectorRandomizer : public MultiVectorRandomizerBase<Scalar> {
00061 public:
00062 
00064   ListedMultiVectorRandomizer(
00065     const Teuchos::RCP<const MultiVectorBase<Scalar> >    multiVecs[]
00066     ,const int                                                    numMultiVecs
00067     );
00068 
00070   void initialize(
00071     const Teuchos::RCP<const MultiVectorBase<Scalar> >    multiVecs[]
00072     ,const int                                                    numMultiVecs
00073     );
00074 
00077 
00079   bool isCompatible( const VectorSpaceBase<Scalar> &space ) const;
00081   void randomize( MultiVectorBase<Scalar> *mv );
00082 
00084 
00085 private:
00086 
00087   typedef std::vector<Teuchos::RCP<const MultiVectorBase<Scalar> > > multiVecs_t;
00088   
00089   multiVecs_t  multiVecs_;
00090 
00091   int          curr_mv_i_;
00092   
00093 };
00094 
00095 // //////////////////////////////
00096 // Definitions
00097 
00098 template<class Scalar>
00099 ListedMultiVectorRandomizer<Scalar>::ListedMultiVectorRandomizer(
00100   const Teuchos::RCP<const MultiVectorBase<Scalar> >    multiVecs[]
00101   ,const int                                                    numMultiVecs
00102   )
00103 {
00104   initialize(multiVecs,numMultiVecs);
00105 }
00106 
00107 template<class Scalar>
00108 void ListedMultiVectorRandomizer<Scalar>::initialize(
00109   const Teuchos::RCP<const MultiVectorBase<Scalar> >    multiVecs[]
00110   ,const int                                                    numMultiVecs
00111   )
00112 {
00113   multiVecs_.resize(numMultiVecs);
00114   std::copy( multiVecs, multiVecs + numMultiVecs, multiVecs_.begin() );
00115   curr_mv_i_ = 0;
00116 }
00117 
00118 // Overridden from MultiVectorRandomizerBase
00119 
00120 template<class Scalar>
00121 bool ListedMultiVectorRandomizer<Scalar>::isCompatible( const VectorSpaceBase<Scalar> &space ) const
00122 {
00123   return multiVecs_[curr_mv_i_]->range()->isCompatible(space);
00124 }
00125 
00126 template<class Scalar>
00127 void ListedMultiVectorRandomizer<Scalar>::randomize( MultiVectorBase<Scalar> *mv )
00128 {
00129 #ifdef TEUCHOS_DEBUG
00130   TEST_FOR_EXCEPT( mv==NULL );
00131   TEST_FOR_EXCEPT( multiVecs_.size()==0 );
00132 #endif
00133   const Teuchos::RCP<const MultiVectorBase<Scalar> > currMV = multiVecs_[curr_mv_i_];
00134 #ifdef TEUCHOS_DEBUG
00135   THYRA_ASSERT_VEC_SPACES("ListedMultiVectorRandomizer<Scalar>::randomize(mv)", *currMV->range(), *mv->range() );
00136   THYRA_ASSERT_VEC_SPACES("ListedMultiVectorRandomizer<Scalar>::randomize(mv)", *currMV->domain(), *mv->domain() );
00137 #endif
00138   Thyra::assign( mv, *currMV );
00139   if( curr_mv_i_ == static_cast<int>(multiVecs_.size()) - 1 )
00140     curr_mv_i_ = 0;
00141   else
00142     ++curr_mv_i_;
00143 }
00144 
00145 } // namespace Thyra
00146 
00147 #endif // THYRA_LISTED_MULTI_VECTOR_RANDOMIZER_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines