/usr/include/trilinos/Thyra_DefaultSpmdVectorSpaceFactory_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 | // @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_SPMD_VECTOR_SPACE_FACTORY_STD_DECL_HPP
#define THYRA_SPMD_VECTOR_SPACE_FACTORY_STD_DECL_HPP
#include "Thyra_VectorSpaceFactoryBase.hpp"
namespace Teuchos { template<typename Ordinal> class Comm; }
namespace Thyra {
/** \brief Concrete implementation of a vector-space factory for a
* locally-replicated distributed <tt>DefaultSpmdVectorSpace</tt> objects.
*
* This will create either serial independent (<tt>comm.get()==NULL</tt>) or
* locally replicated (<tt>comm.get()!=NULL</tt>) vector space objects (see
* <tt>createVecSpc()</tt>). The primary motivation for this subclass is to
* create locally replicated vector spaces for the domain space of
* <tt>DefaultSpmdMultiVector</tt>. In addition, an object of this type is
* also returned from <tt>SpmdVectorSpaceDefaultBase::smallVecSpcFtcy()</tt>.
*
* Note that the default constructor is not allowed to avoid mistakes in using
* this class.
*
* \ingroup Thyra_Op_Vec_adapters_Spmd_concrete_std_grp
*/
template<class Scalar>
class DefaultSpmdVectorSpaceFactory : public VectorSpaceFactoryBase<Scalar> {
public:
/** \brief Return the Spmd communicator. */
Teuchos::RCP<const Teuchos::Comm<Ordinal> > getComm() const;
/** @name Overridden from VectorSpaceFactoryBase */
//@{
/** \brief Create a new locally-replicated <tt>DefaultSpmdVectorSpace</tt>
* object given its dimension!
*
* \param dim
* [in] The dimension of the (locally replicated) vector space to create.
*
* This function returns:
\code
return defaultSpmdVectorSpace(this->getComm(), dim, dim)</tt>
\endcode
* and therefore <tt>return->dim()==dim</tt> and this implementation fully
* satisfies the specification of
* <tt>VectorSpaceFactoryBase::createVecSpc()</tt>.
*/
Teuchos::RCP<const VectorSpaceBase<Scalar> > createVecSpc(int dim) const;
//@}
private:
Teuchos::RCP<const Teuchos::Comm<Ordinal> > comm_;
public:
/** \brief Depreciated . */
DefaultSpmdVectorSpaceFactory(
const Teuchos::RCP<const Teuchos::Comm<Ordinal> > &comm = Teuchos::null
);
}; // end class DefaultSpmdVectorSpaceFactory
/** \brief Construct with a <tt>Teuchos::Comm</tt> object.
*
* \param comm [in] The communicator. This object must be maintained by the
* client the entire time that <tt>this</tt> is in use. It is allowed for
* <tt>comm.get()==NULL</tt>.
*
* Postconditions:<ul>
* <li><tt>returnVal->getComm().get() == comm.get()</tt>
* </ul>
*
* \relates DefaultSpmdVectorSpaceFactory
*/
template<class Scalar>
RCP<DefaultSpmdVectorSpaceFactory<Scalar> >
defaultSpmdVectorSpaceFactory(
const Teuchos::RCP<const Teuchos::Comm<Ordinal> > &comm = Teuchos::null
)
{
return Teuchos::rcp(new DefaultSpmdVectorSpaceFactory<Scalar>(comm));
}
// ///////////////////////////
// Inline members
template<class Scalar>
inline
Teuchos::RCP<const Teuchos::Comm<Ordinal> >
DefaultSpmdVectorSpaceFactory<Scalar>::getComm() const
{
return comm_;
}
} // end namespace Thyra
#endif // THYRA_SPMD_VECTOR_SPACE_FACTORY_STD_DECL_HPP
|