Thyra Package Browser (Single Doxygen Collection) Version of the Day
Thyra_LinearSolverBuilderBase.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_LINEAR_SOLVER_BUILDING_BASE
00030 #define THYRA_LINEAR_SOLVER_BUILDING_BASE
00031 
00032 #include "Teuchos_ParameterListAcceptor.hpp"
00033 #include "Thyra_LinearOpWithSolveFactoryBase.hpp"
00034 
00035 
00036 namespace Thyra {
00037 
00038 
00046 template<class Scalar>
00047 class LinearSolverBuilderBase : virtual public Teuchos::ParameterListAcceptor
00048 {
00049 public:
00050   
00063   virtual Teuchos::RCP<LinearOpWithSolveFactoryBase<Scalar> >
00064   createLinearSolveStrategy(
00065     const std::string &linearSolveStrategyName ) const = 0;
00066   
00079   virtual Teuchos::RCP<PreconditionerFactoryBase<Scalar> >
00080   createPreconditioningStrategy(
00081     const std::string &preconditioningStrategyName ) const = 0;
00082 
00083   /* \brief Create a new LinearOpWithSolveFactory object given a typical
00084    * forward linear operator and a typical solve criteria.
00085    *
00086    * \param  typicalFwdOp
00087    *           [in] A typical forward linear operator that represents the types of
00088    *           operator that will be used to solve linear system.
00089    * \param  typicalSolveCriteria
00090    *           [in] A typical solve criteria that will be used to solve for linear
00091    *           systems.
00092    * \param  typicalSolveUse
00093    *           [in] Determines how the solver will be used.
00094    * \param  solveStrategy
00095    *           [out] The LOWSF object that was determined to be the best suited for solving
00096    *           the typical system given above.
00097    * \param  initialLOWS
00098    *           [out] The LOWS object that was created that is consistent with the returned
00099    *           solve strategy.  If <tt>initialLOWS->get()==NULL</tt> on return then there is no
00100    *           such object returned.
00101    * \param  setupTime
00102    *           [out] The amount of time it took to setup the solver <tt>*initalLOWS</tt> before
00103    *           a solve was performed.
00104    * \param  solveTime
00105    *           [out] The amount of time it took to solve a typical linear system for the
00106    *           returned <tt>*initalLOWS</tt> object.
00107    *
00108    * ToDo: Finish documentation!
00109    */
00110   /*
00111     virtual void createSmartSolveStrategy(
00112     const Teuchos::RCP<LinearOpBase<Scalar>               &typicalFwdOp
00113     ,const SolveCritiera<Scalar>                                  &typicalSolveCriteria
00114     ,const ESupportSolveUse                                       &typicalSolveUse
00115     ,Teuchos::RCP<LinearOpWithSolveFactoryBase<Scalar> >  *solveStrategy
00116     ,Teuchos::RCP<Teuchos::ParameterList>                 *solveStrategyParameters
00117     ,Teuchos::RCP<LinearOpWithSolveBase<Scalar> >         *initialLOWS
00118     ,double                                                       *setupTime
00119     ,double                                                       *solveTime
00120     ) const = 0;
00121   */
00122 
00123 private:
00124   
00125   // Not defined and not to be called
00126   LinearSolverBuilderBase<Scalar>&
00127   operator=(const LinearSolverBuilderBase<Scalar>&);
00128 
00129 };
00130 
00131 
00136 template<class Scalar>
00137 Teuchos::RCP<LinearOpWithSolveFactoryBase<Scalar> >
00138 createLinearSolveStrategy(
00139   const LinearSolverBuilderBase<Scalar> &linearSolverBuilder,
00140   const std::string &linearSolveStrategyName = ""
00141   )
00142 {
00143   return linearSolverBuilder.createLinearSolveStrategy(
00144     linearSolveStrategyName );
00145 }
00146 
00147 
00152 template<class Scalar>
00153 Teuchos::RCP<PreconditionerFactoryBase<Scalar> >
00154 createPreconditioningStrategy(
00155   const LinearSolverBuilderBase<Scalar> &linearSolverBuilder,
00156   const std::string &preconditioningStrategyName = ""
00157   )
00158 {
00159   return linearSolverBuilder.createPreconditioningStrategy(
00160     preconditioningStrategyName );
00161 }
00162 
00163 
00164 } // namespace Thyra
00165 
00166 #endif // THYRA_LINEAR_SOLVER_BUILDING_BASE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines