iter_ctrl.hpp

Go to the documentation of this file.

#ifndef PARALUTION_ITER_CTRL_HPP_
#define PARALUTION_ITER_CTRL_HPP_

#include <vector>
#include <string>

namespace paralution {

class IterationControl {

public:

  IterationControl();
  ~IterationControl();

  void Init(const double abs,
            const double rel,
            const double div,
            const int max);

  void Init(const double abs,
            const double rel,
            const double div,
            const int min,
            const int max);

  void InitTolerance(const double abs,
                     const double rel,
                     const double div);

  void InitMinimumIterations(const int min);

  void InitMaximumIterations(const int max);

  int GetMinimumIterations(void) const;

  int GetMaximumIterations(void) const;

  bool InitResidual(const double res);

  void Clear(void);

  bool CheckResidual(const double res);

  bool CheckResidual(const double res, const int index);

  bool CheckResidualNoCount(const double res) const;

  void RecordHistory(void);

  void WriteHistoryToFile(const std::string filename) const;

  void Verbose(const int verb=1);

  void PrintInit(void);

  void PrintStatus(void);

  // Return the iteration count
  int GetIterationCount(void);

  // Return the current residual
  double GetCurrentResidual(void);

  // Return the current status
  int GetSolverStatus(void);

  int GetAmaxResidualIndex(void);

private:

  int verb_;

  int iteration_;

  bool init_res_;

  double initial_residual_;

  double absolute_tol_;
  double relative_tol_;
  double divergence_tol_;
  int minimum_iter_;
  int maximum_iter_;

  int reached_;

  std::vector<double> residual_history_;

  double current_res_;

  int current_index_;

  bool rec_;

};


}

#endif // PARALUTION_ITER_CTRL_HPP_