Amesos2_Superlumt_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_SUPERLUMT_DECL_HPP
#define AMESOS2_SUPERLUMT_DECL_HPP

#include "Amesos2_SolverTraits.hpp"
#include "Amesos2_SolverCore_decl.hpp"
#include "Amesos2_Superlumt_FunctionMap.hpp"


namespace Amesos2 {


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

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

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

  typedef typename type_map::type                                  slu_type;
  typedef typename type_map::magnitude_type                  magnitude_type;

  typedef FunctionMap<Amesos2::Superlumt,slu_type>             function_map;




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


  ~Superlumt( );


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 );
  /* Parameters to support in the future:
   *
   *  <li> \c "IterRefine" : { \c "NO" | \c "SINGLE" | \c "DOUBLE" | \c "EXTRA"
   *     }. Specifies whether to perform iterative refinement, and in
   *     what precision to compute the residual. (Not currently supported)</li>
   */

  Teuchos::RCP<const Teuchos::ParameterList> getValidParameters_impl() const;


  bool loadA_impl(EPhase current_phase);


  // struct holds all data necessary to make a superlu factorization or solve call
  mutable struct SLUData {
    SLUMT::SuperMatrix A, BX, L, U;
    SLUMT::SuperMatrix AC; 

    SLUMT::superlumt_options_t options;
    SLUMT::superlu_memusage_t mem_usage;
    SLUMT::Gstat_t stat;

    Teuchos::Array<magnitude_type> berr; 
    Teuchos::Array<magnitude_type> ferr; 
    Teuchos::Array<int> perm_r;
    Teuchos::Array<int> perm_c;
    Teuchos::Array<magnitude_type> R;
    Teuchos::Array<magnitude_type> C;

    // in contrast to SuperLU, memory for etree will be allocated by
    // pxgssvx and the pointer will be stored in `options'

    SLUMT::equed_t equed;       
    bool rowequ, colequ;        
  } data_;

  // The following Arrays are persisting storage arrays for A, X, and B
  Teuchos::Array<typename TypeMap<Amesos2::Superlumt,scalar_type>::type> nzvals_;
  Teuchos::Array<int> rowind_;
  Teuchos::Array<int> colptr_;

  /* Note: In the above, must use "Amesos2::Superlumt" rather than
   * "Superlumt" because otherwise the compiler references the
   * specialized type of the class, and not the templated type that is
   * required for Amesos2::TypeMap
   */

  /* SuperLU can accept input in either compressed-row or
   * compressed-column storage.  We will store and pass matrices in
   * *compressed-row* format because that is the format Amesos used.
   */

  bool is_contiguous_;

};                              // End class Superlumt


// Specialize the solver_traits struct for SuperLU_MT
template <>
struct solver_traits<Superlumt> {
#ifdef HAVE_TEUCHOS_COMPLEX
  typedef Meta::make_list6<float,
                           double,
                           std::complex<float>,
                           std::complex<double>,
                           SLUMT::C::complex,
                           SLUMT::Z::doublecomplex> supported_scalars;
#else
  typedef Meta::make_list2<float, double> supported_scalars;
#endif
};

} // end namespace Amesos2

#endif  // AMESOS2_SUPERLUMT_DECL_HPP