00001 // $Id: LOCA_Stepper.H,v 1.41 2008/08/05 21:01:18 etphipp Exp $ 00002 // $Source: /space/CVS/Trilinos/packages/nox/src-loca/src/LOCA_Stepper.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-loca/src/LOCA_Stepper.H,v $ 00036 // $Author: etphipp $ 00037 // $Date: 2008/08/05 21:01:18 $ 00038 // $Revision: 1.41 $ 00039 // ************************************************************************ 00040 //@HEADER 00041 00042 #ifndef LOCA_STEPPER_H 00043 #define LOCA_STEPPER_H 00044 00045 #include "Teuchos_RCP.hpp" 00046 00047 #include "LOCA_Abstract_Iterator.H" // base class 00048 #include "Teuchos_ParameterList.hpp" // class data element 00049 #include "NOX_Solver_Generic.H" // class data element 00050 #include "NOX_StatusTest_Generic.H" // for enum StatusType 00051 #include "NOX_Common.H" // for <string> class 00052 00053 // forward declarations 00054 namespace LOCA { 00055 class GlobalData; 00056 namespace MultiContinuation { 00057 class AbstractStrategy; 00058 class AbstractGroup; 00059 class ExtendedVector; 00060 } 00061 namespace MultiPredictor { 00062 class AbstractStrategy; 00063 } 00064 namespace Eigensolver { 00065 class AbstractStrategy; 00066 } 00067 namespace SaveEigenData { 00068 class AbstractStrategy; 00069 } 00070 namespace StepSize { 00071 class AbstractStrategy; 00072 } 00073 namespace Parameter { 00074 class SublistParser; 00075 } 00076 } 00077 00078 namespace LOCA { 00079 00090 class Stepper : public LOCA::Abstract::Iterator { 00091 00092 public: 00093 00095 Stepper(const Teuchos::RCP<LOCA::GlobalData>& global_data, 00096 const Teuchos::RCP<LOCA::MultiContinuation::AbstractGroup>& initialGuess, 00097 const Teuchos::RCP<NOX::StatusTest::Generic>& t, 00098 const Teuchos::RCP<Teuchos::ParameterList>& p); 00099 00101 virtual ~Stepper(); 00102 00104 virtual bool 00105 reset(const Teuchos::RCP<LOCA::GlobalData>& global_data, 00106 const Teuchos::RCP<LOCA::MultiContinuation::AbstractGroup>& initialGuess, 00107 const Teuchos::RCP<NOX::StatusTest::Generic>& t, 00108 const Teuchos::RCP<Teuchos::ParameterList>& p); 00109 00111 virtual Teuchos::RCP<const LOCA::MultiContinuation::AbstractGroup> 00112 getSolutionGroup() const; 00113 00115 00120 virtual Teuchos::RCP<const LOCA::MultiContinuation::AbstractGroup> 00121 getBifurcationGroup() const; 00122 00124 virtual Teuchos::RCP<const Teuchos::ParameterList> 00125 getList() const; 00126 00131 virtual Teuchos::RCP<const NOX::Solver::Generic> 00132 getSolver() const; 00133 00134 protected: 00135 00137 virtual LOCA::Abstract::Iterator::IteratorStatus start(); 00138 00140 virtual LOCA::Abstract::Iterator::IteratorStatus 00141 finish(LOCA::Abstract::Iterator::IteratorStatus iteratorStatus); 00142 00144 virtual LOCA::Abstract::Iterator::StepStatus 00145 preprocess(LOCA::Abstract::Iterator::StepStatus stepStatus); 00146 00148 virtual LOCA::Abstract::Iterator::StepStatus 00149 compute(LOCA::Abstract::Iterator::StepStatus stepStatus); 00150 00152 virtual LOCA::Abstract::Iterator::StepStatus 00153 postprocess(LOCA::Abstract::Iterator::StepStatus stepStatus); 00154 00156 virtual LOCA::Abstract::Iterator::IteratorStatus 00157 stop(LOCA::Abstract::Iterator::StepStatus stepStatus); 00158 00160 Teuchos::RCP<LOCA::MultiContinuation::AbstractGroup> 00161 buildConstrainedGroup( 00162 const Teuchos::RCP<LOCA::MultiContinuation::AbstractGroup>& grp); 00163 00165 LOCA::Abstract::Iterator::StepStatus 00166 computeStepSize(LOCA::Abstract::Iterator::StepStatus stepStatus, 00167 double& stepSize); 00168 00170 virtual void printInitializationInfo(); 00171 00173 virtual void printStartStep(); 00174 00176 virtual void printEndStep(LOCA::Abstract::Iterator::StepStatus stepStatus); 00177 00179 virtual void printEndInfo(); 00180 00182 virtual bool withinThreshold(); 00183 00184 private: 00185 00187 Stepper(const Stepper&); 00188 00190 Stepper& operator = (const Stepper&); 00191 00192 protected: 00193 00195 Teuchos::RCP<LOCA::GlobalData> globalData; 00196 00198 Teuchos::RCP<LOCA::Parameter::SublistParser> parsedParams; 00199 00201 Teuchos::RCP<LOCA::MultiPredictor::AbstractStrategy> predictor; 00202 00204 Teuchos::RCP<LOCA::MultiContinuation::AbstractStrategy> curGroupPtr; 00205 00207 Teuchos::RCP<LOCA::MultiContinuation::AbstractStrategy> prevGroupPtr; 00208 00210 Teuchos::RCP<LOCA::Eigensolver::AbstractStrategy> eigensolver; 00211 00213 Teuchos::RCP<LOCA::SaveEigenData::AbstractStrategy> saveEigenData; 00214 00216 Teuchos::RCP<LOCA::MultiContinuation::AbstractGroup> bifGroupPtr; 00217 00219 Teuchos::RCP<NOX::StatusTest::Generic> statusTestPtr; 00220 00222 Teuchos::RCP<Teuchos::ParameterList> paramListPtr; 00223 00225 Teuchos::RCP<Teuchos::ParameterList> stepperList; 00226 00228 Teuchos::RCP<NOX::Solver::Generic> solverPtr; 00229 00231 Teuchos::RCP<LOCA::MultiContinuation::ExtendedVector> curPredictorPtr; 00232 00234 Teuchos::RCP<LOCA::MultiContinuation::ExtendedVector> prevPredictorPtr; 00235 00237 Teuchos::RCP<LOCA::StepSize::AbstractStrategy> stepSizeStrategyPtr; 00238 00240 string conParamName; 00241 00243 vector<int> conParamIDs; 00244 00246 double startValue; 00247 00249 double maxValue; 00250 00252 double minValue; 00253 00255 double stepSize; 00256 00258 int maxNonlinearSteps; 00259 00261 double targetValue; 00262 00264 bool isTargetStep; 00265 00267 bool doTangentFactorScaling; 00268 00270 double tangentFactor; 00271 00273 double minTangentFactor; 00274 00276 double tangentFactorExponent; 00277 00279 bool calcEigenvalues; 00280 00282 bool return_failed_on_max_steps; 00283 }; 00284 } // end namespace LOCA 00285 00286 #endif 00287