Thyra Version of the Day
Thyra_DetachedMultiVectorView.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 #include "Thyra_MultiVectorBase.hpp"
00043 #include "Thyra_AssertOp.hpp"
00044 
00045 #ifndef THYRA_EXPLICIT_MULTI_VECTOR_VIEW_HPP
00046 #define THYRA_EXPLICIT_MULTI_VECTOR_VIEW_HPP
00047 
00048 namespace Thyra {
00049 
00050 
00056 template<class Scalar>
00057 class ConstDetachedMultiVectorView {
00058 public:
00060   ConstDetachedMultiVectorView(
00061     const RCP<const MultiVectorBase<Scalar> > &mv,
00062     const Range1D &rowRng = Range1D(), const Range1D &colRng = Range1D()
00063     )
00064     : mv_(mv) { mv_->acquireDetachedView(rowRng, colRng, &smv_); }
00066   ConstDetachedMultiVectorView(
00067     const MultiVectorBase<Scalar>& mv,
00068     const Range1D &rowRng = Range1D(), const Range1D &colRng = Range1D()
00069     )
00070     : mv_(rcpFromRef(mv)) { mv_->acquireDetachedView(rowRng, colRng, &smv_); }
00072   ~ConstDetachedMultiVectorView() { mv_->releaseDetachedView(&smv_); }
00074   const RTOpPack::ConstSubMultiVectorView<Scalar>& smv() const { return smv_; }
00076   Ordinal globalOffset() const { return smv_.globalOffset(); }
00078   Ordinal subDim() const { return smv_.subDim(); }
00080   Ordinal colOffset() const { return smv_.colOffset(); }
00082   Ordinal numSubCols() const { return smv_.numSubCols(); }
00084   const Scalar* values() const { return smv_.values().get(); }
00086   Ordinal leadingDim() const { return smv_.leadingDim(); }
00090   const Scalar& operator()(Ordinal i, Ordinal j) const { return smv_(i,j); }
00091 private:
00092   RCP<const MultiVectorBase<Scalar> > mv_;
00093   RTOpPack::ConstSubMultiVectorView<Scalar> smv_;
00094   // Not defined and not to be called
00095   ConstDetachedMultiVectorView();
00096   ConstDetachedMultiVectorView(const ConstDetachedMultiVectorView<Scalar>&);
00097   ConstDetachedMultiVectorView<Scalar>& operator==(
00098     const ConstDetachedMultiVectorView<Scalar>&);
00099 };
00100  
00101 
00107 template<class Scalar>
00108 class DetachedMultiVectorView {
00109 public:
00111   DetachedMultiVectorView(
00112     const RCP<MultiVectorBase<Scalar> >& mv,
00113     const Range1D &rowRng = Range1D(), const Range1D &colRng = Range1D()
00114     )
00115     : mv_(mv) { mv_->acquireDetachedView(rowRng, colRng, &smv_); }
00117   DetachedMultiVectorView(
00118     MultiVectorBase<Scalar>& mv,
00119     const Range1D &rowRng = Range1D(), const Range1D &colRng = Range1D()
00120     )
00121     : mv_(rcpFromRef(mv)) { mv_->acquireDetachedView(rowRng,colRng,&smv_); }
00123   ~DetachedMultiVectorView() { mv_->commitDetachedView(&smv_); }
00125   const RTOpPack::SubMultiVectorView<Scalar>& smv() const { return smv_; }
00127   Ordinal globalOffset() const { return smv_.globalOffset(); }
00129   Ordinal subDim() const { return smv_.subDim(); }
00131   Ordinal colOffset() const { return smv_.colOffset(); }
00133   Ordinal numSubCols() const { return smv_.numSubCols(); }
00135   Scalar* values() const { return smv_.values().get(); }
00137   Ordinal leadingDim() const { return smv_.leadingDim(); }
00141   Scalar& operator()(Ordinal i, Ordinal j) { return smv_(i,j); }
00142 private:
00143   RCP<MultiVectorBase<Scalar> > mv_;
00144   RTOpPack::SubMultiVectorView<Scalar> smv_;
00145   // Not defined and not to be called
00146   DetachedMultiVectorView();
00147   DetachedMultiVectorView(const DetachedMultiVectorView<Scalar>&);
00148   DetachedMultiVectorView<Scalar>& operator==(
00149     const DetachedMultiVectorView<Scalar>&);
00150 };
00151 
00152 
00157 template<class Scalar>
00158 void doExplicitMultiVectorAdjoint(
00159   const MultiVectorBase<Scalar>& mvIn, MultiVectorBase<Scalar>* mvTransOut
00160   )
00161 {
00162   typedef Teuchos::ScalarTraits<Scalar> ST;
00163 #ifdef TEUCHOS_DEBUG
00164   TEUCHOS_TEST_FOR_EXCEPT(0==mvTransOut);
00165   THYRA_ASSERT_VEC_SPACES("doExplicitMultiVectorAdjoint(...)",
00166     *mvIn.domain(), *mvTransOut->range()
00167     );
00168   THYRA_ASSERT_VEC_SPACES("doExplicitMultiVectorAdjoint(...)",
00169     *mvIn.range(), *mvTransOut->domain()
00170     );
00171 #endif
00172   ConstDetachedMultiVectorView<Scalar> dMvIn(mvIn);
00173   DetachedMultiVectorView<Scalar> dMvTransOut(*mvTransOut);
00174   const int m = dMvIn.subDim();
00175   const int n = dMvIn.numSubCols();
00176   for ( int j = 0; j < n; ++j ) {
00177     for ( int i = 0; i < m; ++i ) {
00178       dMvTransOut(j,i) = ST::conjugate(dMvIn(i,j));
00179     }
00180   }
00181 }
00182 
00183 
00184 } // namespace Thyra
00185 
00186 
00187 #endif // THYRA_EXPLICIT_MULTI_VECTOR_VIEW_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines