SolverStatistics.hpp

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2024 Total, S.A
 * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2023-2024 Chevron
 * Copyright (c) 2019-     GEOS/GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */
 
/*
 * @file SolverStatistics.hpp
 */
 
 
#ifndef GEOS_PHYSICSSOLVERS_SOLVERSTATISTICS_HPP
#define GEOS_PHYSICSSOLVERS_SOLVERSTATISTICS_HPP
 
#include "dataRepository/Group.hpp"
 
namespace geos
{
 
class SolverStatistics : public dataRepository::Group
{
public:
 
  SolverStatistics( string const & name,
                    dataRepository::Group * const parent );
 
  void initializeTimeStepStatistics();
 
  void logNonlinearIteration( integer const numLinearIterations );
 
  void logNonlinearIteration();
 
  void logOuterLoopIteration();
 
  void logTimeStepCut();
 
  void saveTimeStepStatistics();
 
  void outputStatistics() const;
 
  integer getNumTimeSteps() const
  { return m_numTimeSteps; }
 
  integer getNumTimeStepCuts() const
  { return m_numTimeStepCuts; }
 
  integer getNumSuccessfulOuterLoopIterations() const
  { return m_numSuccessfulOuterLoopIterations; }
 
  integer getNumSuccessfulNonlinearIterations() const
  { return m_numSuccessfulNonlinearIterations; }
 
  integer getNumSuccessfulLinearIterations() const
  { return m_numSuccessfulLinearIterations; }
 
  integer getNumDiscardedOuterLoopIterations() const
  { return m_numDiscardedOuterLoopIterations; }
 
  integer getNumDiscardedNonlinearIterations() const
  { return m_numDiscardedNonlinearIterations; }
 
  integer getNumDiscardedLinearIterations() const
  { return m_numDiscardedLinearIterations; }
 
 
  struct viewKeyStruct
  {
    static constexpr char const * numTimeStepsString() { return "numTimeSteps"; }
    static constexpr char const * numTimeStepCutsString() { return "numTimeStepCuts"; }
 
    static constexpr char const * numSuccessfulOuterLoopIterationsString() { return "numSuccessfulOuterLoopIterations"; }
    static constexpr char const * numSuccessfulNonlinearIterationsString() { return "numSuccessfulNonlinearIterations"; }
    static constexpr char const * numSuccessfulLinearIterationsString() { return "numSuccessfulLinearIterations"; }
 
    static constexpr char const * numDiscardedOuterLoopIterationsString() { return "numDiscardedOuterLoopIterations"; }
    static constexpr char const * numDiscardedNonlinearIterationsString() { return "numDiscardedNonlinearIterations"; }
    static constexpr char const * numDiscardedLinearIterationsString() { return "numDiscardedLinearIterations"; }
  };
 
private:
  integer m_numTimeSteps;
 
  integer m_numTimeStepCuts;
 
 
  integer m_currentNumOuterLoopIterations;
 
  integer m_currentNumNonlinearIterations;
 
  integer m_currentNumLinearIterations;
 
 
  integer m_numSuccessfulOuterLoopIterations;
 
  integer m_numSuccessfulNonlinearIterations;
 
  integer m_numSuccessfulLinearIterations;
 
 
  integer m_numDiscardedOuterLoopIterations;
 
  integer m_numDiscardedNonlinearIterations;
 
  integer m_numDiscardedLinearIterations;
 
};
 
} //namespace geos
 
#endif // GEOS_PHYSICSSOLVERS_SOLVERSTATISTICS_HPP