Thyra Package Browser (Single Doxygen Collection) Version of the Day
Thyra_LinearOpWithSolveHelpers.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_OP_WITH_SOLVE_FACTORY_SUBCLASS_HELPERS_HPP
00030 #define THYRA_LINEAR_OP_WITH_SOLVE_FACTORY_SUBCLASS_HELPERS_HPP
00031 
00032 
00033 #include "Thyra_LinearOpWithSolveBase.hpp"
00034 #include "Teuchos_toString.hpp"
00035 
00036 
00037 namespace Thyra {
00038 
00039 
00047 template<class Scalar>
00048 void assertSolveSupports(
00049   const LinearOpWithSolveBase<Scalar> &lows,
00050   const EOpTransp M_trans,
00051   const Ptr<const SolveCriteria<Scalar> > solveCriteria = Teuchos::null
00052   );
00053 
00054 
00062 template<class Scalar>
00063 void assertSupportsSolveMeasureType(
00064   const LinearOpWithSolveBase<Scalar> &lows,
00065   const EOpTransp M_trans,
00066   const SolveMeasureType &solveMeasureType
00067   );
00068 // 2010/08/22: rabartl: ToDo: Remove this once bug 4915 is finished!
00069 
00070 
00071 } // namespace Thyra
00072 
00073 
00074 //
00075 // Implementations
00076 //
00077 
00078 
00079 template<class Scalar>
00080 void Thyra::assertSolveSupports(
00081   const LinearOpWithSolveBase<Scalar> &lows,
00082   const EOpTransp M_trans,
00083   const Ptr<const SolveCriteria<Scalar> > solveCriteria
00084   )
00085 {
00086   using Teuchos::toString;
00087   TEST_FOR_EXCEPTION(
00088     !lows.solveSupports(M_trans, solveCriteria),
00089     std::logic_error,
00090     "Error, the LinearOpWithSolve object \"" << lows.description() << "\"\n"
00091     "for M_trans = " << toString(M_trans) << " does not support the solve"
00092     " criteria = "
00093     << ( nonnull(solveCriteria) ? toString(*solveCriteria) : std::string("null") )
00094     << "!"
00095     );
00096 }
00097 // 2010/08/22: rabartl: Bug 4915 ToDo: Move the above into the NIV function
00098 // solve(...).
00099 
00100 
00101 template<class Scalar>
00102 void Thyra::assertSupportsSolveMeasureType(
00103   const LinearOpWithSolveBase<Scalar> &lows,
00104   const EOpTransp M_trans,
00105   const SolveMeasureType &solveMeasureType
00106   )
00107 {
00108   TEST_FOR_EXCEPTION(
00109     !solveSupportsSolveMeasureType(lows,M_trans,solveMeasureType),
00110     std::logic_error,
00111     "Error, the LinearOpWithSolve object \"" << lows.description() << "\"\n"
00112     "for M_trans = " << toString(M_trans) << " does not support the solve"
00113     " measure = "
00114     << toString(solveMeasureType.numerator)
00115     << "/"
00116     << toString(solveMeasureType.denominator)
00117     << "!"
00118     );
00119 }
00120 
00121 
00122 
00123 #endif // THYRA_LINEAR_OP_WITH_SOLVE_FACTORY_SUBCLASS_HELPERS_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines