Amesos2_SolverCore_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_SOLVERCORE_DECL_HPP
#define AMESOS2_SOLVERCORE_DECL_HPP

#include <string>

#include <Teuchos_RCP.hpp>
#include <Teuchos_ParameterList.hpp>

#include "Amesos2_Solver.hpp"
#include "Amesos2_MatrixTraits.hpp"
#include "Amesos2_MatrixAdapter_decl.hpp"
#include "Amesos2_MultiVecAdapter_decl.hpp"
#include "Amesos2_TypeDecl.hpp"

#include "Amesos2_Control.hpp"
#include "Amesos2_Status.hpp"
#include "Amesos2_Timers.hpp"

namespace Amesos2 {


  /* This is the base class to be used in a *statically* polymorphic
   * way. E.g. for the Superlu solver:
   *
   * In Amesos2_Superlu.hpp:
   * class Superlu : SolverCore<Superlu> { ... }
   *
   * Each concrete solver will implement several private sub-functions
   * that will be called within the common code for each function.
   */

  template <template <class,class> class ConcreteSolver,
      class Matrix,
      class Vector >
  class SolverCore : public Amesos2::Solver<Matrix,Vector>
  {
  public:

    // Grant public access to contained types
    typedef SolverCore<ConcreteSolver,Matrix,Vector>                       type;
    typedef Solver<Matrix,Vector>                                    super_type;
    typedef ConcreteSolver<Matrix,Vector>                           solver_type;
    typedef Matrix                                                  matrix_type;
    typedef Vector                                                  vector_type;
    typedef typename MatrixAdapter<matrix_type>::scalar_t           scalar_type;
    typedef typename MatrixAdapter<matrix_type>::local_ordinal_t    local_ordinal_type;
    typedef typename MatrixAdapter<matrix_type>::global_ordinal_t   global_ordinal_type;
    typedef typename MatrixAdapter<matrix_type>::global_size_t      global_size_type;
    typedef typename MatrixAdapter<matrix_type>::node_t             node_type;




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


    ~SolverCore( );


    SolverCore(const solver_type& rhs);


    super_type& operator=(const solver_type* rhs);




    super_type& preOrdering();


    super_type& symbolicFactorization();


    super_type& numericFactorization();


    void solve();


    void solve(const Teuchos::Ptr<Vector> X, const Teuchos::Ptr<const Vector> B) const;


    void solve(Vector* X, const Vector* B) const;
  



    bool matrixShapeOK();

    void setA( const Teuchos::RCP<const Matrix> a, EPhase keep_phase = CLEAN );

    void setA( const Matrix* a, EPhase keep_phase = CLEAN ){ setA(Teuchos::rcp(a), keep_phase); }

    void setX(const Teuchos::RCP<Vector> x){ multiVecX_ = x; }

    void setX(Vector* x){ multiVecX_ = Teuchos::rcp(x); }
  
    const Teuchos::RCP<Vector> getX(){ return( multiVecX_ ); }

    Vector* getXRaw(){ return multiVecX_.getRawPtr(); }

    void setB(const Teuchos::RCP<const Vector> b){ multiVecB_ = b; }

    void setB(const Vector* b){ multiVecB_ = Teuchos::rcp(b); }

    const Teuchos::RCP<const Vector> getB(){ return( multiVecB_ ); }

    const Vector* getBRaw(){ return multiVecB_.getRawPtr(); }




    super_type& setParameters(
            const Teuchos::RCP<Teuchos::ParameterList> & parameterList );


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


    void setParameterList(const Teuchos::RCP<Teuchos::ParameterList> & parameterList)
    {
      setParameters(parameterList);
    }


    Teuchos::RCP<Teuchos::ParameterList> getNonconstParameterList()
    {
      return Teuchos::null;
    }


    Teuchos::RCP<Teuchos::ParameterList> unsetParameterList()
    {
      return Teuchos::null;
    }






    Teuchos::RCP<const Teuchos::Comm<int> > getComm() const
    {
      return matrixA_->getComm();
    }

  
    inline Status& getStatus() const { return( status_ ); }




    std::string description() const;


    void describe(Teuchos::FancyOStream &out,
      const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const;


    void printTiming(
         Teuchos::FancyOStream &out,
         const Teuchos::EVerbosityLevel verbLevel) const;


    void getTiming(Teuchos::ParameterList& timingParameterList) const;


    std::string name() const;

  private:

    void loadA(EPhase current_phase);

  protected:

    void setNnzLU(size_t nnz){ status_.lu_nnz_ = nnz; }

    Teuchos::RCP<const MatrixAdapter<Matrix> > matrixA_;

    bool matrix_loaded_;


    Teuchos::RCP<Vector> multiVecX_;

    Teuchos::RCP<const Vector> multiVecB_;

    global_size_type globalNumRows_;

    global_size_type globalNumCols_;

    global_size_type globalNumNonZeros_;

    global_size_type rowIndexBase_;

    global_size_type columnIndexBase_;


    mutable Status status_;

    Control control_;

    mutable Timers timers_;


    /* Useful MPI vars */

    int rank_;

    bool root_;

    int nprocs_;

  };        // End class Amesos2::SolverCore


} // end namespace Amesos2

#endif  // AMESOS2_SOLVERCORE_DECL_HPP