Thyra_LinearOpWithSolveTesterDecl.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_WITH_SOLVE_TESTER_DECL_HPP
#define THYRA_LINEAR_OP_WITH_SOLVE_TESTER_DECL_HPP

#include "Thyra_LinearOpWithSolveBase.hpp"
#include "Teuchos_StandardMemberCompositionMacros.hpp"

namespace Thyra {

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

  typedef typename Teuchos::ScalarTraits<RangeScalar>::magnitudeType              RangeScalarMag;
  typedef typename Teuchos::ScalarTraits<DomainScalar>::magnitudeType             DomainScalarMag;
  typedef typename Teuchos::PromotionTraits<RangeScalar,DomainScalar>::promote    Scalar;
  typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType                   ScalarMag;

  LinearOpWithSolveTester(
    const bool                 check_forward_default                    = true
    ,const RangeScalarMag      forward_default_residual_warning_tol     = 1e-6
    ,const RangeScalarMag      forward_default_residual_error_tol       = 1e-5
    ,const DomainScalarMag     forward_default_solution_error_warning_tol= 1e-6
    ,const DomainScalarMag     forward_default_solution_error_error_tol = 1e-5
    ,const bool                check_forward_residual                   = true
    ,const RangeScalarMag      forward_residual_solve_tol               = 1e-5
    ,const RangeScalarMag      forward_residual_slack_warning_tol       = 1e-6
    ,const RangeScalarMag      forward_residual_slack_error_tol         = 1e-5
    ,const bool                check_forward_solution_error             = true
    ,const RangeScalarMag      forward_solution_error_solve_tol         = 1e-5
    ,const RangeScalarMag      forward_solution_error_slack_warning_tol = 1e-6
    ,const RangeScalarMag      forward_solution_error_slack_error_tol   = 1e-5
    ,const bool                check_adjoint_default                    = true
    ,const DomainScalarMag     adjoint_default_residual_warning_tol     = 1e-6
    ,const DomainScalarMag     adjoint_default_residual_error_tol       = 1e-5
    ,const RangeScalarMag      adjoint_default_solution_error_warning_tol= 1e-6
    ,const RangeScalarMag      adjoint_default_solution_error_error_tol = 1e-5
    ,const bool                check_adjoint_residual                   = true
    ,const DomainScalarMag     adjoint_residual_solve_tol               = 1e-5
    ,const DomainScalarMag     adjoint_residual_slack_warning_tol       = 1e-6
    ,const DomainScalarMag     adjoint_residual_slack_error_tol         = 1e-5
    ,const bool                check_adjoint_solution_error             = true
    ,const DomainScalarMag     adjoint_solution_error_solve_tol         = 1e-5
    ,const DomainScalarMag     adjoint_solution_error_slack_warning_tol = 1e-6
    ,const DomainScalarMag     adjoint_solution_error_slack_error_tol   = 1e-5
    ,const int                 num_random_vectors                       = 1
    ,const bool                show_all_tests                           = false
    ,const bool                dump_all                                 = false
    );
  
  STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, check_forward_default  )

  
  STANDARD_MEMBER_COMPOSITION_MEMBERS( RangeScalarMag, forward_default_residual_warning_tol  )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( RangeScalarMag, forward_default_residual_error_tol  )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( DomainScalarMag, forward_default_solution_error_warning_tol  )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( DomainScalarMag, forward_default_solution_error_error_tol  )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, check_forward_residual  )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( RangeScalarMag, forward_residual_solve_tol  )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( RangeScalarMag, forward_residual_slack_warning_tol  )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( RangeScalarMag, forward_residual_slack_error_tol  )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, check_forward_solution_error  )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( RangeScalarMag, forward_solution_error_solve_tol  )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( RangeScalarMag, forward_solution_error_slack_warning_tol  )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( RangeScalarMag, forward_solution_error_slack_error_tol  )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, check_adjoint_default  )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( DomainScalarMag, adjoint_default_residual_warning_tol  )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( DomainScalarMag, adjoint_default_residual_error_tol  )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( RangeScalarMag, adjoint_default_solution_error_warning_tol  )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( RangeScalarMag, adjoint_default_solution_error_error_tol  )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, check_adjoint_residual  )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( DomainScalarMag, adjoint_residual_solve_tol  )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( DomainScalarMag, adjoint_residual_slack_warning_tol  )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( DomainScalarMag, adjoint_residual_slack_error_tol  )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( bool, check_adjoint_solution_error  )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( RangeScalarMag, adjoint_solution_error_solve_tol  )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( RangeScalarMag, adjoint_solution_error_slack_warning_tol  )

  STANDARD_MEMBER_COMPOSITION_MEMBERS( RangeScalarMag, adjoint_solution_error_slack_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 )

  void turn_off_all_tests();

  void set_all_solve_tol( const ScalarMag solve_tol );

  void set_all_slack_warning_tol( const ScalarMag slack_warning_tol );

  void set_all_slack_error_tol( const ScalarMag slack_error_tol );
  
  bool check(
    const LinearOpWithSolveBase<RangeScalar,DomainScalar>   &op
    ,std::ostream                                           *out
    ,const std::string                                      &leadingIndent  = ""
    ,const std::string                                      &indentSpacer   = "  "
    ) const;


}; // class LinearOpWithSolveTester

} // namespace Thyra

#endif // THYRA_LINEAR_OP_WITH_SOLVE_TESTER_DECL_HPP

---