https://mooseframework.inl.gov
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
TerminateControl Class Reference

This control block will terminate a run if its input indicates so. More...

#include <TerminateControl.h>

Inheritance diagram for TerminateControl:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 TerminateControl (const InputParameters &parameters)
 
virtual void execute ()
 
virtual void init ()
 
const std::vector< std::string > & getControlDataDependencies () const
 Return the Controls that must run before this Control.
 
std::vector< std::string > & getDependencies ()
 
virtual bool enabled () const
 
std::shared_ptr< MooseObject > getSharedPtr ()
 
std::shared_ptr< const MooseObject > getSharedPtr () const
 
bool isKokkosObject () const
 
MooseApp & getMooseApp () const
 
const std::string & type () const
 
const std::string & name () const
 
std::string typeAndName () const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
MooseObjectName uniqueName () const
 
const InputParameters & parameters () const
 
const hit::Node * getHitNode () const
 
bool hasBase () const
 
const std::string & getBase () const
 
const T & getParam (const std::string &name) const
 
std::vector< std::pair< T1, T2 > > getParam (const std::string &param1, const std::string &param2) const
 
const T * queryParam (const std::string &name) const
 
const T & getRenamedParam (const std::string &old_name, const std::string &new_name) const
 
T getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
 
bool isParamValid (const std::string &name) const
 
