Amesos2_Status.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_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