www.mooseframework.org
src
postprocessors
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
13
registerMooseObject
(
"MooseApp"
,
TimestepSize
);
14
15
InputParameters
16
TimestepSize::validParams
()
17
{
18
InputParameters
params =
GeneralPostprocessor::validParams
();
19
params.
addClassDescription
(
"Reports the timestep size"
);
20
return
params;
21
}
22
23
TimestepSize::TimestepSize
(
const
InputParameters
& parameters)
24
:
GeneralPostprocessor
(parameters), _feproblem(dynamic_cast<
FEProblemBase
&>(_subproblem))
25
{
26
}
27
28
Real
29
TimestepSize::getValue
()
const
30
{
31
return
_feproblem
.
dt
();
32
}
TimestepSize::validParams
static InputParameters validParams()
Definition:
TimestepSize.C:16
registerMooseObject
registerMooseObject("MooseApp", TimestepSize)
TimestepSize::TimestepSize
TimestepSize(const InputParameters ¶meters)
Definition:
TimestepSize.C:23
InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
Definition:
InputParameters.h:63
TimestepSize.h
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:145
GeneralPostprocessor::validParams
static InputParameters validParams()
Definition:
GeneralPostprocessor.C:13
TimestepSize::getValue
virtual Real getValue() const override
This will return the current time step size.
Definition:
TimestepSize.C:29
TimestepSize::_feproblem
FEProblemBase & _feproblem
Definition:
TimestepSize.h:30
FEProblem.h
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
TimestepSize
Definition:
TimestepSize.h:14
FEProblemBase::dt
virtual Real & dt() const
Definition:
FEProblemBase.h:521
Generated on Wed Mar 27 2024 17:44:45 for www.mooseframework.org by
1.8.14