Thyra Version of the Day
Thyra_DetachedSpmdVectorView.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_DETACHED_SPMD_VECTOR_VIEW_HPP
00043 #define THYRA_DETACHED_SPMD_VECTOR_VIEW_HPP
00044 
00045 
00046 #include "Thyra_SpmdVectorBase.hpp"
00047 #include "Teuchos_Assert.hpp"
00048 
00049 
00050 namespace Thyra {
00051 
00052 
00061 template<class Scalar>
00062 class ConstDetachedSpmdVectorView {
00063 public:
00065   ConstDetachedSpmdVectorView(const Teuchos::RCP<const VectorBase<Scalar> > &v)
00066     {
00067       using Teuchos::rcp_dynamic_cast;
00068       if (!is_null(v)) {
00069         const RCP<const SpmdVectorBase<Scalar> > spmd_v =
00070           rcp_dynamic_cast<const SpmdVectorBase<Scalar> >(v, true);
00071         v_ = spmd_v;
00072         sv_ = spmd_v->getLocalSubVector();
00073       }
00074       else {
00075         v_ = Teuchos::null;
00076         sv_ = RTOpPack::ConstSubVectorView<Scalar>();
00077       }
00078     }
00080   ~ConstDetachedSpmdVectorView()
00081     {}
00083   const RCP<const SpmdVectorSpaceBase<Scalar> > spmdSpace() const
00084     { if (!is_null(v_)) return v_->spmdSpace(); return Teuchos::null; }
00086   const RTOpPack::ConstSubVectorView<Scalar>& sv() const { return sv_; }
00088   Teuchos_Index globalOffset() const { return sv_.globalOffset(); }
00090   Teuchos_Index subDim() const { return sv_.subDim(); }
00092   const ArrayRCP<const Scalar> values() const { return sv_.values(); }
00094   ptrdiff_t stride() const { return sv_.stride(); }
00096   const Scalar& operator[](Teuchos_Index i) const { return sv_[i]; }
00098   const Scalar& operator()(Teuchos_Index i) const { return sv_(i); }
00099 private:
00100   Teuchos::RCP<const SpmdVectorBase<Scalar> > v_;
00101   RTOpPack::ConstSubVectorView<Scalar>  sv_;
00102   // Not defined and not to be called
00103   ConstDetachedSpmdVectorView();
00104   ConstDetachedSpmdVectorView(const ConstDetachedSpmdVectorView<Scalar>&);
00105   ConstDetachedSpmdVectorView<Scalar>& operator==(
00106     const ConstDetachedSpmdVectorView<Scalar>&);
00107 };
00108 
00109 
00118 template<class Scalar>
00119 class DetachedSpmdVectorView {
00120 public:
00122   DetachedSpmdVectorView(const Teuchos::RCP<VectorBase<Scalar> > &v)
00123     {
00124       using Teuchos::rcp_dynamic_cast;
00125       if (!is_null(v)) {
00126         const RCP<SpmdVectorBase<Scalar> > spmd_v =
00127           rcp_dynamic_cast<SpmdVectorBase<Scalar> >(v, true);
00128         v_ = spmd_v;
00129         sv_ = spmd_v->getNonconstLocalSubVector();
00130       }
00131       else {
00132         v_ = Teuchos::null;
00133         sv_ = RTOpPack::SubVectorView<Scalar>();
00134       }
00135     }
00137   ~DetachedSpmdVectorView()
00138     {}
00140   const RCP<const SpmdVectorSpaceBase<Scalar> > spmdSpace() const
00141     { if (!is_null(v_)) return v_->spmdSpace(); return Teuchos::null; }
00143   const RTOpPack::SubVectorView<Scalar>& sv() const { return sv_; }
00145   Teuchos_Index globalOffset() const { return sv_.globalOffset(); }
00147   Teuchos_Index subDim() const { return sv_.subDim(); }
00149   const ArrayRCP<const Scalar> values() const { return sv_.values(); }
00151   ptrdiff_t stride() const { return sv_.stride(); }
00153   Scalar& operator[](Teuchos_Index i) const { return sv_[i]; }
00155   Scalar& operator()(Teuchos_Index i) const { return sv_(i); }
00156 private:
00157   Teuchos::RCP<SpmdVectorBase<Scalar> > v_;
00158   RTOpPack::SubVectorView<Scalar>  sv_;
00159   // Not defined and not to be called
00160   DetachedSpmdVectorView();
00161   DetachedSpmdVectorView(const DetachedSpmdVectorView<Scalar>&);
00162   DetachedSpmdVectorView<Scalar>& operator==(
00163     const DetachedSpmdVectorView<Scalar>&);
00164 };
00165 
00166 
00167 } // namespace Thyra
00168 
00169 
00170 #endif // THYRA_DETACHED_SPMD_VECTOR_VIEW_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines