Amesos2_PardisoMKL_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_PARDISOMKL_DECL_HPP
#define AMESOS2_PARDISOMKL_DECL_HPP

#include <map>

#include <Teuchos_StandardParameterEntryValidators.hpp>

#include "Amesos2_SolverTraits.hpp"
#include "Amesos2_SolverCore.hpp"
#include "Amesos2_PardisoMKL_FunctionMap.hpp"


namespace Amesos2 {


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

    static const char* name;    // declaration. Initialization outside.

    typedef PardisoMKL<Matrix,Vector>                                       type;
    typedef SolverCore<Amesos2::PardisoMKL,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;

    typedef TypeMap<Amesos2::PardisoMKL,scalar_type>                    type_map;

    typedef typename type_map::type                           solver_scalar_type;
    typedef typename type_map::magnitude_type              solver_magnitude_type;

    // This may be PMKL::_INTEGER_t or long long int depending on the
    // mapping and input ordinal
    typedef typename TypeMap<Amesos2::PardisoMKL,local_ordinal_type>::type int_t;

    /* For PardisoMKL we dispatch based on the integer type instead of
     * the scalar type:
     *   - _INTEGER_t    => use the pardiso(...)    method
     *   - long long int => use the pardiso_64(...) method
     */
    typedef FunctionMap<Amesos2::PardisoMKL,int_t>                  function_map;




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


    ~PardisoMKL( );


  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);



    void check_pardiso_mkl_error(EPhase phase, int_t error) const;

    void set_pardiso_mkl_matrix_type(int_t mtype = 0);


    /* Declare private variables necessary for interaction with the
     * PardisoMKL TPL.
     *
     * For example, the following Arrays are persisting storage arrays
     * for A, X, and B that can be used with solvers expecting a
     * compressed-row representation of the matrix A.
     */

    Teuchos::Array<solver_scalar_type> nzvals_;
    Teuchos::Array<int_t> colind_;
    Teuchos::Array<int_t> rowptr_;
    mutable Teuchos::Array<solver_scalar_type> xvals_;
    mutable Teuchos::Array<solver_scalar_type> bvals_;

    mutable void* pt_[64];
    int_t mtype_;
    int_t n_;
    Teuchos::Array<int_t> perm_;
    mutable int_t nrhs_;

    int_t iparm_[64];

    static const int_t msglvl_;

    // We will deal with 1 factor at a time
    static const int_t maxfct_;
    static const int_t mnum_;


    static const bool complex_
    = Meta::or_<Meta::is_same<solver_scalar_type, PMKL::_MKL_Complex8>::value,
                Meta::is_same<solver_scalar_type, PMKL::_DOUBLE_COMPLEX_t>::value>::value;

    bool is_contiguous_;

};                              // End class PardisoMKL


// Specialize the solver_traits struct for PardisoMKL.
template <>
struct solver_traits<PardisoMKL> {
#ifdef HAVE_TEUCHOS_COMPLEX
  typedef Meta::make_list6<float,
                           double,
                           std::complex<float>,
                           std::complex<double>,
                           PMKL::_MKL_Complex8,
                           PMKL::_DOUBLE_COMPLEX_t> supported_scalars;
#else
typedef Meta::make_list2<float,
                         double> supported_scalars;
#endif
};

} // end namespace Amesos

#endif  // AMESOS2_PARDISOMKL_DECL_HPP