Thyra Version of the Day
Thyra_DefaultNonlinearSolverBuilder.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_DEFAULT_NONLINEAR_SOLVER_BUILDER_HPP
00043 #define THYRA_DEFAULT_NONLINEAR_SOLVER_BUILDER_HPP
00044 
00045 #include "Thyra_NonlinearSolverBuilderBase.hpp"
00046 #include "Teuchos_AbstractFactory.hpp"
00047 
00048 
00049 namespace Thyra {
00050 
00051 
00061 class DefaultNonlinearSolverBuilder
00062   : public Thyra::NonlinearSolverBuilderBase<double>
00063 {
00064 public:
00065 
00068 
00070   DefaultNonlinearSolverBuilder();
00071 
00073   ~DefaultNonlinearSolverBuilder();
00074 
00076   void setNonlinearSolverFactory(
00077     const RCP<const AbstractFactory<Thyra::NonlinearSolverBase<double> > >
00078     &nonlinearSolverFactory,
00079     const std::string &nonlinearSolverTypeName
00080     );
00081   
00085   std::string getNonlinearSolverName() const;
00086 
00088 
00091 
00093   void setParameterList(RCP<ParameterList> const& paramList);
00095   RCP<ParameterList> getNonconstParameterList();
00097   RCP<ParameterList> unsetParameterList();
00099   RCP<const ParameterList> getParameterList() const;
00101   RCP<const ParameterList> getValidParameters() const;
00102 
00104   
00107 
00109   virtual Teuchos::RCP<NonlinearSolverBase<Scalar> >
00110   createNonlinearSolver(const std::string &nonlinearSolverTypeName) const;
00111 
00113 
00114 private:
00115 
00116   // //////////////////////////////////////
00117   // Private types
00118 
00119   typedef RCP<const AbstractFactory<Thyra::NonlinearSolverBase<double> > >
00120   ns_fcty_t;
00121 
00122   // //////////////////////////////////////
00123   // Private data members
00124   
00125   RCP<ParameterList> paramList_;
00126   mutable RCP<const ParameterList> validParamList_;
00127   Array<std::string> validNonlinearSolverNames_;
00128   Array<ns_fcty_t> nonlinearSolverArray_;
00129   std::string defaultNonlinearSolverName_;
00130 
00131   // //////////////////////////////////////
00132   // Private member functions
00133 
00134   void initializeDefaults();
00135 
00136 };
00137 
00138 
00139 } // namespace Thyra
00140 
00141 
00145 template<class NonlinearSolverType, class Scalar>
00146 void setNonlinearSolverFactory(
00147   const std::string &nonlinearSolverTypeName,
00148   const Ptr<DefaultNonlinearSolverBuilder<Scalar> > &defaultNonlinearSolverBuilder
00149   )
00150 {
00151   TEUCHOS_TEST_FOR_EXCEPT(true);
00152 }
00153 
00154 
00155 #endif // THYRA_DEFAULT_NONLINEAR_SOLVER_BUILDER_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines