Thyra Version of the Day
Loading...
Searching...
No Matches
Thyra_LinearOpWithSolveHelpers.hpp
1// @HEADER
2// ***********************************************************************
3//
4// Thyra: Interfaces and Support for Abstract Numerical Algorithms
5// Copyright (2004) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.gov)
38//
39// ***********************************************************************
40// @HEADER
41
42#ifndef THYRA_LINEAR_OP_WITH_SOLVE_FACTORY_SUBCLASS_HELPERS_HPP
43#define THYRA_LINEAR_OP_WITH_SOLVE_FACTORY_SUBCLASS_HELPERS_HPP
44
45
46#include "Thyra_LinearOpWithSolveBase.hpp"
47#include "Teuchos_toString.hpp"
48
49
50namespace Thyra {
51
52
60template<class Scalar>
63 const EOpTransp M_trans,
64 const Ptr<const SolveCriteria<Scalar> > solveCriteria = Teuchos::null
65 );
66
74template<class Scalar>
75void assertSupportsSolveMeasureType(
77 const EOpTransp M_trans,
78 const SolveMeasureType &solveMeasureType
79 );
80// 2010/08/22: rabartl: ToDo: Deprecate this bug 4915 is finished!
81
82} // namespace Thyra
83
84
85//
86// Implementations
87//
88
89
90template<class Scalar>
91void Thyra::assertSolveSupports(
93 const EOpTransp M_trans,
94 const Ptr<const SolveCriteria<Scalar> > solveCriteria
95 )
96{
99 !lows.solveSupports(M_trans, solveCriteria),
100 std::logic_error,
101 "Error, the LinearOpWithSolve object \"" << lows.description() << "\"\n"
102 "for M_trans = " << toString(M_trans) << " does not support the solve"
103 " criteria = "
104 << ( nonnull(solveCriteria) ? toString(*solveCriteria) : std::string("null") )
105 << "!"
106 );
107}
108// 2010/08/22: rabartl: Bug 4915 ToDo: Move the above into the NIV function
109// solve(...).
110
111template<class Scalar>
112void Thyra::assertSupportsSolveMeasureType(
113 const LinearOpWithSolveBase<Scalar> &lows,
114 const EOpTransp M_trans,
115 const SolveMeasureType &solveMeasureType
116 )
117{
119 !solveSupportsSolveMeasureType(lows,M_trans,solveMeasureType),
120 std::logic_error,
121 "Error, the LinearOpWithSolve object \"" << lows.description() << "\"\n"
122 "for M_trans = " << toString(M_trans) << " does not support the solve"
123 " measure = "
124 << toString(solveMeasureType.numerator)
125 << "/"
126 << toString(solveMeasureType.denominator)
127 << "!"
128 );
129}
130
131#endif // THYRA_LINEAR_OP_WITH_SOLVE_FACTORY_SUBCLASS_HELPERS_HPP
virtual std::string description() const
Base class for all linear operators that can support a high-level solve operation.
bool solveSupports(EOpTransp transp) const
Return if solve() supports the argument transp.
void assertSolveSupports(const LinearOpWithSolveBase< Scalar > &lows, const EOpTransp M_trans, const Ptr< const SolveCriteria< Scalar > > solveCriteria=Teuchos::null)
Assert that a LOWSB object supports a particular solve type.
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
EOpTransp
Enumeration for determining how a linear operator is applied. `*.
std::string toString(const T &t)
TEUCHOSCORE_LIB_DLL_EXPORT std::string toString(const EVerbosityLevel verbLevel)
Simple struct that defines the requested solution criteria for a solve.