bool isParamSetByUser (const std::string &name) const
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void paramError (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramInfo (const std::string &param, Args... args) const
 
std::string messagePrefix (const bool hit_prefix=true) const
 
std::string errorPrefix (const std::string &) const
 
void mooseError (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseDeprecatedNoTrace (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
void callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) const
 
std::string getDataFileName (const std::string &param) const
 
std::string getDataFileNameByName (const std::string &relative_path) const
 
std::string getDataFilePath (const std::string &relative_path) const
 
bool isImplicit ()
 
Moose::StateArg determineState () const
 
virtual void initialSetup ()
 
virtual void timestepSetup ()
 
virtual void jacobianSetup ()
 
virtual void residualSetup ()
 
virtual void subdomainSetup ()
 
virtual void customSetup (const ExecFlagType &)
 
const ExecFlagEnum & getExecuteOnEnum () const
 
const Function & getFunction (const std::string &name) const
 
const Function & getFunctionByName (const FunctionName &name) const
 
bool hasFunction (const std::string &param_name) const
 
bool hasFunctionByName (const FunctionName &name) const
 
Moose::Kokkos::Function getKokkosFunction (const std::string &name) const
 
const T & getKokkosFunction (const std::string &name) const
 
Moose::Kokkos::Function getKokkosFunctionByName (const FunctionName &name) const
 
const T & getKokkosFunctionByName (const FunctionName &name) const
 
bool hasKokkosFunction (const std::string &param_name) const
 
bool hasKokkosFunctionByName (const FunctionName &name) const
 
UserObjectName getUserObjectName (const std::string &param_name) const
 
const T & getUserObject (const std::string &param_name, bool is_dependency=true) const
 
const T & getUserObjectByName (const UserObjectName &object_name, bool is_dependency=true) const
 
const UserObjectBase & getUserObjectBase (const std::string &param_name, bool is_dependency=true) const
 
const UserObjectBase & getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObject (const std::string &param_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
bool hasUserObjectByName (const UserObjectName &object_name) const
 
PerfGraph & perfGraph ()
 
bool isDefaultPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessor (const std::string &param_name, const unsigned int index=0) const
 
bool hasPostprocessorByName (const PostprocessorName &name) const
 
std::size_t coupledPostprocessors (const std::string &param_name) const
 
const PostprocessorName & getPostprocessorName (const std::string &param_name, const unsigned int index=0) const
 
const VectorPostprocessorValue & getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const VectorPostprocessorValue & getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
 
const ScatterVectorPostprocessorValue & getScatterVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool hasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
 
bool hasVectorPostprocessor (const std::string &param_name) const
 
bool hasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool hasVectorPostprocessorByName (const VectorPostprocessorName &name) const
 
const VectorPostprocessorName & getVectorPostprocessorName (const std::string &param_name) const
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
const PostprocessorValue & getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
virtual const PostprocessorValue & getPostprocessorValueByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOldByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
const PostprocessorValue & getPostprocessorValueOlderByName (const PostprocessorName &name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributed (const std::string &param_name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
bool isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const
 
const Parallel::Communicator & comm () const
 
processor_id_type n_processors () const
 
processor_id_type processor_id () const
 

Static Public Member Functions

static InputParameters validParams ()
 
static void callMooseError (MooseApp *const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node *node, const bool show_trace=true)
 
static MultiMooseEnum getExecuteOptions ()
 

Public Attributes

 usingCombinedWarningSolutionWarnings
 
const ConsoleStream _console
 

Static Public Attributes

static const std::string type_param
 
static const std::string name_param
 
static const std::string unique_name_param
 
static const std::string app_param
 
static const std::string moose_base_param
 
static const std::string kokkos_object_param
 

Protected Member Functions

template<typename T >
T & declareComponentControlData (const std::string &data_name)
 Declare control data with name 'component:data_name'.
 
template<typename T >
T & declareControlData (const std::string &data_name)
 Declare control data with name 'data_name'.
 
template<typename T >
const T & getControlData (const std::string &param_name)
 Get a reference to control data that are specified in the input parameter 'param_name'.
 
template<typename T >
const T & getControlDataOld (const std::string &param_name)
 Get a reference to control data value from a previous time step that is specified in the input parameter 'param_name'.
 
template<typename T >
const T & getControlDataByName (const std::string &data_name)
 Get a reference to control data that are specified by 'data_name' name.
 
template<typename T >
const T & getControlDataOldByName (const std::string &data_name)
 Get a reference to control data value from previous time step that is specified by 'data_name' name.
 
template<typename T >
const T & getComponentControlDataOld (const std::string &data_name)
 Get a reference to a component control data value from previous time step.
 
bool hasControllableParameterByName (const std::string &name) const
 
void flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const
 
InvalidSolutionID registerInvalidSolutionInternal (const std::string &message, const bool warning) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level) const
 
PerfID registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const
 
std::string timedSectionName (const std::string &section_name) const
 
virtual void addUserObjectDependencyHelper (const UserObjectBase &) const
 
T & declareRestartableData (const std::string &data_name, Args &&... args)
 
ManagedValue< T > declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
const T & getRestartableData (const std::string &data_name) const
 
T & declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
 
T & declareRecoverableData (const std::string &data_name, Args &&... args)
 
T & declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)
 
T & declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)
 
std::string restartableName (const std::string &data_name) const
 
virtual void addPostprocessorDependencyHelper (const PostprocessorName &) const
 
virtual void addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &) const
 
const ReporterContextBase & getReporterContextBaseByName (const ReporterName &reporter_name) const
 
const ReporterName & getReporterName (const std::string &param_name) const
 
virtual void addReporterDependencyHelper (const ReporterName &)
 
ControllableParameter getControllableParameter (const std::string &param_name)
 
ControllableParameter getControllableParameter (const std::string &param_name)
 
ControllableParameter getControllableParameterByName (const std::string &param_name)
 
ControllableParameter getControllableParameterByName (const std::string &tag, const std::string &object_name, const std::string &param_name)
 
ControllableParameter getControllableParameterByName (const MooseObjectName &object_name, const std::string &param_name)
 
ControllableParameter getControllableParameterByName (const MooseObjectParameterName &param_name)
 
ControllableParameter getControllableParameterByName (const std::string &param_name)
 
ControllableParameter getControllableParameterByName (const std::string &tag, const std::string &object_name, const std::string &param_name)
 
ControllableParameter getControllableParameterByName (const MooseObjectName &object_name, const std::string &param_name)
 
ControllableParameter getControllableParameterByName (const MooseObjectParameterName &param_name)
 
T getControllableValue (const std::string &name, bool warn_when_values_differ=true)
 
T getControllableValue (const std::string &name, bool warn_when_values_differ=true)
 
T getControllableValueByName (const std::string &name, bool warn_when_values_differ=true)
 
T getControllableValueByName (const std::string &object_name, const std::string &param_name, bool warn_when_values_differ=true)
 
T getControllableValueByName (const MooseObjectName &object_name, const std::string &param_name, bool warn_when_values_differ=true)
 
T getControllableValueByName (const std::string &tag, const std::string &object_name, const std::string &param_name, bool warn_when_values_differ=true)
 
T getControllableValueByName (const MooseObjectParameterName &desired, bool warn_when_values_differ=true)
 
T getControllableValueByName (const std::string &name, bool warn_when_values_differ=true)
 
T getControllableValueByName (const std::string &object_name, const std::string &param_name, bool warn_when_values_differ=true)
 
T getControllableValueByName (const MooseObjectName &object_name, const std::string &param_name, bool warn_when_values_differ=true)
 
T getControllableValueByName (const std::string &tag, const std::string &object_name, const std::string &param_name, bool warn_when_values_differ=true)
 
T getControllableValueByName (const MooseObjectParameterName &desired, bool warn_when_values_differ=true)
 
void setControllableValue (const std::string &name, const T &value)
 
void setControllableValue (const std::string &name, const T &value)
 
void setControllableValueByName (const std::string &name, const T &value)
 
void setControllableValueByName (const std::string &object_name, const std::string &param_name, const T &value)
 
void setControllableValueByName (const MooseObjectName &object_name, const std::string &param_name, const T &value)
 
void setControllableValueByName (const std::string &tag, const std::string &object_name, const std::string &param_name, const T &value)
 
void setControllableValueByName (const MooseObjectParameterName &name, const T &value)
 
void setControllableValueByName (const std::string &name, const T &value)
 
void setControllableValueByName (const std::string &object_name, const std::string &param_name, const T &value)
 
void setControllableValueByName (const MooseObjectName &object_name, const std::string &param_name, const T &value)
 
void setControllableValueByName (const std::string &tag, const std::string &object_name, const std::string &param_name, const T &value)
 
void setControllableValueByName (const MooseObjectParameterName &name, const T &value)
 
const T & getReporterValue (const std::string &param_name, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, const std::size_t time_index=0)
 
const T & getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)
 
