Thyra_DefaultSpmdMultiVectorDecl.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_Spmd_MULTI_VECTOR_STD_DECL_HPP
#define THYRA_Spmd_MULTI_VECTOR_STD_DECL_HPP

#include "Thyra_SpmdMultiVectorBaseDecl.hpp"

namespace Thyra {

template<class Scalar>
class DefaultSpmdMultiVector : virtual public SpmdMultiVectorBase<Scalar> {
public:

  using SpmdMultiVectorBase<Scalar>::subView;
  using SpmdMultiVectorBase<Scalar>::col;


  DefaultSpmdMultiVector();

  DefaultSpmdMultiVector(
    const Teuchos::RefCountPtr<const SpmdVectorSpaceBase<Scalar> >          &spmdRangeSpace
    ,const Teuchos::RefCountPtr<const ScalarProdVectorSpaceBase<Scalar> >   &domainSpace
    );

  DefaultSpmdMultiVector(
    const Teuchos::RefCountPtr<const SpmdVectorSpaceBase<Scalar> >          &spmdRangeSpace
    ,const Teuchos::RefCountPtr<const ScalarProdVectorSpaceBase<Scalar> >   &domainSpace
    ,const Teuchos::RefCountPtr<Scalar>                                     &localValues
    ,const Index                                                            leadingDim
    );

  void initialize(
    const Teuchos::RefCountPtr<const SpmdVectorSpaceBase<Scalar> >         &spmdRangeSpace
    ,const Teuchos::RefCountPtr<const ScalarProdVectorSpaceBase<Scalar> >  &domainSpace
    );

  void initialize(
    const Teuchos::RefCountPtr<const SpmdVectorSpaceBase<Scalar> >         &spmdRangeSpace
    ,const Teuchos::RefCountPtr<const ScalarProdVectorSpaceBase<Scalar> >  &domainSpace
    ,const Teuchos::RefCountPtr<Scalar>                                    &localValues
    ,const Index                                                           leadingDim
    );

  void uninitialize(
    Teuchos::RefCountPtr<const SpmdVectorSpaceBase<Scalar> >         *spmdRangeSpace = NULL
    ,Teuchos::RefCountPtr<const ScalarProdVectorSpaceBase<Scalar> >  *domainSpace    = NULL
    ,Teuchos::RefCountPtr<Scalar>                                    *localValues    = NULL
    ,Index                                                           *leadingDim     = NULL
    );


  std::string description() const;

  Teuchos::RefCountPtr< const ScalarProdVectorSpaceBase<Scalar> >
  domainScalarProdVecSpc() const;

  Teuchos::RefCountPtr<VectorBase<Scalar> > col(Index j);
  Teuchos::RefCountPtr<MultiVectorBase<Scalar> > subView( const Range1D& col_rng );
  Teuchos::RefCountPtr<const MultiVectorBase<Scalar> > subView(
    const int numCols, const int cols[]
    ) const;
  Teuchos::RefCountPtr<MultiVectorBase<Scalar> > subView(
    const int numCols, const int cols[]
    );


  Teuchos::RefCountPtr<const SpmdVectorSpaceBase<Scalar> > spmdSpace() const;
  void getLocalData( Scalar **localValues, Index *leadingDim );
  void commitLocalData( Scalar *localValues );
  void getLocalData( const Scalar **localValues, Index *leadingDim ) const;
  void freeLocalData( const Scalar *localValues ) const;
  
private:
  
  // ///////////////////////////////////////
  // Private data members

  Teuchos::RefCountPtr<const SpmdVectorSpaceBase<Scalar> >         spmdRangeSpace_;
  Teuchos::RefCountPtr<const ScalarProdVectorSpaceBase<Scalar> >   domainSpace_;
  Teuchos::RefCountPtr<Scalar>                                     localValues_;
  Index                                                            leadingDim_;
  
  // ///////////////////////////////////////
  // Private member functions

  Teuchos::RefCountPtr<Scalar> createContiguousCopy(
    const int numCols, const int cols[]
    ) const;
  
}; // end class DefaultSpmdMultiVector

} // end namespace Thyra

#endif // THYRA_Spmd_MULTI_VECTOR_STD_DECL_HPP

---