Thyra_DefaultProductVectorDecl.hpp

// @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_PRODUCT_VECTOR_DECL_HPP
#define THYRA_PRODUCT_VECTOR_DECL_HPP

#include "Thyra_ProductVectorBase.hpp"
#include "Thyra_VectorDefaultBase.hpp"
#include "Teuchos_ConstNonconstObjectContainer.hpp"
#include "Teuchos_as.hpp"


namespace Thyra {


template <class Scalar> class DefaultProductVectorSpace;


template<class Scalar>
class DefaultProductVector
  : virtual public ProductVectorBase<Scalar>,
    virtual protected VectorDefaultBase<Scalar>
{
public:


  DefaultProductVector(
    const Teuchos::RCP<const DefaultProductVectorSpace<Scalar> >  &productSpace
    );

  DefaultProductVector(
    const Teuchos::RCP<const DefaultProductVectorSpace<Scalar> >  &productSpace
    ,const Teuchos::RCP<VectorBase<Scalar> >                      vecs[]
    );

  DefaultProductVector(
    const Teuchos::RCP<const DefaultProductVectorSpace<Scalar> >  &productSpace
    ,const Teuchos::RCP<const VectorBase<Scalar> >                vecs[]
    );

  void initialize(
    const Teuchos::RCP<const DefaultProductVectorSpace<Scalar> >  &productSpace
    );

  void initialize(
    const Teuchos::RCP<const DefaultProductVectorSpace<Scalar> >  &productSpace
    ,const Teuchos::RCP<VectorBase<Scalar> >                      vecs[]
    );

  void initialize(
    const Teuchos::RCP<const DefaultProductVectorSpace<Scalar> >  &productSpace
    ,const Teuchos::RCP<const VectorBase<Scalar> >                vecs[]
    );

  void uninitialize();


                                                
  std::string description() const;

  void describe(
    Teuchos::FancyOStream &out,
    const Teuchos::EVerbosityLevel verbLevel
    ) const;



  Teuchos::RCP<VectorBase<Scalar> > getNonconstVectorBlock(const int k); 
  Teuchos::RCP<const VectorBase<Scalar> > getVectorBlock(const int k) const;


  void setBlock(int i, const Teuchos::RCP<const VectorBase<Scalar> >& b); 
  void setNonconstBlock(int i, const Teuchos::RCP<VectorBase<Scalar> >& b); 


  Teuchos::RCP<const ProductVectorSpaceBase<Scalar> > productSpace() const;
  bool blockIsConst(const int k) const; 
  Teuchos::RCP<MultiVectorBase<Scalar> >
  getNonconstMultiVectorBlock(const int k);
  Teuchos::RCP<const MultiVectorBase<Scalar> >
  getMultiVectorBlock(const int k) const;



  Teuchos::RCP< const VectorSpaceBase<Scalar> > space() const;
  void applyOp(
    const RTOpPack::RTOpT<Scalar>    &op
    ,const int                       num_vecs
    ,const VectorBase<Scalar>*const  vecs[]
    ,const int                       num_targ_vecs
    ,VectorBase<Scalar>*const        targ_vecs[]
    ,RTOpPack::ReductTarget          *reduct_obj
    ,const Index                     first_ele
    ,const Index                     sub_dim
    ,const Index                     global_offset
    ) const;
  void acquireDetachedVectorViewImpl(
    const Range1D& rng, RTOpPack::ConstSubVectorView<Scalar>* sub_vec
    ) const;
  void releaseDetachedVectorViewImpl(
    RTOpPack::ConstSubVectorView<Scalar>* sub_vec
    ) const;
  void acquireNonconstDetachedVectorViewImpl(
    const Range1D& rng, RTOpPack::SubVectorView<Scalar>* sub_vec
    );
  void commitNonconstDetachedVectorViewImpl(
    RTOpPack::SubVectorView<Scalar>* sub_vec
    );
  void setSubVector(
    const RTOpPack::SparseSubVectorT<Scalar>& sub_vec
    );


private:

  // //////////////////////////////
  // Private types

  typedef Teuchos::ConstNonconstObjectContainer<VectorBase<Scalar> > CNVC;

  // //////////////////////////////
  // Private data members

  Teuchos::RCP<const DefaultProductVectorSpace<Scalar> >  productSpace_;
  Teuchos::Array<CNVC> vecs_;
  // cache
  int numBlocks_;

protected:

  // //////////////////////////////
  // Protected member functions

  // Added to allow TSFExtended DefaultProductVector to derive from this.
  DefaultProductVector();

};


template<class Scalar>
inline
Teuchos::RCP<DefaultProductVector<Scalar> >
defaultProductVector(
  const Teuchos::RCP<const DefaultProductVectorSpace<Scalar> > &productSpace
  )
{
  return Teuchos::rcp(
    new DefaultProductVector<Scalar>(productSpace)
    );
}


template<class Scalar>
Teuchos::RCP<DefaultProductVector<Scalar> >
defaultProductVector(
  const Teuchos::RCP<const DefaultProductVectorSpace<Scalar> > &productSpace,
  const Teuchos::RCP<VectorBase<Scalar> > vecs[]
  )
{
  return Teuchos::rcp(
    new DefaultProductVector<Scalar>(productSpace,vecs)
    );
}


template<class Scalar>
Teuchos::RCP<DefaultProductVector<Scalar> >
defaultProductVector(
  const Teuchos::RCP<const DefaultProductVectorSpace<Scalar> > &productSpace,
  const Teuchos::RCP<const VectorBase<Scalar> > vecs[]
  )
{
  return Teuchos::rcp(
    new DefaultProductVector<Scalar>(productSpace,vecs)
    );
}


template<class Scalar>
Teuchos::RCP<DefaultProductVector<Scalar> >
defaultProductVector(
  const Teuchos::RCP<const DefaultProductVectorSpace<Scalar> > &productSpace,
  const Teuchos::Array<Teuchos::RCP<const VectorBase<Scalar> > > &vecs
  )
{
#ifdef TEUCHOS_DEBUG
  TEST_FOR_EXCEPT( Teuchos::as<int>(vecs.size()) != productSpace->numBlocks() );
#endif
  return defaultProductVector(productSpace,&vecs[0]);
}


} // namespace Thyra


#endif // THYRA_PRODUCT_VECTOR_DECL_HPP

---