Thyra_DefaultProductVectorSpaceDecl.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_SPACE_DECL_HPP
#define THYRA_PRODUCT_VECTOR_SPACE_DECL_HPP

#include "Thyra_ProductVectorSpaceBase.hpp"
#include "Thyra_VectorSpaceDefaultBase.hpp"
#include "Teuchos_implicit_cast.hpp"

namespace Thyra {

template<class Scalar>
class DefaultProductVectorSpace
  : virtual public ProductVectorSpaceBase<Scalar>
  , virtual protected VectorSpaceDefaultBase<Scalar>
{
public:


  DefaultProductVectorSpace(
    const int                                                       numBlocks
    ,const Teuchos::RCP<const VectorSpaceBase<Scalar> >     vecSpaces[]
    );
  
  virtual void initialize(
    const int                                                       numBlocks
    ,const Teuchos::RCP<const VectorSpaceBase<Scalar> >     vecSpaces[]
    );

  bool hasBeenCloned() const;

  virtual void uninitialize(
    int                                                             *numBlocks  = NULL
    ,Teuchos::RCP<const VectorSpaceBase<Scalar> >           vecSpaces[] = NULL
    );

  virtual const Teuchos::RCP<const VectorSpaceBase<Scalar> >* vecSpaces() const;

  virtual const Index* vecSpacesOffsets() const;

  void getVecSpcPoss( Index i, int* kth_vector_space, Index* kth_global_offset ) const;
  


  int numBlocks() const;
  Teuchos::RCP<const VectorSpaceBase<Scalar> > getBlock(const int k) const; 



  Index dim() const;
  bool isCompatible( const VectorSpaceBase<Scalar>& vecSpc ) const;
  Teuchos::RCP< VectorBase<Scalar> > createMember() const;
  Scalar scalarProd( const VectorBase<Scalar>& x, const VectorBase<Scalar>& y ) const;
  void scalarProds( const MultiVectorBase<Scalar>& X, const MultiVectorBase<Scalar>& Y, Scalar scalar_prods[] ) const;
  bool hasInCoreView(const Range1D& rng, const EViewType viewType, const EStrideType strideType) const;
  Teuchos::RCP< const VectorSpaceFactoryBase<Scalar> > smallVecSpcFcty() const;
  Teuchos::RCP< MultiVectorBase<Scalar> > createMembers(int numMembers) const;
  Teuchos::RCP< const VectorSpaceBase<Scalar> > clone() const;


                                                
  std::string description() const;

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

  
protected:

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

  DefaultProductVectorSpace() : numBlocks_(0), dim_(0) {}

private:
 
  // ///////////////////////////////////
  // Private types

  typedef Teuchos::Array<Teuchos::RCP<const VectorSpaceBase<Scalar> > > vecSpaces_t;
  typedef Teuchos::Array<Index> vecSpacesOffsets_t;
 
  // ///////////////////////////////////
  // Private data members

  int                                        numBlocks_;
  Teuchos::RCP<vecSpaces_t>          vecSpaces_;
  Teuchos::RCP<vecSpacesOffsets_t>   vecSpacesOffsets_;
  // cached info
  Index                                      dim_;
  bool                                       isInCore_;

  // ///////////////////////////////////
  // Private member functions

  void assertInitialized() const;

};


template<class Scalar>
inline
Teuchos::RCP<DefaultProductVectorSpace<Scalar> >
productVectorSpace(
  const Teuchos::Array<Teuchos::RCP<const VectorSpaceBase<Scalar> > > &vecSpaces
  )
{
  return Teuchos::rcp(
    new DefaultProductVectorSpace<Scalar>(vecSpaces.size(),&vecSpaces[0])
    );
}


template<class Scalar>
inline
Teuchos::RCP<DefaultProductVectorSpace<Scalar> >
productVectorSpace(
  const Teuchos::RCP<const VectorSpaceBase<Scalar> > &vecSpace,
  const int numBlocks
  )
{
  using Teuchos::Array;
  using Teuchos::RCP;
  Array<RCP<const VectorSpaceBase<Scalar> > > vecSpaceBlocks;
  for ( int i = 0; i < numBlocks; ++i )
    vecSpaceBlocks.push_back(vecSpace);
  return productVectorSpace(vecSpaceBlocks);
}


// /////////////////////////////////
// Inline members

template<class Scalar>
inline const Teuchos::RCP<const VectorSpaceBase<Scalar> >*
DefaultProductVectorSpace<Scalar>::vecSpaces() const
{
  return ( dim_ ? &(*vecSpaces_)[0] : NULL );
}

template<class Scalar>
inline const Index* DefaultProductVectorSpace<Scalar>::vecSpacesOffsets() const
{
  return ( dim_ ? &(*vecSpacesOffsets_)[0] : NULL );
}

template<class Scalar>
inline bool DefaultProductVectorSpace<Scalar>::hasBeenCloned() const
{
  return vecSpaces_.count() > 1;
}

template<class Scalar>
inline
void DefaultProductVectorSpace<Scalar>::assertInitialized() const
{
  using Teuchos::implicit_cast;
#ifdef TEUCHOS_DEBUG
  TEST_FOR_EXCEPT( is_null(vecSpaces_) );
#endif
}

} // namespace Thyra

#endif // THYRA_PRODUCT_VECTOR_SPACE_DECL_HPP

---