TSFEigensolver.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 TSFEIGENSOLVER_HPP
#define TSFEIGENSOLVER_HPP

#include "SundanceDefs.hpp"
#include "TSFVectorDecl.hpp" 
#include "TSFSolverState.hpp"
#include "Teuchos_ParameterList.hpp"
#include "TSFEigensolverBase.hpp"

namespace TSFExtended
{
using Teuchos::ParameterList;

/**
 * Handle class for eigensolvers
 */
template <class Scalar>
class Eigensolver : public Sundance::Handle<EigensolverBase<Scalar> >
{
public:
  /** */
  Eigensolver() : Handle<EigensolverBase<Scalar> >() {;}
  /** */
  Eigensolver( Sundance::Handleable<EigensolverBase<Scalar> >* rawPtr) 
    : Handle<EigensolverBase<Scalar> >(rawPtr) {;}
  /** */
  Eigensolver(const RCP<EigensolverBase<Scalar> >& smartPtr)
    : Handle<EigensolverBase<Scalar> >(smartPtr) {;}
  

  /** */
  void solve(
    const LinearOperator<Scalar>& K,
    const LinearOperator<Scalar>& M,
    Array<Vector<Scalar> >& ev,
    Array<std::complex<Scalar> >& ew) const 
    {
      this->ptr()->solve(K, M, ev, ew);
    }

  /** */
  void solve(
    const LinearOperator<Scalar>& K,
    Array<Vector<Scalar> >& ev,
    Array<std::complex<Scalar> >& ew) const 
    {
      this->ptr()->solve(K, ev, ew);
    }

  /** */
  const ParameterList& params() const 
    {
      TEST_FOR_EXCEPTION(this->ptr().get()==0, std::runtime_error,
                       "null pointer in Eigensolver::parameters()");
      return this->ptr()->params();
    }
  
  /** */
  ParameterList& params() 
    {
      TEST_FOR_EXCEPTION(this->ptr().get()==0, std::runtime_error,
                       "null pointer in Eigensolver::parameters()");
      return this->ptr()->params();
    }
  

  static FancyOStream& os()
    {
      return ObjectWithClassVerbosity<EigensolverBase<Scalar> >::os();
    }
};


  
}


#endif