Thyra_MultiVectorTester_decl.hpp

// @HEADER
// ***********************************************************************
// 
//    Thyra: Interfaces and Support for Abstract Numerical Algorithms
//                 Copyright (2004) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef THYRA_MULTI_VECTOR_TESTER_DECL_HPP
#define THYRA_MULTI_VECTOR_TESTER_DECL_HPP

#include "Thyra_OperatorVectorTypes.hpp"
#include "Thyra_LinearOpTester.hpp"
#include "Teuchos_Describable.hpp"


namespace Thyra {


template<class Scalar>
class MultiVectorTester : public Teuchos::Describable {
public:

  typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType ScalarMag;

  LinearOpTester<Scalar>& linearOpTester();

  const LinearOpTester<Scalar>& linearOpTester() const;

  void warning_tol( const ScalarMag &warning_tol );

  ScalarMag warning_tol() const;

  void error_tol( const ScalarMag &error_tol );

  ScalarMag error_tol() const;

  void num_random_vectors( const int num_random_vectors );

  int num_random_vectors() const;

  void show_all_tests( const bool show_all_tests );

  bool show_all_tests() const;

  void dump_all( const bool dump_all );

  bool dump_all() const;

  MultiVectorTester(
    const ScalarMag warning_tol = 1e-13,
    const ScalarMag error_tol = 1e-10,
    const int num_random_vectors = 1,
    const bool show_all_tests = false,
    const bool dump_all = false
    );

  bool checkMultiVector(const VectorSpaceBase<Scalar> &vs,
    const Ptr<Teuchos::FancyOStream> &out) const;

  bool check(
    const MultiVectorBase<Scalar> &mv,
    const Ptr<Teuchos::FancyOStream> &out
    ) const;

private:

  LinearOpTester<Scalar> linearOpTester_;

  ScalarMag warning_tol_;
  ScalarMag error_tol_;
  int num_random_vectors_;
  bool show_all_tests_;
  bool dump_all_;
  
}; // class MultiVectorTester


// //////////////////////////////////
// Inline members


template<class Scalar>
inline
LinearOpTester<Scalar>& MultiVectorTester<Scalar>::linearOpTester()
{
  return linearOpTester_;
}


template<class Scalar>
inline
const LinearOpTester<Scalar>& MultiVectorTester<Scalar>::linearOpTester() const
{
  return linearOpTester_;
}


template<class Scalar>
inline
void MultiVectorTester<Scalar>::warning_tol( const ScalarMag &warning_tol_in )
{
  warning_tol_ = warning_tol_in;
  linearOpTester_.set_all_warning_tol(warning_tol_in);
}


template<class Scalar>
inline
typename MultiVectorTester<Scalar>::ScalarMag
MultiVectorTester<Scalar>::warning_tol() const
{
  return warning_tol_;
}


template<class Scalar>
inline
void MultiVectorTester<Scalar>::error_tol( const ScalarMag &error_tol_in )
{
  error_tol_ = error_tol_in;
  linearOpTester_.set_all_error_tol(error_tol_in);
}


template<class Scalar>
inline
typename MultiVectorTester<Scalar>::ScalarMag
MultiVectorTester<Scalar>::error_tol() const
{
  return error_tol_;
}


template<class Scalar>
inline
void MultiVectorTester<Scalar>::num_random_vectors( const int num_random_vectors_in )
{
  num_random_vectors_ = num_random_vectors_in;
  linearOpTester_.num_random_vectors(num_random_vectors_in);
}


template<class Scalar>
inline
int MultiVectorTester<Scalar>::num_random_vectors() const
{
  return num_random_vectors_;
}


template<class Scalar>
inline
void MultiVectorTester<Scalar>::show_all_tests( const bool show_all_tests_in )
{
  show_all_tests_ = show_all_tests_in;
  linearOpTester_.show_all_tests(show_all_tests_in);
}


template<class Scalar>
inline
bool MultiVectorTester<Scalar>::show_all_tests() const
{
  return show_all_tests_;
}


template<class Scalar>
inline
void MultiVectorTester<Scalar>::dump_all( const bool dump_all_in )
{
  dump_all_ = dump_all_in;
  linearOpTester_.dump_all(dump_all_in);
}


template<class Scalar>
inline
bool MultiVectorTester<Scalar>::dump_all() const
{
  return dump_all_;
}


} // namespace Thyra


#endif // THYRA_MULTI_VECTOR_TESTER_DECL_HPP