AbstractLinAlgPack_DirectSparseSolver.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

#ifndef ALAP_DIRECT_SPARSE_SOLVER_H
#define ALAP_DIRECT_SPARSE_SOLVER_H

#include "AbstractLinAlgPack_Types.hpp"
#include "AbstractLinAlgPack_MatrixConvertToSparse.hpp"
#include "AbstractLinAlgPack_MatrixNonsing.hpp"
#include "Teuchos_RCP.hpp"
#include "Teuchos_AbstractFactory.hpp"

namespace AbstractLinAlgPack {

class DirectSparseSolver {
public:


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

  class BasisMatrix : public AbstractLinAlgPack::MatrixNonsing {
  public:
    typedef Teuchos::RCP<FactorizationStructure>  fact_struc_ptr_t;
    virtual const fact_struc_ptr_t&  get_fact_struc() const = 0;
  };

  typedef Teuchos::RCP<
    const Teuchos::AbstractFactory<BasisMatrix> >   basis_matrix_factory_ptr_t;

  class UnsymmetricRankDeficientException : public std::logic_error
  {public: UnsymmetricRankDeficientException (const std::string& what_arg)
  : std::logic_error(what_arg) {}};

  class IncompatibleMatrixStructureException : public std::logic_error
  {public: IncompatibleMatrixStructureException (const std::string& what_arg)
  : std::logic_error(what_arg) {}};

  class InvalidObjectType : public std::logic_error
  {public: InvalidObjectType (const std::string& what_arg)
  : std::logic_error(what_arg) {}};

  class NoCurrentBasisException : public std::logic_error
  {public: NoCurrentBasisException (const std::string& what_arg)
  : std::logic_error(what_arg) {}};

  class FactorizationFailure : public std::logic_error
  {public: FactorizationFailure (const std::string& what_arg)
  : std::logic_error(what_arg) {}};

  
  virtual ~DirectSparseSolver() {}

  virtual const basis_matrix_factory_ptr_t basis_matrix_factory() const = 0;

  virtual void estimated_fillin_ratio( value_type estimated_fillin_ratio ) = 0;

  virtual void analyze_and_factor(
    const AbstractLinAlgPack::MatrixConvertToSparse   &A
    ,DenseLinAlgPack::IVector                            *row_perm
    ,DenseLinAlgPack::IVector                            *col_perm
    ,size_type                                      *rank
    ,BasisMatrix                                    *basis_matrix
    ,std::ostream                                   *out            = NULL
    ) = 0;
  
  virtual void factor(
    const AbstractLinAlgPack::MatrixConvertToSparse   &A
    ,BasisMatrix                                    *basis_matrix
    ,const BasisMatrix::fact_struc_ptr_t            &fact_struc    = Teuchos::null
    ,std::ostream                                   *out           = NULL
    ) = 0;

  virtual const BasisMatrix::fact_struc_ptr_t& get_fact_struc() const = 0;

  virtual void set_uninitialized() = 0;

};  // end class DirectSparseSolver 

} // end namespace AbstractLinAlgPack 

#endif  // ALAP_DIRECT_SPARSE_SOLVER_H