00001 // $Id: NOX_Solver_LineSearchBased.H,v 1.29 2007/08/09 22:51:14 rppawlo Exp $ 00002 // $Source: /space/CVS/Trilinos/packages/nox/src/NOX_Solver_LineSearchBased.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_LineSearchBased.H,v $ 00036 // $Author: rppawlo $ 00037 // $Date: 2007/08/09 22:51:14 $ 00038 // $Revision: 1.29 $ 00039 // ************************************************************************ 00040 //@HEADER 00041 00042 #ifndef NOX_SOLVER_LINESEARCHBASED_H 00043 #define NOX_SOLVER_LINESEARCHBASED_H 00044 00045 #include "NOX_Solver_Generic.H" // base class 00046 #include "NOX_Solver_PrePostOperator.H" // class data element 00047 #include "Teuchos_ParameterList.hpp" // class data element 00048 #include "NOX_Utils.H" // class data element 00049 #include "Teuchos_RCP.hpp" // class data element 00050 00051 // Forward declarations 00052 namespace NOX { 00053 class GlobalData; 00054 namespace LineSearch { 00055 class Generic; 00056 } 00057 namespace Direction { 00058 class Generic; 00059 } 00060 } 00061 00062 namespace NOX { 00063 namespace Solver { 00064 00117 class LineSearchBased : public Generic { 00118 00119 public: 00120 00122 00125 LineSearchBased(const Teuchos::RCP<NOX::Abstract::Group>& grp, 00126 const Teuchos::RCP<NOX::StatusTest::Generic>& tests, 00127 const Teuchos::RCP<Teuchos::ParameterList>& params); 00128 00130 virtual ~LineSearchBased(); 00131 00132 virtual void reset(const NOX::Abstract::Vector& initialGuess, 00133 const Teuchos::RCP<NOX::StatusTest::Generic>& tests); 00134 virtual void reset(const NOX::Abstract::Vector& initialGuess); 00135 virtual NOX::StatusTest::StatusType getStatus(); 00136 virtual NOX::StatusTest::StatusType step(); 00137 virtual NOX::StatusTest::StatusType solve(); 00138 virtual const NOX::Abstract::Group& getSolutionGroup() const; 00139 virtual const NOX::Abstract::Group& getPreviousSolutionGroup() const; 00140 virtual int getNumIterations() const; 00141 virtual const Teuchos::ParameterList& getList() const; 00142 00144 virtual double getStepSize() const; 00145 00146 protected: 00147 00149 virtual void init(); 00150 00152 virtual void printUpdate(); 00153 00154 protected: 00155 00157 Teuchos::RCP<NOX::GlobalData> globalDataPtr; 00158 00160 Teuchos::RCP<NOX::Utils> utilsPtr; 00161 00163 Teuchos::RCP<NOX::Abstract::Group> solnPtr; 00164 00166 Teuchos::RCP<NOX::Abstract::Group> oldSolnPtr; 00167 00169 Teuchos::RCP<NOX::Abstract::Vector> dirPtr; 00170 00172 Teuchos::RCP<NOX::StatusTest::Generic> testPtr; 00173 00175 Teuchos::RCP<Teuchos::ParameterList> paramsPtr; 00176 00178 Teuchos::RCP<NOX::LineSearch::Generic> lineSearchPtr; 00179 00181 Teuchos::RCP<NOX::Direction::Generic> directionPtr; 00182 00184 double stepSize; 00185 00187 int nIter; 00188 00190 NOX::StatusTest::StatusType status; 00191 00193 NOX::StatusTest::CheckType checkType; 00194 00196 NOX::Solver::PrePostOperator prePostOperator; 00197 00198 }; 00199 } // namespace Solver 00200 } // namespace NOX 00201 00202 #endif 00203