https://mooseframework.inl.gov
SetComponentBoolValueControl.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 
11 
12 registerMooseObject("ThermalHydraulicsApp", SetComponentBoolValueControl);
13 
16 {
18  params.addRequiredParam<std::string>("component", "The name of the component to be controlled.");
19  params.addRequiredParam<std::string>(
20  "parameter", "The name of the parameter in the component to be controlled.");
21  params.addRequiredParam<std::string>("value",
22  "The name of control data to be set in the component.");
23  params.addClassDescription(
24  "Control to set a boolean value of a component parameter with control data boolean");
25  return params;
26 }
27 
29  : THMControl(parameters),
30  _component_name(getParam<std::string>("component")),
31  _param_name(getParam<std::string>("parameter")),
32  _ctrl_param_name("component", _component_name, _param_name),
33  _value(getControlData<bool>("value"))
34 {
35 }
36 
37 void
39 {
40  setControllableValueByName<bool>(_ctrl_param_name, _value);
41 }
MooseObjectParameterName _ctrl_param_name
Control parameter name used internally by MOOSE (the name is generated by THM)
void addRequiredParam(const std::string &name, const std::string &doc_string)
SetComponentBoolValueControl(const InputParameters &parameters)
static InputParameters validParams()
Definition: THMControl.C:13
const bool & _value
The value that is written into the component.
registerMooseObject("ThermalHydraulicsApp", SetComponentBoolValueControl)
void addClassDescription(const std::string &doc_string)
Control to set a boolean value of a component parameter.