/usr/include/trilinos/Thyra_ProductVectorBase.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 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 | // @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_PRODUCT_VECTOR_BASE_HPP
#define THYRA_PRODUCT_VECTOR_BASE_HPP
#include "Thyra_ProductMultiVectorBase.hpp"
namespace Thyra {
/** \brief Base interface for product vectors.
*
* This class defines an abstract interface for a vector that is built
* out of the one or more other vectors to form what mathematicians
* like to call a "product vector".
*
* A product vector is simply the concatenation of two or more vectors
* to form a larger "composite" vector. Specifically, a product vector
* with <tt>numBlock</tt> constituent block vectors represents the blocked
* vector
\verbatim
[ v[0] ]
[ v[1] ]
this = [ . ]
[ v[numBlocks-1] ]
\endverbatim
* The constituent vectors <tt>v[k]</tt> can be accessed through the
* <tt>const</tt> and non-<tt>const</tt> access functions
* <tt>getBlock()</tt>.
*
* A product vector knows its product space which is returned by the
* </tt>productSpace()</tt> function. A <tt>%ProductVectorBase</tt>
* object is created by a <tt>ProductVectorSpaceBase</tt> object and
* never directly created by clients.
*
* This class is only an interface. A standard implementation of this
* interface that should be sufficient for 99% or so of use cases is
* provided in the concrete subclass <tt>DefaultProductVector</tt>.
*
* \ingroup Thyra_Op_Vec_extended_interfaces_code_grp
*/
template<class Scalar>
class ProductVectorBase
: virtual public VectorBase<Scalar>
, virtual public ProductMultiVectorBase<Scalar>
{
public:
/** \brief Returns a non-persisting non-<tt>const</tt> view of the
* (zero-based) <tt>k</tt>th block vector.
*
* \param k [in] The (zero-based) <tt>k</tt>th block index specifying which
* vector block to access.
*
* Preconditions:<ul>
* <li> <tt>productSpace().get()!=NULL</tt>
* <li> <tt>0 <= k && k < productSpace()->numBlocks()</tt>
* <li> <tt>blockIsConst(k)==false</tt>
* </ul>
*
* Note that <tt>*this</tt> is not guaranteed to be modified until the smart
* pointer returned from this function, as well as any other smart pointers
* created from this smart pointer, are destroyed. This requirement allows
* more flexibility in how this function is implemented.
*
* Also note that no further interactions with <tt>*this</tt> should be
* performed until the view returned from this function is released as
* described above.
*/
virtual RCP<VectorBase<Scalar> >
getNonconstVectorBlock(const int k) = 0;
/** \brief Returns a non-persisting <tt>const</tt> view of the (zero-based)
* <tt>k</tt>th block vector.
*
* \param k [in] The (zero-based) <tt>k</tt>th block index specifying which
* vectorblock to access.
*
* Preconditions:<ul>
* <li> <tt>productSpace().get()!=NULL</tt>
* <li> <tt>0 <= k <= productSpace()->numBlocks()-1tt>
* </ul>
*/
virtual RCP<const VectorBase<Scalar> >
getVectorBlock(const int k) const = 0;
private:
// Not defined and not to be called
ProductVectorBase<Scalar>&
operator=(const ProductVectorBase<Scalar>&);
};
/** \brief Dynamic cast from a <tt>VectorBase</tt> to a
* <tt>ProductVectorBase</tt> object and thow exception if this fails.
*
* \relates ProductVectorBase
*/
template<class Scalar>
inline
RCP<Thyra::ProductVectorBase<Scalar> >
nonconstProductVectorBase(
const RCP<Thyra::VectorBase<Scalar> > &v
)
{
return Teuchos::rcp_dynamic_cast<Thyra::ProductVectorBase<Scalar> >(v, true);
}
/** \brief Dynamic cast from a <tt>const VectorBase</tt> to a <tt>const
* ProductVectorBase</tt> object and thow exception if this fails.
*
* \relates ProductVectorBase
*/
template<class Scalar>
inline
RCP<const Thyra::ProductVectorBase<Scalar> >
productVectorBase(
const RCP<const Thyra::VectorBase<Scalar> > &v
)
{
return Teuchos::rcp_dynamic_cast<const Thyra::ProductVectorBase<Scalar> >(v, true);
}
} // namespace Thyra
#endif // THYRA_PRODUCT_VECTOR_BASE_HPP
|