AnasaziEigenproblem.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//                 Anasazi: Block Eigensolvers Package
//                 Copyright 2004 Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// 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 Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER

#ifndef ANASAZI_EIGENPROBLEM_H
#define ANASAZI_EIGENPROBLEM_H

#include "AnasaziConfigDefs.hpp"
#include "AnasaziTypes.hpp"
#include "Teuchos_SerialDenseMatrix.hpp"
#include "Teuchos_RCP.hpp"


namespace Anasazi {
  
  template<class ScalarType, class MV, class OP>
  class Eigenproblem {

  public:


    
    Eigenproblem() {};
    
    virtual ~Eigenproblem() {};
    

    
    virtual void setOperator( const Teuchos::RCP<const OP> &Op ) = 0;

    virtual void setA( const Teuchos::RCP<const OP> &A ) = 0;

    virtual void setM( const Teuchos::RCP<const OP> &M ) = 0;

    virtual void setPrec( const Teuchos::RCP<const OP> &Prec ) = 0;

    virtual void setInitVec( const Teuchos::RCP<MV> &InitVec ) = 0; 

    virtual void setAuxVecs( const Teuchos::RCP<const MV> &AuxVecs ) = 0;

    virtual void setNEV( int nev ) = 0;

    virtual void setHermitian( bool isSym ) = 0;

    virtual bool setProblem() = 0;

    virtual void setSolution(const Eigensolution<ScalarType,MV> &sol) = 0;

    


    virtual Teuchos::RCP<const OP> getOperator() const = 0;

    virtual Teuchos::RCP<const OP> getA() const = 0;

    virtual Teuchos::RCP<const OP> getM() const = 0;

    virtual Teuchos::RCP<const OP> getPrec() const = 0;

    virtual Teuchos::RCP<const MV> getInitVec() const = 0;

    virtual Teuchos::RCP<const MV> getAuxVecs() const = 0;

    virtual int getNEV() const = 0;

    virtual bool isHermitian() const = 0;

    virtual bool isProblemSet() const = 0;

    virtual const Eigensolution<ScalarType,MV> & getSolution() const = 0;

  };
   
} // end Anasazi namespace
#endif

// end AnasaziEigenproblem.hpp