www.mooseframework.org
TimeSequenceStepper.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 "TimeSequenceStepper.h"
11 
13 
16 {
18  params.addRequiredParam<std::vector<Real>>("time_sequence", "The values of t");
19  params.addClassDescription("Solves the Transient problem at a sequence of given time points.");
20  return params;
21 }
22 
24  : TimeSequenceStepperBase(parameters)
25 {
26 }
27 
28 void
30 {
31  setupSequence(getParam<std::vector<Real>>("time_sequence"));
32 }
virtual void init() override
Initialize the time stepper.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
void setupSequence(const std::vector< Real > &times)
registerMooseObject("MooseApp", TimeSequenceStepper)
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...
static InputParameters validParams()
const T & getParam(const std::string &name) const
Retrieve a parameter for the object.
Solves the PDEs at a sequence of time points given as a vector in the input file. ...
Solves the PDEs at a sequence of given time points.
static InputParameters validParams()
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)