const T & getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValue (const std::string &param_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 
bool hasReporterValueByName (const ReporterName &reporter_name) const
 

Protected Attributes

const bool _throw_error
 Flag to throw an error if the terminate condition is met.
 
const std::string & _termination_message
 Message to use if termination occurs.
 
const bool & _terminate
 The control data that indicates if the simulation should be terminated.
 
THMProblem * _sim
 
std::vector< std::string > _control_data_depends_on
 A list of control data that are required to run before this control may run.
 
FEProblemBase & _fe_problem
 
std::vector< std::string > _depends_on
 
const bool & _enabled
 
MooseApp & _app
 
Factory & _factory
 
ActionFactory & _action_factory
 
const std::string & _type
 
const std::string & _name
 
const InputParameters & _pars
 
MooseApp & _pg_moose_app
 
const std::string _prefix
 
const InputParameters & _ti_params
 
FEProblemBase & _ti_feproblem
 
bool _is_implicit
 
Real & _t
 
const Real & _t_old
 
int & _t_step
 
Real & _dt
 
Real & _dt_old
 
bool _is_transient
 
const ExecFlagEnum & _execute_enum
 
const ExecFlagType & _current_execute_flag
 
MooseApp & _restartable_app
 
const std::string _restartable_system_name
 
const THREAD_ID _restartable_tid
 
const bool _restartable_read_only
 
const Parallel::Communicator & _communicator
 

Private Member Functions

const Moose::FunctionBase * getKokkosFunctionByNameHelper (const FunctionName &name) const
 
const UserObjectBase & getUserObjectFromFEProblem (const UserObjectName &object_name, const THREAD_ID tid=0) const
 
const T & castUserObject (const UserObjectBase &uo_base, const std::string &param_name="") const
 
void mooseObjectError (const std::string &param_name, std::stringstream &oss) const
 
const std::string & userObjectType (const UserObjectBase &uo) const
 
const std::string & userObjectName (const UserObjectBase &uo) const
 
RestartableDataValue & registerRestartableDataOnApp (std::unique_ptr< RestartableDataValue > data, THREAD_ID tid) const
 
void registerRestartableNameWithFilterOnApp (const std::string &name, Moose::RESTARTABLE_FILTER filter)
 
RestartableData< T > & declareRestartableDataHelper (const std::string &data_name, void *context, Args &&... args) const
 
const PostprocessorName & getPostprocessorNameInternal (const std::string &param_name, const unsigned int index, const bool allow_default_value=true) const
 
bool isDefaultPostprocessorValueByName (const PostprocessorName &name) const
 
PostprocessorValue getDefaultPostprocessorValueByName (const PostprocessorName &name) const
 
void checkParam (const std::string &param_name, const unsigned int index=std::numeric_limits< unsigned int >::max()) const
 
bool postprocessorsAdded () const
 
const VectorPostprocessorValue & getVectorPostprocessorByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name, bool broadcast, std::size_t t_index) const
 
