Thyra_VectorSpaceBase_decl.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_VECTOR_SPACE_BASE_DECL_HPP
#define THYRA_VECTOR_SPACE_BASE_DECL_HPP

#include "Thyra_OperatorVectorTypes.hpp"
#include "Teuchos_Describable.hpp"


namespace Thyra {


template<class Scalar>
RCP<const VectorSpaceBase<Scalar> >
makeHaveOwnership( const RCP<const VectorSpaceBase<Scalar> > &vs );


template<class Scalar>
RCP< VectorBase<Scalar> >
createMember(
  const RCP<const VectorSpaceBase<Scalar> > &vs,
  const std::string &label=""
  );


template<class Scalar>
RCP< VectorBase<Scalar> >
createMember( const VectorSpaceBase<Scalar> &vs, const std::string &label="" );


template<class Scalar>
RCP< MultiVectorBase<Scalar> >
createMembers(
  const RCP<const VectorSpaceBase<Scalar> > &vs, int numMembers,
  const std::string &label=""
  );


template<class Scalar>
RCP< MultiVectorBase<Scalar> >
createMembers(
  const RCP<const VectorSpaceBase<Scalar> > &vs,
  const RCP<const VectorSpaceBase<Scalar> > &domain,
  const std::string &label=""
  );


template<class Scalar>
RCP< MultiVectorBase<Scalar> >
createMembers(
  const VectorSpaceBase<Scalar> &vs, int numMembers,
  const std::string &label=""
  );


template<class Scalar>
RCP<VectorBase<Scalar> >
createMemberView(
  const RCP<const VectorSpaceBase<Scalar> > &vs,
  const RTOpPack::SubVectorView<Scalar> &raw_v,
  const std::string &label=""
  );


template<class Scalar>
RCP<VectorBase<Scalar> >
createMemberView(
  const VectorSpaceBase<Scalar> &vs,
  const RTOpPack::SubVectorView<Scalar> &raw_v,
  const std::string &label=""
  );


template<class Scalar>
RCP<const VectorBase<Scalar> >
createMemberView(
  const RCP<const VectorSpaceBase<Scalar> > &vs,
  const RTOpPack::ConstSubVectorView<Scalar> &raw_v,
  const std::string &label=""
  );


template<class Scalar>
RCP<const VectorBase<Scalar> >
createMemberView(
  const VectorSpaceBase<Scalar> &vs,
  const RTOpPack::ConstSubVectorView<Scalar> &raw_v,
  const std::string &label=""
  );


template<class Scalar>
RCP<MultiVectorBase<Scalar> >
createMembersView(
  const RCP<const VectorSpaceBase<Scalar> > &vs,
  const RTOpPack::SubMultiVectorView<Scalar> &raw_mv,
  const std::string &label=""
  );


template<class Scalar>
RCP<MultiVectorBase<Scalar> >
createMembersView(
  const VectorSpaceBase<Scalar> &vs,
  const RTOpPack::SubMultiVectorView<Scalar> &raw_mv,
  const std::string &label=""
  );


template<class Scalar>
RCP<const MultiVectorBase<Scalar> >
createMembersView(
  const RCP<const VectorSpaceBase<Scalar> > &vs,
  const RTOpPack::ConstSubMultiVectorView<Scalar> &raw_mv,
  const std::string &label=""
  );


template<class Scalar>
RCP<const MultiVectorBase<Scalar> >
createMembersView(
  const VectorSpaceBase<Scalar> &vs,
  const RTOpPack::ConstSubMultiVectorView<Scalar> &raw_mv,
  const std::string &label=""
  );


template<class Scalar>
class VectorSpaceBase : virtual public Teuchos::Describable {
public:


  virtual Ordinal dim() const = 0;

  virtual bool isCompatible( const VectorSpaceBase<Scalar>& vecSpc ) const = 0;

  virtual RCP< const VectorSpaceFactoryBase<Scalar> > smallVecSpcFcty() const = 0;

