Thyra_LinearOpTester_decl.hpp

// @HEADER
// *****************************************************************************
//    Thyra: Interfaces and Support for Abstract Numerical Algorithms
//
// Copyright 2004 NTESS and the Thyra contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @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_PromotionTraits.hpp"
#include "Teuchos_StandardMemberCompositionMacros.hpp"
#include "Teuchos_FancyOStream.hpp"


namespace Thyra {


template<class Scalar>
class LinearOpTester {
public:

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

  LinearOpTester();
  
  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<Scalar> &op,
    const Ptr<MultiVectorRandomizerBase<Scalar> > &rangeRandomizer,
    const Ptr<MultiVectorRandomizerBase<Scalar> > &domainRandomizer,
    const Ptr<FancyOStream> &out
    ) const;

  bool check(
    const LinearOpBase<Scalar> &op,
    const Ptr<FancyOStream> &out
    ) const;

  bool compare(
    const LinearOpBase<Scalar> &op1,
    const LinearOpBase<Scalar> &op2,
    const Ptr<MultiVectorRandomizerBase<Scalar> > &domainRandomizer,
    const Ptr<FancyOStream> &out_arg
    ) const;
 
  bool compare(
    const LinearOpBase<Scalar> &op1,
    const LinearOpBase<Scalar> &op2,
    const Ptr<FancyOStream> &out_arg
    ) const;

private:

  void setDefaultTols();

}; // class LinearOpTester


} // namespace Thyra


#endif // THYRA_LINEAR_OP_TESTER_DECL_HPP