Thyra_LinearOpTesterDecl.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.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef THYRA_LINEAR_OP_TESTER_DECL_HPP
#define THYRA_LINEAR_OP_TESTER_DECL_HPP

#include "Thyra_OperatorVectorTypes.hpp"
#include "Thyra_MultiVectorRandomizerBase.hpp"
#include "Teuchos_ScalarTraits.hpp"
#include "Teuchos_StandardMemberCompositionMacros.hpp"
#include "Teuchos_FancyOStream.hpp"

namespace Thyra {

template<class RangeScalar, class DomainScalar = RangeScalar>
class LinearOpTester {
public:

  typedef typename Teuchos::PromotionTraits<RangeScalar,DomainScalar>::promote Scalar;

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

  LinearOpTester(
    const bool          check_linear_properties         = true
    ,const ScalarMag    linear_properties_warning_tol   = 1e-13
    ,const ScalarMag    linear_properties_error_tol     = 1e-10
    ,const bool         check_adjoint                   = true
    ,const ScalarMag    adjoint_warning_tol             = 1e-13
    ,const ScalarMag    adjoint_error_tol               = 1e-10
    ,const bool         check_for_symmetry              = false
    ,const ScalarMag    symmetry_warning_tol            = 1e-13
    ,const ScalarMag    symmetry_error_tol              = 1e-10
    ,const int          num_random_vectors              = 1
    ,const bool         show_all_tests                  = false
    ,const bool         dump_all                        = false
    ,const int          num_rhs                         = 1
    );

  STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, check_linear_properties )

  
  STANDARD_MEMBER_COMPOSITION_MEMBERS( ScalarMag, linear_properties_warning_tol )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( ScalarMag, linear_properties_error_tol )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, check_adjoint  )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( ScalarMag, adjoint_warning_tol )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( ScalarMag, adjoint_error_tol )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, check_for_symmetry  )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( ScalarMag, symmetry_warning_tol )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( ScalarMag, symmetry_error_tol )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( int, num_random_vectors )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, show_all_tests )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, dump_all )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( int, num_rhs )

  void enable_all_tests( const bool enable_all_tests );

  void set_all_warning_tol( const ScalarMag warning_tol );

  void set_all_error_tol( const ScalarMag error_tol );

  bool check(
    const LinearOpBase<RangeScalar,DomainScalar>  &op
    ,MultiVectorRandomizerBase<RangeScalar>       *rangeRandomizer
    ,MultiVectorRandomizerBase<DomainScalar>      *domainRandomizer
    ,Teuchos::FancyOStream                        *out
    ) const;

  bool check(
    const LinearOpBase<RangeScalar,DomainScalar>  &op
    ,Teuchos::FancyOStream                        *out
    ) const;

  bool compare(
    const LinearOpBase<RangeScalar,DomainScalar>  &op1
    ,const LinearOpBase<RangeScalar,DomainScalar> &op2
    ,MultiVectorRandomizerBase<DomainScalar>      *domainRandomizer
    ,Teuchos::FancyOStream                        *out
    ) const;
  
  bool compare(
    const LinearOpBase<RangeScalar,DomainScalar>  &op1
    ,const LinearOpBase<RangeScalar,DomainScalar> &op2
    ,Teuchos::FancyOStream                        *out
    ) const;

}; // class LinearOpTester

} // namespace Thyra

#endif // THYRA_LINEAR_OP_TESTER_DECL_HPP

---