  virtual Scalar scalarProd(
    const VectorBase<Scalar>& x, const VectorBase<Scalar>& y
    ) const = 0;

  void scalarProds(
    const MultiVectorBase<Scalar>& X, const MultiVectorBase<Scalar>& Y,
    const ArrayView<Scalar> &scalarProds_out
    ) const
    {
      scalarProdsImpl(X, Y, scalarProds_out);
    }



  virtual bool isEuclidean() const;

  virtual bool hasInCoreView(
    const Range1D &rng = Range1D(),
    const EViewType viewType = VIEW_TYPE_DETACHED,
    const EStrideType strideType = STRIDE_TYPE_NONUNIT
    ) const;

  virtual RCP< const VectorSpaceBase<Scalar> > clone() const;


#ifndef DOXYGEN_COMPILE

#ifndef TEMPLATE_FRIENDS_NOT_SUPPORTED


  friend RCP< VectorBase<Scalar> >
  createMember<>( 
    const RCP<const VectorSpaceBase<Scalar> > &vs,
    const std::string &label
    );

  friend RCP< MultiVectorBase<Scalar> >
  createMembers<>(
    const RCP<const VectorSpaceBase<Scalar> > &vs,
    int numMembers, const std::string &label
    );

  friend RCP<VectorBase<Scalar> >
  createMemberView<>(
    const RCP<const VectorSpaceBase<Scalar> > &vs,
    const RTOpPack::SubVectorView<Scalar> &raw_v,
    const std::string &label
    );

  friend RCP<const VectorBase<Scalar> >
  createMemberView<>(
    const RCP<const VectorSpaceBase<Scalar> > &vs,
    const RTOpPack::ConstSubVectorView<Scalar> &raw_v,
    const std::string &label
    );

  friend RCP<MultiVectorBase<Scalar> >
  createMembersView<>(
    const RCP<const VectorSpaceBase<Scalar> > &vs,
    const RTOpPack::SubMultiVectorView<Scalar> &raw_mv,
    const std::string &label
    );

  friend RCP<const MultiVectorBase<Scalar> >
  createMembersView<>(
    const RCP<const VectorSpaceBase<Scalar> > &vs,
    const RTOpPack::ConstSubMultiVectorView<Scalar> &raw_mv,
    const std::string &label
    );


#endif // DOXYGEN_COMPILE

#endif // TEMPLATE_FRIENDS_NOT_SUPPORTED

#ifndef TEMPLATE_FRIENDS_NOT_SUPPORTED
protected:
#endif


  virtual RCP< VectorBase<Scalar> > createMember() const = 0;

  virtual RCP< MultiVectorBase<Scalar> >
  createMembers(int numMembers) const = 0;

  virtual RCP<VectorBase<Scalar> >
  createMemberView( const RTOpPack::SubVectorView<Scalar> &raw_v ) const = 0;

  virtual RCP<const VectorBase<Scalar> >
  createMemberView( const RTOpPack::ConstSubVectorView<Scalar> &raw_v ) const = 0;

  virtual RCP<MultiVectorBase<Scalar> >
  createMembersView( const RTOpPack::SubMultiVectorView<Scalar> &raw_mv ) const = 0;

  virtual RCP<const MultiVectorBase<Scalar> >
  createMembersView(
    const RTOpPack::ConstSubMultiVectorView<Scalar> &raw_mv ) const = 0;


protected:

  virtual void scalarProdsImpl(
    const MultiVectorBase<Scalar>& X, const MultiVectorBase<Scalar>& Y,
    const ArrayView<Scalar> &scalarProds
    ) const = 0;

public:


  void scalarProds(
    const MultiVectorBase<Scalar>& X, const MultiVectorBase<Scalar>& Y,
    Scalar scalarProds[]
    ) const;


};


} // end namespace Thyra


#endif  // THYRA_VECTOR_SPACE_BASE_DECL_HPP

---