Thyra_VectorSpaceDecl.hpp

Go to the documentation of this file.

// @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.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef THYRA_VECTORSPACE_DECL_HPP
#define THYRA_VECTORSPACE_DECL_HPP

#include "Teuchos_Handle.hpp"
#include "Thyra_ConfigDefs.hpp"
#include "Thyra_VectorSpaceBaseDecl.hpp"
#include "Thyra_VectorBaseDecl.hpp"
#include "Thyra_VectorDecl.hpp"

namespace Thyra
{

  template <class Scalar>
  class VectorSpace : public Teuchos::ConstHandle<VectorSpaceBase<Scalar> >
  {
  public:
    TEUCHOS_CONST_HANDLE_CTORS(VectorSpace<Scalar>, VectorSpaceBase<Scalar>);

    Vector<Scalar>  createMember() const ;

    Teuchos::RefCountPtr<MultiVectorBase<Scalar> > createMembers(int n) const ;

    int dim() const {return this->constPtr()->dim();}

    bool isCompatible(const VectorSpace<Scalar>& vecSpc) const; 

    bool isInCore() const {return this->constPtr()->isInCore();}

    bool operator==(const VectorSpace<Scalar>& other) const ;

    bool operator!=(const VectorSpace<Scalar>& other) const ;

    bool contains(const Vector<Scalar>& vec) const ;

    int numBlocks() const ;

    VectorSpace<Scalar> getBlock(int k) const ;

    void setBlock(int k, const VectorSpace<Scalar>& space);

  };

  template <class Scalar>
  Vector<Scalar> createMember( const VectorSpace<Scalar> &space )
  { return space.createMember(); }

  template <class Scalar>
  Teuchos::RefCountPtr<const VectorSpaceBase<Scalar> > 
  productSpace(const Teuchos::Array<VectorSpace<Scalar> >& spaces);

  template <class Scalar>
  Teuchos::RefCountPtr<const VectorSpaceBase<Scalar> > 
  productSpace(VectorSpace<Scalar>& s1);

  template <class Scalar>
  Teuchos::RefCountPtr<const VectorSpaceBase<Scalar> > 
  productSpace(VectorSpace<Scalar>& s1, 
               VectorSpace<Scalar>& s2);

  template <class Scalar>
  Teuchos::RefCountPtr<const VectorSpaceBase<Scalar> > 
  productSpace(VectorSpace<Scalar>& s1,VectorSpace<Scalar>& s2,
               VectorSpace<Scalar>& s3);

  template <class Scalar>
  int lowestLocallyOwnedIndex(const VectorSpace<Scalar>& s) ;

  template <class Scalar>
  int numLocalElements(const VectorSpace<Scalar>& s) ;

  template <class Scalar>
  bool indexIsLocal(const VectorSpace<Scalar>& s, Index i);

  template <class Scalar>
  bool isSPMD(const VectorSpace<Scalar>& s);

}

#endif

---