MOOCHO/Thyra Adapter Software Version of the Day
AbstractLinAlgPack_VectorMutableThyra.hpp
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00005 //                  Copyright (2003) 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 (rabartl@sandia.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef ALAP_VECTOR_MUTABLE_Thyra_HPP
00043 #define ALAP_VECTOR_MUTABLE_Thyra_HPP
00044 
00045 #include "AbstractLinAlgPack_VectorMutable.hpp"
00046 #include "AbstractLinAlgPack_VectorApplyOpSerialBase.hpp"
00047 #include "AbstractLinAlgPack_VectorSpaceThyra.hpp"
00048 #include "Thyra_VectorBase.hpp"
00049 
00050 namespace AbstractLinAlgPack {
00051 
00054 class VectorMutableThyra : public VectorMutable, private VectorApplyOpSerialBase {
00055 public:
00056 
00059 
00066   VectorMutableThyra();
00069   VectorMutableThyra( const Teuchos::RCP<Thyra::VectorBase<value_type> >& thyra_vec );
00082   void initialize( const Teuchos::RCP<Thyra::VectorBase<value_type> >& thyra_vec );
00089   Teuchos::RCP<Thyra::VectorBase<value_type> > set_uninitialized();
00095   Teuchos::RCP<const Thyra::VectorBase<value_type> > thyra_vec() const;
00096 
00098 
00101 
00103   const VectorSpace& space() const;
00105   void apply_op(
00106     const RTOpPack::RTOp       &op
00107     ,const size_t              num_vecs
00108     ,const Vector*             vecs[]
00109     ,const size_t              num_targ_vecs
00110     ,VectorMutable*            targ_vecs[]
00111     ,RTOpPack::ReductTarget    *reduct_obj
00112     ,const index_type          first_ele
00113     ,const index_type          sub_dim
00114     ,const index_type          global_offset
00115     ) const;
00117   index_type dim() const;
00119   void get_sub_vector( const Range1D& rng, RTOpPack::SubVector* sub_vec ) const;
00121   void free_sub_vector( RTOpPack::SubVector* sub_vec ) const;
00122 
00124 
00127 
00129   void get_sub_vector( const Range1D& rng, RTOpPack::MutableSubVector* sub_vec );
00131   void commit_sub_vector( RTOpPack::MutableSubVector* sub_vec );
00133   void set_sub_vector( const RTOpPack::SparseSubVector& sub_vec );
00135   void Vp_StMtV(
00136     value_type                       alpha
00137     ,const GenPermMatrixSlice        &P
00138     ,BLAS_Cpp::Transp                P_trans
00139     ,const Vector                    &x
00140     ,value_type                      beta
00141     );
00142 
00143 
00145 
00146 private:
00147 
00148 #ifdef DOXYGEN_COMPILE
00149   Thyra::VectorBase<value_type>                          *thyra_vector;
00150 #else
00151   Teuchos::RCP<Thyra::VectorBase<value_type> >   thyra_vec_;
00152 #endif
00153   VectorSpaceThyra                                       space_;
00154 
00155   // Not defined and not to be called!
00156   //VectorMutableThyra(const VectorMutableThyra&);
00157   VectorMutableThyra& operator=(const VectorMutableThyra&);
00158 
00159 }; // class VectorMutableThyra 
00160 
00161 // ////////////////////////////////
00162 // Inline functions
00163 
00164 inline
00165 Teuchos::RCP<const Thyra::VectorBase<value_type> >
00166 VectorMutableThyra::thyra_vec() const
00167 {
00168   return thyra_vec_;
00169 }
00170 
00171 } // end namespace AbstractLinAlgPack
00172 
00173 #endif  // ALAP_VECTOR_MUTABLE_Thyra_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends