Thyra  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Thyra_SpmdVectorBase.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_SPMD_VECTOR_BASE_DECL_HPP
43 #define THYRA_SPMD_VECTOR_BASE_DECL_HPP
44 
45 
46 #include "Thyra_VectorBase.hpp"
47 #include "Thyra_SpmdMultiVectorBase.hpp"
48 
49 
50 namespace Thyra {
51 
52 
65 template<class Scalar>
67  virtual public VectorBase<Scalar>,
68  virtual public SpmdMultiVectorBase<Scalar>
69 {
70 public:
71 
76 
79 
83  { return getNonconstLocalSubVectorImpl(); }
84 
88  { return getLocalSubVectorImpl(); }
89 
107  void getNonconstLocalData(const Ptr<ArrayRCP<Scalar> > &localValues)
108  { this->getNonconstLocalVectorDataImpl(localValues); }
109 
127  void getLocalData(const Ptr<ArrayRCP<const Scalar> > &localValues) const
128  { this->getLocalVectorDataImpl(localValues); }
129 
131 
132 protected:
133 
136 
140 
143  getLocalSubVectorImpl() const = 0;
144 
146  virtual void getNonconstLocalVectorDataImpl(
147  const Ptr<ArrayRCP<Scalar> > &localValues) = 0;
148 
150  virtual void getLocalVectorDataImpl(
151  const Ptr<ArrayRCP<const Scalar> > &localValues) const = 0;
152 
154 
155 
156 }; // end class SpmdVectorBase
157 
158 
159 } // end namespace Thyra
160 
161 
162 #endif // THYRA_SPMD_VECTOR_BASE_DECL_HPP
Base interface class for SPMD multi-vectors.
Base class for SPMD vectors that can provide views of contiguous elements in a process.
virtual RTOpPack::SubVectorView< Scalar > getNonconstLocalSubVectorImpl()=0
Virtual implementation for getNonconstLocalSubVector().
RTOpPack::ConstSubVectorView< Scalar > getLocalSubVector() const
Get a const generalized view of local vector data.
virtual RTOpPack::ConstSubVectorView< Scalar > getLocalSubVectorImpl() const =0
Virtual implementation for getLocalSubVector().
RTOpPack::SubVectorView< Scalar > getNonconstLocalSubVector()
Get a non-const generalized view of local vector data.
Abstract interface for finite-dimensional dense vectors.
void getLocalData(const Ptr< ArrayRCP< const Scalar > > &localValues) const
Returns a const pointer to the beginning of the local vector data.
virtual void getNonconstLocalVectorDataImpl(const Ptr< ArrayRCP< Scalar > > &localValues)=0
Implementation of getNonconstLocalData()
virtual void getLocalVectorDataImpl(const Ptr< ArrayRCP< const Scalar > > &localValues) const =0
Implementation of getLocalData()
void getNonconstLocalData(const Ptr< ArrayRCP< Scalar > > &localValues)
Returns a non-const pointer to the beginning of the local vector data.