/usr/include/trilinos/Thyra_DefaultSpmdVector_decl.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 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 | // @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_DEFAULT_SPMD_VECTOR_DECL_HPP
#define THYRA_DEFAULT_SPMD_VECTOR_DECL_HPP
#include "Thyra_SpmdVectorDefaultBase_decl.hpp"
namespace Thyra {
/** \brief Efficient concrete implementation subclass for SPMD vectors.
*
* This subclass provides a very efficient and very general concrete
* implementation of a <tt>Thyra::VectorBase</tt> object for any SPMD
* platform.
*
* Objects of this type generally should not be constructed directly by a
* client but instead by using the concrete vector space subclass
* <tt>Thyra::DefaultSpmdVectorSpace</tt> and using the function
* <tt>Thyra::createMember()</tt>.
*
* The storage type can be anything since an <tt>ArrayRCP</tt> is used to pass
* in the local values pointer into the constructor and <tt>initialize()</tt>.
*
* \ingroup Thyra_Op_Vec_adapters_Spmd_concrete_std_grp
*/
template<class Scalar>
class DefaultSpmdVector : virtual public SpmdVectorDefaultBase<Scalar> {
public:
/** @name Constructors/initializers */
//@{
/** \brief Construct to uninitialized. */
DefaultSpmdVector();
/** \brief Calls <tt>initialize()</tt>. */
DefaultSpmdVector(
const RCP<const SpmdVectorSpaceBase<Scalar> > &spmdSpace
,const ArrayRCP<Scalar> &localValues
,const Ordinal stride
);
/** \brief Initialize.
*
* \param spmdSpace
* [in] Smart pointer to <tt>SpmdVectorSpaceBase</tt> object
* that defines the data distribution for <tt>spmdSpace()</tt> and <tt>space()</tt>.
* \param localValues
* [in] Smart pointer to beginning of local strided vector data.
* This array must be at least of dimension <tt>mpiRangeSpace->localDim()*stride</tt>
* and <tt>(&*localValues)[ i*stride ]</tt> gives the local value
* of the zero-based entry <tt>(i)</tt> where <tt>i=0...spmdSpace()->localSubDim()-1</tt>.
* \param stride
* [in] Stride between local vector elements.
*
* <b>Preconditions:</b><ul>
* <li><tt>spmdSpace.get()!=NULL</tt>
* <li><tt>localValues.get()!=NULL</tt>
* <li><tt>stride != 0</tt>
* </ul>
*
* <b>Postconditions:</b><ul>
* <li> <tt>this->getRCptr().get() == localValues.get()</tt>
* <li> <tt>this->getPtr() == &*localValues</tt>
* <li> <tt>this->getStride() == stride</tt>
* </ul>
*/
void initialize(
const RCP<const SpmdVectorSpaceBase<Scalar> > &spmdSpace
,const ArrayRCP<Scalar> &localValues
,const Ordinal stride
);
/** \brief Set to an uninitialized state.
*
* <b>Postconditions:</b><ul>
* <li><tt>this->spmdSpace().get() == NULL</tt>.
*/
void uninitialize(
RCP<const SpmdVectorSpaceBase<Scalar> > *spmdSpace = NULL
,ArrayRCP<Scalar> *localValues = NULL
,Ordinal *stride = NULL
);
//@}
/** @name Accessors (inlined for minimal overhead) */
//@{
/** \brief . */
ArrayRCP<Scalar> getRCPtr();
/** \brief . */
ArrayRCP<const Scalar> getRCPtr() const;
/** \brief . */
Scalar* getPtr();
/** \brief . */
const Scalar* getPtr() const;
/** \brief . */
Ordinal getStride() const;
//@}
/** @name Overridden from SpmdMultiVectorBase */
//@{
/** \brief . */
RCP<const SpmdVectorSpaceBase<Scalar> > spmdSpaceImpl() const;
//@}
/** @name Overridden from SpmdVectorBase */
//@{
/** \brief . */
void getNonconstLocalVectorDataImpl(const Ptr<ArrayRCP<Scalar> > &localValues);
/** \brief . */
void getLocalVectorDataImpl(const Ptr<ArrayRCP<const Scalar> > &localValues) const;
//@}
private:
// ///////////////////////////////////////
// Private data members
RCP<const SpmdVectorSpaceBase<Scalar> > spmdSpace_;
ArrayRCP<Scalar> localValues_;
Ordinal stride_;
};
// /////////////////////////////////////////////////////
// Inline members
template<class Scalar>
inline
ArrayRCP<Scalar>
DefaultSpmdVector<Scalar>::getRCPtr()
{
return localValues_;
}
template<class Scalar>
inline
ArrayRCP<const Scalar>
DefaultSpmdVector<Scalar>::getRCPtr() const
{
return localValues_;
}
template<class Scalar>
inline
Scalar* DefaultSpmdVector<Scalar>::getPtr()
{
return localValues_.get();
}
template<class Scalar>
inline
const Scalar* DefaultSpmdVector<Scalar>::getPtr() const
{
return localValues_.get();
}
template<class Scalar>
inline
Ordinal DefaultSpmdVector<Scalar>::getStride() const
{
return stride_;
}
} // end namespace Thyra
#endif // THYRA_DEFAULT_SPMD_VECTOR_DECL_HPP
|