libtrilinos-dev 10.4.0.dfsg-1ubuntu2 / usr / include / trilinos / AbstractLinAlgPack_MultiVectorMutableThyra.hpp

// @HEADER
// ***********************************************************************
// 
// Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
//                  Copyright (2003) 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 Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef ALAP_MULTI_VECTOR_MUTABLE_Thyra_HPP
#define ALAP_MULTI_VECTOR_MUTABLE_Thyra_HPP

#include "AbstractLinAlgPack_MultiVectorMutable.hpp"
#include "AbstractLinAlgPack_MatrixOpThyra.hpp"
#include "Thyra_MultiVectorBase.hpp"

namespace AbstractLinAlgPack {

/** \brief <tt>MultiVectorMutable</tt> adapter subclass for <tt>Thyra::MultiVectorBase</tt>.
 */
class MultiVectorMutableThyra
  :virtual public MultiVectorMutable
  ,virtual public MatrixOpThyra
{
public:

  /** @name Constructors / Initializers */
  //@{

  /** \brief Construct to uninitialized.
   *
   * Postconditioins:<ul>
   * <li><tt>this->thyra_vec().get() == NULL</tt>
   * <li>See the post conditions for <tt>MatrixOpThyra::MatrixOpThyra()</tt>
   * </ul>
   */
  MultiVectorMutableThyra();
  /** \brief Calls <tt>this->initialize()</tt>.
   */
  MultiVectorMutableThyra( const Teuchos::RCP<Thyra::MultiVectorBase<value_type> >& thyra_multi_vec );
  /** \brief Initalize given a smart pointer to a <tt>Thyra::MultiVectorBase</tt> object.
   *
   * @param  thyra_multi_vec  [in] Smart pointer to Thyra vector <tt>this</tt> will adapt.
   *
   * Preconditioins:<ul>
   * <li><tt>thyra_multi_vec.get() != NULL</tt> (throw <tt>std::invalid_argument</tt>)
   * </ul>
   *
   * Postconditioins:<ul>
   * <li><tt>this->thyra_multi_vec().get() == thyra_multi_vec.get()</tt>
   * <li>See the post conditions for <tt>MatrixOpThyra::initialize()</tt>
   * </ul>
   */
  void initialize( const Teuchos::RCP<Thyra::MultiVectorBase<value_type> >& thyra_multi_vec );
  /** \brief Set to uninitialized and return smart pointer to the internal <tt>Thyra::LinearOpBase</tt> object.
   *
   * Postconditioins:<ul>
   * <li><tt>this->thyra_multi_vec().get() == NULL</tt>
   * </ul>
   *
   * Note that his nonvirtual function hides the nonvirtual function
   * <tt>MatrixOpThyra::set_uninitialized()</tt>.
   */
  Teuchos::RCP<Thyra::MultiVectorBase<value_type> > set_uninitialized();
  /** \brief Return a smart pointer to the internal <tt>Thyra::LinearOpBase</tt> object.
   */
  Teuchos::RCP<const Thyra::MultiVectorBase<value_type> > thyra_multi_vec() const;

  //@}

  /** @name Overridden from MatrixOpThyra */
  //@{

  /// Performs a const_cast<> and dynamic_cast<> and passes on to <tt>this->initialize()</tt>.
  void initialize( const Teuchos::RCP<const Thyra::LinearOpBase<value_type> >& thyra_linear_op );

  //@}

  /** @name Overridden from MatrixOp */
  //@{

  /// Overridden to call <tt>MatrixOpThyra::clone()</tt>
  mat_mut_ptr_t clone();
  /// Overridden to call <tt>MultiVectorMutable::operator=()</tt>
  MatrixOp& operator=(const MatrixOp& mwo_rhs);
  /// Overridden to call <tt>MatrixOpThyra::Vp_StMtV()</tt>
  void Vp_StMtV(
    VectorMutable* v_lhs, value_type alpha, BLAS_Cpp::Transp trans_rhs1
    ,const Vector& v_rhs2, value_type beta
    ) const;
  /// Overridden to call <tt>MatrixOpThyra::Mp_StMtM()</tt>
  bool Mp_StMtM(
    MatrixOp* mwo_lhs, value_type alpha
    ,BLAS_Cpp::Transp trans_rhs1
    ,const MatrixOp& mwo_rhs2, BLAS_Cpp::Transp trans_rhs2
    ,value_type beta
    ) const;

  //@}

  /** @name Overridden from MultiVector */
  //@{

  ///  Returns <tt>COL_ACCESS</tt>
  access_by_t access_by() const;
  /** \brief . */
  void apply_op(
    EApplyBy apply_by, const RTOpPack::RTOp& primary_op
    ,const size_t num_multi_vecs,      const MultiVector*   multi_vecs[]
    ,const size_t num_targ_multi_vecs, MultiVectorMutable*  targ_multi_vecs[]
    ,RTOpPack::ReductTarget* reduct_objs[]
    ,const index_type primary_first_ele,   const index_type primary_sub_dim, const index_type primary_global_offset
    ,const index_type secondary_first_ele, const index_type secondary_sub_dim
    ) const;
  /** \brief . */
  void apply_op(
    EApplyBy apply_by, const RTOpPack::RTOp& primary_op, const RTOpPack::RTOp& secondary_op
    ,const size_t num_multi_vecs,      const MultiVector*   multi_vecs[]
    ,const size_t num_targ_multi_vecs, MultiVectorMutable*  targ_multi_vecs[]
    ,RTOpPack::ReductTarget *reduct_obj
    ,const index_type primary_first_ele, const index_type primary_sub_dim, const index_type primary_global_offset
    ,const index_type secondary_first_ele, const index_type secondary_sub_dim
    ) const;

  //@}

  /** @name Overridden from MultiVectorMutable */
  //@{

  /** \brief . */
  vec_mut_ptr_t col(index_type j);
  /// <tt>return.get()==NULL</tt>
  vec_mut_ptr_t row(index_type i);
  /// <tt>return.get()==NULL</tt>
  vec_mut_ptr_t diag(int k);
  /** \brief . */
  multi_vec_mut_ptr_t mv_sub_view(const Range1D& row_rng, const Range1D& col_rng);

  //@}

private:

  /** \brief . */
  Teuchos::RCP<Thyra::MultiVectorBase<value_type> > cast_thyra_multi_vec();
  
}; // end class MultiVectorMutableThyra

} // end namespace AbstractLinAlgPack

#endif // ALAP_MULTI_VECTOR_MUTABLE_Thyra_HPP