Thyra  Version of the Day
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 
50 namespace Thyra {
51 
52 
65 template<class Scalar>
67 {
68 public:
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 
164  RCP<const VectorSpaceBase<Scalar> > range() const;
166  RCP<const VectorSpaceBase<Scalar> > domain() const;
168 
172  RCP<VectorBase<Scalar> > nonconstColImpl(Ordinal j);
174  RCP<MultiVectorBase<Scalar> >
175  nonconstContigSubViewImpl( const Range1D& col_rng );
177 
178 protected:
179 
182 
184  void assignImpl(Scalar alpha);
185 
187 
190 
195  bool opSupportedImpl(EOpTransp M_trans) const;
196 
213  void applyImpl(
214  const EOpTransp M_trans,
215  const MultiVectorBase<Scalar> &X,
216  const Ptr<MultiVectorBase<Scalar> > &Y,
217  const Scalar alpha,
218  const Scalar beta
219  ) const;
220 
222 
223 private:
224 
225  RCP<const VectorSpaceBase<Scalar> > range_;
226  RCP<const VectorSpaceBase<Scalar> > domain_;
227  Array<RCP<VectorBase<Scalar> > > col_vecs_;
228 
229 };
230 
231 
232 } // end namespace Thyra
233 
234 
235 #endif // THYRA_DEFAULT_COLUMNWISE_MULTI_VECTOR_DECL_HPP
EOpTransp
Enumeration for determining how a linear operator is applied. `*.
RCP< const VectorSpaceBase< Scalar > > domain() const
Abstract interface for objects that represent a space for vectors.
bool opSupportedImpl(EOpTransp M_trans) const
For complex Scalar types returns true for NOTRANS and CONJTRANS and for real types returns true for a...
Node subclass that uses a default MultiVectorBase implementation to provide default implementations f...
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.
Teuchos::Ordinal Ordinal
Type for the dimension of a vector space. `*.
Interface for a collection of column vectors called a multi-vector.
RCP< VectorBase< Scalar > > nonconstColImpl(Ordinal j)
Abstract interface for finite-dimensional dense vectors.
void initialize(const RCP< VectorBase< Scalar > > &col_vec)
Initialize given a single vector object.
Default subclass for MultiVectorBase implemented using columns of separate abstract vectors...
RCP< MultiVectorBase< Scalar > > nonconstContigSubViewImpl(const Range1D &col_rng)
RCP< const VectorSpaceBase< Scalar > > range() const
Teuchos::Range1D Range1D