https://mooseframework.inl.gov
TimestepSize.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://mooseframework.inl.gov
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #include "TimestepSize.h"
11 #include "FEProblem.h"
12 
14 
17 {
19  params.addClassDescription("Reports the timestep size");
20 
21  // Not supported
22  params.suppressParameter<bool>("use_displaced_mesh");
23  return params;
24 }
25 
27  : GeneralPostprocessor(parameters), _feproblem(dynamic_cast<FEProblemBase &>(_subproblem))
28 {
29 }
30 
31 Real
33 {
34  return _feproblem.dt();
35 }
static InputParameters validParams()
Definition: TimestepSize.C:16
registerMooseObject("MooseApp", TimestepSize)
TimestepSize(const InputParameters &parameters)
Definition: TimestepSize.C:26
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
Specialization of SubProblem for solving nonlinear equations plus auxiliary equations.
void suppressParameter(const std::string &name)
This method suppresses an inherited parameter so that it isn&#39;t required or valid in the derived class...
static InputParameters validParams()
virtual Real getValue() const override
This will return the current time step size.
Definition: TimestepSize.C:32
FEProblemBase & _feproblem
Definition: TimestepSize.h:30
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...
virtual Real & dt() const