00001 // $Id: NOX_Direction_SteepestDescent.H,v 1.21 2007/06/21 16:22:46 rhoope Exp $ 00002 // $Source: /space/CVS/Trilinos/packages/nox/src/NOX_Direction_SteepestDescent.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_Direction_SteepestDescent.H,v $ 00036 // $Author: rhoope $ 00037 // $Date: 2007/06/21 16:22:46 $ 00038 // $Revision: 1.21 $ 00039 // ************************************************************************ 00040 //@HEADER 00041 00042 #ifndef NOX_DIRECTION_STEEPESTDESCENT_H 00043 #define NOX_DIRECTION_STEEPESTDESCENT_H 00044 00045 #include "NOX_Direction_Generic.H" // base class 00046 00047 // Forward declaration 00048 namespace NOX { 00049 class Utils; 00050 class GlobalData; 00051 namespace MeritFunction { 00052 class Generic; 00053 } 00054 } 00055 00056 namespace NOX { 00057 namespace Direction { 00058 00060 00096 class SteepestDescent : public Generic { 00097 00098 public: 00099 00101 enum ScalingType { 00103 TwoNorm, 00105 QuadMin, 00107 FunctionTwoNorm, 00109 None 00110 }; 00111 00113 SteepestDescent(const Teuchos::RCP<NOX::GlobalData>& gd, 00114 Teuchos::ParameterList& params); 00115 00117 ~SteepestDescent(); 00118 00119 // derived 00120 bool reset(const Teuchos::RCP<NOX::GlobalData>& gd, 00121 Teuchos::ParameterList& params); 00122 00123 // derived 00124 bool compute(NOX::Abstract::Vector& dir, NOX::Abstract::Group& grp, 00125 const NOX::Solver::Generic& solver); 00126 00127 // derived 00128 virtual bool compute(NOX::Abstract::Vector& dir, NOX::Abstract::Group& grp, 00129 const NOX::Solver::LineSearchBased& solver); 00130 00131 private: 00132 00134 void throwError(const string& functionName, const string& errorMsg); 00135 00136 private: 00137 00139 Teuchos::RCP<NOX::GlobalData> globalDataPtr; 00140 00142 Teuchos::RCP<NOX::Utils> utils; 00143 00145 Teuchos::RCP<NOX::Abstract::Vector> tmpVecPtr; 00146 00148 ScalingType scaleType; 00149 00151 Teuchos::RCP<NOX::MeritFunction::Generic> meritFuncPtr; 00152 00153 }; 00154 } // namespace Direction 00155 } // namespace NOX 00156 #endif