Thyra_VectorBase.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_BASE_DECL_HPP
#define THYRA_VECTOR_BASE_DECL_HPP


#include "Thyra_OperatorVectorTypes.hpp"
#include "Thyra_MultiVectorBase_decl.hpp"
#include "RTOpPack_RTOpT.hpp"
#include "RTOpPack_SparseSubVectorT.hpp"


namespace Thyra {


template<class Scalar>
class VectorBase : virtual public MultiVectorBase<Scalar>
{
public:

#ifdef THYRA_INJECT_USING_DECLARATIONS
  using MultiVectorBase<Scalar>::apply;
#endif


  // Overloading assign for VectorBase argument
  using MultiVectorBase<Scalar>::assign;

  void assign(const VectorBase<Scalar>& x)
    { assignVecImpl(x); }

  void randomize(Scalar l, Scalar u)
    { randomizeImpl(l,u); }

  // Overloading update for VectorBase argument.
  using MultiVectorBase<Scalar>::update;

  void update(
    Scalar alpha,
    const VectorBase<Scalar>& x)
    { updateVecImpl(alpha, x); }

  // Overloading linear_combination for VectorBase arguments.
  using MultiVectorBase<Scalar>::linear_combination;

  void linear_combination(
    const ArrayView<const Scalar>& alpha,
    const ArrayView<const Ptr<const VectorBase<Scalar> > >& x,
    const Scalar& beta
    )
    { linearCombinationVecImpl(alpha, x, beta); }

  Scalar dot(const VectorBase<Scalar>& x) const
    { return dotImpl(x); }

  typename Teuchos::ScalarTraits<Scalar>::magnitudeType
  norm_1() const
    { return norm1Impl(); }

  typename Teuchos::ScalarTraits<Scalar>::magnitudeType
  norm_2() const
    { return norm2Impl(); }

  typename Teuchos::ScalarTraits<Scalar>::magnitudeType
  norm_2(const VectorBase<Scalar>& x) const
    { return norm2WeightedImpl(x); }

  typename Teuchos::ScalarTraits<Scalar>::magnitudeType
  norm_inf() const
    { return normInfImpl(); }



  virtual RCP< const VectorSpaceBase<Scalar> > space() const = 0;



  void applyOp(
    const RTOpPack::RTOpT<Scalar> &op,
    const ArrayView<const Ptr<const VectorBase<Scalar> > > &vecs,
    const ArrayView<const Ptr<VectorBase<Scalar> > > &targ_vecs,
    const Ptr<RTOpPack::ReductTarget> &reduct_obj,
    const Ordinal global_offset
    ) const
    {
      applyOpImpl(op, vecs, targ_vecs, reduct_obj, global_offset);
    }



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



  void acquireDetachedView(
    const Range1D& rng, RTOpPack::ConstSubVectorView<Scalar>* sub_vec
    ) const
    { acquireDetachedVectorViewImpl(rng,sub_vec); }

  void releaseDetachedView(
    RTOpPack::ConstSubVectorView<Scalar>* sub_vec
    ) const
    { releaseDetachedVectorViewImpl(sub_vec); }

  void acquireDetachedView(
    const Range1D& rng, RTOpPack::SubVectorView<Scalar>* sub_vec
    )
    { acquireNonconstDetachedVectorViewImpl(rng,sub_vec); }

  void commitDetachedView(
    RTOpPack::SubVectorView<Scalar>* sub_vec
    )
    { commitNonconstDetachedVectorViewImpl(sub_vec); }

  void setSubVector(
    const RTOpPack::SparseSubVectorT<Scalar>& sub_vec
    )
    { setSubVectorImpl(sub_vec); }


protected:


  virtual void assignVecImpl(const VectorBase<Scalar>& x) = 0;

  virtual void randomizeImpl(Scalar l, Scalar u) = 0;

  virtual void absImpl(const VectorBase<Scalar>& x) = 0;

