AbstractLinAlgPack_MatrixSymOpGetGMSSym.hpp

Go to the documentation of this file.

// @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.
// 
// 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 (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef MATRIX_SYM_WITH_OP_GET_GMS_SYM_H
#define MATRIX_SYM_WITH_OP_GET_GMS_SYM_H

#include "AbstractLinAlgPack_Types.hpp"
#include "AbstractLinAlgPack_MatrixSymOp.hpp"
#include "DenseLinAlgPack_DMatrixAsTriSym.hpp"
#include "Teuchos_dyn_cast.hpp"

namespace AbstractLinAlgPack {

class MatrixSymOpGetGMSSym
  : virtual public AbstractLinAlgPack::MatrixSymOp // doxygen needs full name
{
public:

  virtual const DenseLinAlgPack::DMatrixSliceSym get_sym_gms_view() const = 0;

  virtual void free_sym_gms_view(const DenseLinAlgPack::DMatrixSliceSym* sym_gms_view) const = 0;

}; // end class MatrixSymOpGetGMSSym

class MatrixDenseSymEncap {
public:

  MatrixDenseSymEncap( const MatrixSymOpGetGMSSym&  mat_get );
  MatrixDenseSymEncap( const MatrixSymOp& mat );
  ~MatrixDenseSymEncap();
  const DenseLinAlgPack::DMatrixSliceSym operator()() const;

private:

  const MatrixSymOpGetGMSSym     &mat_get_;
  const DenseLinAlgPack::DMatrixSliceSym          sym_gms_view_;
  MatrixDenseSymEncap();                                       // Not defined and not to be called!
  MatrixDenseSymEncap(const MatrixDenseSymEncap&);             // ""
  MatrixDenseSymEncap& operator=(const MatrixDenseSymEncap&);  // ""

}; // end class MatrixDenseSymEncap

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

// MatrixDenseSymEncap

inline
MatrixDenseSymEncap::MatrixDenseSymEncap( const MatrixSymOpGetGMSSym&  mat_get )
  :mat_get_(mat_get)
  ,sym_gms_view_(mat_get_.get_sym_gms_view())
{}

inline
MatrixDenseSymEncap::MatrixDenseSymEncap( const MatrixSymOp& mat )
  :mat_get_(Teuchos::dyn_cast<const MatrixSymOpGetGMSSym>(mat))
  ,sym_gms_view_(mat_get_.get_sym_gms_view())
{}

inline
MatrixDenseSymEncap::~MatrixDenseSymEncap()
{
  mat_get_.free_sym_gms_view(&sym_gms_view_);
}

inline
const DenseLinAlgPack::DMatrixSliceSym MatrixDenseSymEncap::operator()() const
{
  return sym_gms_view_;
}

} // end namespace AbstractLinAlgPack

#endif // MATRIX_SYM_WITH_OP_GET_GMS_SYM_H