Amesos2_STRUMPACK_decl.hpp

// @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 Lisa Claus (lclaus@lbl.gov)
//
// ***********************************************************************
//
// @HEADER


#ifndef AMESOS2_STRUMPACK_DECL_HPP
#define AMESOS2_STRUMPACK_DECL_HPP

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

#ifdef HAVE_MPI
#include "StrumpackSparseSolverMPIDist.hpp"
#else
#include "StrumpackSparseSolver.hpp"
#endif

namespace Amesos2 {


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

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

  typedef STRUMPACK<Matrix,Vector>                                     type;
  typedef SolverCore<Amesos2::STRUMPACK,Matrix,Vector>           strum_type;

  typedef Matrix                                                matrix_type;
  typedef Vector                                                vector_type;

  // Since typedef's are not inheritted, go grab them
  typedef typename strum_type::scalar_type                      scalar_type;
  typedef typename strum_type::local_ordinal_type        local_ordinal_type;
  typedef typename strum_type::global_ordinal_type      global_ordinal_type;
  typedef typename strum_type::global_size_type            global_size_type;
  typedef typename strum_type::node_type                          node_type;

  typedef Kokkos::DefaultHostExecutionSpace                     HostExecSpaceType;
  typedef Kokkos::View<global_ordinal_type*, HostExecSpaceType> host_ordinal_type_array;
  typedef Kokkos::View<scalar_type*, HostExecSpaceType>         host_value_type_array;



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


  ~STRUMPACK( );


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

#ifdef HAVE_MPI
  Teuchos::RCP<strumpack::StrumpackSparseSolverMPIDist<scalar_type,global_ordinal_type>> sp_;
#else
  Teuchos::RCP<strumpack::StrumpackSparseSolver<scalar_type,global_ordinal_type>> sp_;
#endif


  // The following Arrays are persisting storage arrays for A, X, and B
  host_value_type_array nzvals_view_;
  host_ordinal_type_array colind_view_;
  host_ordinal_type_array rowptr_view_;
  // /// 1D store for B values
   mutable Teuchos::Array<scalar_type> bvals_;
  // /// 1D store for X values
   mutable Teuchos::Array<scalar_type> xvals_;

#ifdef HAVE_MPI
  Teuchos::RCP<const Tpetra::Map<local_ordinal_type,
                                 global_ordinal_type,
                                 node_type> > strumpack_rowmap_;
#endif
};                              // End class STRUMPACK


// Specialize the solver_traits template for STRUMPACK
template <>
struct solver_traits<STRUMPACK> {
#if defined(HAVE_TEUCHOS_COMPLEX) && !defined(__clang__)
  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_STRUMPACK_DECL_HPP