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