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 
15 
18 {
20  params.addRequiredParam<std::vector<Real>>("time_sequence", "The values of t");
21  params.addClassDescription("Solves the Transient problem at a sequence of given time points.");
22  return params;
23 }
24 
26  : TimeSequenceStepperBase(parameters)
27 {
28 }
29 
30 void
32 {
33  setupSequence(getParam<std::vector<Real>>("time_sequence"));
34 }
TimeSequenceStepperBase
Solves the PDEs at a sequence of given time points.
Definition: TimeSequenceStepperBase.h:23
TimeSequenceStepper.h
defineLegacyParams
defineLegacyParams(TimeSequenceStepper)
TimeSequenceStepper::init
virtual void init() override
Initialize the time stepper.
Definition: TimeSequenceStepper.C:31
TimeSequenceStepper::validParams
static InputParameters validParams()
Definition: TimeSequenceStepper.C:17
registerMooseObject
registerMooseObject("MooseApp", TimeSequenceStepper)
TimeSequenceStepper::TimeSequenceStepper
TimeSequenceStepper(const InputParameters &parameters)
Definition: TimeSequenceStepper.C:25
InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
Definition: InputParameters.h:53
TimeSequenceStepperBase::setupSequence
void setupSequence(const std::vector< Real > &times)
Definition: TimeSequenceStepperBase.C:31
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
TimeSequenceStepperBase::validParams
static InputParameters validParams()
Definition: TimeSequenceStepperBase.C:17
InputParameters::addRequiredParam
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...
Definition: InputParameters.h:1176
TimeSequenceStepper
Solves the PDEs at a sequence of time points given as a vector in the input file.
Definition: TimeSequenceStepper.h:23