Thyra Package Browser (Single Doxygen Collection) Version of the Day
Thyra_DefaultNonlinearSolverBuilder.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_DEFAULT_NONLINEAR_SOLVER_BUILDER_HPP
00030 #define THYRA_DEFAULT_NONLINEAR_SOLVER_BUILDER_HPP
00031 
00032 #include "Thyra_NonlinearSolverBuilderBase.hpp"
00033 #include "Teuchos_AbstractFactory.hpp"
00034 
00035 
00036 namespace Thyra {
00037 
00038 
00048 class DefaultNonlinearSolverBuilder
00049   : public Thyra::NonlinearSolverBuilderBase<double>
00050 {
00051 public:
00052 
00055 
00057   DefaultNonlinearSolverBuilder();
00058 
00060   ~DefaultNonlinearSolverBuilder();
00061 
00063   void setNonlinearSolverFactory(
00064     const RCP<const AbstractFactory<Thyra::NonlinearSolverBase<double> > >
00065     &nonlinearSolverFactory,
00066     const std::string &nonlinearSolverTypeName
00067     );
00068   
00072   std::string getNonlinearSolverName() const;
00073 
00075 
00078 
00080   void setParameterList(RCP<ParameterList> const& paramList);
00082   RCP<ParameterList> getNonconstParameterList();
00084   RCP<ParameterList> unsetParameterList();
00086   RCP<const ParameterList> getParameterList() const;
00088   RCP<const ParameterList> getValidParameters() const;
00089 
00091   
00094 
00096   virtual Teuchos::RCP<NonlinearSolverBase<Scalar> >
00097   createNonlinearSolver(const std::string &nonlinearSolverTypeName) const;
00098 
00100 
00101 private:
00102 
00103   // //////////////////////////////////////
00104   // Private types
00105 
00106   typedef RCP<const AbstractFactory<Thyra::NonlinearSolverBase<double> > >
00107   ns_fcty_t;
00108 
00109   // //////////////////////////////////////
00110   // Private data members
00111   
00112   RCP<ParameterList> paramList_;
00113   mutable RCP<const ParameterList> validParamList_;
00114   Array<std::string> validNonlinearSolverNames_;
00115   Array<ns_fcty_t> nonlinearSolverArray_;
00116   std::string defaultNonlinearSolverName_;
00117 
00118   // //////////////////////////////////////
00119   // Private member functions
00120 
00121   void initializeDefaults();
00122 
00123 };
00124 
00125 
00126 } // namespace Thyra
00127 
00128 
00132 template<class NonlinearSolverType, class Scalar>
00133 void setNonlinearSolverFactory(
00134   const std::string &nonlinearSolverTypeName,
00135   const Ptr<DefaultNonlinearSolverBuilder<Scalar> > &defaultNonlinearSolverBuilder
00136   )
00137 {
00138   TEST_FOR_EXCEPT(true);
00139 }
00140 
00141 
00142 #endif // THYRA_DEFAULT_NONLINEAR_SOLVER_BUILDER_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines