Thyra Version of the Day
Thyra_LinearOpWithSolveHelpers.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_LINEAR_OP_WITH_SOLVE_FACTORY_SUBCLASS_HELPERS_HPP
00043 #define THYRA_LINEAR_OP_WITH_SOLVE_FACTORY_SUBCLASS_HELPERS_HPP
00044 
00045 
00046 #include "Thyra_LinearOpWithSolveBase.hpp"
00047 #include "Teuchos_toString.hpp"
00048 
00049 
00050 namespace Thyra {
00051 
00052 
00060 template<class Scalar>
00061 void assertSolveSupports(
00062   const LinearOpWithSolveBase<Scalar> &lows,
00063   const EOpTransp M_trans,
00064   const Ptr<const SolveCriteria<Scalar> > solveCriteria = Teuchos::null
00065   );
00066 
00067 
00075 template<class Scalar>
00076 THYRA_DEPRECATED void assertSupportsSolveMeasureType(
00077   const LinearOpWithSolveBase<Scalar> &lows,
00078   const EOpTransp M_trans,
00079   const SolveMeasureType &solveMeasureType
00080   );
00081 // 2010/08/22: rabartl: ToDo: Remove this once bug 4915 is finished!
00082 
00083 
00084 } // namespace Thyra
00085 
00086 
00087 //
00088 // Implementations
00089 //
00090 
00091 
00092 template<class Scalar>
00093 void Thyra::assertSolveSupports(
00094   const LinearOpWithSolveBase<Scalar> &lows,
00095   const EOpTransp M_trans,
00096   const Ptr<const SolveCriteria<Scalar> > solveCriteria
00097   )
00098 {
00099   using Teuchos::toString;
00100   TEUCHOS_TEST_FOR_EXCEPTION(
00101     !lows.solveSupports(M_trans, solveCriteria),
00102     std::logic_error,
00103     "Error, the LinearOpWithSolve object \"" << lows.description() << "\"\n"
00104     "for M_trans = " << toString(M_trans) << " does not support the solve"
00105     " criteria = "
00106     << ( nonnull(solveCriteria) ? toString(*solveCriteria) : std::string("null") )
00107     << "!"
00108     );
00109 }
00110 // 2010/08/22: rabartl: Bug 4915 ToDo: Move the above into the NIV function
00111 // solve(...).
00112 
00113 
00114 template<class Scalar>
00115 void Thyra::assertSupportsSolveMeasureType(
00116   const LinearOpWithSolveBase<Scalar> &lows,
00117   const EOpTransp M_trans,
00118   const SolveMeasureType &solveMeasureType
00119   )
00120 {
00121   TEUCHOS_TEST_FOR_EXCEPTION(
00122     !solveSupportsSolveMeasureType(lows,M_trans,solveMeasureType),
00123     std::logic_error,
00124     "Error, the LinearOpWithSolve object \"" << lows.description() << "\"\n"
00125     "for M_trans = " << toString(M_trans) << " does not support the solve"
00126     " measure = "
00127     << toString(solveMeasureType.numerator)
00128     << "/"
00129     << toString(solveMeasureType.denominator)
00130     << "!"
00131     );
00132 }
00133 
00134 
00135 
00136 #endif // THYRA_LINEAR_OP_WITH_SOLVE_FACTORY_SUBCLASS_HELPERS_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines