Thyra
Version of the Day
Toggle main menu visibility
Loading...
Searching...
No Matches
core
src
support
operator_solve
client_support
Thyra_DefaultDiagonalLinearOpWithSolve_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
#ifndef THYRA_DIAGONAL_LINEAR_OP_WITH_SOLVE_DECL_HPP
43
#define THYRA_DIAGONAL_LINEAR_OP_WITH_SOLVE_DECL_HPP
44
45
#include "Thyra_DefaultDiagonalLinearOp.hpp"
46
#include "Thyra_LinearOpWithSolveBase.hpp"
47
48
49
namespace
Thyra {
50
51
91
template
<
class
Scalar>
92
class
DefaultDiagonalLinearOpWithSolve
93
:
virtual
public
DefaultDiagonalLinearOp
<Scalar>,
94
virtual
public
LinearOpWithSolveBase
<Scalar>
95
{
96
public
:
97
100
107
DefaultDiagonalLinearOpWithSolve
();
108
110
DefaultDiagonalLinearOpWithSolve
(
111
const
RCP
<
const
VectorBase<Scalar>
> &diag
112
);
113
114
protected
:
115
118
119
bool
solveSupportsImpl
(EOpTransp M_trans)
const
;
121
bool
solveSupportsSolveMeasureTypeImpl
(
122
EOpTransp M_trans,
const
SolveMeasureType
& solveMeasureType)
const
;
124
SolveStatus<Scalar>
solveImpl
(
125
const
EOpTransp transp,
126
const
MultiVectorBase<Scalar>
&B,
127
const
Ptr
<
MultiVectorBase<Scalar>
> &X,
128
const
Ptr
<
const
SolveCriteria<Scalar>
> solveCriteria
129
)
const
;
131
132
};
133
134
139
template
<
class
Scalar>
140
RCP<DefaultDiagonalLinearOpWithSolve<Scalar>
>
141
defaultDiagonalLinearOpWithSolve
()
142
{
143
return
Teuchos::rcp
(
new
DefaultDiagonalLinearOpWithSolve<Scalar>
);
144
}
145
146
151
template
<
class
Scalar>
152
RCP<DefaultDiagonalLinearOpWithSolve<Scalar>
>
153
defaultDiagonalLinearOpWithSolve
(
154
const
RCP
<
const
VectorBase<Scalar>
> &diag
155
)
156
{
157
RCP<DefaultDiagonalLinearOpWithSolve<Scalar>
> ddlows =
158
defaultDiagonalLinearOpWithSolve<Scalar>
();
159
ddlows->initialize(diag);
160
return
ddlows;
161
}
162
163
164
165
}
// end namespace Thyra
166
167
168
#endif
// THYRA_DIAGONAL_LINEAR_OP_WITH_SOLVE_DECL_HPP
Teuchos::Ptr
Teuchos::RCP
Thyra::DefaultDiagonalLinearOpWithSolve::solveSupportsSolveMeasureTypeImpl
bool solveSupportsSolveMeasureTypeImpl(EOpTransp M_trans, const SolveMeasureType &solveMeasureType) const
Definition
Thyra_DefaultDiagonalLinearOpWithSolve_def.hpp:91
Thyra::DefaultDiagonalLinearOpWithSolve::defaultDiagonalLinearOpWithSolve
RCP< DefaultDiagonalLinearOpWithSolve< Scalar > > defaultDiagonalLinearOpWithSolve(const RCP< const VectorBase< Scalar > > &diag)
Nonmember constructor.
Definition
Thyra_DefaultDiagonalLinearOpWithSolve_decl.hpp:153
Thyra::DefaultDiagonalLinearOpWithSolve::solveImpl
SolveStatus< Scalar > solveImpl(const EOpTransp transp, const MultiVectorBase< Scalar > &B, const Ptr< MultiVectorBase< Scalar > > &X, const Ptr< const SolveCriteria< Scalar > > solveCriteria) const
Definition
Thyra_DefaultDiagonalLinearOpWithSolve_def.hpp:100
Thyra::DefaultDiagonalLinearOpWithSolve::defaultDiagonalLinearOpWithSolve
RCP< DefaultDiagonalLinearOpWithSolve< Scalar > > defaultDiagonalLinearOpWithSolve()
Nonmember constructor.
Definition
Thyra_DefaultDiagonalLinearOpWithSolve_decl.hpp:141
Thyra::DefaultDiagonalLinearOpWithSolve::solveSupportsImpl
bool solveSupportsImpl(EOpTransp M_trans) const
Definition
Thyra_DefaultDiagonalLinearOpWithSolve_def.hpp:81
Thyra::DefaultDiagonalLinearOpWithSolve::DefaultDiagonalLinearOpWithSolve
DefaultDiagonalLinearOpWithSolve()
Constructs to uninitialized.
Definition
Thyra_DefaultDiagonalLinearOpWithSolve_def.hpp:60
Thyra::DefaultDiagonalLinearOp::DefaultDiagonalLinearOp
DefaultDiagonalLinearOp()
Constructs to uninitialized.
Definition
Thyra_DefaultDiagonalLinearOp_def.hpp:60
Thyra::LinearOpWithSolveBase
Base class for all linear operators that can support a high-level solve operation.
Definition
Thyra_LinearOpWithSolveBase_decl.hpp:311
Thyra::MultiVectorBase
Interface for a collection of column vectors called a multi-vector.
Definition
Thyra_MultiVectorBase_decl.hpp:496
Thyra::VectorBase
Abstract interface for finite-dimensional dense vectors.
Definition
Thyra_VectorBase.hpp:147
Teuchos::rcp
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
Thyra::SolveCriteria
Simple struct that defines the requested solution criteria for a solve.
Definition
Thyra_SolveSupportTypes.hpp:312
Thyra::SolveMeasureType
Solve tolerance type.
Definition
Thyra_SolveSupportTypes.hpp:112
Thyra::SolveStatus
Simple struct for the return status from a solve.
Definition
Thyra_SolveSupportTypes.hpp:423
Generated by
1.17.0