Thyra_VectorSpaceDecl.hpp

Go to the documentation of this file.
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 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 #ifndef THYRA_VECTORSPACE_DECL_HPP
00030 #define THYRA_VECTORSPACE_DECL_HPP
00031 
00032 #include "Teuchos_Handle.hpp"
00033 #include "Thyra_ConfigDefs.hpp"
00034 #include "Thyra_VectorSpaceBaseDecl.hpp"
00035 #include "Thyra_VectorBaseDecl.hpp"
00036 #include "Thyra_VectorDecl.hpp"
00037 
00038 namespace Thyra
00039 {
00040 
00045   template <class Scalar>
00046   class VectorSpace : public Teuchos::ConstHandle<VectorSpaceBase<Scalar> >
00047   {
00048   public:
00049     TEUCHOS_CONST_HANDLE_CTORS(VectorSpace<Scalar>, VectorSpaceBase<Scalar>);
00050 
00052     Vector<Scalar>  createMember() const ;
00053 
00062     Teuchos::RCP<MultiVectorBase<Scalar> > createMembers(int n) const ;
00063 
00065     int dim() const {return this->constPtr()->dim();}
00066 
00077     bool isCompatible(const VectorSpace<Scalar>& vecSpc) const; 
00078 
00080     bool isInCore() const {return this->constPtr()->isInCore();}
00081 
00083     bool operator==(const VectorSpace<Scalar>& other) const ;
00084 
00086     bool operator!=(const VectorSpace<Scalar>& other) const ;
00087 
00089     bool contains(const Vector<Scalar>& vec) const ;
00090 
00092     int numBlocks() const ;
00093 
00095     VectorSpace<Scalar> getBlock(int k) const ;
00096 
00098     void setBlock(int k, const VectorSpace<Scalar>& space);
00099 
00100   };
00101 
00106   template <class Scalar>
00107   Vector<Scalar> createMember( const VectorSpace<Scalar> &space )
00108   { return space.createMember(); }
00109 
00114   template <class Scalar>
00115   Teuchos::RCP<const VectorSpaceBase<Scalar> > 
00116   productSpace(const Teuchos::Array<VectorSpace<Scalar> >& spaces);
00117 
00122   template <class Scalar>
00123   Teuchos::RCP<const VectorSpaceBase<Scalar> > 
00124   productSpace(VectorSpace<Scalar>& s1);
00125 
00130   template <class Scalar>
00131   Teuchos::RCP<const VectorSpaceBase<Scalar> > 
00132   productSpace(VectorSpace<Scalar>& s1, 
00133                VectorSpace<Scalar>& s2);
00134 
00139   template <class Scalar>
00140   Teuchos::RCP<const VectorSpaceBase<Scalar> > 
00141   productSpace(VectorSpace<Scalar>& s1,VectorSpace<Scalar>& s2,
00142                VectorSpace<Scalar>& s3);
00143 
00154   template <class Scalar>
00155   int lowestLocallyOwnedIndex(const VectorSpace<Scalar>& s) ;
00156 
00167   template <class Scalar>
00168   int numLocalElements(const VectorSpace<Scalar>& s) ;
00169 
00174   template <class Scalar>
00175   bool indexIsLocal(const VectorSpace<Scalar>& s, Index i);
00176 
00181   template <class Scalar>
00182   bool isSPMD(const VectorSpace<Scalar>& s);
00183 
00184 }
00185 
00186 #endif

Generated on Tue Oct 20 12:47:27 2009 for Thyra Package Browser (Single Doxygen Collection) by doxygen 1.4.7