Belos Package Browser (Single Doxygen Collection) Development
BelosSolverManager.hpp
Go to the documentation of this file.
00001 
00002 //@HEADER
00003 // ************************************************************************
00004 //
00005 //                 Belos: Block Linear Solvers Package
00006 //                  Copyright 2004 Sandia Corporation
00007 //
00008 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00009 // the U.S. Government retains certain rights in this software.
00010 //
00011 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are
00013 // met:
00014 //
00015 // 1. Redistributions of source code must retain the above copyright
00016 // notice, this list of conditions and the following disclaimer.
00017 //
00018 // 2. Redistributions in binary form must reproduce the above copyright
00019 // notice, this list of conditions and the following disclaimer in the
00020 // documentation and/or other materials provided with the distribution.
00021 //
00022 // 3. Neither the name of the Corporation nor the names of the
00023 // contributors may be used to endorse or promote products derived from
00024 // this software without specific prior written permission.
00025 //
00026 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00027 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00029 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00030 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00031 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00032 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00033 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00034 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00035 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00036 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 //
00038 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00039 //
00040 // ************************************************************************
00041 //@HEADER
00042 
00043 #ifndef BELOS_SOLVERMANAGER_HPP
00044 #define BELOS_SOLVERMANAGER_HPP
00045 
00050 #include "BelosConfigDefs.hpp"
00051 #include "BelosTypes.hpp"
00052 #include "BelosLinearProblem.hpp"
00053 
00054 #include "Teuchos_ParameterList.hpp"
00055 #include "Teuchos_RCP.hpp"
00056 #include "Teuchos_Describable.hpp"
00057 
00063 namespace Belos {
00064 
00065 
00066 template <class ScalarType, class MV, class OP>
00067 class StatusTest;
00068 
00069 
00070 template<class ScalarType, class MV, class OP>
00071 class SolverManager : virtual public Teuchos::Describable {
00072 
00073   public:
00074 
00076 
00077 
00079   SolverManager() {};
00080 
00082   virtual ~SolverManager() {};
00084 
00086 
00087 
00089   virtual const LinearProblem<ScalarType,MV,OP>& getProblem() const = 0;
00090 
00092   virtual Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const = 0;
00093 
00095   virtual Teuchos::RCP<const Teuchos::ParameterList> getCurrentParameters() const = 0;
00096 
00108   virtual typename Teuchos::ScalarTraits<ScalarType>::magnitudeType achievedTol() const {
00109     TEUCHOS_TEST_FOR_EXCEPTION(true, std::runtime_error, "achievedTol() not implemented");
00110   }
00111 
00113   virtual int getNumIters() const = 0;
00114 
00118   virtual bool isLOADetected() const = 0;
00119 
00121 
00123 
00124 
00126   virtual void setProblem( const Teuchos::RCP<LinearProblem<ScalarType,MV,OP> > &problem ) = 0;
00127 
00138   virtual void setParameters( const Teuchos::RCP<Teuchos::ParameterList> &params ) = 0;
00139 
00141   virtual void setUserConvStatusTest(
00142     const Teuchos::RCP<StatusTest<ScalarType,MV,OP> > &userConvStatusTest
00143     )
00144     {
00145       TEUCHOS_TEST_FOR_EXCEPT_MSG(true, "Error, the function setUserConvStatusTest() has not been"
00146         << " overridden for the class" << this->description() << " yet!");
00147     }
00148 
00150 
00152 
00153 
00160   virtual void reset( const ResetType type ) = 0;
00162 
00164 
00165 
00167   //
00178   virtual ReturnType solve() = 0;
00180 
00181 };
00182 
00183 
00184 namespace Details {
00185 
00203   template<class ScalarType,
00204            class MV,
00205            class OP,
00206            const bool isComplex = Teuchos::ScalarTraits<ScalarType>::isComplex>
00207   class RealSolverManager;
00208 
00209   // Specialization for isComplex = true adds nothing to SolverManager.
00210   template<class ScalarType, class MV, class OP>
00211   class RealSolverManager<ScalarType, MV, OP, false> :
00212     public SolverManager<ScalarType, MV, OP> {
00213   public:
00214     RealSolverManager () {}
00215     virtual ~RealSolverManager () {}
00216   };
00217 
00218   // Specialization for isComplex = true (ScalarType is complex) adds
00219   // a constructor that always throws std::logic_error.  Subclasses
00220   // must always call the base class constructor.
00221   //
00222   // The complex version (isComplex = true) needs to implement all the
00223   // pure virtual methods in SolverManager, even though they can never
00224   // actually be called, since the constructor throws.
00225   template<class ScalarType, class MV, class OP>
00226   class RealSolverManager<ScalarType, MV, OP, true> :
00227     public SolverManager<ScalarType, MV, OP> {
00228   public:
00229     RealSolverManager () {
00230       TEUCHOS_TEST_FOR_EXCEPTION( true, std::logic_error,
00231         "This solver is not implemented for complex ScalarType." );
00232     }
00233     virtual ~RealSolverManager () {}
00234 
00235     virtual const LinearProblem<ScalarType,MV,OP>& getProblem() const {
00236       TEUCHOS_TEST_FOR_EXCEPTION( true, std::logic_error,
00237         "This solver is not implemented for complex ScalarType." );
00238     }
00239     virtual Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const {
00240       TEUCHOS_TEST_FOR_EXCEPTION( true, std::logic_error,
00241         "This solver is not implemented for complex ScalarType." );
00242     }
00243     virtual Teuchos::RCP<const Teuchos::ParameterList> getCurrentParameters() const {
00244       TEUCHOS_TEST_FOR_EXCEPTION( true, std::logic_error,
00245         "This solver is not implemented for complex ScalarType." );
00246     }
00247     virtual int getNumIters() const {
00248       TEUCHOS_TEST_FOR_EXCEPTION( true, std::logic_error,
00249         "This solver is not implemented for complex ScalarType." );
00250     }
00251     virtual bool isLOADetected() const {
00252       TEUCHOS_TEST_FOR_EXCEPTION( true, std::logic_error,
00253         "This solver is not implemented for complex ScalarType." );
00254     }
00255     virtual void setProblem (const Teuchos::RCP<LinearProblem<ScalarType,MV,OP> > &problem) {
00256       TEUCHOS_TEST_FOR_EXCEPTION( true, std::logic_error,
00257         "This solver is not implemented for complex ScalarType." );
00258     }
00259     virtual void setParameters (const Teuchos::RCP<Teuchos::ParameterList>& params) {
00260       TEUCHOS_TEST_FOR_EXCEPTION( true, std::logic_error,
00261         "This solver is not implemented for complex ScalarType." );
00262     }
00263     virtual void reset (const ResetType type) {
00264       TEUCHOS_TEST_FOR_EXCEPTION( true, std::logic_error,
00265         "This solver is not implemented for complex ScalarType." );
00266     }
00267     virtual ReturnType solve () {
00268       TEUCHOS_TEST_FOR_EXCEPTION( true, std::logic_error,
00269         "This solver is not implemented for complex ScalarType." );
00270     }
00271   };
00272 
00273 } // namespace Details
00274 
00275 
00276 } // End Belos namespace
00277 
00278 #endif /* BELOS_SOLVERMANAGER_HPP */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines