Amesos2_Status.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//           Amesos2: Templated Direct Sparse Solver Package
//
// Copyright 2011 NTESS and the Amesos2 contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef AMESOS2_STATUS_HPP
#define AMESOS2_STATUS_HPP

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

#include "Amesos2_TypeDecl.hpp"

namespace Amesos2 {

  template < template <class,class> class ConcreteSolver, class Matrix, class Vector > class SolverCore;

  class Status {
  public:
    template < template <class,class> class ConcreteSolver, class Matrix, class Vector >
    friend class SolverCore;

    Status()
      : numPreOrder_(0)
      , numSymbolicFact_(0)
      , numNumericFact_(0)
      , numSolve_(0)

      , last_phase_(CLEAN)

      , lu_nnz_(0)
    { }


    ~Status() { };

    inline int getNumPreOrder() const
    { return( numPreOrder_ ); }

    inline int getNumSymbolicFact() const
    { return( numSymbolicFact_ ); }

    inline int getNumNumericFact() const
    { return( numNumericFact_ ); }

    inline int getNumSolve() const
    { return( numSolve_ ); }

    inline bool preOrderingDone() const
    { return( last_phase_ >= PREORDERING ); }

    inline bool symbolicFactorizationDone() const
    { return( last_phase_ >= SYMBFACT ); }

    inline bool numericFactorizationDone() const
    { return( last_phase_ >= NUMFACT ); }

    inline size_t getNnzLU() const
    { return( lu_nnz_ ); }


  private:

    int numPreOrder_;

    int numSymbolicFact_;

    int numNumericFact_;

    int numSolve_;

    EPhase last_phase_;

    size_t lu_nnz_;

  };                              // end class Amesos2::Status


} // end namespace Amesos2

#endif  // AMESOS2_STATUS_HPP