Thyra Version of the Day
Loading...
Searching...
No Matches
Thyra_DetachedSpmdVectorView.hpp
1// @HEADER
2// ***********************************************************************
3//
4// Thyra: Interfaces and Support for Abstract Numerical Algorithms
5// Copyright (2004) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.gov)
38//
39// ***********************************************************************
40// @HEADER
41
42#ifndef THYRA_DETACHED_SPMD_VECTOR_VIEW_HPP
43#define THYRA_DETACHED_SPMD_VECTOR_VIEW_HPP
44
45
46#include "Thyra_SpmdVectorBase.hpp"
47#include "Teuchos_Assert.hpp"
48
49
50namespace Thyra {
51
52
61template<class Scalar>
63public:
66 {
67 using Teuchos::rcp_dynamic_cast;
68 if (!is_null(v)) {
70 rcp_dynamic_cast<const SpmdVectorBase<Scalar> >(v, true);
71 v_ = spmd_v;
72 sv_ = spmd_v->getLocalSubVector();
73 }
74 else {
75 v_ = Teuchos::null;
77 }
78 }
81 {}
84 { if (!is_null(v_)) return v_->spmdSpace(); return Teuchos::null; }
86 const RTOpPack::ConstSubVectorView<Scalar>& sv() const { return sv_; }
88 Teuchos_Ordinal globalOffset() const { return sv_.globalOffset(); }
90 Teuchos_Ordinal subDim() const { return sv_.subDim(); }
92 const ArrayRCP<const Scalar> values() const { return sv_.values(); }
94 ptrdiff_t stride() const { return sv_.stride(); }
96 const Scalar& operator[](Teuchos_Ordinal i) const { return sv_[i]; }
98 const Scalar& operator()(Teuchos_Ordinal i) const { return sv_(i); }
99private:
102 // Not defined and not to be called
107};
108
109
118template<class Scalar>
120public:
123 {
124 using Teuchos::rcp_dynamic_cast;
125 if (!is_null(v)) {
126 const RCP<SpmdVectorBase<Scalar> > spmd_v =
127 rcp_dynamic_cast<SpmdVectorBase<Scalar> >(v, true);
128 v_ = spmd_v;
129 sv_ = spmd_v->getNonconstLocalSubVector();
130 }
131 else {
132 v_ = Teuchos::null;
134 }
135 }
138 {}
141 { if (!is_null(v_)) return v_->spmdSpace(); return Teuchos::null; }
143 const RTOpPack::SubVectorView<Scalar>& sv() const { return sv_; }
145 Teuchos_Ordinal globalOffset() const { return sv_.globalOffset(); }
147 Teuchos_Ordinal subDim() const { return sv_.subDim(); }
149 const ArrayRCP<const Scalar> values() const { return sv_.values(); }
151 ptrdiff_t stride() const { return sv_.stride(); }
153 Scalar& operator[](Teuchos_Ordinal i) const { return sv_[i]; }
155 Scalar& operator()(Teuchos_Ordinal i) const { return sv_(i); }
156private:
159 // Not defined and not to be called
164};
165
166
167} // namespace Thyra
168
169
170#endif // THYRA_DETACHED_SPMD_VECTOR_VIEW_HPP
Ordinal globalOffset() const
const ArrayRCP< const Scalar > values() const
ptrdiff_t stride() const
const ArrayRCP< Scalar > values() const
Create an explicit detached non-mutable (const) view of all of the local elements on this process of ...
const RTOpPack::ConstSubVectorView< Scalar > & sv() const
const ArrayRCP< const Scalar > values() const
const Scalar & operator[](Teuchos_Ordinal i) const
const Scalar & operator()(Teuchos_Ordinal i) const
const RCP< const SpmdVectorSpaceBase< Scalar > > spmdSpace() const
ConstDetachedSpmdVectorView(const Teuchos::RCP< const VectorBase< Scalar > > &v)
Create an explicit detached mutable (non-const) view of all of the local elements on this process of ...
DetachedSpmdVectorView(const Teuchos::RCP< VectorBase< Scalar > > &v)
Scalar & operator()(Teuchos_Ordinal i) const
const RTOpPack::SubVectorView< Scalar > & sv() const
Scalar & operator[](Teuchos_Ordinal i) const
const ArrayRCP< const Scalar > values() const
const RCP< const SpmdVectorSpaceBase< Scalar > > spmdSpace() const
Abstract interface for finite-dimensional dense vectors.