AbstractLinAlgPack_MatrixOpGetGMS.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 MATRIX_WITH_OP_GET_GMS_H
#define MATRIX_WITH_OP_GET_GMS_H

#include "AbstractLinAlgPack_Types.hpp"
#include "AbstractLinAlgPack_MatrixOp.hpp"
#include "DenseLinAlgPack_DMatrixClass.hpp"
#include "Teuchos_dyn_cast.hpp"

namespace AbstractLinAlgPack {

class MatrixOpGetGMS 
  : virtual public AbstractLinAlgPack::MatrixOp // doxygen needs full path
{
public:

  virtual const DMatrixSlice get_gms_view() const = 0;

  virtual void free_gms_view(const DMatrixSlice* gms_view) const = 0;

}; // end class MatrixOpGetGMS

class MatrixDenseEncap {
public:

  MatrixDenseEncap( const MatrixOpGetGMS&  mat_get );
  MatrixDenseEncap( const MatrixOp& mat );
  ~MatrixDenseEncap();
  const DMatrixSlice operator()() const;

private:

  const MatrixOpGetGMS     &mat_get_;
  const DMatrixSlice         gms_view_;
  MatrixDenseEncap();                                      // Not defined and not to be called!
  MatrixDenseEncap(const MatrixDenseEncap&);               // ""
  MatrixDenseEncap& operator=(const MatrixDenseEncap&);    // ""

}; // end class MatrixDenseEncap

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

// MatrixDenseEncap

inline
MatrixDenseEncap::MatrixDenseEncap( const MatrixOpGetGMS&  mat_get )
  :mat_get_(mat_get)
  ,gms_view_(mat_get_.get_gms_view())
{}

inline
MatrixDenseEncap::MatrixDenseEncap( const MatrixOp& mat )
  :mat_get_(Teuchos::dyn_cast<const MatrixOpGetGMS>(mat))
  ,gms_view_(mat_get_.get_gms_view())
{}

inline
MatrixDenseEncap::~MatrixDenseEncap()
{
  mat_get_.free_gms_view(&gms_view_);
}

inline
const DMatrixSlice MatrixDenseEncap::operator()() const
{
  return gms_view_;
}

} // end namespace AbstractLinAlgPack

#endif // MATRIX_WITH_OP_GET_GMS_H