Thyra Package Browser (Single Doxygen Collection) Version of the Day
Thyra_NonlinearSolverBuilderBase.hpp
Go to the documentation of this file.
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 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 #ifndef THYRA_NONLINEAR_SOLVER_BUILDER_BASE
00030 #define THYRA_NONLINEAR_SOLVER_BUILDER_BASE
00031 
00032 #include "Thyra_NonlinearSolverBase.hpp"
00033 #include "Teuchos_ParameterListAcceptor.hpp"
00034 
00035 
00036 namespace Thyra {
00037 
00038 
00044 template<class Scalar>
00045 class NonlinearSolverBuilderBase : virtual public Teuchos::ParameterListAcceptor
00046 {
00047 public:
00048   
00060   virtual Teuchos::RCP<NonlinearSolverBase<Scalar> >
00061   createNonlinearSolver(const std::string &nonlinearSolverTypeName) const = 0;
00062 
00063 private:
00064   
00065   // Not defined and not to be called
00066   NonlinearSolverBuilderBase<Scalar>&
00067   operator=(const NonlinearSolverBuilderBase<Scalar>&);
00068 
00069 };
00070 
00071 
00076 template<class Scalar>
00077 Teuchos::RCP<NonlinearSolverBase<Scalar> >
00078 createNonlinearSolver(
00079   const NonlinearSolverBuilderBase<Scalar> &nonlinearSolverBuilder,
00080   const std::string &nonlinearSolverTypeName = ""
00081   )
00082 {
00083   return nonlinearSolverBuilder.createNonlinearSolver(nonlinearSolverTypeName);
00084 }
00085 
00086 
00087 } // namespace Thyra
00088 
00089 
00090 #endif // THYRA_NONLINEAR_SOLVER_BUILDER_BASE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines