Thyra Version of the Day
Loading...
Searching...
No Matches
Thyra_DefaultSpmdVector_decl.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_DEFAULT_SPMD_VECTOR_DECL_HPP
43#define THYRA_DEFAULT_SPMD_VECTOR_DECL_HPP
44
45
46#include "Thyra_SpmdVectorDefaultBase_decl.hpp"
47
48
49namespace Thyra {
50
51
68template<class Scalar>
69class DefaultSpmdVector : virtual public SpmdVectorDefaultBase<Scalar> {
70public:
71
74
75
78
82 ,const ArrayRCP<Scalar> &localValues
83 ,const Ordinal stride
84 );
85
111 void initialize(
113 ,const ArrayRCP<Scalar> &localValues
114 ,const Ordinal stride
115 );
116
122 void uninitialize(
124 ,ArrayRCP<Scalar> *localValues = NULL
125 ,Ordinal *stride = NULL
126 );
127
129
132
138 Scalar* getPtr();
140 const Scalar* getPtr() const;
142 Ordinal getStride() const;
143
145
148
151
153
157 void getNonconstLocalVectorDataImpl(const Ptr<ArrayRCP<Scalar> > &localValues);
159 void getLocalVectorDataImpl(const Ptr<ArrayRCP<const Scalar> > &localValues) const;
160
162
163private:
164
165 // ///////////////////////////////////////
166 // Private data members
167
169 ArrayRCP<Scalar> localValues_;
170 Ordinal stride_;
171
172};
173
174
175// /////////////////////////////////////////////////////
176// Inline members
177
178
179template<class Scalar>
180inline
183{
184 return localValues_;
185}
186
187
188template<class Scalar>
189inline
192{
193 return localValues_;
194}
195
196
197template<class Scalar>
198inline
200{
201 return localValues_.get();
202}
203
204
205template<class Scalar>
206inline
208{
209 return localValues_.get();
210}
211
212
213template<class Scalar>
214inline
216{
217 return stride_;
218}
219
220
221} // end namespace Thyra
222
223
224#endif // THYRA_DEFAULT_SPMD_VECTOR_DECL_HPP
T * get() const
Efficient concrete implementation subclass for SPMD vectors.
RCP< const SpmdVectorSpaceBase< Scalar > > spmdSpaceImpl() const
void getNonconstLocalVectorDataImpl(const Ptr< ArrayRCP< Scalar > > &localValues)
void getLocalVectorDataImpl(const Ptr< ArrayRCP< const Scalar > > &localValues) const
void initialize(const RCP< const SpmdVectorSpaceBase< Scalar > > &spmdSpace, const ArrayRCP< Scalar > &localValues, const Ordinal stride)
Initialize.
DefaultSpmdVector()
Construct to uninitialized.
void uninitialize(RCP< const SpmdVectorSpaceBase< Scalar > > *spmdSpace=NULL, ArrayRCP< Scalar > *localValues=NULL, Ordinal *stride=NULL)
Set to an uninitialized state.
RCP< const SpmdVectorSpaceBase< Scalar > > spmdSpace() const
Returns the SPMD vector space object for the range of *this multi-vector.
Base class for SPMD vectors that can provide views of contiguous elements in a process.
Base abstract VectorSpaceBase class for all SPMD-based vector spaces.
Teuchos::Ordinal Ordinal
Type for the dimension of a vector space. `*.