Thyra Version of the Day
Thyra_DefaultSpmdVectorSpace_decl.hpp
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 //    Thyra: Interfaces and Support for Abstract Numerical Algorithms
00005 //                 Copyright (2004) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 
00043 #ifndef THYRA_DEFAULT_SPMD_VECTOR_SPACE_DECL_HPP
00044 #define THYRA_DEFAULT_SPMD_VECTOR_SPACE_DECL_HPP
00045 
00046 
00047 #include "Thyra_SpmdVectorSpaceDefaultBase_decl.hpp"
00048 #include "Thyra_ProductVectorSpaceBase.hpp"
00049 
00050 
00051 namespace Thyra {
00052 
00053 
00068 template<class Scalar>
00069 class DefaultSpmdVectorSpace
00070   : public SpmdVectorSpaceDefaultBase<Scalar>
00071 {
00072 public:
00073 
00076 
00078   static RCP<DefaultSpmdVectorSpace<Scalar> > create();
00079 
00087   void initialize(const Ordinal dim);
00088 
00143   void initialize(
00144     const RCP<const Teuchos::Comm<Ordinal> > &comm,
00145     const Ordinal localSubDim, const Ordinal globalDim
00146     );
00147 
00156   void uninitialize();
00157 
00159 
00165   bool hasInCoreView(
00166     const Range1D& rng, const EViewType viewType, const EStrideType strideType
00167     ) const;
00169   RCP< const VectorSpaceBase<Scalar> > clone() const;
00171 
00172 protected:
00173 
00176 
00178   RCP<VectorBase<Scalar> >
00179   createMember() const;
00181   RCP<MultiVectorBase<Scalar> >
00182   createMembers(int numMembers) const;
00184   RCP<VectorBase<Scalar> >
00185   createMemberView( const RTOpPack::SubVectorView<Scalar> &raw_v ) const;
00187   RCP<const VectorBase<Scalar> >
00188   createMemberView( const RTOpPack::ConstSubVectorView<Scalar> &raw_v ) const;
00190   RCP<MultiVectorBase<Scalar> >
00191   createMembersView( const RTOpPack::SubMultiVectorView<Scalar> &raw_mv ) const;
00193   RCP<const MultiVectorBase<Scalar> >
00194   createMembersView( const RTOpPack::ConstSubMultiVectorView<Scalar> &raw_mv ) const;
00195 
00197 
00198 public:
00199 
00202 
00204   RCP<const Teuchos::Comm<Ordinal> > getComm() const;
00206   Ordinal localSubDim() const;
00207 
00209 
00210 private:
00211 
00212   // //////////////////////////////////////
00213   // Private data members
00214 
00215   RCP<const Teuchos::Comm<Ordinal> > comm_;
00216   Ordinal localSubDim_;
00217   int numProc_;
00218   int procRank_;
00219   RCP<DefaultSpmdVectorSpace<Scalar> > weakSelfPtr_;
00220 
00221   // /////////////////////////////////////
00222   // Private member functions
00223  
00224   DefaultSpmdVectorSpace();
00225 
00226 public:
00227 
00230 
00232   THYRA_DEPRECATED
00233   DefaultSpmdVectorSpace(
00234     const Ordinal dim
00235     );
00236 
00238   THYRA_DEPRECATED
00239   DefaultSpmdVectorSpace(
00240     const RCP<const Teuchos::Comm<Ordinal> > &comm,
00241     const Ordinal localSubDim, const Ordinal globalDim
00242     );
00243 
00245  
00246 }; // end class DefaultSpmdVectorSpace
00247 
00248 
00253 template<class Scalar>
00254 RCP<DefaultSpmdVectorSpace<Scalar> >
00255 defaultSpmdVectorSpace()
00256 {
00257   return DefaultSpmdVectorSpace<Scalar>::create();
00258 }
00259 
00260 
00265 template<class Scalar>
00266 RCP<DefaultSpmdVectorSpace<Scalar> >
00267 defaultSpmdVectorSpace( const Ordinal dim )
00268 {
00269   RCP<DefaultSpmdVectorSpace<Scalar> > vs =
00270     DefaultSpmdVectorSpace<Scalar>::create();
00271   vs->initialize(dim);
00272   return vs;
00273 }
00274 
00275 
00281 template<class Scalar>
00282 RCP<DefaultSpmdVectorSpace<Scalar> >
00283 defaultSpmdVectorSpace(
00284   const RCP<const Teuchos::Comm<Ordinal> > &comm,
00285   const Ordinal localSubDim, const Ordinal globalDim
00286   )
00287 {
00288   RCP<DefaultSpmdVectorSpace<Scalar> > vs =
00289     DefaultSpmdVectorSpace<Scalar>::create();
00290   vs->initialize(comm, localSubDim, globalDim);
00291   return vs;
00292 }
00293 
00294 
00295 } // end namespace Thyra
00296 
00297 
00298 #endif // THYRA_DEFAULT_SPMD_VECTOR_SPACE_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines