www.mooseframework.org
Problem.h
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 #pragma once
11 
12 #include "MooseObject.h"
13 #include "PerfGraphInterface.h"
14 
15 class TimePeriodOld;
16 class Problem;
17 
18 template <>
20 
24 class Problem : public MooseObject, public PerfGraphInterface
25 {
26 public:
28 
30  virtual ~Problem();
31 
32  virtual void init() = 0;
33 
37  void _setCLIOption() { _cli_option_found = true; }
38 
42  virtual void terminateSolve() { _termination_requested = true; };
43 
49 
50 protected:
52  bool _cli_option_found;
53 
56 
59 };
60 
Problem::validParams
static InputParameters validParams()
Definition: Problem.C:17
Problem::init
virtual void init()=0
Problem::terminateSolve
virtual void terminateSolve()
Allow objects to request clean termination of the solve.
Definition: Problem.h:42
PerfGraphInterface.h
Problem::_color_output
bool _color_output
True if we're going to attempt to write color output.
Definition: Problem.h:55
Problem::isSolveTerminationRequested
virtual bool isSolveTerminationRequested()
Check of termination has been requested.
Definition: Problem.h:48
Problem::_setCLIOption
void _setCLIOption()
For Internal Use.
Definition: Problem.h:37
MooseObject::parameters
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:76
MooseObject
Every object that can be built by the factory should be derived from this class.
Definition: MooseObject.h:50
InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
Definition: InputParameters.h:53
Problem
Class that hold the whole problem being solved.
Definition: Problem.h:24
MooseObject.h
Problem::_cli_option_found
bool _cli_option_found
True if the CLI option is found.
Definition: Problem.h:48
validParams< Problem >
InputParameters validParams< Problem >()
PerfGraphInterface
Interface for objects that needs transient capabilities.
Definition: PerfGraphInterface.h:31
Problem::Problem
Problem(const InputParameters &parameters)
Definition: Problem.C:25
Problem::_termination_requested
bool _termination_requested
True if termination of the solve has been requested.
Definition: Problem.h:58
Problem::~Problem
virtual ~Problem()
Definition: Problem.C:34