www.mooseframework.org
TimeSequenceStepper.C
Go to the documentation of this file.
1 /****************************************************************/
2 /* DO NOT MODIFY THIS HEADER */
3 /* MOOSE - Multiphysics Object Oriented Simulation Environment */
4 /* */
5 /* (c) 2010 Battelle Energy Alliance, LLC */
6 /* ALL RIGHTS RESERVED */
7 /* */
8 /* Prepared by Battelle Energy Alliance, LLC */
9 /* Under Contract No. DE-AC07-05ID14517 */
10 /* With the U. S. Department of Energy */
11 /* */
12 /* See COPYRIGHT for full restrictions */
13 /****************************************************************/
14 
15 #include "TimeSequenceStepper.h"
16 
17 template <>
20 {
22  params.addRequiredParam<std::vector<Real>>("time_sequence", "The values of t");
23  params.addClassDescription("Solves the Transient problem at a sequence of given time points.");
24  return params;
25 }
26 
28  : TimeSequenceStepperBase(parameters)
29 {
30 }
31 
32 void
34 {
35  setupSequence(getParam<std::vector<Real>>("time_sequence"));
36 }
virtual void init() override
Initialize the time stepper.
InputParameters validParams< TimeSequenceStepper >()
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
void setupSequence(const std::vector< Real > &times)
void addRequiredParam(const std::string &name, const std::string &doc_string)
This method adds a parameter and documentation string to the InputParameters object that will be extr...
InputParameters validParams< TimeSequenceStepperBase >()
const T & getParam(const std::string &name) const
Retrieve a parameter for the object.
Definition: MooseObject.h:122
Solves the PDEs at a sequence of given time points.
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...
TimeSequenceStepper(const InputParameters &parameters)