Thyra Version of the Day
Loading...
Searching...
No Matches
Thyra_SpmdMultiVectorBase.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_MULTI_VECTOR_BASE_DECL_HPP
43#define THYRA_SPMD_MULTI_VECTOR_BASE_DECL_HPP
44
45
46#include "Thyra_MultiVectorBase.hpp"
47
48
49namespace Thyra {
50
51
52template<class Scalar> class SpmdVectorSpaceBase;
53
54
66template<class Scalar>
67class SpmdMultiVectorBase : virtual public MultiVectorBase<Scalar>
68{
69public:
70
73
79
84
89
111 const Ptr<ArrayRCP<Scalar> > &localValues, const Ptr<Ordinal> &leadingDim
112 )
113 { getNonconstLocalMultiVectorDataImpl(localValues, leadingDim); }
114
136 const Ptr<ArrayRCP<const Scalar> > &localValues, const Ptr<Ordinal> &leadingDim
137 ) const
138 { getLocalMultiVectorDataImpl(localValues, leadingDim); }
139
141
142protected:
143
146
149
153
157
160 const Ptr<ArrayRCP<Scalar> > &localValues, const Ptr<Ordinal> &leadingDim
161 ) = 0;
162
165 const Ptr<ArrayRCP<const Scalar> > &localValues, const Ptr<Ordinal> &leadingDim
166 ) const = 0;
167
169
170}; // end class SpmdMultiVectorBase
171
172
173} // end namespace Thyra
174
175
176#endif // THYRA_SPMD_MULTI_VECTOR_BASE_DECL_HPP
Interface for a collection of column vectors called a multi-vector.
Base interface class for SPMD multi-vectors.
RTOpPack::SubMultiVectorView< Scalar > getNonconstLocalSubMultiVector()
Get a non-const generalized view of local multi-vector data.
virtual void getLocalMultiVectorDataImpl(const Ptr< ArrayRCP< const Scalar > > &localValues, const Ptr< Ordinal > &leadingDim) const =0
Virtual implementation for getLocalData().
virtual void getNonconstLocalMultiVectorDataImpl(const Ptr< ArrayRCP< Scalar > > &localValues, const Ptr< Ordinal > &leadingDim)=0
Virtual implementation for getNonconstLocalData().
virtual RTOpPack::SubMultiVectorView< Scalar > getNonconstLocalSubMultiVectorImpl()=0
Virtual implementation for getNonconstLocalSubMultiVector().
RCP< const SpmdVectorSpaceBase< Scalar > > spmdSpace() const
Returns the SPMD vector space object for the range of *this multi-vector.
void getLocalData(const Ptr< ArrayRCP< const Scalar > > &localValues, const Ptr< Ordinal > &leadingDim) const
Returns a const pointer to a Fortran-style view of the local multi-vector data.
virtual RTOpPack::ConstSubMultiVectorView< Scalar > getLocalSubMultiVectorImpl() const =0
Virtual implementation for getLocalSubMultiVector().
virtual RCP< const SpmdVectorSpaceBase< Scalar > > spmdSpaceImpl() const =0
Virtual implementation for spmdSpace().
RTOpPack::ConstSubMultiVectorView< Scalar > getLocalSubMultiVector() const
Get a const generalized view of local multi-vector data.
void getNonconstLocalData(const Ptr< ArrayRCP< Scalar > > &localValues, const Ptr< Ordinal > &leadingDim)
Returns a non-const pointer to a Fortran-style view of the local multi-vector data.