Anasazi  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
AnasaziThyraDebugAdapter.hpp
Go to the documentation of this file.
1 // @HEADER
2 // *****************************************************************************
3 // Anasazi: Block Eigensolvers Package
4 //
5 // Copyright 2004 NTESS and the Anasazi contributors.
6 // SPDX-License-Identifier: BSD-3-Clause
7 // *****************************************************************************
8 // @HEADER
9 
14 #ifndef ANASAZI_THYRA_DEBUG_ADAPTER_HPP
15 #define ANASAZI_THYRA_DEBUG_ADAPTER_HPP
16 
17 #include "AnasaziConfigDefs.hpp"
18 #include "AnasaziTypes.hpp"
19 #include "AnasaziMultiVec.hpp"
20 #include "AnasaziOperator.hpp"
21 
22 #include "AnasaziThyraAdapter.hpp"
23 #include <Thyra_DetachedMultiVectorView.hpp>
24 #include <Thyra_MultiVectorBase.hpp>
25 #include <Thyra_MultiVectorStdOps.hpp>
26 
27 #include "Teuchos_Assert.hpp"
29 #include "Teuchos_RCP.hpp"
30 #include "Teuchos_TimeMonitor.hpp"
31 
32 namespace Anasazi {
33 
35 
37  //
38  //--------template class AnasaziThyraMultiVec-----------------
39  //
41 
49  template<class ScalarType>
50  class ThyraMultiVec : public MultiVec<ScalarType> {
51  public:
52 
55  typedef typename Teuchos::ScalarTraits<ScalarType>::magnitudeType MagnitudeType;
57 
59 
60 
62 
66  ThyraMultiVec( const Teuchos::RCP<Thyra::MultiVectorBase< ScalarType > > & mv ) :
67  _timerCreate(Teuchos::TimeMonitor::getNewTimer("ThyraMultiVec::create")),
68  _timerClone(Teuchos::TimeMonitor::getNewTimer("ThyraMultiVec::clone")),
69  _timerDestroy(Teuchos::TimeMonitor::getNewTimer("ThyraMultiVec::destroy")),
70  _timerMvTimesMatAddMv(Teuchos::TimeMonitor::getNewTimer("ThyraMultiVec::mvtimesmataddmv")),
71  _timerMvTransMv(Teuchos::TimeMonitor::getNewTimer("ThyraMultiVec::mvtransmv")),
72  _timerMvAddMv(Teuchos::TimeMonitor::getNewTimer("ThyraMultiVec::mvaddmv")),
73  _timerMvDot(Teuchos::TimeMonitor::getNewTimer("ThyraMultiVec::mvdot")),
74  _timerMvNorm(Teuchos::TimeMonitor::getNewTimer("ThyraMultiVec::mvnorm")),
75  _timerMvScale(Teuchos::TimeMonitor::getNewTimer("ThyraMultiVec::mvscale")),
76  _timerSetBlock(Teuchos::TimeMonitor::getNewTimer("ThyraMultiVec::setblock")),
77  _timerMvInit(Teuchos::TimeMonitor::getNewTimer("ThyraMultiVec::mvinit")),
78  _timerMvRandom(Teuchos::TimeMonitor::getNewTimer("ThyraMultiVec::mvrandom"))
79  {
80  Teuchos::TimeMonitor timer(*_timerCreate);
81  Thyra_MV = mv;
82  }
83 
85 
90  ThyraMultiVec( const Teuchos::RCP<Thyra::MultiVectorBase< ScalarType > > & mv, std::vector<Teuchos::RCP<Teuchos::Time> >& timers )
91  {
92  copyTimers( timers );
93  Teuchos::TimeMonitor timer(*_timerCreate);
94  Thyra_MV = mv;
95  }
96 
98 
103  {
104  copyTimers( mv.getTimers() );
105  Teuchos::TimeMonitor timer(*_timerCreate);
106  Thyra_MV = MVT::CloneCopy( *(mv.getRCP()) );
107  }
108 
110  virtual ~ThyraMultiVec() { Teuchos::TimeMonitor timer(*_timerDestroy); }
111 
113 
115 
116 
121  MultiVec<ScalarType> * Clone ( const int numvecs ) const
122  {
123  Teuchos::TimeMonitor timer(*_timerClone);
124  std::vector<Teuchos::RCP<Teuchos::Time> > myTimers = getTimers();
125  return new ThyraMultiVec<ScalarType>( MVT::Clone( *Thyra_MV, numvecs ), myTimers ); }
126 
133  {
134  Teuchos::TimeMonitor timer(*_timerClone);
135  std::vector<Teuchos::RCP<Teuchos::Time> > myTimers = getTimers();
136  return new ThyraMultiVec<ScalarType>( MVT::CloneCopy( *Thyra_MV ), myTimers );
137  }
138 
146  MultiVec<ScalarType> * CloneCopy ( const std::vector<int>& index ) const
147  {
148  Teuchos::TimeMonitor timer(*_timerClone);
149  std::vector<Teuchos::RCP<Teuchos::Time> > myTimers = getTimers();
150  return new ThyraMultiVec<ScalarType>( MVT::CloneCopy( *Thyra_MV, index ), myTimers );
151  }
152 
160  MultiVec<ScalarType> * CloneViewNonConst ( const std::vector<int>& index )
161  {
162  Teuchos::TimeMonitor timer(*_timerClone);
163  std::vector<Teuchos::RCP<Teuchos::Time> > myTimers = getTimers();
164  return new ThyraMultiVec<ScalarType>( MVT::CloneViewNonConst( *Thyra_MV, index ), myTimers );
165  }
166 
174  const MultiVec<ScalarType> * CloneView ( const std::vector<int>& index ) const
175  {
176  Teuchos::TimeMonitor timer(*_timerClone);
177  std::vector<Teuchos::RCP<Teuchos::Time> > myTimers = getTimers();
178  Teuchos::RCP<Thyra::MultiVectorBase<ScalarType> > nonconst_ptr_to_const_view = Teuchos::rcp_const_cast<Thyra::MultiVectorBase<ScalarType> >( MVT::CloneView(*Thyra_MV,index) );
179  const MultiVec<ScalarType> * const_ret = new ThyraMultiVec<ScalarType>( nonconst_ptr_to_const_view, myTimers );
180  return const_ret;
181  }
182 
184 
186 
187 
189  int GetNumberVecs () const { return MVT::GetNumberVecs( *Thyra_MV ); }
190 
192  ptrdiff_t GetGlobalLength () const { return MVT::GetGlobalLength( *Thyra_MV ); }
193 
195 
197 
198 
200  void MvTimesMatAddMv ( ScalarType alpha, const MultiVec<ScalarType>& A,
202  ScalarType beta )
203  {
204  Teuchos::TimeMonitor timer(*_timerMvTimesMatAddMv);
205  const Anasazi::ThyraMultiVec<ScalarType>* vec_A = dynamic_cast<const Anasazi::ThyraMultiVec<ScalarType>* >(&A);
206  MVT::MvTimesMatAddMv( alpha, *(vec_A->getRCP()), B, beta, *Thyra_MV );
207  }
208 
211  void MvAddMv ( ScalarType alpha, const MultiVec<ScalarType>& A,
212  ScalarType beta, const MultiVec<ScalarType>& B)
213  {
214  Teuchos::TimeMonitor timer(*_timerMvAddMv);
215  const Anasazi::ThyraMultiVec<ScalarType>* vec_A = dynamic_cast<const Anasazi::ThyraMultiVec<ScalarType>* >(&A);
216  const Anasazi::ThyraMultiVec<ScalarType>* vec_B = dynamic_cast<const Anasazi::ThyraMultiVec<ScalarType>* >(&B);
217  MVT::MvAddMv( alpha, *(vec_A->getRCP()), beta, *(vec_B->getRCP()), *Thyra_MV );
218  }
219 
223 #ifdef HAVE_ANASAZI_EXPERIMENTAL
224  , ConjType conj = Anasazi::CONJ
225 #endif
226  ) const
227  {
228  Teuchos::TimeMonitor timer(*_timerMvTransMv);
229  const Anasazi::ThyraMultiVec<ScalarType>* vec_A = dynamic_cast<const Anasazi::ThyraMultiVec<ScalarType>* >(&A);
230  MVT::MvTransMv( alpha, *(vec_A->getRCP()), *Thyra_MV, B );
231  }
232 
235  void MvDot ( const MultiVec<ScalarType>& A, std::vector<ScalarType> &b
236 #ifdef HAVE_ANASAZI_EXPERIMENTAL
237  , ConjType conj = Anasazi::CONJ
238 #endif
239  ) const
240  {
241  Teuchos::TimeMonitor timer(*_timerMvDot);
242  const Anasazi::ThyraMultiVec<ScalarType>* vec_A = dynamic_cast<const Anasazi::ThyraMultiVec<ScalarType>* >(&A);
243  MVT::MvDot( *Thyra_MV, *(vec_A->getRCP()), b );
244  }
245 
248  void MvScale ( ScalarType alpha ) { Teuchos::TimeMonitor timer(*_timerMvScale); MVT::MvScale( *Thyra_MV, alpha ); }
249 
252  void MvScale ( const std::vector<ScalarType>& alpha ) { Teuchos::TimeMonitor timer(*_timerMvScale); MVT::MvScale( *Thyra_MV, alpha ); }
253 
255 
257 
261  void MvNorm ( std::vector<typename Teuchos::ScalarTraits<ScalarType>::magnitudeType> &normvec ) const { Teuchos::TimeMonitor timer(*_timerMvNorm); MVT::MvNorm( *Thyra_MV, normvec ); }
263 
265 
266 
271  void SetBlock ( const MultiVec<ScalarType>& A, const std::vector<int>& index )
272  {
273  Teuchos::TimeMonitor timer(*_timerSetBlock);
274  const Anasazi::ThyraMultiVec<ScalarType>* vec_A = dynamic_cast<const Anasazi::ThyraMultiVec<ScalarType>* >(&A);
275  MVT::SetBlock( *(vec_A->getRCP()), index, *Thyra_MV );
276  }
277 
280  void MvRandom() { Teuchos::TimeMonitor timer(*_timerMvRandom); MVT::MvRandom( *Thyra_MV ); }
281 
284  void MvInit ( ScalarType alpha ) { Teuchos::TimeMonitor timer(*_timerMvInit); MVT::MvInit( *Thyra_MV, alpha ); }
285 
287 
288 
291 
295 
298  std::vector<Teuchos::RCP<Teuchos::Time> > getTimers() const {
299  std::vector<Teuchos::RCP<Teuchos::Time> > timers;
300  timers.push_back( _timerCreate );
301  timers.push_back( _timerClone );
302  timers.push_back( _timerDestroy );
303  timers.push_back( _timerMvTimesMatAddMv );
304  timers.push_back( _timerMvTransMv );
305  timers.push_back( _timerMvAddMv );
306  timers.push_back( _timerMvDot );
307  timers.push_back( _timerMvNorm );
308  timers.push_back( _timerMvScale );
309  timers.push_back( _timerSetBlock );
310  timers.push_back( _timerMvInit );
311  timers.push_back( _timerMvRandom );
312 
313  return timers;
314  }
315 
318  void copyTimers( const std::vector<Teuchos::RCP<Teuchos::Time> >& timers ) {
319  _timerCreate = timers[0];
320  _timerClone = timers[1];
321  _timerDestroy = timers[2];
322  _timerMvTimesMatAddMv = timers[3];
323  _timerMvTransMv = timers[4];
324  _timerMvAddMv = timers[5];
325  _timerMvDot = timers[6];
326  _timerMvNorm = timers[7];
327  _timerMvScale = timers[8];
328  _timerSetBlock = timers[9];
329  _timerMvInit = timers[10];
330  _timerMvRandom = timers[11];
331  }
333 
335 
337 
339  void MvPrint( std::ostream& os ) const { MVT::MvPrint( *Thyra_MV, os ); }
341 
342  private:
343 
345  Teuchos::RCP<Teuchos::Time> _timerCreate, _timerClone, _timerDestroy;
346  Teuchos::RCP<Teuchos::Time> _timerMvTimesMatAddMv, _timerMvTransMv, _timerMvAddMv, _timerMvDot;
347  Teuchos::RCP<Teuchos::Time> _timerMvNorm, _timerMvScale, _timerSetBlock, _timerMvInit, _timerMvRandom;
348  };
349  //-------------------------------------------------------------
350 
352  //
353  //--------template class AnasaziThyraOp---------------------
354  //
356 
363  template<class ScalarType>
364  class ThyraOp : public virtual Operator<ScalarType> {
365  public:
366 
367  typedef OperatorTraits<ScalarType,Thyra::MultiVectorBase<ScalarType>,Thyra::LinearOpBase<ScalarType> > OPT;
368 
370 
371 
373  ThyraOp(const Teuchos::RCP<const Thyra::LinearOpBase<ScalarType> > &Op ) { Thyra_Op = Op; }
374 
376  ~ThyraOp() {}
378 
380 
381 
385  void Apply ( const MultiVec<ScalarType>& X, MultiVec<ScalarType>& Y ) const
386  {
387  const Anasazi::ThyraMultiVec<ScalarType>* vec_X = dynamic_cast<const Anasazi::ThyraMultiVec<ScalarType>* >(&X);
389  OPT::Apply( *Thyra_Op, *(vec_X->getRCP()), *(vec_Y->getRCP()) );
390  }
391 
393 
394  private:
396  };
397 
398 } // end of Anasazi namespace
399 
400 #endif
401 // end of file ANASAZI_THYRA_DEBUG_ADAPTER_HPP
static void MvNorm(const TMVB &mv, std::vector< typename Teuchos::ScalarTraits< ScalarType >::magnitudeType > &normvec)
Compute the 2-norm of each individual vector of mv. Upon return, normvec[i] holds the value of ...
int GetNumberVecs() const
Obtain the vector length of *this.
const MultiVec< ScalarType > * CloneView(const std::vector< int > &index) const
Creates a new ThyraMultiVec that shares the selected contents of *this.
MultiVec< ScalarType > * CloneViewNonConst(const std::vector< int > &index)
Creates a new ThyraMultiVec that shares the selected contents of *this.
static void MvDot(const TMVB &mv, const TMVB &A, std::vector< ScalarType > &b)
Compute a vector b where the components are the individual dot-products of the i-th columns of A and ...
ThyraOp(const Teuchos::RCP< const Thyra::LinearOpBase< ScalarType > > &Op)
Basic constructor. Accepts reference-counted pointer to an Thyra_Operator.
void Apply(const MultiVec< ScalarType > &X, MultiVec< ScalarType > &Y) const
This method takes the Anasazi::MultiVec X and applies the operator to it resulting in the Anasazi::Mu...
Teuchos::RCP< Thyra::MultiVectorBase< ScalarType > > getRCP()
Return the reference-counted pointer held by this object.
ptrdiff_t GetGlobalLength() const
Obtain the number of vectors in *this.
Virtual base class which defines basic traits for the operator type.
Template specialization of Anasazi::OperatorTraits class using the Thyra::LinearOpBase virtual base c...
void MvDot(const MultiVec< ScalarType > &A, std::vector< ScalarType > &b) const
Compute a vector b where the components are the individual dot-products, i.e. where A[i] is the i-th...
void copyTimers(const std::vector< Teuchos::RCP< Teuchos::Time > > &timers)
Copy a std::vector&lt;&gt; of timers into this object.
static void MvTimesMatAddMv(const ScalarType alpha, const TMVB &A, const Teuchos::SerialDenseMatrix< int, ScalarType > &B, const ScalarType beta, TMVB &mv)
Update mv with .
void MvInit(ScalarType alpha)
Replace each element of the vectors in *this with alpha.
Template specialization of Anasazi::MultiVecTraits class using the Thyra::MultiVectorBase class...
Interface for multivectors used by Anasazi&#39; linear solvers.
void MvNorm(std::vector< typename Teuchos::ScalarTraits< ScalarType >::magnitudeType > &normvec) const
Compute the 2-norm of each individual vector of *this. Upon return, normvec[i] holds the 2-norm of th...
void MvScale(const std::vector< ScalarType > &alpha)
Scale each element of the i-th vector in *this with alpha[i].
static void MvPrint(const TMVB &mv, std::ostream &os)
Print the mv multi-vector to the os output stream.
ConjType
Enumerated types used to specify conjugation arguments.
void MvRandom()
Fill the vectors in *this with random numbers.
void MvTransMv(ScalarType alpha, const MultiVec< ScalarType > &A, Teuchos::SerialDenseMatrix< int, ScalarType > &B) const
Compute a dense matrix B through the matrix-matrix multiply .
static void MvTransMv(const ScalarType alpha, const TMVB &A, const TMVB &mv, Teuchos::SerialDenseMatrix< int, ScalarType > &B)
Compute a dense matrix B through the matrix-matrix multiply .
MultiVec< ScalarType > * CloneCopy(const std::vector< int > &index) const
Creates a new ThyraMultiVec and copies the selected contents of *this into the new vector (deep copy)...
Basic adapter class for Anasazi::MultiVec that uses Thyra::MultiVectorBase&lt;ScalarType&gt;.
Traits class which defines basic operations on multivectors.
ThyraMultiVec(const Teuchos::RCP< Thyra::MultiVectorBase< ScalarType > > &mv, std::vector< Teuchos::RCP< Teuchos::Time > > &timers)
Basic ThyraMultiVec constructor (wraps Thyra::MultiVectorBase&lt;&gt; object).
Specializations of the Anasazi multi-vector and operator traits classes using Thyra base classes Line...
void MvPrint(std::ostream &os) const
Print *this ThyraMultiVec.
static void MvAddMv(const ScalarType alpha, const TMVB &A, const ScalarType beta, const TMVB &B, TMVB &mv)
Replace mv with .
Anasazi header file which uses auto-configuration information to include necessary C++ headers...
static void MvRandom(TMVB &mv)
Replace the vectors in mv with random vectors.
void MvAddMv(ScalarType alpha, const MultiVec< ScalarType > &A, ScalarType beta, const MultiVec< ScalarType > &B)
Replace *this with .
Basic adapter class for Anasazi::Operator that uses Thyra_Operator.
std::vector< Teuchos::RCP< Teuchos::Time > > getTimers() const
Return a std::vector&lt;&gt; of timers held by this object.
void MvScale(ScalarType alpha)
Scale each element of the vectors in *this with alpha.
static int GetNumberVecs(const TMVB &mv)
Obtain the number of vectors in mv.
Templated virtual class for creating operators that can interface with the Anasazi::OperatorTraits cl...
MultiVec< ScalarType > * CloneCopy() const
Creates a new ThyraMultiVec and copies contents of *this into the new vector (deep copy)...
static void SetBlock(const TMVB &A, const std::vector< int > &index, TMVB &mv)
Copy the vectors in A to a set of vectors in mv indicated by the indices given in index...
static Teuchos::RCP< TMVB > CloneViewNonConst(TMVB &mv, const std::vector< int > &index)
Creates a new MultiVectorBase that shares the selected contents of mv (shallow copy).
static void MvInit(TMVB &mv, ScalarType alpha=Teuchos::ScalarTraits< ScalarType >::zero())
Replace each element of the vectors in mv with alpha.
Types and exceptions used within Anasazi solvers and interfaces.
ThyraMultiVec(const ThyraMultiVec< ScalarType > &mv)
Copy constructor.
static Teuchos::RCP< TMVB > CloneCopy(const TMVB &mv)
Creates a new MultiVectorBase and copies contents of mv into the new vector (deep copy)...
virtual ~ThyraMultiVec()
Destructor.
MultiVec< ScalarType > * Clone(const int numvecs) const
Creates a new empty ThyraMultiVec containing numvecs columns.
void SetBlock(const MultiVec< ScalarType > &A, const std::vector< int > &index)
Copy the vectors in A to a set of vectors in *this.
void MvTimesMatAddMv(ScalarType alpha, const MultiVec< ScalarType > &A, const Teuchos::SerialDenseMatrix< int, ScalarType > &B, ScalarType beta)
Update *this with .
static ptrdiff_t GetGlobalLength(const TMVB &mv)
Obtain the vector length of mv.
static void Apply(const Thyra::LinearOpBase< ScalarType > &Op, const Thyra::MultiVectorBase< ScalarType > &x, Thyra::MultiVectorBase< ScalarType > &y)
This method takes the MultiVectorBase x and applies the LinearOpBase Op to it resulting in the MultiV...
Interface for multivectors used by Anasazi&#39;s linear solvers.
Teuchos::RCP< const Thyra::MultiVectorBase< ScalarType > > getRCP() const
Return the const reference-counted pointer held by this object.
static Teuchos::RCP< const TMVB > CloneView(const TMVB &mv, const std::vector< int > &index)
Creates a new const MultiVectorBase that shares the selected contents of mv (shallow copy)...
ThyraMultiVec(const Teuchos::RCP< Thyra::MultiVectorBase< ScalarType > > &mv)
Basic ThyraMultiVec constructor (wraps Thyra::MultiVectorBase&lt;&gt; object).
Anasazi&#39;s templated virtual class for constructing an operator that can interface with the OperatorTr...
static void MvScale(TMVB &mv, const ScalarType alpha)
Scale each element of the vectors in *this with alpha.
static Teuchos::RCP< TMVB > Clone(const TMVB &mv, const int numvecs)
Creates a new empty MultiVectorBase containing numvecs columns.