Loading [MathJax]/extensions/tex2jax.js
www.mooseframework.org
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
TimestepSize.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
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 
16 
19 {
21  params.addClassDescription("Reports the timestep size");
22  return params;
23 }
24 
26  : GeneralPostprocessor(parameters), _feproblem(dynamic_cast<FEProblemBase &>(_subproblem))
27 {
28 }
29 
30 Real
32 {
33  return _feproblem.dt();
34 }
FEProblem.h
GeneralPostprocessor::validParams
static InputParameters validParams()
Definition: GeneralPostprocessor.C:15
FEProblemBase::dt
virtual Real & dt() const
Definition: FEProblemBase.h:443
InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
Definition: InputParameters.h:53
TimestepSize.h
TimestepSize::getValue
virtual Real getValue() override
This will return the current time step size.
Definition: TimestepSize.C:31
GeneralPostprocessor
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
Definition: GeneralPostprocessor.h:27
InputParameters::addClassDescription
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.
Definition: InputParameters.C:70
registerMooseObject
registerMooseObject("MooseApp", TimestepSize)
TimestepSize::TimestepSize
TimestepSize(const InputParameters &parameters)
Definition: TimestepSize.C:25
TimestepSize::_feproblem
FEProblemBase & _feproblem
Definition: TimestepSize.h:36
defineLegacyParams
defineLegacyParams(TimestepSize)
TimestepSize::validParams
static InputParameters validParams()
Definition: TimestepSize.C:18
FEProblemBase
Specialization of SubProblem for solving nonlinear equations plus auxiliary equations.
Definition: FEProblemBase.h:139
TimestepSize
Definition: TimestepSize.h:20