AbstractLinAlgPack_SuperLUSolver.hpp

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

#ifdef SPARSE_SOLVER_PACK_USE_SUPERLU

#ifndef SSP_SUPERLU_SOLVER_H
#define SSP_SUPERLU_SOLVER_H

#include "Teuchos_RCP.hpp"

namespace SuperLUPack {

class SuperLUSolver {
public:


  class FactorizationStructure {
  public:
    virtual ~FactorizationStructure() {}
  };

  class FactorizationNonzeros {
  public:
    virtual ~FactorizationNonzeros() {}
  };


  virtual ~SuperLUSolver() {}


  static Teuchos::RCP<SuperLUSolver>                         create_solver();
  static Teuchos::RCP<SuperLUSolver::FactorizationStructure> create_fact_struct();
  static Teuchos::RCP<SuperLUSolver::FactorizationNonzeros>  create_fact_nonzeros();



  virtual void analyze_and_factor(
    int                         m
    ,int                        n
    ,int                        nz
    ,const double               a_val[]
    ,const int                  a_row_i[]
    ,const int                  a_col_ptr[]
    ,FactorizationStructure     *fact_struct
    ,FactorizationNonzeros      *fact_nonzeros
    ,int                        perm_r[]
    ,int                        perm_c[]
    ,int                        *rank
    ) = 0;
  
  virtual void factor(
    int                             m
    ,int                            n
    ,int                            nz
    ,const double                   a_val[]
    ,const int                      a_row_i[]
    ,const int                      a_col_ptr[]
    ,const FactorizationStructure   &fact_struct
    ,FactorizationNonzeros          *fact_nonzeros
    ) = 0;

  

  virtual void solve(
    const FactorizationStructure    &fact_struct
    ,const FactorizationNonzeros    &fact_nonzeros
    ,bool                           transp
    ,int                            n
    ,int                            nrhs
    ,double                         rhs[]
    ,int                            ldrhs
    ) const = 0;


}; // end class SuperLUSolver

} // end namespace SuperLUPack

#endif // SSP_SUPERLU_SOLVER_H

#endif // SPARSE_SOLVER_PACK_USE_SUPERLU