Thyra Version of the Day
Loading...
Searching...
No Matches
Thyra_DefaultSerialDenseLinearOpWithSolve_decl.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
43#ifndef THYRA_DEFAULT_SERIAL_DENSE_LINEAR_OP_WITH_SOLVE_DECL_HPP
44#define THYRA_DEFAULT_SERIAL_DENSE_LINEAR_OP_WITH_SOLVE_DECL_HPP
45
46
47#include "Thyra_LinearOpWithSolveBase.hpp"
48#include "RTOpPack_LapackWrappers.hpp"
49
50
51namespace Thyra {
52
53
54/* \brief . */
55inline RTOpPack::ETransp convertToRTOpPackETransp( const EOpTransp transp )
56{
57#ifdef TEUCHOS_DEBUG
59#endif
60 switch(transp) {
61 case NOTRANS:
62 return RTOpPack::NOTRANS;
63 case TRANS:
64 return RTOpPack::TRANS;
65 case CONJTRANS:
66 return RTOpPack::CONJTRANS;
67 default:
69 }
70 TEUCHOS_UNREACHABLE_RETURN(RTOpPack::NOTRANS);
71}
72// ToDo: Move the above function into Thyra_OperatorVectorTypes.hpp
73
74
90template<class Scalar>
92 : virtual public LinearOpWithSolveBase<Scalar>
93{
94public:
95
98
101
103 void initialize( const RCP<const MultiVectorBase<Scalar> > &M );
104
107
109
112
117
119
120protected:
121
124
126 bool opSupportedImpl(EOpTransp M_trans) const;
128 void applyImpl(
129 const EOpTransp M_trans,
131 const Ptr<MultiVectorBase<Scalar> > &Y,
132 const Scalar alpha,
133 const Scalar beta
134 ) const;
135
137
140
142 bool solveSupportsImpl(EOpTransp M_trans) const;
145 EOpTransp M_trans, const SolveMeasureType& solveMeasureType) const;
148 const EOpTransp transp,
150 const Ptr<MultiVectorBase<Scalar> > &X,
151 const Ptr<const SolveCriteria<Scalar> > solveCriteria
152 ) const;
153
155
156private:
157
158 // /////////////////////////
159 // Private data members
160
163 Array<int> ipiv_;
164
165 // /////////////////////////
166 // Private member functions
167
168 static void factorize(
171 const Ptr<Array<int> > &ipiv
172 );
173
174 static void backsolve(
176 const ArrayView<const int> ipiv,
177 const EOpTransp transp,
180 );
181
182 // Not defined and not to be called
185
186};
187
188
193template<class Scalar>
196{
198}
199
200
205template<class Scalar>
208{
211 M_lows->initialize(M); // With throw if singular
212 return M_lows;
213}
214
215
216} // end namespace Thyra
217
218
219#endif // THYRA_DEFAULT_SERIAL_DENSE_LINEAR_OP_WITH_SOLVE_DECL_HPP
Simple concreate subclass of LinearOpWithSolveBase for serial dense matrices implemented using LAPACK...
void applyImpl(const EOpTransp M_trans, const MultiVectorBase< Scalar > &X, const Ptr< MultiVectorBase< Scalar > > &Y, const Scalar alpha, const Scalar beta) const
bool solveSupportsSolveMeasureTypeImpl(EOpTransp M_trans, const SolveMeasureType &solveMeasureType) const
void initialize(const RCP< const MultiVectorBase< Scalar > > &M)
SolveStatus< Scalar > solveImpl(const EOpTransp transp, const MultiVectorBase< Scalar > &B, const Ptr< MultiVectorBase< Scalar > > &X, const Ptr< const SolveCriteria< Scalar > > solveCriteria) const
RCP< DefaultSerialDenseLinearOpWithSolve< Scalar > > defaultSerialDenseLinearOpWithSolve()
Nonmember constructor.
RCP< DefaultSerialDenseLinearOpWithSolve< Scalar > > defaultSerialDenseLinearOpWithSolve(const RCP< const MultiVectorBase< Scalar > > &M)
Nonmember constructor.
Base class for all linear operators that can support a high-level solve operation.
Interface for a collection of column vectors called a multi-vector.
#define TEUCHOS_TEST_FOR_EXCEPT(throw_exception_test)
EOpTransp
Enumeration for determining how a linear operator is applied. `*.
@ TRANS
Use the transposed operator.
@ NOTRANS
Use the non-transposed operator.
@ CONJTRANS
Use the transposed operator with complex-conjugate clements (same as TRANS for real scalar types).
@ CONJ
Use the non-transposed operator with complex-conjugate elements (same as NOTRANS for real scalar type...
#define TEUCHOS_UNREACHABLE_RETURN(dummyReturnVal)
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
Simple struct that defines the requested solution criteria for a solve.
Simple struct for the return status from a solve.