117 lines
3.7 KiB
C++
117 lines
3.7 KiB
C++
// @HEADER
|
|
// ***********************************************************************
|
|
//
|
|
// Anasazi: Block Eigensolvers Package
|
|
// 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 ANASAZI_STATUS_TEST_HPP
|
|
#define ANASAZI_STATUS_TEST_HPP
|
|
|
|
/*!
|
|
\file AnasaziStatusTest.hpp
|
|
\brief Pure virtual base class for defining the status testing capabilities of Anasazi.
|
|
*/
|
|
|
|
|
|
#include "AnasaziConfigDefs.hpp"
|
|
#include "AnasaziTypes.hpp"
|
|
|
|
#include "AnasaziStatusTestDecl.hpp"
|
|
#include "AnasaziEigensolverDecl.hpp"
|
|
|
|
namespace Anasazi {
|
|
|
|
//! @name StatusTest Exceptions
|
|
//@{
|
|
|
|
/** \brief Exception thrown to signal error in a status test during Anasazi::StatusTest::checkStatus().
|
|
*/
|
|
class StatusTestError : public AnasaziError
|
|
{public: StatusTestError(const std::string& what_arg) : AnasaziError(what_arg) {}};
|
|
|
|
//@}
|
|
|
|
|
|
template <class ScalarType, class MV, class OP>
|
|
class StatusTest {
|
|
|
|
public:
|
|
//! @name Constructors/destructors
|
|
//@{
|
|
|
|
//! Constructor
|
|
StatusTest() {};
|
|
|
|
//! Destructor
|
|
virtual ~StatusTest() {};
|
|
//@}
|
|
|
|
//! @name Status methods
|
|
//@{
|
|
/*! Check status as defined by test.
|
|
|
|
\return TestStatus indicating whether the test passed or failed.
|
|
*/
|
|
virtual TestStatus checkStatus( Eigensolver<ScalarType,MV,OP>* solver ) = 0;
|
|
|
|
//! Return the result of the most recent checkStatus call, or undefined if it has not been run.
|
|
virtual TestStatus getStatus() const = 0;
|
|
//@}
|
|
|
|
//! @name Reset methods
|
|
//@{
|
|
//! Informs the status test that it should reset its internal configuration to the uninitialized state.
|
|
/*! This is necessary for the case when the status test is being reused by another solver or for another
|
|
eigenvalue problem. The status test may have information that pertains to a particular problem or solver
|
|
state. The internal information will be reset back to the uninitialized state. The user specified information
|
|
that the convergence test uses will remain.
|
|
*/
|
|
virtual void reset() = 0;
|
|
|
|
//! Clears the results of the last status test.
|
|
/*! This should be distinguished from the reset() method, as it only clears the cached result from the last
|
|
* status test, so that a call to getStatus() will return ::Undefined. This is necessary for the SEQOR and SEQAND
|
|
* tests in the StatusTestCombo class, which may short circuit and not evaluate all of the StatusTests contained
|
|
* in them.
|
|
*/
|
|
virtual void clearStatus() = 0;
|
|
|
|
//@}
|
|
|
|
//! @name Print methods
|
|
//@{
|
|
|
|
//! Output formatted description of stopping test to output stream.
|
|
virtual std::ostream& print(std::ostream& os, int indent = 0) const = 0;
|
|
|
|
//@}
|
|
|
|
};
|
|
|
|
} // end of Anasazi namespace
|
|
|
|
#endif /* ANASAZI_STATUS_TEST_HPP */
|