Belos Version of the Day
BelosGmresBaseFactory.hpp
Go to the documentation of this file.
00001 //@HEADER
00002 // ************************************************************************
00003 //
00004 //                 Belos: Block Linear Solvers Package
00005 //                  Copyright 2004 Sandia Corporation
00006 //
00007 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00008 // the U.S. Government retains certain rights in this software.
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 Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ************************************************************************
00040 //@HEADER
00041 
00042 #ifndef __Belos_GmresBaseFactory_hpp
00043 #define __Belos_GmresBaseFactory_hpp
00044 
00045 #include <BelosStandardGmres.hpp>
00046 
00047 namespace Belos {
00048 
00071   template<class Scalar, class MV, class OP>
00072   class GmresBaseFactory {
00073   public:
00074     typedef GmresBase<Scalar, MV, OP> base_type;
00075     typedef LinearProblem<Scalar, MV, OP> lp_type;
00076     typedef OrthoManager<Scalar, MV> ortho_type;
00077 
00088     static Teuchos::RCP<base_type> 
00089     create (const Teuchos::RCP<lp_type>& lp,
00090       const Teuchos::RCP<const ortho_type>& ortho,
00091       const Teuchos::RCP<OutputManager<Scalar> >& outMan,
00092       const Teuchos::RCP<const Teuchos::ParameterList>& params)
00093     {
00094       using Teuchos::ParameterList;
00095       using Teuchos::RCP;
00096       using Teuchos::rcp;
00097 
00098       const char prefix[] = "Belos::GmresBaseFactory::create: ";
00099 
00100       // Get the maximum number of iterations.
00101       //
00102       // TODO (mfh {16,21} Feb 2011) Pass in maxIterCount and flexible
00103       // through the parameter list.  They shouldn't be passed as
00104       // arguments to create(), since they are really specific to the
00105       // GmresBase implementation.  For example, one could imagine a
00106       // GmresBase implementation that doesn't do restarting, and that
00107       // allocates new basis vectors as necessary until convergence or
00108       // running out of memory.
00109       //
00110       // TODO (mfh 16 Feb 2011) Fill in other GMRES implementations.
00111       const int maxIterCount = 20;
00112       const bool flexible = false;
00113       TEST_FOR_EXCEPTION(lp.is_null(), std::logic_error, 
00114        prefix << "LinearProblem instance is null.");
00115       TEST_FOR_EXCEPTION(ortho.is_null(), std::logic_error, 
00116        prefix << "OrthoManager instance is null.");
00117       return rcp (new StandardGmres<Scalar, MV, OP> (lp, ortho, outMan, 
00118                  maxIterCount, flexible));
00119     }
00120   };
00121 
00122 } // namespace Belos
00123 
00124 
00125 #endif // __Belos_GmresBaseFactory_hpp
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines