Times.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

// Moose includes
#include "GeneralReporter.h"

class Times : public GeneralReporter
{
public:
  static InputParameters validParams();
  Times(const InputParameters & parameters);
  virtual ~Times() = default;

  const std::vector<Real> & getTimes() const;

  const std::set<Real> getUniqueTimes() const
  {
    return std::set<Real>(_times.begin(), _times.end());
  };

  Real getCurrentTime() const { return _fe_problem.time(); }

  Real getTimeAtIndex(unsigned int index) const;

  Real getPreviousTime(const Real current_time) const;

  Real getNextTime(const Real current_time, const bool error_if_no_next) const;

protected:
  virtual void initialize() override = 0;

  virtual void execute() override { initialize(); }

  virtual void finalize() override;

  virtual void timestepSetup() override {}
  virtual void residualSetup() override {}
  virtual void jacobianSetup() override {}

  void clearTimes();

  std::vector<Real> & _times;

  const bool _need_broadcast;
  const bool _need_sort;
  const bool _need_unique;
  const Real _unique_tol;
};