Amesos2_Solver_decl.hpp

Go to the documentation of this file.

// @HEADER
//
// ***********************************************************************
//
//           Amesos2: Templated Direct Sparse Solver Package
//                  Copyright 2011 Sandia Corporation
//
// Under the 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 AMESOS2_SOLVER_DECL_HPP
#define AMESOS2_SOLVER_DECL_HPP

#include <Teuchos_Describable.hpp>
#include <Teuchos_ParameterList.hpp>
#include <Teuchos_RCP.hpp>
#include <Teuchos_Comm.hpp>

#include "Amesos2_TypeDecl.hpp"
#include "Amesos2_Status.hpp"

namespace Amesos2 {


  template <class Matrix, class Vector>
  class Solver : public Teuchos::Describable {

  public:

    typedef Solver<Matrix,Vector> type;



    virtual type& preOrdering( void ) = 0;


    virtual type& symbolicFactorization( void ) = 0;


    virtual type& numericFactorization( void ) = 0;


    virtual void solve( void ) = 0;


    virtual void solve(const Teuchos::Ptr<Vector>       X,
           const Teuchos::Ptr<const Vector> B) const = 0;


    virtual void solve(Vector* X, const Vector* B) const = 0;


    virtual type& setParameters( const Teuchos::RCP<Teuchos::ParameterList> & parameterList ) = 0;


    virtual Teuchos::RCP<const Teuchos::ParameterList> getValidParameters( void ) const = 0;



    virtual void setA( const Teuchos::RCP<const Matrix> a, EPhase keep_phase = CLEAN ) = 0;

    virtual void setA( const Matrix* a, EPhase keep_phase = CLEAN ) = 0;
    

    virtual bool matrixShapeOK( void ) = 0;


    virtual void setX( const Teuchos::RCP<Vector> x ) = 0;


    virtual void setX( Vector* x ) = 0;


    virtual const Teuchos::RCP<Vector> getX( void ) = 0;


    virtual Vector* getXRaw( void ) = 0;


    virtual void setB( const Teuchos::RCP<const Vector> b ) = 0;


    virtual void setB( const Vector* b ) = 0;


    virtual const Teuchos::RCP<const Vector> getB( void ) = 0;


    virtual const Vector* getBRaw( void ) = 0;


    virtual Teuchos::RCP<const Teuchos::Comm<int> > getComm( void ) const = 0;


    virtual Status& getStatus() const = 0;


    virtual std::string name( void ) const = 0;



    virtual std::string description( void ) const = 0;


    virtual void describe( Teuchos::FancyOStream &out,
         const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default ) const = 0;



    virtual void printTiming( Teuchos::FancyOStream &out,
            const Teuchos::EVerbosityLevel verbLevel = Teuchos::Describable::verbLevel_default ) const = 0;


    virtual void getTiming( Teuchos::ParameterList& timingParameterList ) const = 0;


  };                              // End class Solver


} // end namespace Amesos2

#endif  // AMESOS2_SOLVER_BASE_DECL_HPP