PseudoTimestep.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 "GeneralPostprocessor.h"

class PseudoTimestep : public GeneralPostprocessor
{
public:
  static InputParameters validParams();
  PseudoTimestep(const InputParameters & parameters);

  virtual void execute() override;
  virtual void initialize() override;
  using Postprocessor::getValue;
  virtual Real getValue() const override;

  enum class PseudotimeMethod
  {
    SER,
    RDM,
    EXP
  };

protected:
  const PseudotimeMethod _method;

  const Real _initial_dt;
  const Real _alpha;

  unsigned int _iterations_window;

  bool _bound;

  Real _max_dt;

  Real _dt;

  std::vector<Real> & _residual_norms_sequence;
  std::vector<Real> & _iterations_step_sequence;

  Real currentResidualNorm() const;

  Real timestepSER() const;

  Real timestepEXP() const;

  Real timestepRDM() const;

  void outputPseudoTimestep(Real curr_dt) const;
};