https://mooseframework.inl.gov
Loading...
Searching...
No Matches
TerminateChainControl.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 "ChainControl.h"
13
18{
19public:
21
23
24 virtual void execute() override;
25
26protected:
30 void terminate();
31
34
36 const bool _throw_error;
37
39 const std::string & _termination_message;
40
42 const bool & _input;
43};
Control that additionally provides the capability to produce/consume data values, to allow control op...
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
Terminates the simulation when a boolean chain control data has a certain value.
virtual void execute() override
Execute the control.
const bool _throw_error
Flag to throw an error if the terminate condition is met.
void terminate()
Performs termination.
const bool _terminate_on_true
Whether to terminate on true or false.
const std::string & _termination_message
Message to use if termination occurs.
static InputParameters validParams()
const bool & _input
The control data that indicates if the simulation should be terminated.