Thyra
Version of the Day
core
src
support
operator_solve
client_support
Thyra_DefaultLinearOpSource_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_DEFUALT_LINEAR_OP_SOURCE_DECL_HPP
43
#define THYRA_DEFUALT_LINEAR_OP_SOURCE_DECL_HPP
44
45
#include "Thyra_LinearOpSourceBase.hpp"
46
#include "Teuchos_ConstNonconstObjectContainer.hpp"
47
48
namespace
Thyra {
49
53
template
<
class
Scalar>
54
class
DefaultLinearOpSource
:
virtual
public
LinearOpSourceBase
<Scalar>
55
{
56
public
:
57
60
63
DefaultLinearOpSource
();
64
67
DefaultLinearOpSource
(
68
const
Teuchos::RCP
<
LinearOpBase<Scalar>
> &op
69
);
70
73
DefaultLinearOpSource
(
74
const
Teuchos::RCP
<
const
LinearOpBase<Scalar>
> &op
75
);
76
79
void
initialize
(
80
const
Teuchos::RCP
<
LinearOpBase<Scalar>
> &op
81
);
82
85
void
initialize
(
86
const
Teuchos::RCP
<
const
LinearOpBase<Scalar>
> &op
87
);
88
95
void
uninitialize
();
96
98
99
// ToDo: Override functions from Describable!
100
104
bool
isOpConst
()
const
;
106
Teuchos::RCP<LinearOpBase<Scalar>
>
getNonconstOp
();
108
Teuchos::RCP<const LinearOpBase<Scalar>
>
getOp
()
const
;
110
111
private
:
112
113
Teuchos::ConstNonconstObjectContainer<LinearOpBase<Scalar>
> op_;
114
115
};
116
117
// //////////////////////////////
118
// Related functions
119
125
template
<
class
Scalar>
126
Teuchos::RCP<const DefaultLinearOpSource<Scalar>
>
127
defaultLinearOpSource
(
128
const
Teuchos::RCP
<
const
LinearOpBase<Scalar>
> &op
129
)
130
{
131
return
Teuchos::rcp(
new
DefaultLinearOpSource<Scalar>
(op));
132
}
133
134
}
// namespace Thyra
135
136
#endif // THYRA_DEFUALT_LINEAR_OP_SOURCE_DECL_HPP
Thyra::DefaultLinearOpSource::getNonconstOp
Teuchos::RCP< LinearOpBase< Scalar > > getNonconstOp()
Definition:
Thyra_DefaultLinearOpSource_def.hpp:116
Thyra::LinearOpSourceBase
Base interface for objects that can return a linear operator.
Definition:
Thyra_LinearOpSourceBase.hpp:57
Teuchos::RCP
Thyra::DefaultLinearOpSource::DefaultLinearOpSource
DefaultLinearOpSource()
Construct to uninitialized.
Definition:
Thyra_DefaultLinearOpSource_def.hpp:57
Thyra::LinearOpBase
Base class for all linear operators.
Definition:
Thyra_LinearOpBase_decl.hpp:191
Thyra::DefaultLinearOpSource::isOpConst
bool isOpConst() const
Definition:
Thyra_DefaultLinearOpSource_def.hpp:108
Thyra::DefaultLinearOpSource
Default implementation of a LinearOpSourceBase that just accepts and gives up a single linear operato...
Definition:
Thyra_DefaultLinearOpSource_decl.hpp:54
Thyra::DefaultLinearOpSource::getOp
Teuchos::RCP< const LinearOpBase< Scalar > > getOp() const
Definition:
Thyra_DefaultLinearOpSource_def.hpp:124
Thyra::DefaultLinearOpSource::defaultLinearOpSource
Teuchos::RCP< const DefaultLinearOpSource< Scalar > > defaultLinearOpSource(const Teuchos::RCP< const LinearOpBase< Scalar > > &op)
Create a DefaultLinearOpSource object out of a LinearOpBase object.
Definition:
Thyra_DefaultLinearOpSource_decl.hpp:127
Teuchos::ConstNonconstObjectContainer
Thyra::DefaultLinearOpSource::initialize
void initialize(const Teuchos::RCP< LinearOpBase< Scalar > > &op)
Initialize with a non-const linear operator.
Definition:
Thyra_DefaultLinearOpSource_def.hpp:80
Thyra::DefaultLinearOpSource::uninitialize
void uninitialize()
Uninitialize.
Definition:
Thyra_DefaultLinearOpSource_def.hpp:98
Generated by
1.8.16