Thyra Version of the Day
Thyra_NonlinearSolverBase.hpp
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 //    Thyra: Interfaces and Support for Abstract Numerical Algorithms
00005 //                 Copyright (2004) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef THYRA_NONLINEAR_SOLVER_BASE_HPP
00043 #define THYRA_NONLINEAR_SOLVER_BASE_HPP
00044 
00045 #include "Thyra_LinearOpWithSolveBase.hpp"
00046 #include "Thyra_ModelEvaluator.hpp"
00047 #include "Teuchos_Describable.hpp"
00048 #include "Teuchos_VerboseObject.hpp"
00049 #include "Teuchos_ParameterListAcceptor.hpp"
00050 
00051 
00052 namespace Thyra {
00053 
00054 
00074 template <class Scalar>
00075 class NonlinearSolverBase
00076   : virtual public Teuchos::Describable
00077   , virtual public Teuchos::VerboseObject<NonlinearSolverBase<Scalar> >
00078   , virtual public Teuchos::ParameterListAcceptor
00079 {
00080 public:
00081   
00084 
00092   virtual void setModel(
00093     const RCP<const ModelEvaluator<Scalar> > &model
00094     ) = 0;
00095   
00097   virtual RCP<const ModelEvaluator<Scalar> > getModel() const = 0;
00098   
00118   virtual SolveStatus<Scalar> solve(
00119     VectorBase<Scalar> *x,
00120     const SolveCriteria<Scalar> *solveCriteria = NULL,
00121     VectorBase<Scalar> *delta = NULL
00122     ) = 0;
00123   
00125   
00128 
00133   virtual bool supportsCloning() const;
00134 
00155   virtual RCP<NonlinearSolverBase<Scalar> > cloneNonlinearSolver() const;
00156   
00162   virtual RCP<const VectorBase<Scalar> > get_current_x() const;
00163 
00169   virtual bool is_W_current() const;
00170 
00186   virtual RCP<LinearOpWithSolveBase<Scalar> >
00187   get_nonconst_W( const bool forceUpToDate = false );
00188 
00196   virtual RCP<const LinearOpWithSolveBase<Scalar> > get_W() const;
00197 
00207   virtual void set_W_is_current(bool W_is_current);
00208 
00210 
00211 private:
00212   
00213   // Not defined and not to be called
00214   NonlinearSolverBase<Scalar>&
00215   operator=(const NonlinearSolverBase<Scalar>&);
00216 
00217 };
00218 
00219 
00224 template <class Scalar>
00225 const SolveStatus<Scalar> solve(
00226   NonlinearSolverBase<Scalar> &nonlinearSolver,
00227     VectorBase<Scalar> *x,
00228     const SolveCriteria<Scalar> *solveCriteria = NULL,
00229     VectorBase<Scalar> *delta = NULL
00230     )
00231 {
00232   return nonlinearSolver.solve(x,solveCriteria,delta);
00233 }
00234 
00235 
00236 // ///////////////////////////////
00237 // Implementations
00238 
00239 template <class Scalar>
00240 bool NonlinearSolverBase<Scalar>::supportsCloning() const
00241 {
00242   return false;
00243 }
00244 
00245 template <class Scalar>
00246 RCP<NonlinearSolverBase<Scalar> >
00247 NonlinearSolverBase<Scalar>::cloneNonlinearSolver() const
00248 {
00249   return Teuchos::null;
00250 }
00251 
00252 template <class Scalar>
00253 RCP<const VectorBase<Scalar> >
00254 NonlinearSolverBase<Scalar>::get_current_x() const
00255 {
00256   return Teuchos::null;
00257 }
00258 
00259 template <class Scalar>
00260 bool NonlinearSolverBase<Scalar>::is_W_current() const
00261 {
00262   return false;
00263 }
00264 
00265 template <class Scalar>
00266 RCP<LinearOpWithSolveBase<Scalar> >
00267 NonlinearSolverBase<Scalar>::get_nonconst_W(const bool forceUpToDate)
00268 {
00269   return Teuchos::null;
00270 }
00271 
00272 template <class Scalar>
00273 RCP<const LinearOpWithSolveBase<Scalar> >
00274 NonlinearSolverBase<Scalar>::get_W() const
00275 {
00276   return Teuchos::null;
00277 }
00278 
00279 template <class Scalar>
00280 void NonlinearSolverBase<Scalar>::set_W_is_current(bool W_is_current)
00281 {
00282   TEUCHOS_TEST_FOR_EXCEPTION(
00283     true, std::logic_error,
00284     "Error, the subclass object described as " << this->description() << " did not"
00285     " override this function!"
00286     );
00287 }
00288 
00289 
00290 } // namespace Thyra
00291 
00292 
00293 #endif // THYRA_NONLINEAR_SOLVER_BASE_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines