IterationAdaptiveDT.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

#include "TimeStepper.h"
#include "LinearInterpolation.h"
#include "PostprocessorInterface.h"

class Function;
class PiecewiseBase;
class PiecewiseLinear;

class IterationAdaptiveDT : public TimeStepper, public PostprocessorInterface
{
public:
  static InputParameters validParams();

  IterationAdaptiveDT(const InputParameters & parameters);

  virtual void init() override;
  virtual void preExecute() override;

  virtual void rejectStep() override;
  virtual void acceptStep() override;

  virtual bool constrainStep(Real & dt) override;

protected:
  virtual Real computeInitialDT() override;
  virtual Real computeDT() override;
  virtual Real computeFailedDT() override;
  virtual bool converged() const override;

  void computeAdaptiveDT(Real & dt, bool allowToGrow = true, bool allowToShrink = true);
  Real computeInterpolationDT();
  void limitDTByFunction(Real & limitedDT);
  void limitDTToPostprocessorValue(Real & limitedDT) const;

  Real & _dt_old;

  const Real _input_dt;

  bool & _tfunc_last_step;
  bool & _sync_last_step;

  int _optimal_iterations;
  int _iteration_window;
  const int _linear_iteration_ratio;
  bool _adaptive_timestepping;

  std::vector<const PostprocessorValue *> _pps_value;

  std::vector<const Function *> _timestep_limiting_functions;
  std::vector<const PiecewiseBase *> _piecewise_timestep_limiting_functions;
  std::vector<const PiecewiseLinear *> _piecewise_linear_timestep_limiting_functions;

  std::vector<Real> _times;

  Real _max_function_change;
  const bool _force_step_every_function_point;
  const Real _post_function_sync_dt;

  std::set<Real> _tfunc_times;

  LinearInterpolation _time_ipol;
  const bool _use_time_ipol;

  const Real & _growth_factor;
  const Real & _cutback_factor;

  unsigned int & _nl_its;
  unsigned int & _l_its;

  bool & _cutback_occurred;
  bool _at_function_point;

  bool _reject_large_step;
  double _large_step_rejection_threshold;
  mutable std::optional<Real> _dt_from_reject;
};