const VectorPostprocessorContext< VectorPostprocessorValue > & getVectorPostprocessorContextByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name) const
 
bool vectorPostprocessorsAdded () const
 
bool reportersAdded () const
 
void possiblyCheckHasReporter (const ReporterName &reporter_name, const std::string &param_name="") const
 
const PostprocessorValue & getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const
 
const PostprocessorValue & getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const
 
const PostprocessorValue & getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const
 
const PostprocessorValue & getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const
 
void possiblyCheckHasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
 
void possiblyCheckHasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
 
void possiblyCheckHasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 
void possiblyCheckHasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
 

Static Private Member Functions

static const hit::Node * getHitNode (const InputParameters &params)
 
static std::string messagePrefix (const InputParameters &params, const bool hit_prefix)
 

Private Attributes

InputParameterWarehouse & _input_parameter_warehouse
 
const ParallelParamObject & _parent
 
const MooseBase & _si_moose_base
 
const FEProblemBase * _si_problem
 
const std::string _ti_name
 
ExecFlagEnum _empty_execute_enum
 
const MooseObject & _fni_object
 
const InputParameters & _fni_params
 
FEProblemBase & _fni_feproblem
 
const THREAD_ID _fni_tid
 
const MooseObject & _uoi_moose_object
 
const FEProblemBase & _uoi_feproblem
 
const THREAD_ID _uoi_tid
 
const RestartableDataMapName _metaname
 
std::string _restartable_name
 
const MooseObject & _ppi_moose_object
 
const InputParameters & _ppi_params
 
const FEProblemBase & _ppi_feproblem
 
std::map< PostprocessorName, std::unique_ptr< PostprocessorValue > > _default_values
 
const bool _broadcast_by_default
 
const MooseObject & _vpi_moose_object
 
const FEProblemBase & _vpi_feproblem
 
const THREAD_ID _vpi_tid
 
const InputParameters & _ri_params
 
FEProblemBase & _ri_fe_problem_base
 
const ReporterData & _ri_reporter_data
 
const MooseObject & _ri_moose_object
 

Detailed Description

This control block will terminate a run if its input indicates so.

Definition at line 17 of file TerminateControl.h.

Constructor & Destructor Documentation

◆ TerminateControl()

TerminateControl::TerminateControl ( const InputParameters &  parameters)

Definition at line 29 of file TerminateControl.C.

30 : THMControl(parameters),
31
32 _throw_error(getParam<bool>("throw_error")),
33 _termination_message(getParam<std::string>("termination_message")),
34 _terminate(getControlData<bool>("input"))
35{
36}
Control::parameters
const InputParameters & parameters() const
TerminateControl::_termination_message
const std::string & _termination_message
Message to use if termination occurs.
Definition TerminateControl.h:29
TerminateControl::_terminate
const bool & _terminate
The control data that indicates if the simulation should be terminated.
Definition TerminateControl.h:32
TerminateControl::_throw_error
const bool _throw_error
Flag to throw an error if the terminate condition is met.
Definition TerminateControl.h:26

