Thyra Version of the Day
Loading...
Searching...
No Matches
Thyra_PhysicallyBlockedLinearOpBase.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_PHYSICALLY_BLOCKED_LINEAR_OP_BASE_HPP
43#define THYRA_PHYSICALLY_BLOCKED_LINEAR_OP_BASE_HPP
44
45#include "Thyra_BlockedLinearOpBase.hpp"
46
47
48namespace Thyra {
49
50
62template<class Scalar>
64 : virtual public BlockedLinearOpBase<Scalar>
65{
66public:
67
78 virtual void beginBlockFill() = 0;
79
95 virtual void beginBlockFill(
96 const int numRowBlocks, const int numColBlocks
97 ) = 0;
98
118 virtual void beginBlockFill(
121 ) = 0;
122
124 virtual bool blockFillIsActive() const = 0;
125
140 virtual bool acceptsBlock(const int i, const int j) const = 0;
141
153 virtual void setNonconstBlock(
154 const int i, const int j
155 ,const Teuchos::RCP<LinearOpBase<Scalar> > &block
156 ) = 0;
157
169 virtual void setBlock(
170 const int i, const int j
171 ,const Teuchos::RCP<const LinearOpBase<Scalar> > &block
172 ) = 0;
173
185 virtual void endBlockFill() = 0;
186
195 virtual void uninitialize() = 0;
196
197private:
198
199 // Not defined and not to be called
202
203};
204
205
206} // namespace Thyra
207
208
209#endif // THYRA_PHYSICALLY_BLOCKED_LINEAR_OP_BASE_HPP
Base interface for linear operators that can be accessed as sub-blocks.
virtual Teuchos::RCP< const ProductVectorSpaceBase< Scalar > > productDomain() const =0
Return the product space for the domain.
virtual Teuchos::RCP< const ProductVectorSpaceBase< Scalar > > productRange() const =0
Return the product space for the range.
Base class for all linear operators.
Base interface for physically blocked linear operators.
virtual void uninitialize()=0
Set to uninitlaized.
virtual void beginBlockFill(const int numRowBlocks, const int numColBlocks)=0
Begin a block fill where the product range and domain spaces will be created on the fly but the total...
virtual void beginBlockFill()=0
Begin a block fill where the product range and domain spaces will be created on the fly and the numbe...
virtual void setNonconstBlock(const int i, const int j, const Teuchos::RCP< LinearOpBase< Scalar > > &block)=0
Set a non-const block linear operator.
virtual void setBlock(const int i, const int j, const Teuchos::RCP< const LinearOpBase< Scalar > > &block)=0
Set a const block linear operator.
virtual void endBlockFill()=0
End a block fill after which *this object can be used.
virtual void beginBlockFill(const Teuchos::RCP< const ProductVectorSpaceBase< Scalar > > &productRange, const Teuchos::RCP< const ProductVectorSpaceBase< Scalar > > &productDomain)=0
Begin a block fill where the product range and domain spaces are set a priori.
virtual bool acceptsBlock(const int i, const int j) const =0
Determines if the block (i,j) can be filled or not.
virtual bool blockFillIsActive() const =0
Determines if a block fill is active or not .