/usr/include/trilinos/Thyra_ScalarProdVectorSpaceBase_decl.hpp is in libtrilinos-thyra-dev 12.12.1-5.
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 | // @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_SCALAR_PROD_VECTOR_SPACE_BASE_DECL_HPP
#define THYRA_SCALAR_PROD_VECTOR_SPACE_BASE_DECL_HPP
#include "Thyra_OperatorVectorAdapterSupportTypes.hpp"
#include "Thyra_VectorSpaceDefaultBase.hpp"
namespace Thyra {
/** \brief Base subclass for <tt>VectorSpaceBase</tt> that allows the
* definition of an application-specific scalar product to be swapped
* in and out.
*
* This subclass defines machinery for extracting out the definition of a
* scalar product as an object that can be replaced. The default
* implementation of scalar product is the Euclidean scalar product (i.e. dot
* product). The idea is that, in most cases, the definition of a scalar
* product may be more general than a specific concrete vector implementation
* (i.e. a single scalar product may work with all serial and all MPI-based
* vectors if, for example, it is implemented through an
* <tt>RTOpPack::RTOpT</tt> object). Or, a scalar product way work with any
* MPI SPMD vector or multi-vector. This subclass allows an application code
* to set a specialized scalar product without having to depend on a
* particular concrete vector (and vector space) implementation.
*
* Almost every data-structure centric concrete <tt>VectorSpaceBase</tt>
* subclass should inherit from this subclass since it makes it easy for
* application developers to redefine the scalar product without having to
* create a new <tt>VectorSpaceBase</tt> subclass which can have many
* repercussions.
*
* The reason that this machinery in this base subclass is separated out from
* the <tt>VectorSpaceDefaultBase</tt> interface class is that, first it would
* clutter the base interface since this machinery is an implementation
* artifact and, second, every <tt>VectorSpaceBase</tt> subclass will not
* utilize this machinery. For example, composite (see
* <tt>ProductVectorSpaceBase</tt>) and decorator subclasses should not derive
* from this subclass.
*
* \ingroup Thyra_Op_Vec_basic_adapter_support_grp
*/
template<class Scalar>
class ScalarProdVectorSpaceBase : virtual public VectorSpaceDefaultBase<Scalar> {
public:
/** @name Constructors / initializers */
//@{
/** \brief Construct to use dot product as the default.
*
* <b>Postconditions:</b><ul>
*
* <li><tt>dynamic_cast<const
* EuclideanScalarProd<Scalar>*>(&*this->getScalarProd()) != NULL</tt>
*
* </ul>
*/
ScalarProdVectorSpaceBase();
/** \brief Construct with a different scalar product.
*
* <b>Preconditions:</b><ul>
*
* <li><tt>scalarProd.get()!=NULL</tt> (throw
* <tt>std::invalid_argument</tt>)
*
* </ul>
*
* <b>Postconditions:</b><ul>
*
* <li><tt>this->getScalarProd().get() == scalarProd.get()</tt>
*
* </ul>
*/
ScalarProdVectorSpaceBase(
const RCP<const ScalarProdBase<Scalar> > &scalarProd );
/** \brief Set a different scalar product.
*
* This function is made virtual so that subclasses can override it
* and take control of what happens. However, any override should
* call back on this base implementation to set the actual scalar
* product object.
*
* <b>Preconditions:</b><ul>
*
* <li><tt>scalarProd.get()!=NULL</tt> (throw
* <tt>std::invalid_argument</tt>)
*
* </ul>
*
* <b>Postconditions:</b><ul>
*
* <li><tt>this->getScalarProd().get() == scalarProd.get()</tt>
*
* </ul>
*/
virtual void setScalarProd(
const RCP<const ScalarProdBase<Scalar> > &scalarProd );
/** \brief Return the current scalar product.
*/
RCP<const ScalarProdBase<Scalar> > getScalarProd() const;
//@}
/** @name Overridden from VectorSpaceBase */
//@{
/// Returns <tt>getScalarProd()->isEuclidean()</tt>
bool isEuclidean() const;
/// Returns <tt>getScalarProd()->scalarProd(x,y)</tt>
Scalar scalarProd(
const VectorBase<Scalar>& x, const VectorBase<Scalar>& y ) const;
/// Calls <tt>getScalarProd()->scalarProds(X,Y,scalar_prods)</tt>
void scalarProdsImpl(
const MultiVectorBase<Scalar>& X, const MultiVectorBase<Scalar>& Y,
const ArrayView<Scalar> &scalarProds_out ) const;
//@}
private:
RCP<const ScalarProdBase<Scalar> > scalarProd_;
};
/** \brief Create a small vector space casted to ScalarProdVectorSpaceBase.
*
* \relates ScalarProdVectorSpaceBase
*/
template<class Scalar>
RCP<const ScalarProdVectorSpaceBase<Scalar> >
createSmallScalarProdVectorSpaceBase(
const RCP<const VectorSpaceBase<Scalar> > &vs,
const Ordinal dim
)
{
return Teuchos::rcp_dynamic_cast<const ScalarProdVectorSpaceBase<Scalar> >(
vs->smallVecSpcFcty()->createVecSpc(dim), true);
}
} // end namespace Thyra
#endif // THYRA_SCALAR_PROD_VECTOR_SPACE_BASE_DECL_HPP
|