Ifpack2_Details_Amesos2Wrapper_decl.hpp

Go to the documentation of this file.

/*@HEADER
// ***********************************************************************
//
//       Ifpack2: Tempated Object-Oriented Algebraic Preconditioner Package
//                 Copyright (2009) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// 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 IFPACK2_DETAILS_AMESOS2WRAPPER_DECL_HPP
#define IFPACK2_DETAILS_AMESOS2WRAPPER_DECL_HPP

#include <Ifpack2_ConfigDefs.hpp>
#include <Ifpack2_Preconditioner.hpp>
#include <Ifpack2_Details_CanChangeMatrix.hpp>
#include <Ifpack2_CondestType.hpp>

#ifdef HAVE_IFPACK2_AMESOS2
#include <Amesos2_config.h>
#include <Amesos2.hpp>
}

using namespace Ifpack2;

namespace Teuchos {
  // forward declaration
  class ParameterList;
}

namespace Ifpack2 {
namespace Details {
template<class MatrixType>
class Amesos2Wrapper :
    virtual public ::Ifpack2::Preconditioner<typename MatrixType::scalar_type,
                                           typename MatrixType::local_ordinal_type,
                                           typename MatrixType::global_ordinal_type,
                                           typename MatrixType::node_type>,
    virtual public ::Ifpack2::Details::CanChangeMatrix<Tpetra::RowMatrix<typename MatrixType::scalar_type,
                                                                       typename MatrixType::local_ordinal_type,
                                                                       typename MatrixType::global_ordinal_type,
                                                                       typename MatrixType::node_type> >
{
public:


  typedef typename MatrixType::scalar_type scalar_type;

  TEUCHOS_DEPRECATED typedef typename MatrixType::scalar_type Scalar;


  typedef typename MatrixType::local_ordinal_type local_ordinal_type;

  TEUCHOS_DEPRECATED typedef typename MatrixType::local_ordinal_type LocalOrdinal;


  typedef typename MatrixType::global_ordinal_type global_ordinal_type;

  TEUCHOS_DEPRECATED typedef typename MatrixType::global_ordinal_type GlobalOrdinal;


  typedef typename MatrixType::node_type node_type;

  TEUCHOS_DEPRECATED typedef typename MatrixType::node_type Node;


  typedef typename ::Teuchos::ScalarTraits<scalar_type>::magnitudeType magnitude_type;

  TEUCHOS_DEPRECATED typedef typename ::Teuchos::ScalarTraits<scalar_type>::magnitudeType magnitudeType;

  typedef Tpetra::RowMatrix<scalar_type,
                            local_ordinal_type,
                            global_ordinal_type,
                            node_type> row_matrix_type;

  typedef Tpetra::Map<local_ordinal_type,
                      global_ordinal_type,
                      node_type> map_type;

  typedef Tpetra::CrsMatrix<scalar_type,
                            local_ordinal_type,
                            global_ordinal_type,
                            node_type> crs_matrix_type;



  explicit Amesos2Wrapper (const ::Teuchos::RCP<const row_matrix_type>& A);

  virtual ~Amesos2Wrapper();




  void setParameters (const ::Teuchos::ParameterList& params);

  void initialize ();

  inline bool isInitialized() const {
    return IsInitialized_;
  }

  void compute();

  inline bool isComputed() const {
    return IsComputed_;
  }




  virtual void
  setMatrix (const ::Teuchos::RCP<const row_matrix_type>& A);




  void
  apply (const Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& X,
         Tpetra::MultiVector<scalar_type,local_ordinal_type,global_ordinal_type,node_type>& Y,
         ::Teuchos::ETransp mode = ::Teuchos::NO_TRANS,
         scalar_type alpha = ::Teuchos::ScalarTraits<scalar_type>::one(),
         scalar_type beta = ::Teuchos::ScalarTraits<scalar_type>::zero()) const;

  ::Teuchos::RCP<const map_type> getDomainMap () const;

  ::Teuchos::RCP<const map_type> getRangeMap () const;

  bool hasTransposeApply () const;




  virtual magnitude_type TEUCHOS_DEPRECATED
  computeCondEst (CondestType CT = Cheap,
                  local_ordinal_type MaxIters = 1550,
                  magnitude_type Tol = 1e-9,
                  const ::Teuchos::Ptr<const Tpetra::RowMatrix<scalar_type,local_ordinal_type,global_ordinal_type,node_type> >& Matrix_in = ::Teuchos::null);

  virtual magnitude_type TEUCHOS_DEPRECATED getCondEst () const {
    return Condest_;
  }

  ::Teuchos::RCP<const ::Teuchos::Comm<int> > getComm () const;

  ::Teuchos::RCP<const row_matrix_type> getMatrix () const;

  int getNumInitialize () const;

  int getNumCompute () const;

  int getNumApply () const;

  double getInitializeTime () const;

  double getComputeTime () const;

  double getApplyTime () const;




  std::string description () const;

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

private:
  typedef ::Teuchos::ScalarTraits<scalar_type> STS;
  typedef ::Teuchos::ScalarTraits<magnitude_type> STM;
  typedef typename ::Teuchos::Array<local_ordinal_type>::size_type size_type;

  typedef Tpetra::MultiVector<scalar_type, local_ordinal_type, global_ordinal_type, node_type> MV;

  Amesos2Wrapper (const Amesos2Wrapper<MatrixType>& RHS);

  Amesos2Wrapper<MatrixType>& operator= (const Amesos2Wrapper<MatrixType>& RHS);

  ::Teuchos::RCP<Amesos2::Solver<crs_matrix_type, MV> > amesos2solver_;

  static ::Teuchos::RCP<const row_matrix_type>
  makeLocalFilter (const ::Teuchos::RCP<const row_matrix_type>& A);

  //Teuchos::RCP<const MatrixType> A_;
  ::Teuchos::RCP<const row_matrix_type> A_;

  ::Teuchos::RCP<const crs_matrix_type> A_local_crs_;

  // \name Parameters (set by setParameters())

  ::Teuchos::RCP<const ::Teuchos::ParameterList> parameterList_;

  // \name Other internal data

  magnitude_type Condest_;
  double InitializeTime_;
  double ComputeTime_;
  mutable double ApplyTime_;
  int NumInitialize_;
  int NumCompute_;
  mutable int NumApply_;
  bool IsInitialized_;
  bool IsComputed_;
  std::string SolverName_;
}; // class Amesos2Wrapper

} // namespace Details
} // namespace Ifpack2

#endif // HAVE_IFPACK2_AMESOS2

#endif // IFPACK2_DETAILS_AMESOS2WRAPPER_DECL_HPP