00001 // $Id: NOX_Solver_Generic.H,v 1.26 2007/08/01 20:50:40 rppawlo Exp $ 00002 // $Source: /space/CVS/Trilinos/packages/nox/src/NOX_Solver_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_Solver_Generic.H,v $ 00036 // $Author: rppawlo $ 00037 // $Date: 2007/08/01 20:50:40 $ 00038 // $Revision: 1.26 $ 00039 // ************************************************************************ 00040 //@HEADER 00041 00042 #ifndef NOX_SOLVER_GENERIC_H 00043 #define NOX_SOLVER_GENERIC_H 00044 00045 #include "NOX_StatusTest_Generic.H" // for NOX::StatusTest::StatusType 00046 00047 // Forward declarations 00048 namespace Teuchos { 00049 class ParameterList; 00050 } 00051 namespace NOX { 00052 namespace Abstract { 00053 class Vector; 00054 class Group; 00055 } 00056 } 00057 #include "Teuchos_RCP.hpp" 00058 00059 namespace NOX { 00060 00068 namespace Solver { 00069 00085 class Generic { 00086 00087 public: 00088 00090 Generic() {}; 00091 00093 virtual ~Generic() {}; 00094 00096 virtual void reset(const NOX::Abstract::Vector& initial_guess) = 0; 00097 00099 virtual void reset(const NOX::Abstract::Vector& initial_guess, 00100 const Teuchos::RCP<NOX::StatusTest::Generic>& test) = 0; 00101 00103 virtual NOX::StatusTest::StatusType getStatus() = 0; 00104 00106 virtual NOX::StatusTest::StatusType step() = 0; 00107 00114 virtual NOX::StatusTest::StatusType solve() = 0; 00115 00117 virtual const NOX::Abstract::Group& getSolutionGroup() const = 0; 00118 00120 virtual const NOX::Abstract::Group& getPreviousSolutionGroup() const = 0; 00121 00123 virtual int getNumIterations() const = 0; 00124 00126 virtual const Teuchos::ParameterList& getList() const = 0; 00127 00128 }; 00129 } // namespace Solver 00130 } // namespace NOX 00131 00132 00133 #endif