Member Function Documentation

◆ declareComponentControlData()

template<typename T >
T & THMControl::declareComponentControlData ( const std::string &  data_name)
protectedinherited

Declare control data with name 'component:data_name'.

Parameters
data_nameA unique name for the control data

Definition at line 101 of file THMControl.h.

102{
103 std::string full_name = name() + ":" + data_name;
104 ControlData<T> * data_ptr = _sim->declareControlData<T>(full_name, this);
105 return data_ptr->set();
106}
T
const double T
Definition GasLiquidMassTransferTest.C:19
ControlData
Concrete definition of a parameter value for a specified type.
Definition ControlData.h:92
Control::name
const std::string & name() const
Simulation::declareControlData
ControlData< T > * declareControlData(const std::string &name, THMControl *ctrl)
Declare control data of type T and name 'name', if it does not exist it will be created.
Definition Simulation.h:311
THMControl::_sim
THMProblem * _sim
Definition THMControl.h:90

◆ declareControlData()

template<typename T >
T & THMControl::declareControlData ( const std::string &  data_name)
protectedinherited

Declare control data with name 'data_name'.

Parameters
data_nameA unique name for the control data

Definition at line 110 of file THMControl.h.

111{
112 ControlData<T> * data_ptr = _sim->declareControlData<T>(data_name, this);
113 return data_ptr->set();
114}

◆ execute()

void TerminateControl::execute ( )
virtual

Implements Control.

Definition at line 39 of file TerminateControl.C.

40{
41 if (_terminate)
42 {
43 if (_throw_error)
44 mooseError(_termination_message);
45 else
46 {
47 _console << _termination_message << std::endl;
48 _fe_problem.terminateSolve();
49 }
50 }
51}
Control::_console
const ConsoleStream _console
Control::_fe_problem
FEProblemBase & _fe_problem
Control::mooseError
void mooseError(Args &&... args) const
FEProblemBase::terminateSolve
virtual void terminateSolve()

◆ getComponentControlDataOld()

template<typename T >
const T & THMControl::getComponentControlDataOld ( const std::string &  data_name)
protectedinherited

Get a reference to a component control data value from previous time step.

Parameters
data_nameThe name of the control data

Definition at line 165 of file THMControl.h.

166{
167 std::string full_name = name() + ":" + data_name;
168 return getControlDataOldByName<T>(full_name);
169}

◆ getControlData()

template<typename T >
const T & THMControl::getControlData ( const std::string &  param_name)
protectedinherited

Get a reference to control data that are specified in the input parameter 'param_name'.

Parameters
param_nameThe parameter name that contains the name of the control data

Definition at line 118 of file THMControl.h.

119{
120 std::string data_name = getParam<std::string>(param_name);
121 return getControlDataByName<T>(data_name);
122}

◆ getControlDataByName()

template<typename T >
const T & THMControl::getControlDataByName ( const std::string &  data_name)
protectedinherited

Get a reference to control data that are specified by 'data_name' name.

Parameters
data_nameThe name of the control data

Definition at line 134 of file THMControl.h.

135{
136 ControlData<T> * data_ptr = _sim->getControlData<T>(data_name);
137 if (data_ptr == nullptr)
138 mooseError("Trying to get control data '",
139 data_name,
140 "', but it does not exist in the system. Check your spelling.");
141
142 // set up dependencies for this control object
143 auto it = std::find(_control_data_depends_on.begin(), _control_data_depends_on.end(), data_name);
144 if (it == _control_data_depends_on.end())
145 _control_data_depends_on.push_back(data_name);
146
147 return data_ptr->get();
148}
ControlData::get
const T & get() const
Definition ControlData.h:108
Simulation::getControlData
ControlData< T > * getControlData(const std::string &name)
Get control data of type T and name 'name', if it does not exist it will be created.
Definition Simulation.h:290
THMControl::_control_data_depends_on
std::vector< std::string > _control_data_depends_on
A list of control data that are required to run before this control may run.
Definition THMControl.h:93

