/usr/include/trilinos/Thyra_BlockedLinearOpBase.hpp is in libtrilinos-thyra-dev 12.4.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 | // @HEADER
// ***********************************************************************
//
// Thyra: Interfaces and Support for Abstract Numerical Algorithms
// Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.gov)
//
// ***********************************************************************
// @HEADER
#ifndef THYRA_BLOCKED_LINEAR_OP_BASE_HPP
#define THYRA_BLOCKED_LINEAR_OP_BASE_HPP
#include "Thyra_LinearOpBase.hpp"
namespace Thyra {
/** \brief . */
template <class Scalar> class ProductVectorSpaceBase;
/** \brief Base interface for linear operators that can be accessed as
* sub-blocks.
*
* ToDo: Finish Documentation.
*
* \ingroup Thyra_Op_Vec_extended_interfaces_code_grp
*/
template<class Scalar>
class BlockedLinearOpBase
: virtual public LinearOpBase<Scalar>
{
public:
/** \brief Return the product space for the range.
*
* A return value of <tt>return.get()==NULL</tt> is an indication that
* <tt>*this</tt> is not fully initialized.
*/
virtual Teuchos::RCP<const ProductVectorSpaceBase<Scalar> >
productRange() const = 0;
/** \brief Return the product space for the domain.
*
* A return value of <tt>return.get()==NULL</tt> is an indication that
* <tt>*this</tt> is not fully initialized.
*/
virtual Teuchos::RCP<const ProductVectorSpaceBase<Scalar> >
productDomain() const = 0;
/** \brief Return if the block <tt>(i,j)</tt> exists or not.
*
* \param i [in] Zero-based index for the block row.
* \param j [in] Zero-based index for the block column.
*
* <b>Preconditions:</b><ul>
* <li><tt>0 <= i && i < this->productRange()->numBlocks()</tt>
* <li><tt>0 <= j && j < this->productDomain()->numBlocks()</tt>
* </ul>
*/
virtual bool blockExists(const int i, const int j) const = 0;
/** \brief Return if the block <tt>(i,j)</tt> is const only or not.
*
* \param i [in] Zero-based index for the block row.
* \param j [in] Zero-based index for the block column.
*
* <b>Preconditions:</b><ul>
* <li><tt>0 <= i && i < this->productRange()->numBlocks()</tt>
* <li><tt>0 <= j && j < this->productDomain()->numBlocks()</tt>
* </ul>
*/
virtual bool blockIsConst(const int i, const int j) const = 0;
/** \brief Return a non-const view of the block <tt>(i,j)</tt> if it exists.
*
* \param i [in] Zero-based index for the block row.
* \param j [in] Zero-based index for the block column.
*
* <b>Preconditions:</b><ul>
* <li><tt>this->blockIsConst(i,j)==false</tt>
* <li><tt>0 <= i && i < this->productRange()->numBlocks()</tt>
* <li><tt>0 <= j && j < this->productDomain()->numBlocks()</tt>
* </ul>
*
* <b>Postconditions:</b><ul>
* <li>[<tt>this->blockExists(i,j)==true</tt>] <tt>return.get()!=NULL</tt>
* <li>[<tt>this->blockExists(i,j)==false</tt>] <tt>return.get()==NULL</tt>
* </ul>
*/
virtual Teuchos::RCP<LinearOpBase<Scalar> >
getNonconstBlock(const int i, const int j) = 0;
/** \brief Return a const view of the block <tt>(i,j)</tt> if it exists.
*
* \param i [in] Zero-based index for the block row.
* \param j [in] Zero-based index for the block column.
*
* <b>Preconditions:</b><ul>
* <li><tt>0 <= i && i < this->productRange()->numBlocks()</tt>
* <li><tt>0 <= j && j < this->productDomain()->numBlocks()</tt>
* </ul>
*
* <b>Postconditions:</b><ul>
* <li>[<tt>this->blockExists(i,j)==true</tt>] <tt>return.get()!=NULL</tt>
* <li>[<tt>this->blockExists(i,j)==false</tt>] <tt>return.get()==NULL</tt>
* </ul>
*/
virtual Teuchos::RCP<const LinearOpBase<Scalar> >
getBlock(const int i, const int j) const = 0;
};
} // namespace Thyra
#endif // THYRA_BLOCKED_LINEAR_OP_BASE_HPP
|