https://mooseframework.inl.gov
src
postprocessors
NumTimeSteps.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 "
NumTimeSteps.h
"
11
#include "
FEProblem.h
"
12
13
registerMooseObject
(
"MooseApp"
,
NumTimeSteps
);
14
15
InputParameters
16
NumTimeSteps::validParams
()
17
{
18
InputParameters
params =
GeneralPostprocessor::validParams
();
19
params.
addClassDescription
(
"Reports the timestep number"
);
20
return
params;
21
}
22
23
NumTimeSteps::NumTimeSteps
(
const
InputParameters
& parameters)
24
:
GeneralPostprocessor
(parameters), _feproblem(dynamic_cast<
FEProblemBase
&>(_subproblem))
25
{
26
}
27
28
Real
29
NumTimeSteps::getValue
()
const
30
{
31
return
_feproblem
.
timeStep
();
32
}
registerMooseObject
registerMooseObject("MooseApp", NumTimeSteps)
NumTimeSteps::_feproblem
FEProblemBase & _feproblem
Definition:
NumTimeSteps.h:33
NumTimeSteps
Reports on the number of time steps already taken in the transient.
Definition:
NumTimeSteps.h:17
InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
Definition:
InputParameters.h:66
GeneralPostprocessor
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
Definition:
GeneralPostprocessor.h:21
FEProblemBase
Specialization of SubProblem for solving nonlinear equations plus auxiliary equations.
Definition:
FEProblemBase.h:132
NumTimeSteps::NumTimeSteps
NumTimeSteps(const InputParameters ¶meters)
Definition:
NumTimeSteps.C:23
GeneralPostprocessor::validParams
static InputParameters validParams()
Definition:
GeneralPostprocessor.C:13
NumTimeSteps::validParams
static InputParameters validParams()
Definition:
NumTimeSteps.C:16
FEProblem.h
NumTimeSteps.h
FEProblemBase::timeStep
virtual int & timeStep() const
Definition:
FEProblemBase.h:516
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
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:82
NumTimeSteps::getValue
virtual Real getValue() const override
This will return the current time step number.
Definition:
NumTimeSteps.C:29
Generated on Wed Jul 16 2025 13:56:15 for https://mooseframework.inl.gov by
1.8.14