Thyra Version of the Day
Loading...
Searching...
No Matches
Thyra_DefaultColumnwiseMultiVector_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_COLUMNWISE_MULTI_VECTOR_DECL_HPP
43#define THYRA_DEFAULT_COLUMNWISE_MULTI_VECTOR_DECL_HPP
44
45#include "Thyra_MultiVectorDefaultBase_decl.hpp"
46#include "Thyra_VectorSpaceBase_decl.hpp"
47#include "Thyra_VectorBase.hpp"
48
49
50namespace Thyra {
51
52
65template<class Scalar>
67{
68public:
69
72
81
84 const RCP<VectorBase<Scalar> > &col_vec
85 );
86
89 const RCP<const VectorSpaceBase<Scalar> > &range,
90 const RCP<const VectorSpaceBase<Scalar> > &domain,
91 const ArrayView<const RCP<VectorBase<Scalar> > > &col_vecs = Teuchos::null
92 );
93
110 void initialize(
111 const RCP<VectorBase<Scalar> > &col_vec
112 );
113
150 void initialize(
151 const RCP<const VectorSpaceBase<Scalar> > &range,
152 const RCP<const VectorSpaceBase<Scalar> > &domain,
153 const ArrayView<const RCP<VectorBase<Scalar> > > &col_vecs = Teuchos::null
154 );
155
157 void uninitialize();
158
160
168
175 nonconstContigSubViewImpl( const Range1D& col_rng );
177
178protected:
179
182
184 virtual void assignImpl(Scalar alpha);
185
187 virtual void assignMultiVecImpl(const MultiVectorBase<Scalar>& mv);
188
190 virtual void scaleImpl(Scalar alpha);
191
193 virtual void updateImpl(
194 Scalar alpha,
196 );
197
199 virtual void linearCombinationImpl(
200 const ArrayView<const Scalar>& alpha,
201 const ArrayView<const Ptr<const MultiVectorBase<Scalar> > >& mv,
202 const Scalar& beta
203 );
204
206 virtual void dotsImpl(
207 const MultiVectorBase<Scalar>& mv,
208 const ArrayView<Scalar>& prods
209 ) const;
210
212 virtual void norms1Impl(
214 ) const;
215
217 virtual void norms2Impl(
219 ) const;
220
222 virtual void normsInfImpl(
224 ) const;
225
227
230
235 bool opSupportedImpl(EOpTransp M_trans) const;
236
253 void applyImpl(
254 const EOpTransp M_trans,
256 const Ptr<MultiVectorBase<Scalar> > &Y,
257 const Scalar alpha,
258 const Scalar beta
259 ) const;
260
262
263private:
264
267 Array<RCP<VectorBase<Scalar> > > col_vecs_;
268
269};
270
271
272} // end namespace Thyra
273
274
275#endif // THYRA_DEFAULT_COLUMNWISE_MULTI_VECTOR_DECL_HPP
Default subclass for MultiVectorBase implemented using columns of separate abstract vectors.
void applyImpl(const EOpTransp M_trans, const MultiVectorBase< Scalar > &X, const Ptr< MultiVectorBase< Scalar > > &Y, const Scalar alpha, const Scalar beta) const
This function is implemented in terms of the multi-vector applyOp() function.
virtual void assignMultiVecImpl(const MultiVectorBase< Scalar > &mv)
RCP< MultiVectorBase< Scalar > > nonconstContigSubViewImpl(const Range1D &col_rng)
virtual void linearCombinationImpl(const ArrayView< const Scalar > &alpha, const ArrayView< const Ptr< const MultiVectorBase< Scalar > > > &mv, const Scalar &beta)
virtual void updateImpl(Scalar alpha, const MultiVectorBase< Scalar > &mv)
virtual void dotsImpl(const MultiVectorBase< Scalar > &mv, const ArrayView< Scalar > &prods) const
virtual void norms2Impl(const ArrayView< typename ScalarTraits< Scalar >::magnitudeType > &norms) const
virtual void normsInfImpl(const ArrayView< typename ScalarTraits< Scalar >::magnitudeType > &norms) const
virtual void norms1Impl(const ArrayView< typename ScalarTraits< Scalar >::magnitudeType > &norms) const
RCP< const VectorSpaceBase< Scalar > > domain() const
void initialize(const RCP< VectorBase< Scalar > > &col_vec)
Initialize given a single vector object.
RCP< const VectorSpaceBase< Scalar > > range() const
RCP< VectorBase< Scalar > > nonconstColImpl(Ordinal j)
bool opSupportedImpl(EOpTransp M_trans) const
For complex Scalar types returns true for NOTRANS and CONJTRANS and for real types returns true for a...
Interface for a collection of column vectors called a multi-vector.
void norms(const MultiVectorBase< Scalar > &V, const ArrayView< typename ScalarTraits< Scalar >::magnitudeType > &norms)
Column-wise multi-vector natural norm.
Node subclass that uses a default MultiVectorBase implementation to provide default implementations f...
Abstract interface for finite-dimensional dense vectors.
Abstract interface for objects that represent a space for vectors.
EOpTransp
Enumeration for determining how a linear operator is applied. `*.
Teuchos::Ordinal Ordinal
Type for the dimension of a vector space. `*.