AbstractLinAlgPack_DirectSparseSolverImp.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_IMP_H
#define ALAP_DIRECT_SPARSE_SOLVER_IMP_H

#include "AbstractLinAlgPack_DirectSparseSolver.hpp"
#include "AbstractLinAlgPack_VectorSpaceSerial.hpp"

namespace AbstractLinAlgPack {

class DirectSparseSolverImp;

class DirectSparseSolverImp : public DirectSparseSolver {
public:


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

  class BasisMatrixImp : public BasisMatrix {
  public:


    typedef Teuchos::RCP<FactorizationNonzeros> fact_nonzeros_ptr_t;



    virtual const fact_nonzeros_ptr_t&  get_fact_nonzeros() const;



    const VectorSpace& space_cols() const;
    const VectorSpace& space_rows() const;
    size_type rows() const;
    size_type cols() const;



    mat_mns_mut_ptr_t clone_mns();



    virtual const fact_struc_ptr_t&  get_fact_struc() const;


  protected:


    BasisMatrixImp();

    BasisMatrixImp(
      size_type                      dim
      ,const fact_struc_ptr_t        &fact_struc
      ,const fact_nonzeros_ptr_t     &fact_nonzeros
      );

    virtual void initialize(
      size_type                      dim
      ,const fact_struc_ptr_t        &fact_struc
      ,const fact_nonzeros_ptr_t     &fact_nonzeros
      );

    void set_uninitialized();



    virtual Teuchos::RCP<BasisMatrixImp> create_matrix() const = 0;


  private:

    friend class DirectSparseSolverImp;

#ifdef DOXYGEN_COMPILE
    FactorizationStructure    *fact_struc;
    FactorizationNonzeros     *fact_nonzeros;
#else
    size_type                 dim_;
    fact_struc_ptr_t          fact_struc_;
    fact_nonzeros_ptr_t       fact_nonzeros_;
    VectorSpaceSerial         vec_space_;
#endif

  }; // end class BasisMatrixImp



  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
    );
  void factor(
    const AbstractLinAlgPack::MatrixConvertToSparse   &A
    ,BasisMatrix                                    *basis_matrix
    ,const BasisMatrix::fact_struc_ptr_t            &fact_struc
    ,std::ostream                                   *out
    );
  const BasisMatrix::fact_struc_ptr_t& get_fact_struc() const;
  void set_uninitialized();


protected:


  virtual const Teuchos::RCP<FactorizationStructure> create_fact_struc() const = 0;

  virtual const Teuchos::RCP<FactorizationNonzeros> create_fact_nonzeros() const = 0;

  virtual void imp_analyze_and_factor(
    const AbstractLinAlgPack::MatrixConvertToSparse   &A
    ,FactorizationStructure                         *fact_struc
    ,FactorizationNonzeros                          *fact_nonzeros
    ,DenseLinAlgPack::IVector                            *row_perm
    ,DenseLinAlgPack::IVector                            *col_perm
    ,size_type                                      *rank
    ,std::ostream                                   *out            = NULL
    ) = 0;

  virtual void imp_factor(
    const AbstractLinAlgPack::MatrixConvertToSparse   &A
    ,const FactorizationStructure                   &fact_struc
    ,FactorizationNonzeros                          *fact_nonzeros
    ,std::ostream                                   *out            = NULL
    ) = 0;


private:

#ifdef DOXYGEN_COMPILE
    FactorizationStructure           *fact_struc;
#else
    BasisMatrix::fact_struc_ptr_t    fact_struc_;
    size_type                        rank_;
#endif

};  // end class DirectSparseSolverImp 

} // end namespace AbstractLinAlgPack 

#endif  // ALAP_DIRECT_SPARSE_SOLVER_IMP_H