00001 // $Id: LOCA_MultiPredictor_Secant.H,v 1.5 2007/06/21 16:22:52 rhoope Exp $ 00002 // $Source: /space/CVS/Trilinos/packages/nox/src-loca/src/LOCA_MultiPredictor_Secant.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_MultiPredictor_Secant.H,v $ 00036 // $Author: rhoope $ 00037 // $Date: 2007/06/21 16:22:52 $ 00038 // $Revision: 1.5 $ 00039 // ************************************************************************ 00040 //@HEADER 00041 00042 #ifndef LOCA_MULTIPREDICTOR_SECANT_H 00043 #define LOCA_MULTIPREDICTOR_SECANT_H 00044 00045 #include "LOCA_MultiPredictor_AbstractStrategy.H" // base class 00046 00047 // forward declarations 00048 namespace LOCA { 00049 class GlobalData; 00050 namespace Parameter { 00051 class SublistParser; 00052 } 00053 } 00054 00055 namespace LOCA { 00056 00057 namespace MultiPredictor { 00058 00060 00083 class Secant : public LOCA::MultiPredictor::AbstractStrategy { 00084 00085 public: 00086 00088 00095 Secant( 00096 const Teuchos::RCP<LOCA::GlobalData>& global_data, 00097 const Teuchos::RCP<LOCA::Parameter::SublistParser>& topParams, 00098 const Teuchos::RCP<Teuchos::ParameterList>& predParams); 00099 00101 virtual ~Secant(); 00102 00104 Secant(const Secant& source, NOX::CopyType type = NOX::DeepCopy); 00105 00107 virtual LOCA::MultiPredictor::AbstractStrategy& 00108 operator=(const LOCA::MultiPredictor::AbstractStrategy& source); 00109 00111 virtual Teuchos::RCP<LOCA::MultiPredictor::AbstractStrategy> 00112 clone(NOX::CopyType type = NOX::DeepCopy) const; 00113 00123 virtual NOX::Abstract::Group::ReturnType 00124 compute(bool baseOnSecant, const vector<double>& stepSize, 00125 LOCA::MultiContinuation::ExtendedGroup& grp, 00126 const LOCA::MultiContinuation::ExtendedVector& prevXVec, 00127 const LOCA::MultiContinuation::ExtendedVector& xVec); 00128 00130 00135 virtual NOX::Abstract::Group::ReturnType 00136 evaluate(const vector<double>& stepSize, 00137 const LOCA::MultiContinuation::ExtendedVector& xVec, 00138 LOCA::MultiContinuation::ExtendedMultiVector& result) const; 00139 00141 virtual NOX::Abstract::Group::ReturnType 00142 computeTangent(LOCA::MultiContinuation::ExtendedMultiVector& tangent); 00143 00145 00148 virtual bool isTangentScalable() const; 00149 00150 protected: 00151 00153 Teuchos::RCP<LOCA::GlobalData> globalData; 00154 00156 Teuchos::RCP<LOCA::MultiPredictor::AbstractStrategy> firstStepPredictor; 00157 00159 bool isFirstStep; 00160 00162 bool isFirstStepComputed; 00163 00165 Teuchos::RCP<LOCA::MultiContinuation::ExtendedMultiVector> predictor; 00166 00168 Teuchos::RCP<LOCA::MultiContinuation::ExtendedVector> secant; 00169 00171 bool initialized; 00172 00173 }; 00174 } // namespace Predictor 00175 } // namespace LOCA 00176 00177 #endif