Thyra  Version of the Day
Thyra_MultiVectorStdOpsTester_def.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_MULTI_VECTOR_STD_OPS_TESTER_HPP
43 #define THYRA_MULTI_VECTOR_STD_OPS_TESTER_HPP
44 
45 #include "Thyra_MultiVectorStdOpsTester_decl.hpp"
46 #include "Thyra_MultiVectorStdOps.hpp"
47 #include "Thyra_TestingTools.hpp"
48 
49 namespace Thyra {
50 
51 // MultiVectorStdOpsTester
52 
53 template <class Scalar>
55  const ScalarMag &warning_tol_in
56  ,const ScalarMag &error_tol_in
57  ,const int num_mv_cols_in
58  )
59  :warning_tol_(warning_tol_in)
60  ,error_tol_(error_tol_in)
61  ,num_mv_cols_(num_mv_cols_in)
62 {}
63 
64 template <class Scalar>
66  const VectorSpaceBase<Scalar> &vecSpc
67  ,std::ostream *out
68  ,const bool &dumpAll
69  )
70 {
71  typedef Teuchos::ScalarTraits<Scalar> ST;
72 
73  if(out)
74  *out << "\n*** Entering MultiVectorStdOpsTester<"<<ST::name()<<">::checkStdOps(...) ...\n"
75  << "using a \'" << vecSpc.description() << "\' object ...\n";
76 
77  bool success = true;
78  if(out) *out << "\nvecSpc.dim() = " << vecSpc.dim() << std::endl;
79 
80  if(out) *out << "\nCreating MultiVectorBase objects V1, V2, V3 and Z ...\n";
81  Teuchos::RCP<MultiVectorBase<Scalar> >
82  V1 = createMembers(vecSpc,num_mv_cols()),
83  V2 = createMembers(vecSpc,num_mv_cols()),
84  V3 = createMembers(vecSpc,num_mv_cols()),
85  Z = createMembers(vecSpc,num_mv_cols());
86 
87  if(out) *out << "\nassign(V1.ptr(),-2.0);\n";
88  assign(V1.ptr(),Scalar(-2.0));
89  if(out) *out << "\nassign(V2.ptr(),-3.0);\n";
90  assign(V2.ptr(),Scalar(-3.0));
91  if(out) *out << "\nassign(V3.ptr(),-4.0);\n";
92  assign(V3.ptr(),Scalar(-4.0));
93 
94  // ToDo: Fill in the tests!
95 
96  if(out) *out
97  << "\n*** Leaving MultiVectorStdOpsTester<"<<ST::name()<<">::checkStdOps(...) ...\n";
98 
99  return success;
100 
101 }
102 
103 } // namespace Thyra
104 
105 #endif // THYRA_MULTI_VECTOR_STD_OPS_TESTER_HPP
MultiVectorStdOpsTester(const ScalarMag &warning_tol=0, const ScalarMag &error_tol=0, const int num_mv_cols=4)
Abstract interface for objects that represent a space for vectors.
bool checkStdOps(const VectorSpaceBase< Scalar > &vecSpc, std::ostream *out=0, const bool &dumpAll=false)
Run the tests using a vector space.
Teuchos::ScalarTraits< Scalar >::magnitudeType ScalarMag
virtual Ordinal dim() const =0
Return the dimension of the vector space.