00001 // $Id: NOX_StatusTest_Generic.H,v 1.10 2006/08/22 00:01:27 rppawlo Exp $ 00002 // $Source: /space/CVS/Trilinos/packages/nox/src/NOX_StatusTest_Generic.H,v $ 00003 00004 //@HEADER 00005 // ************************************************************************ 00006 // 00007 // NOX: An Object-Oriented Nonlinear Solver Package 00008 // Copyright (2002) Sandia Corporation 00009 // 00010 // LOCA: Library of Continuation Algorithms Package 00011 // Copyright (2005) Sandia Corporation 00012 // 00013 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive 00014 // license for use of this work by or on behalf of the U.S. Government. 00015 // 00016 // This library is free software; you can redistribute it and/or modify 00017 // it under the terms of the GNU Lesser General Public License as 00018 // published by the Free Software Foundation; either version 2.1 of the 00019 // License, or (at your option) any later version. 00020 // 00021 // This library is distributed in the hope that it will be useful, but 00022 // WITHOUT ANY WARRANTY; without even the implied warranty of 00023 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 00024 // Lesser General Public License for more details. 00025 // 00026 // You should have received a copy of the GNU Lesser General Public 00027 // License along with this library; if not, write to the Free Software 00028 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 00029 // USA 00030 // 00031 // Questions? Contact Roger Pawlowski (rppawlo@sandia.gov) or 00032 // Eric Phipps (etphipp@sandia.gov), Sandia National Laboratories. 00033 // ************************************************************************ 00034 // CVS Information 00035 // $Source: /space/CVS/Trilinos/packages/nox/src/NOX_StatusTest_Generic.H,v $ 00036 // $Author: rppawlo $ 00037 // $Date: 2006/08/22 00:01:27 $ 00038 // $Revision: 1.10 $ 00039 // ************************************************************************ 00040 //@HEADER 00041 00042 #ifndef NOX_STATUSTEST_GENERIC_H 00043 #define NOX_STATUSTEST_GENERIC_H 00044 00045 #include "NOX_Common.H" // for ostream 00046 00047 namespace NOX { 00048 00049 namespace Solver 00050 { 00051 class Generic; // forward declaration (included below) 00052 } 00053 00055 namespace StatusTest { 00056 00058 enum StatusType 00059 { 00061 Unevaluated = -2, 00063 Unconverged = 0, 00065 Converged = 1, 00067 Failed = -1 00068 }; 00069 00071 enum CheckType 00072 { 00074 Complete, 00076 Minimal, 00078 None 00079 }; 00080 00087 class Generic { 00088 00089 public: 00090 00092 Generic() {}; 00093 00095 virtual ~Generic() {}; 00096 00098 00103 virtual NOX::StatusTest::StatusType 00104 checkStatus(const NOX::Solver::Generic& problem, 00105 NOX::StatusTest::CheckType checkType) = 0; 00106 00108 virtual NOX::StatusTest::StatusType getStatus() const = 0; 00109 00111 virtual ostream& print(ostream& stream, int indent = 0) const = 0; 00112 00113 }; 00114 00115 } // namespace StatusTest 00116 } // namespace NOX 00117 00118 ostream& operator<<(ostream& os, NOX::StatusTest::StatusType type); 00119 00120 00121 #endif 00122