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.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.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:

private:
  
  // Not defined and not to be called
  VectorSpaceBase<Scalar>&
  operator=(const VectorSpaceBase<Scalar>&);

};


} // end namespace Thyra


#endif  // THYRA_VECTOR_SPACE_BASE_DECL_HPP