Amesos2_Lapack_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_LAPACK_DECL_HPP
#define AMESOS2_LAPACK_DECL_HPP
 
#include <Teuchos_ScalarTraits.hpp>
#include <Teuchos_SerialDenseSolver.hpp>
#include <Teuchos_SerialDenseMatrix.hpp>
 
#include "Amesos2_SolverTraits.hpp"
#include "Amesos2_SolverCore.hpp"
 
 
namespace Amesos2 {
 

  template <class Matrix,
      class Vector>
  class Lapack : public SolverCore<Amesos2::Lapack, Matrix, Vector> 
  {
    friend class SolverCore<Amesos2::Lapack,Matrix,Vector>; // Give our base access
                                                            // to our private
                                                            // implementation funcs
  public:

    static const char* name;  // declaration. Initialization outside.
 
    typedef Lapack<Matrix,Vector>                                                type;
    typedef SolverCore<Amesos2::Lapack,Matrix,Vector>                      super_type;
 
    // Since typedef's are not inheritted, go grab them
    typedef typename super_type::scalar_type                              scalar_type;
    typedef typename super_type::local_ordinal_type                local_ordinal_type;
    typedef typename super_type::global_ordinal_type              global_ordinal_type;
    typedef typename super_type::global_size_type                    global_size_type;
 
    // Version of scalar type that can be used in Kokkos device code
    typedef typename MatrixTraits<Matrix>::impl_scalar_type          impl_scalar_type;
 
    typedef typename Teuchos::ScalarTraits<scalar_type>::magnitudeType magnitude_type;
 
    typedef Kokkos::DefaultHostExecutionSpace              HostExecSpaceType;
    typedef Kokkos::View<int*, HostExecSpaceType>          host_size_type_array;
    typedef Kokkos::View<int*, HostExecSpaceType>          host_ordinal_type_array;
    typedef Kokkos::View<impl_scalar_type*, HostExecSpaceType>  host_value_type_array;



    Lapack(Teuchos::RCP<const Matrix> A,
     Teuchos::RCP<Vector>       X,
     Teuchos::RCP<const Vector> B);
    

    ~Lapack( );

 
  private:
  
    int preOrdering_impl();
 

    int symbolicFactorization_impl();
 

    int numericFactorization_impl();
 

    int solve_impl(const Teuchos::Ptr<MultiVecAdapter<Vector> >       X,
       const Teuchos::Ptr<const MultiVecAdapter<Vector> > B) const;
 

    bool matrixShapeOK_impl() const;
 

    void setParameters_impl(const Teuchos::RCP<Teuchos::ParameterList> & parameterList );
 
  
    Teuchos::RCP<const Teuchos::ParameterList> getValidParameters_impl() const;
 

    bool loadA_impl(EPhase current_phase);
 
 
    // We keep some `temporary' storage for when we retrive values
    // from the input matrix
    //
    // NOTE:: It seems that the Teuchos::LAPACK wrappers only really
    // work for the OrdinalType=int case, so that's what we'll work
    // with, but ideally we should just be able to give
    // global_ordinal_type.

    Teuchos::Array<scalar_type> nzvals_;
    // Teuchos::Array<global_ordinal_type> rowind_;
    Teuchos::Array<int> rowind_;
    // Teuchos::Array<global_size_type> colptr_;
    Teuchos::Array<int> colptr_;
    mutable Teuchos::Array<scalar_type> rhsvals_;
 
    // The following Kokkos::View's are persisting storage for A's CCS arrays
    host_value_type_array nzvals_view_;
    host_ordinal_type_array rowind_view_;
    host_size_type_array colptr_view_;

    // Teuchos::SerialDenseMatrix<global_ordinal_type,scalar_type> lu_;
    Teuchos::SerialDenseMatrix<int,scalar_type> lu_;

    // Teuchos::SerialDenseSolver<global_ordinal_type,scalar_type> solver_;
    mutable Teuchos::SerialDenseSolver<int,scalar_type> solver_;
 
    bool is_contiguous_;
 
  };                              // End class Lapack
 
  
  // Specialize the solver_traits struct for Lapack.
  //
  // Specializations of Teuchos::LAPACK only exist for real and
  // complex float and double types.
  //
  // TODO: Reinstate the complex support once the bug in
  // Teuchos::SerialDenseSolver has been fixed
  template <>
  struct solver_traits<Lapack> {
// #ifdef HAVE_TEUCHOS_COMPLEX
//     typedef Meta::make_list4<float,
//           double,
//           std::complex<float>,
//           std::complex<double> >supported_scalars;
// #else
    typedef Meta::make_list2<float, double> supported_scalars;
// #endif
};
  
} // end namespace Amesos2
 
#endif  // AMESOS2_NEWSOLVER_DECL_HPP