TSFRowAccessibleOp.hpp

Go to the documentation of this file.

/* @HEADER@ */
/* ***********************************************************************
// 
//           TSFExtended: Trilinos Solver Framework Extended
//                 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.
// 
// 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 Michael A. Heroux (maherou@sandia.gov) 
// 
// **********************************************************************/
/* @HEADER@ */

#ifndef TSFROWACCESSIBLEOP_HPP
#define TSFROWACCESSIBLEOP_HPP

#include "SundanceDefs.hpp"
#include "Teuchos_Array.hpp"

namespace TSFExtended
{
  /** 
   * Base interface for operators for which a row may be extracted.
   */
  template <class Scalar>
  class RowAccessibleOp 
  {
  public:
    /** Virtual dtor */
    virtual ~RowAccessibleOp(){;}

    /** 
     * Get the non-zero values in the row-th row.
     * @param row the index of the row
     * @param indices the column indices of the non-zero values in row row
     * @param values the non-zero values corresponding to the indices in indices
     */
    virtual void getRow(const int& row, 
      Teuchos::Array<int>& indices, 
      Teuchos::Array<Scalar>& values) const = 0;

  private:
    
    
  };
}

#endif