https://mooseframework.inl.gov
Loading...
Searching...
No Matches
SteadyBase.h
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#pragma once
11
12#include "Executioner.h"
13
14// System includes
15#include <string>
16
17// Forward declarations
18class InputParameters;
19class FEProblemBase;
20
24class SteadyBase : public Executioner
25{
26public:
28
36
37 virtual void execute() override;
38 virtual bool lastSolveConverged() const override { return _last_solve_converged; }
39
45 virtual unsigned int getIterationNumberOutput() const { return _output_iteration_number; }
46
52 virtual void setIterationNumberOutput(unsigned int iteration_number)
53 {
54 _output_iteration_number = iteration_number;
55 }
56
57protected:
60
63
66
68 Real & _time;
69
72
73private:
76};
Executioners are objects that do the actual work of solving your problem.
Definition Executioner.h:37
Specialization of SubProblem for solving nonlinear equations plus auxiliary equations.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
const InputParameters & parameters() const
Get the parameters of the object.
Definition MooseBase.h:131
A base class that can be used for executioners solving for steady state problems.
Definition SteadyBase.h:25
Real & _time
The current time.
Definition SteadyBase.h:68
virtual unsigned int getIterationNumberOutput() const
Get a general iteration number for the purpose of outputting, useful in the presence of a nested solv...
Definition SteadyBase.h:45
virtual bool lastSolveConverged() const override
Whether or not the last solve converged.
Definition SteadyBase.h:38
Real _system_time
The system time.
Definition SteadyBase.h:62
bool _last_solve_converged
Flag showing if the last solve converged.
Definition SteadyBase.h:75
virtual void execute() override
Pure virtual execute function MUST be overridden by children classes.
Definition SteadyBase.C:38
virtual void setIterationNumberOutput(unsigned int iteration_number)
Set a general iteration number for the purpose of outputting, useful in the presence of a nested solv...
Definition SteadyBase.h:52
static InputParameters validParams()
Definition SteadyBase.C:20
unsigned int _output_iteration_number
Iteration number obtained from the main application.
Definition SteadyBase.h:71
int & _time_step
The time step index.
Definition SteadyBase.h:65
FEProblemBase & _problem
Just an alias for now.
Definition SteadyBase.h:59