  virtual void reciprocalImpl(const VectorBase<Scalar>& x) = 0;

  virtual void eleWiseScaleImpl(const VectorBase<Scalar>& x) = 0;

  virtual void updateVecImpl(
    Scalar alpha,
    const VectorBase<Scalar>& x) = 0;

  virtual void linearCombinationVecImpl(
    const ArrayView<const Scalar>& alpha,
    const ArrayView<const Ptr<const VectorBase<Scalar> > >& x,
    const Scalar& beta
    ) = 0;

  virtual Scalar dotImpl(const VectorBase<Scalar>& x) const = 0;

  virtual typename Teuchos::ScalarTraits<Scalar>::magnitudeType
  norm1Impl() const = 0;

  virtual typename Teuchos::ScalarTraits<Scalar>::magnitudeType
  norm2Impl() const = 0;

  virtual typename Teuchos::ScalarTraits<Scalar>::magnitudeType
  norm2WeightedImpl(const VectorBase<Scalar>& x) const = 0;

  virtual typename Teuchos::ScalarTraits<Scalar>::magnitudeType
  normInfImpl() const = 0;

  virtual void applyOpImpl(
    const RTOpPack::RTOpT<Scalar> &op,
    const ArrayView<const Ptr<const VectorBase<Scalar> > > &vecs,
    const ArrayView<const Ptr<VectorBase<Scalar> > > &targ_vecs,
    const Ptr<RTOpPack::ReductTarget> &reduct_obj,
    const Ordinal global_offset
    ) const = 0;
  
  virtual void acquireDetachedVectorViewImpl(
    const Range1D& rng, RTOpPack::ConstSubVectorView<Scalar>* sub_vec
    ) const = 0;

  virtual void releaseDetachedVectorViewImpl(
    RTOpPack::ConstSubVectorView<Scalar>* sub_vec
    ) const = 0;

  virtual void acquireNonconstDetachedVectorViewImpl(
    const Range1D& rng, RTOpPack::SubVectorView<Scalar>* sub_vec
    ) = 0;

  virtual void commitNonconstDetachedVectorViewImpl(
    RTOpPack::SubVectorView<Scalar>* sub_vec
    ) = 0;

  virtual void setSubVectorImpl(
    const RTOpPack::SparseSubVectorT<Scalar>& sub_vec
    ) = 0;


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

public:

  // These are functions that may be removed in the future and should not be
  // called by client code.

  // Don't call this directly.  Use non-member Thyra::abs().  This is because
  // this member function may disappear in the future. (see Trilinos GitHub
  // issue #330)
  void abs(const VectorBase<Scalar>& x)
    { absImpl(x); }

  // Don't call this directly.  Use non-member Thyra::reciprocal().  This is because
  // this member function may disappear in the future. (see Trilinos GitHub
  // issue #330)
  void reciprocal(const VectorBase<Scalar>& x)
    { reciprocalImpl(x); }

  // Don't call this directly.  Use non-member Thyra::ele_wise_scale().  This
  // is because this member function may disappear in the future. (see
  // Trilinos GitHub issue #330)
  void ele_wise_scale(const VectorBase<Scalar>& x)
    { eleWiseScaleImpl(x); }

};


template<class Scalar>
inline
void applyOp(
  const RTOpPack::RTOpT<Scalar> &op,
  const ArrayView<const Ptr<const VectorBase<Scalar> > > &vecs,
  const ArrayView<const Ptr<VectorBase<Scalar> > > &targ_vecs,
  const Ptr<RTOpPack::ReductTarget> &reduct_obj,
  const Ordinal global_offset = 0
  )
{
  if (vecs.size())
    vecs[0]->applyOp(op, vecs, targ_vecs, reduct_obj, global_offset);
  else if (targ_vecs.size())
    targ_vecs[0]->applyOp(op, vecs, targ_vecs, reduct_obj, global_offset);
}


} // end namespace Thyra


#endif  // THYRA_VECTOR_BASE_DECL_HPP