Thyra Version of the Day
Loading...
Searching...
No Matches
Thyra_ListedMultiVectorRandomizer.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_LISTED_MULTI_VECTOR_RANDOMIZER_HPP
43#define THYRA_LISTED_MULTI_VECTOR_RANDOMIZER_HPP
44
45#include "Thyra_MultiVectorRandomizerBase.hpp"
46#include "Thyra_MultiVectorStdOps.hpp"
47
48
49namespace Thyra {
50
51
61template<class Scalar>
63public:
64
67 const Teuchos::RCP<const MultiVectorBase<Scalar> > multiVecs[]
68 ,const int numMultiVecs
69 );
70
72 void initialize(
73 const Teuchos::RCP<const MultiVectorBase<Scalar> > multiVecs[]
74 ,const int numMultiVecs
75 );
76
79
81 bool isCompatible( const VectorSpaceBase<Scalar> &space ) const;
82
84
85private:
86
89
91 void randomizeImpl(const Ptr<MultiVectorBase<Scalar> > &mv);
92
94
95private:
96
97 typedef std::vector<Teuchos::RCP<const MultiVectorBase<Scalar> > > multiVecs_t;
98 multiVecs_t multiVecs_;
99 int curr_mv_i_;
100
101};
102
103
104// //////////////////////////////
105// Definitions
106
107
108template<class Scalar>
110 const Teuchos::RCP<const MultiVectorBase<Scalar> > multiVecs[]
111 ,const int numMultiVecs
112 )
113{
114 initialize(multiVecs,numMultiVecs);
115}
116
117
118template<class Scalar>
120 const Teuchos::RCP<const MultiVectorBase<Scalar> > multiVecs[]
121 ,const int numMultiVecs
122 )
123{
124 multiVecs_.resize(numMultiVecs);
125 std::copy( multiVecs, multiVecs + numMultiVecs, multiVecs_.begin() );
126 curr_mv_i_ = 0;
127}
128
129
130// Overridden from MultiVectorRandomizerBase
131
132
133template<class Scalar>
135{
136 return multiVecs_[curr_mv_i_]->range()->isCompatible(space);
137}
138
139
140// Overridded private functions
141
142
143template<class Scalar>
145 const Ptr<MultiVectorBase<Scalar> > &mv)
146{
147#ifdef TEUCHOS_DEBUG
148 TEUCHOS_TEST_FOR_EXCEPT( multiVecs_.size()==0 );
149#endif
150 const Teuchos::RCP<const MultiVectorBase<Scalar> > currMV = multiVecs_[curr_mv_i_];
151#ifdef TEUCHOS_DEBUG
152 THYRA_ASSERT_VEC_SPACES("ListedMultiVectorRandomizer<Scalar>::randomize(mv)", *currMV->range(), *mv->range() );
153 THYRA_ASSERT_VEC_SPACES("ListedMultiVectorRandomizer<Scalar>::randomize(mv)", *currMV->domain(), *mv->domain() );
154#endif
155 Thyra::assign( mv, *currMV );
156 if( curr_mv_i_ == static_cast<int>(multiVecs_.size()) - 1 )
157 curr_mv_i_ = 0;
158 else
159 ++curr_mv_i_;
160}
161
162
163} // namespace Thyra
164
165
166#endif // THYRA_LISTED_MULTI_VECTOR_RANDOMIZER_HPP
MultiVectorRandomizerBase subclass that returns a revolving list of preset MultiVectorBase objects.
bool isCompatible(const VectorSpaceBase< Scalar > &space) const
ListedMultiVectorRandomizer(const Teuchos::RCP< const MultiVectorBase< Scalar > > multiVecs[], const int numMultiVecs)
Calls this->initialize().
void initialize(const Teuchos::RCP< const MultiVectorBase< Scalar > > multiVecs[], const int numMultiVecs)
Interface for a collection of column vectors called a multi-vector.
Base interface for a strategy object for randomizing a multi-vector.
Abstract interface for objects that represent a space for vectors.
#define TEUCHOS_TEST_FOR_EXCEPT(throw_exception_test)
#define THYRA_ASSERT_VEC_SPACES(FUNC_NAME, VS1, VS2)
This is a very useful macro that should be used to validate that two vector spaces are compatible.