CompositionDT.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 "TimeSequenceStepperBase.h"

class CompositionDT : public TimeStepper
{
public:
  static InputParameters compositionDTParams();
  static InputParameters validParams();

  CompositionDT(const InputParameters & parameters);

  struct CompareFirst
  {
    bool operator()(const std::pair<Real, TimeStepper *> & a,
                    const std::pair<Real, TimeStepper *> & b) const
    {
      return a.first < b.first;
    }
  };
  Real produceCompositionDT(std::set<std::pair<Real, TimeStepper *>, CompareFirst> & dts,
                            std::set<std::pair<Real, TimeStepper *>, CompareFirst> & bound_dts);

  // Find the time point to hit at current time step
  Real getSequenceSteppersNextTime();

  virtual void init() override final;
  virtual void preExecute() override final;
  virtual void preSolve() override final;
  virtual void postSolve() override final;
  virtual void postExecute() override final;
  virtual void preStep() override final;
  virtual void postStep() override final;
  virtual bool constrainStep(Real & dt) override final;

  virtual void step() override final;

  virtual void acceptStep() override final;

  virtual void rejectStep() override final;

  virtual bool converged() const override final;

protected:
  virtual Real computeDT() override final;
  virtual Real computeInitialDT() override final;

private:
  template <typename Lambda>
  void actOnTimeSteppers(Lambda && act);

  std::vector<TimeStepper *> getTimeSteppers();

  // The time step size computed by the Composition TimeStepper
  Real _dt;

  // Whether or not has an initial time step size
  const bool _has_initial_dt;

  // The initial time step size
  const Real _initial_dt;

  // The time stepper(s) input as lower bound of the time stepper size
  const std::set<std::string> _lower_bound;

  // The time stepper selected for use every time step, based on minimum time step size
  TimeStepper * _current_time_stepper;

  // The time stepper selected every time step as providing the lower bound
  TimeStepper * _largest_bound_time_stepper;

  // The time sequence stepper selected every time step as the one with the closest time to hit
  TimeSequenceStepperBase * _closest_time_sequence_stepper;
};