/usr/include/trilinos/Thyra_ProductVectorSpaceBase.hpp is in libtrilinos-thyra-dev 12.10.1-3.
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 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 | // @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_SPACE_BASE_HPP
#define THYRA_PRODUCT_VECTOR_SPACE_BASE_HPP
#include "Thyra_VectorSpaceBase.hpp"
#include "Teuchos_ExpandScalarTypeMacros.hpp"
namespace Thyra {
/** \brief Base interface for product vector spaces.
*
* This class defines an abstract interface for a vector space that is
* built out of the one or more other vector spaces to form what
* mathematicians like to call a "product space".
*
* For example, one can think of a product space as the concatenation
* of one or more vector spaces <tt>V[k]</tt> where
* <tt>k=0,...,numBlocks-1</tt>. A product space <tt>Z</tt> would
* then be represented as:
\verbatim
[ V[0] ]
Z = [ V[1] ]
[ . ]
[ V[numBlocks-1] ]
\endverbatim
*
* The total number of constituent vector spaces is returned by the
* <tt>numBlocks()</tt> function. Smart pointers to the constituent
* vector space blocks themselves are returned using the
* <tt>getBlock()</tt> function.
*
* The vectors created by <tt>this->createMember()</tt> (which is
* inherited from the <tt>VectorSpaceBase</tt> interface) must support the
* <tt>ProductVectorBase</tt> interface
* (i.e. <tt>dynamic_cast<ProductVectorBase<Scalar>*>(&*this->createMember())
* != NULL</tt>). Likewise, the multi-vectors created by
* <tt>this->createMembers()</tt> must support the
* <tt>ProductMultiVectorBase</tt> interface
* (i.e. <tt>dynamic_cast<ProductMultiVectorBase<Scalar>*>(&*this->createMember())
* != NULL</tt>)
*
* 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>DefaultProductVectorSpace</tt>.
*
* \ingroup Thyra_Op_Vec_extended_interfaces_code_grp
*/
template<class Scalar>
class ProductVectorSpaceBase : virtual public VectorSpaceBase<Scalar> {
public:
/** \brief Returns the number of blocks that make up this product space.
*
* Preconditions:<ul>
* <li> <tt>this->dim() > 0</tt>.
* </ul>
*/
virtual int numBlocks() const = 0;
/** \brief Returns a vector space for the <tt>kth</tt> (zero-based) block.
*
* Preconditions:<ul>
* <li> <tt>0 <= k <= numBlocks()-1</tt>
* </ul>
*/
virtual Teuchos::RCP<const VectorSpaceBase<Scalar> > getBlock(const int k) const = 0;
#ifdef DOXYGEN_COMPILE
private:
const VectorSpaceBase<Scalar> *spaces;
#endif
private:
// Not defined and not to be called
ProductVectorSpaceBase<Scalar>&
operator=(const ProductVectorSpaceBase<Scalar>&);
};
/** \brief Dynamic cast from a <tt>VectorSpaceBase</tt> to a
* <tt>ProductVectorSpaceBase</tt> object and thow exception if this fails.
*
* \relates ProductVectorSpaceBase
*/
template<class Scalar>
inline
RCP<ProductVectorSpaceBase<Scalar> >
nonconstProductVectorSpaceBase(
const RCP<VectorSpaceBase<Scalar> > &v,
const bool forceSuccess = true
)
{
return Teuchos::rcp_dynamic_cast<ProductVectorSpaceBase<Scalar> >(
v, forceSuccess);
}
/** \brief Dynamic cast from a <tt>const VectorSpaceBase</tt> to a <tt>const
* ProductVectorSpaceBase</tt> object and thow exception if this fails.
*
* \relates ProductVectorSpaceBase
*/
template<class Scalar>
inline
RCP<const ProductVectorSpaceBase<Scalar> >
productVectorSpaceBase(
const RCP<const VectorSpaceBase<Scalar> > &v,
const bool forceSuccess = true
)
{
return Teuchos::rcp_dynamic_cast<const ProductVectorSpaceBase<Scalar> >(
v, forceSuccess);
}
/** \brief Inline overload of nonconstProductVectorSpaceBase<Scalar>(..) for
* double.
*
* \relates ProductVectorSpaceBase
*/
inline
RCP<ProductVectorSpaceBase<double> >
nonconstProductVectorSpaceBase(
const RCP<VectorSpaceBase<double> > &vs,
const bool forceSuccess = true
)
{
return nonconstProductVectorSpaceBase<double>(vs, forceSuccess);
}
/** \brief Inline overload of productVectorSpaceBase<Scalar>(..) for double.
*
* \relates ProductVectorSpaceBase
*/
inline
RCP<const ProductVectorSpaceBase<double> >
productVectorSpaceBase(
const RCP<const VectorSpaceBase<double> > &vs,
const bool forceSuccess = true
)
{
return productVectorSpaceBase<double>(vs, forceSuccess);
}
} // namespace Thyra
#endif // THYRA_PRODUCT_VECTOR_SPACE_BASE_HPP
|