◆ getControlDataDependencies()

const std::vector< std::string > & THMControl::getControlDataDependencies ( ) const
inlineinherited

Return the Controls that must run before this Control.

Definition at line 26 of file THMControl.h.

27 {
28 return _control_data_depends_on;
29 }

Referenced by Simulation::controlDataIntegrityCheck().

◆ getControlDataOld()

template<typename T >
const T & THMControl::getControlDataOld ( const std::string &  param_name)
protectedinherited

Get a reference to control data value from a previous time step that is specified in the input parameter 'param_name'.

Parameters
param_nameThe parameter name that contains the name of the control data

Definition at line 126 of file THMControl.h.

127{
128 std::string data_name = getParam<std::string>(param_name);
129 return getControlDataOldByName<T>(data_name);
130}

◆ getControlDataOldByName()

template<typename T >
const T & THMControl::getControlDataOldByName ( const std::string &  data_name)
protectedinherited

Get a reference to control data value from previous time step that is specified by 'data_name' name.

Parameters
data_nameThe name of the control data

Definition at line 152 of file THMControl.h.

153{
154 ControlData<T> * data_ptr = _sim->getControlData<T>(data_name);
155 if (data_ptr == nullptr)
156 mooseError("Trying to get control data '",
157 data_name,
158 "', but it does not exist in the system. Check your spelling.");
159
160 return data_ptr->getOld();
161}
ControlData::getOld
const T & getOld() const
Definition ControlData.h:113

◆ init()

virtual void THMControl::init ( )
inlinevirtualinherited

Reimplemented in ParsedFunctionControl, and UnitTripControl.

Definition at line 21 of file THMControl.h.

21{}

Referenced by Simulation::controlDataIntegrityCheck().

◆ validParams()

InputParameters TerminateControl::validParams ( )
static

Definition at line 16 of file TerminateControl.C.

17{
18 InputParameters params = THMControl::validParams();
19 params.addClassDescription(
20 "Terminates the simulation when a THMControl boolean data becomes true");
21 params.addRequiredParam<std::string>(
22 "input", "The name of boolean control data indicating if simulation should be terminated.");
23 params.addParam<bool>("throw_error", false, "Flag to throw an error on termination");
24 params.addRequiredParam<std::string>("termination_message",
25 "Message to use if termination occurs");
26 return params;
27}
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)
THMControl::validParams
static InputParameters validParams()
Definition THMControl.C:13

Member Data Documentation

◆ _control_data_depends_on

std::vector<std::string> THMControl::_control_data_depends_on
protectedinherited

A list of control data that are required to run before this control may run.

Definition at line 93 of file THMControl.h.

Referenced by THMControl::getControlDataByName(), and THMControl::getControlDataDependencies().

◆ _sim

THMProblem* THMControl::_sim
protectedinherited

Definition at line 90 of file THMControl.h.

Referenced by UnitTripControl::buildConditionFunction(), ParsedFunctionControl::buildFunction(), THMControl::declareComponentControlData(), THMControl::declareControlData(), THMControl::getControlDataByName(), and THMControl::getControlDataOldByName().

◆ _terminate

const bool& TerminateControl::_terminate
protected

The control data that indicates if the simulation should be terminated.

Definition at line 32 of file TerminateControl.h.

Referenced by execute().

◆ _termination_message

const std::string& TerminateControl::_termination_message
protected

Message to use if termination occurs.

Definition at line 29 of file TerminateControl.h.

Referenced by execute().

◆ _throw_error

const bool TerminateControl::_throw_error
protected

Flag to throw an error if the terminate condition is met.

Definition at line 26 of file TerminateControl.h.

Referenced by execute().

The documentation for this class was generated from the following files:
Generated on Fri Aug 21 2026 13:43:57 for https://mooseframework.inl.gov by doxygen 1.9.8