https://mooseframework.inl.gov
Steady.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 // MOOSE includes
11 #include "Steady.h"
12 #include "FEProblem.h"
13 #include "Factory.h"
14 #include "MooseApp.h"
15 #include "NonlinearSystem.h"
16 
17 registerMooseObject("MooseApp", Steady);
18 
21 {
23  params.addClassDescription("Executioner for steady-state simulations.");
24  params += FEProblemSolve::validParams();
25  return params;
26 }
27 
28 Steady::Steady(const InputParameters & parameters) : SteadyBase(parameters), _feproblem_solve(*this)
29 {
30  _fixed_point_solve->setInnerSolve(_feproblem_solve);
31 }
32 
33 void
35 {
39 }
40 
41 void
43 {
44  // check to make sure that we don't have any time kernels in this simulation (Steady State)
45  for (const auto & system : _feproblem_solve.systemsToSolve())
46  if (system->containsTimeKernel())
47  mooseError("You have specified time kernels in your steady-state simulation in system ",
48  system->name(),
49  " on the following variables: ",
50  Moose::stringify(system->timeKernelVariableNames()));
51 }
static InputParameters validParams()
Definition: SteadyBase.C:20
Steady executioners usually only call "solve()" on the NonlinearSystem once.
Definition: Steady.h:17
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
registerMooseObject("MooseApp", Steady)
A base class that can be used for executioners solving for steady state problems. ...
Definition: SteadyBase.h:24
virtual void execute(const ExecFlagType &exec_type)
Convenience function for performing execution of MOOSE systems.
FEProblemSolve _feproblem_solve
The solve object to use in this executioner.
Definition: Steady.h:36
const ExecFlagType EXEC_PRE_MULTIAPP_SETUP
Definition: Moose.C:50
void initialSetup() override
static InputParameters validParams()
std::string stringify(const T &t)
conversion to string
Definition: Conversion.h:64
FEProblemBase & _problem
Just an alias for now.
Definition: SteadyBase.h:59
static InputParameters validParams()
Definition: Steady.C:20
const std::vector< SolverSystem * > & systemsToSolve() const
Returns a reference to the vector of solver systems that this object is supposed to solve...
virtual void checkIntegrity()
Check if a time kernel has been declared.
Definition: Steady.C:42
void mooseError(Args &&... args) const
Emits an error prefixed with object name and type.
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...
virtual void init() override
Initialize the executioner.
Definition: Steady.C:34
Steady(const InputParameters &parameters)
Constructor.
Definition: Steady.C:28
std::unique_ptr< FixedPointSolve > _fixed_point_solve
Definition: Executioner.h:151