/usr/include/trilinos/Thyra_DefaultClusteredSpmdProductVectorSpace_def.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 | // @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_HPP
#define THYRA_DEFAULT_CLUSTERED_SPMD_PRODUCT_VECTOR_SPACE_HPP
#include "Thyra_DefaultClusteredSpmdProductVectorSpace_decl.hpp"
#include "Thyra_SpmdVectorSpaceBase.hpp"
#include "Thyra_DefaultClusteredSpmdProductVector.hpp"
#include "Thyra_VectorSpaceDefaultBase.hpp"
#include "Thyra_VectorStdOps.hpp"
#include "Thyra_MultiVectorStdOps.hpp"
#include "Thyra_SpmdVectorSpaceUtilities.hpp"
#include "Teuchos_implicit_cast.hpp"
#include "Teuchos_CommHelpers.hpp"
namespace Thyra {
// Constructors/Intializers/Accessors
template<class Scalar>
DefaultClusteredSpmdProductVectorSpace<Scalar>::DefaultClusteredSpmdProductVectorSpace()
:clusterRootRank_(-1), isEuclidean_(false), globalDim_(0), clusterSubDim_(-1),
clusterOffset_(-1)
{}
template<class Scalar>
DefaultClusteredSpmdProductVectorSpace<Scalar>::DefaultClusteredSpmdProductVectorSpace(
const Teuchos::RCP<const Teuchos::Comm<Ordinal> > &intraClusterComm_in
,const int clusterRootRank_in
,const Teuchos::RCP<const Teuchos::Comm<Ordinal> > &interClusterComm_in
,const int numBlocks_in
,const Teuchos::RCP<const VectorSpaceBase<Scalar> > vecSpaces[]
):
globalDim_(0),
clusterOffset_(-1)
{
initialize(intraClusterComm_in,clusterRootRank_in,interClusterComm_in,numBlocks_in,vecSpaces);
}
template<class Scalar>
void DefaultClusteredSpmdProductVectorSpace<Scalar>::initialize(
const Teuchos::RCP<const Teuchos::Comm<Ordinal> > &intraClusterComm_in
,const int clusterRootRank_in
,const Teuchos::RCP<const Teuchos::Comm<Ordinal> > &interClusterComm_in
,const int numBlocks_in
,const Teuchos::RCP<const VectorSpaceBase<Scalar> > vecSpaces[]
)
{
// Set state
intraClusterComm_ = intraClusterComm_in.assert_not_null();
clusterRootRank_ = clusterRootRank_in;
interClusterComm_ = interClusterComm_in; // This can be NULL!
vecSpaces_.resize(numBlocks_in);
isEuclidean_ = true;
Ordinal l_clusterSubDim = 0;
for( int k = 0; k < numBlocks_in; ++k ) {
l_clusterSubDim += vecSpaces[k]->dim();
if(!vecSpaces[k]->isEuclidean())
isEuclidean_ = false;
vecSpaces_[k] = vecSpaces[k];
}
// We must compute the offsets between clusters and the global dimension by
// only involving the root process in each cluster.
if(interClusterComm_.get()) {
clusterOffset_ = SpmdVectorSpaceUtilities::computeLocalOffset(
*interClusterComm_,l_clusterSubDim
);
globalDim_ = SpmdVectorSpaceUtilities::computeGlobalDim(
*interClusterComm_,l_clusterSubDim
);
}
// Here must then broadcast the values to all processes within each cluster.
{
const Ordinal num = 2;
Ordinal buff[num] = { clusterOffset_, globalDim_ };
Teuchos::broadcast<Ordinal>(*intraClusterComm_, clusterRootRank_, num, &buff[0]);
clusterOffset_ = buff[0];
globalDim_ = buff[1];
}
//
clusterSubDim_ = l_clusterSubDim;
// ToDo: Do a global communication across all clusters to see if all vector
// spaces are all Euclidean. It is unlikely to be the case where all of the
// clusters do not have the same vector spaces so I do not think this will
// even come up. But just in case, we should keep this in mind!
}
// Overridden form Teuchos::Describable
template<class Scalar>
std::string DefaultClusteredSpmdProductVectorSpace<Scalar>::description() const
{
std::ostringstream oss;
oss << "DefaultClusteredSpmdProductVectorSpace{";
oss << "numBlocks="<<vecSpaces_.size();
oss << ",globalDim="<<globalDim_;
oss << ",clusterOffset="<<clusterOffset_;
oss << "}";
return oss.str();
}
// Public overridden from VectorSpaceBase
template<class Scalar>
Ordinal DefaultClusteredSpmdProductVectorSpace<Scalar>::dim() const
{
return globalDim_;
}
template<class Scalar>
bool DefaultClusteredSpmdProductVectorSpace<Scalar>::isCompatible(
const VectorSpaceBase<Scalar>& vecSpc
) const
{
typedef DefaultClusteredSpmdProductVectorSpace<Scalar> DCSPVS;
if (&vecSpc==this) {
return true;
}
const Ptr<const DCSPVS> dcspvs =
Teuchos::ptr_dynamic_cast<const DCSPVS>(Teuchos::ptrFromRef(vecSpc), false);
if (is_null(dcspvs)) {
return false;
}
if (vecSpaces_.size() != dcspvs->vecSpaces_.size()) {
return false;
}
const int l_numBlocks = vecSpaces_.size();
for( int k = 0; k < l_numBlocks; ++k ) {
if (!vecSpaces_[k]->isCompatible(*dcspvs->vecSpaces_[k])) {
return false;
}
}
return true;
}
template<class Scalar>
Teuchos::RCP< const VectorSpaceFactoryBase<Scalar> >
DefaultClusteredSpmdProductVectorSpace<Scalar>::smallVecSpcFcty() const
{
if(!vecSpaces_.size())
return Teuchos::null;
return vecSpaces_[0]->smallVecSpcFcty();
}
template<class Scalar>
Scalar DefaultClusteredSpmdProductVectorSpace<Scalar>::scalarProd(
const VectorBase<Scalar>& x, const VectorBase<Scalar>& y
) const
{
Teuchos::Tuple<Scalar,1> scalarProds_out;
this->scalarProds(x, y, scalarProds_out());
return scalarProds_out[0];
}
template<class Scalar>
void DefaultClusteredSpmdProductVectorSpace<Scalar>::scalarProdsImpl(
const MultiVectorBase<Scalar>& X, const MultiVectorBase<Scalar>& Y,
const ArrayView<Scalar> &scalarProds_out ) const
{
TEUCHOS_TEST_FOR_EXCEPTION(
!isEuclidean_, std::logic_error
,"Error, have not implemented support for none Euclidean scalar products yet!"
);
return dots(X, Y, scalarProds_out);
// ToDo:
// * Create DefaultClusteredSpmdProductMultiVector subclass
// * Cast X and Y this type
// * Accumulate the scalar products across all of the blocks in this cluster
// * Accumulate the full scalar products across all of the clusters
// using *interClusterComm
// * Broadcast the final scalar products to all of the processes in
// a cluster using *intraClusterComm
}
template<class Scalar>
bool DefaultClusteredSpmdProductVectorSpace<Scalar>::isEuclidean() const
{
return isEuclidean_;
}
template<class Scalar>
bool DefaultClusteredSpmdProductVectorSpace<Scalar>::hasInCoreView(
const Range1D& rng, const EViewType viewType, const EStrideType strideType
) const
{
return false; // ToDo: Figure this out for real!
}
template<class Scalar>
Teuchos::RCP< const VectorSpaceBase<Scalar> >
DefaultClusteredSpmdProductVectorSpace<Scalar>::clone() const
{
return Teuchos::rcp(new DefaultClusteredSpmdProductVectorSpace<Scalar>(*this));
}
// Protected overridden from ProductVectorSpaceBase
template<class Scalar>
int DefaultClusteredSpmdProductVectorSpace<Scalar>::numBlocks() const
{
return vecSpaces_.size();
}
template<class Scalar>
Teuchos::RCP<const VectorSpaceBase<Scalar> >
DefaultClusteredSpmdProductVectorSpace<Scalar>::getBlock(const int k) const
{
using Teuchos::implicit_cast;
TEUCHOS_TEST_FOR_EXCEPT( !( 0 <= k && k < implicit_cast<int>(vecSpaces_.size()) ) );
return vecSpaces_[k];
}
// Protected overridden from VectorSpaceBase
template<class Scalar>
Teuchos::RCP<VectorBase<Scalar> >
DefaultClusteredSpmdProductVectorSpace<Scalar>::createMember() const
{
using Teuchos::rcp;
return rcp(new DefaultClusteredSpmdProductVector<Scalar>(rcp(this,false),NULL));
}
template<class Scalar>
Teuchos::RCP<MultiVectorBase<Scalar> >
DefaultClusteredSpmdProductVectorSpace<Scalar>::createMembers(int numMembers) const
{
return VectorSpaceDefaultBase<Scalar>::createMembers(numMembers);
// ToDo: Provide an optimized multi-vector implementation when needed!
}
} // end namespace Thyra
#endif // THYRA_DEFAULT_CLUSTERED_SPMD_PRODUCT_VECTOR_SPACE_HPP
|