/usr/include/trilinos/Thyra_DefaultClusteredSpmdProductVectorSpace_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 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 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 | // @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_CLUSTERED_SPMD_PRODUCT_VECTOR_SPACE_DECL_HPP
#define THYRA_DEFAULT_CLUSTERED_SPMD_PRODUCT_VECTOR_SPACE_DECL_HPP
#include "Thyra_VectorSpaceBase_decl.hpp"
#include "Thyra_ProductVectorSpaceBase.hpp"
#include "Thyra_VectorSpaceDefaultBase.hpp"
#include "Teuchos_Comm.hpp"
namespace Thyra {
/** \brief Concrete subclass of <tt>VectorSpaceBase</tt> that takes a
* collection of individual <tt>VectorSpaceBase</tt> objects distributed over
* many different processes and creates a single vector space.
*
* What this class does is to take different vector space objects distributed
* over a set of different clusters of processes and then creates a single
* vector space object.
*
* Let <tt>numClusters</tt> be the number of clusters that the processes in
* the global communicator are partitioned into. Each cluster of processes is
* represented by another communicator known in this process as
* <tt>intraClusterComm</tt>. The communicator that links the root of each
* cluster is called <tt>interClusterComm</tt>. All communication is performed
* with just these two communicators. There is no overall global communicator
* that encompasses all of the processes.
*
* Within a cluster of processes, the number of constituent vector space
* objects must be the same. Let <tt>v[0]..v[numBlocks-1]</tt> be the
* <tt>numBlocks</tt> <tt>VectorBase</tt> objects for constituent vectors in
* this cluster of processes. There is no assumption make whatsoever about
* the natrue of the <tt>VectorSpaceBase</tt> objects or the
* <tt>[Multi]VectorBase</tt> objects that they create.
*
* ToDo: Finish documentation!
*
* The default copy constructor and assign operator are allowed and they work
* correctly and perform shallow copies of the constituent vector spaces!
*
* \ingroup Thyra_Op_Vec_adapters_Spmd_concrete_std_grp
*/
template<class Scalar>
class DefaultClusteredSpmdProductVectorSpace
: public ProductVectorSpaceBase<Scalar>
, protected VectorSpaceDefaultBase<Scalar>
{
public:
/** \name Constructors/Intializers/Accessors */
//@{
/** \brief . */
DefaultClusteredSpmdProductVectorSpace();
/** \brief . */
DefaultClusteredSpmdProductVectorSpace(
const RCP<const Teuchos::Comm<Ordinal> > &intraClusterComm
,const int clusterRootRank
,const RCP<const Teuchos::Comm<Ordinal> > &interClusterComm
,const int numBlocks
,const RCP<const VectorSpaceBase<Scalar> > vecSpaces[]
);
/** \brief Initalize.
*
* \param intraClusterComm
* [in] The communicator over just this cluster.
* \param clusterRootRank
* [in] The rank of the root process in <tt>*interClusterComm</tt> for this
* cluster of processes. This is also the process that in included in
* <tt>*interClusterComm</tt> (which has a different rank ther obviously).
* \param interClusterComm
* [in] Defines the communicator between the root processes of all of the
* clusters. For the root process of each cluster
* <tt>*interClusterComm!=Spmd_COMM_NULL</tt>,
* otherwise <tt>interClusterComm==Teuchos::null</tt> or
* <tt>*interClusterComm==Spmd_COMM_NULL</tt>.
* \param numBlocks
* [in] Number of vector space blocks for this cluster of processes.
* \param vecSpaces
* [in] Array (length <tt>numBlocks</tt>) of the vector spaces
* for this cluster of processes.
*/
void initialize(
const RCP<const Teuchos::Comm<Ordinal> > &intraClusterComm
,const int clusterRootRank
,const RCP<const Teuchos::Comm<Ordinal> > &interClusterComm
,const int numBlocks
,const RCP<const VectorSpaceBase<Scalar> > vecSpaces[]
);
/** \brief . */
RCP<const Teuchos::Comm<Ordinal> > intraClusterComm() const;
/** \brief . */
int clusterRootRank() const;
/** \brief . */
RCP<const Teuchos::Comm<Ordinal> > interClusterComm() const;
/** \bief The sum of the dimensions of the block vector spaces in this
* cluster.
*/
int clusterSubDim() const;
/** \bief The offset of the first element in the first constituent vector in
* this cluster in the w.r.t. the global vector.
*/
int clusterOffset() const;
//@}
/** @name Overridden form Teuchos::Describable */
//@{
/** \brief . */
std::string description() const;
//@}
/** @name Public overridden from VectorSpaceBase */
//@{
/** \brief . */
Ordinal dim() const;
/** \brief . */
bool isCompatible(const VectorSpaceBase<Scalar>& vecSpc) const;
/** \brief . */
RCP< const VectorSpaceFactoryBase<Scalar> > smallVecSpcFcty() const;
/** \brief . */
Scalar scalarProd( const VectorBase<Scalar>& x, const VectorBase<Scalar>& y ) const;
/** \brief . */
void scalarProdsImpl(
const MultiVectorBase<Scalar>& X, const MultiVectorBase<Scalar>& Y,
const ArrayView<Scalar> &scalarProds ) const;
/** \brief . */
bool isEuclidean() const;
/** \brief . */
bool hasInCoreView(
const Range1D& rng, const EViewType viewType, const EStrideType strideType
) const;
/** \brief . */
RCP< const VectorSpaceBase<Scalar> > clone() const;
//@}
/** @name Protected overridden from ProductVectorSpaceBase */
//@{
/** \brief . */
int numBlocks() const;
/** \brief . */
RCP<const VectorSpaceBase<Scalar> > getBlock(const int k) const;
//@}
protected:
/** @name Protected overridden from VectorSpaceBase */
//@{
/** \brief . */
RCP<VectorBase<Scalar> > createMember() const;
/** \brief . */
RCP<MultiVectorBase<Scalar> > createMembers(int numMembers) const;
//@}
private:
// //////////////////////////////////////
// Private types
typedef std::vector<RCP<const VectorSpaceBase<Scalar> > > vecSpaces_t;
// //////////////////////////////////////
// Private data members
RCP<const Teuchos::Comm<Ordinal> > intraClusterComm_;
int clusterRootRank_;
RCP<const Teuchos::Comm<Ordinal> > interClusterComm_;
vecSpaces_t vecSpaces_; // size == numBlocks
bool isEuclidean_;
Ordinal globalDim_; // The global dimension of all of the block vectors in
// all of the clusters.
Ordinal clusterSubDim_; // The some of the dimensions of the block vector
// spaces in this cluster
Ordinal clusterOffset_; // The offset of the first element in the first
// constituent vector in this cluster in the
// w.r.t. the global vector.
};
// ///////////////////////////
// Inline defintions
template<class Scalar>
RCP<const Teuchos::Comm<Ordinal> >
DefaultClusteredSpmdProductVectorSpace<Scalar>::intraClusterComm() const
{
return intraClusterComm_;
}
template<class Scalar>
int DefaultClusteredSpmdProductVectorSpace<Scalar>::clusterRootRank() const
{
return clusterRootRank_;
}
template<class Scalar>
RCP<const Teuchos::Comm<Ordinal> >
DefaultClusteredSpmdProductVectorSpace<Scalar>::interClusterComm() const
{
return interClusterComm_;
}
template<class Scalar>
int DefaultClusteredSpmdProductVectorSpace<Scalar>::clusterSubDim() const
{
return clusterSubDim_;
}
template<class Scalar>
int DefaultClusteredSpmdProductVectorSpace<Scalar>::clusterOffset() const
{
return clusterOffset_;
}
} // end namespace Thyra
#endif // THYRA_DEFAULT_CLUSTERED_SPMD_PRODUCT_VECTOR_SPACE_DECL_HPP
|