https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
PIDControl Class Reference

This block represents a proportional-integral-derivative controller (PID controller). More...

#include <PIDControl.h>

Inheritance diagram for PIDControl:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 PIDControl (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. More...
 
std::vector< std::string > & getDependencies ()
 
virtual bool enabled () const
 
std::shared_ptr< MooseObject > getSharedPtr ()
 
std::shared_ptr< const MooseObject > getSharedPtr () const
 
MooseApp & getMooseApp () const
 
const std::string & type () const
 
virtual const std::string & name () const
 
std::string typeAndName () const
 
std::string errorPrefix (const std::string &error_type) const
 
void callMooseError (std::string msg, const bool with_prefix) const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
const InputParameters & parameters () const
 
MooseObjectName uniqueName () 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 &nm) const
 
void paramError (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
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void mooseError (Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) 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
 
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 UserObject & getUserObjectBase (const std::string &param_name, bool is_dependency=true) const
 
const UserObject & 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 MultiMooseEnum getExecuteOptions ()
 

Public Attributes

const ConsoleStream _console
 

Protected Member Functions

template<typename T >
T & declareComponentControlData (const std::string &data_name)
 Declare control data with name 'component:data_name'. More...
 
template<typename T >
T & declareControlData (const std::string &data_name)
 Declare control data with name 'data_name'. More...
 
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'. More...
 
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'. More...
 
template<typename T >
const T & getControlDataByName (const std::string &data_name)
 Get a reference to control data that are specified by 'data_name' name. More...
 
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. More...
 
template<typename T >
const T & getComponentControlDataOld (const std::string &data_name)
 Get a reference to a component control data value from previous time step. More...
 
bool hasControllableParameterByName (const std::string &name) 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 UserObject &) 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
 
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)
 

Protected Attributes

const Real & _value
 input data More...
 
const Real & _set_point
 set point More...
 
const Real & _K_p
 The coefficient for the proportional term. More...
 
const Real & _K_i
 The coefficient for the integral term. More...
 
const Real & _K_d
 The coefficient for the derivative term. More...
 
Real & _output
 The output computed by the PID controller. More...
 
const Real & _initial_value
 Initial value. More...
 
Real & _integral
 The integral value accumulated over time. More...
 
const Real & _integral_old
 The old value of _integral. More...
 
Real & _error
 The current value of the error. More...
 
const Real & _error_old
 The old value of the error. More...
 
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. More...
 
FEProblemBase & _fe_problem
 
std::vector< std::string > _depends_on
 
const bool & _enabled
 
MooseApp & _app
 
const std::string _type
 
const std::string _name
 
const InputParameters & _pars
 
Factory & _factory
 
ActionFactory & _action_factory
 
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
 

Detailed Description

This block represents a proportional-integral-derivative controller (PID controller).

It continuously calculates an error value e(t) as the difference between a desired setpoint and a measured process variable and applies a correction based on proportional, integral, and derivative terms.

Definition at line 20 of file PIDControl.h.

Constructor & Destructor Documentation

◆ PIDControl()

PIDControl::PIDControl ( const InputParameters &  parameters)

Definition at line 30 of file PIDControl.C.

31  : THMControl(parameters),
32  _value(getControlData<Real>("input")),
33  _set_point(getControlData<Real>("set_point")),
34  _K_p(getParam<Real>("K_p")),
35  _K_i(getParam<Real>("K_i")),
36  _K_d(getParam<Real>("K_d")),
37  _output(declareComponentControlData<Real>("output")),
38  _initial_value(getParam<Real>("initial_value")),
39  _integral(declareComponentControlData<Real>("integral")),
40  _integral_old(getComponentControlDataOld<Real>("integral")),
41  _error(declareComponentControlData<Real>("error")),
42  _error_old(getComponentControlDataOld<Real>("error"))
43 {
44  _integral = _initial_value;
45 }
THMControl::THMControl
THMControl(const InputParameters &parameters)
Definition: THMControl.C:23
PIDControl::_K_d
const Real & _K_d
The coefficient for the derivative term.
Definition: PIDControl.h:37
PIDControl::_output
Real & _output
The output computed by the PID controller.
Definition: PIDControl.h:39
PIDControl::_integral_old
const Real & _integral_old
The old value of _integral.
Definition: PIDControl.h:45
PIDControl::_initial_value
const Real & _initial_value
Initial value.
Definition: PIDControl.h:41
PIDControl::_K_i
const Real & _K_i
The coefficient for the integral term.
Definition: PIDControl.h:35
PIDControl::_value
const Real & _value
input data
Definition: PIDControl.h:29
PIDControl::_integral
Real & _integral
The integral value accumulated over time.
Definition: PIDControl.h:43
PIDControl::_set_point
const Real & _set_point
set point
Definition: PIDControl.h:31
PIDControl::_error_old
const Real & _error_old
The old value of the error.
Definition: PIDControl.h:49
Control::parameters
const InputParameters & parameters() const
PIDControl::_error
Real & _error
The current value of the error.
Definition: PIDControl.h:47
PIDControl::_K_p
const Real & _K_p
The coefficient for the proportional term.
Definition: PIDControl.h:33

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 }
Control::name
virtual const std::string & name() const
ControlData
Concrete definition of a parameter value for a specified type.
Definition: ControlData.h:91
Simulation::declareControlData
ControlData< T > * declareControlData(const std::string &name, THMControl *ctrl)
Declare control data of type T and name &#39;name&#39;, 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 }
ControlData
Concrete definition of a parameter value for a specified type.
Definition: ControlData.h:91
Simulation::declareControlData
ControlData< T > * declareControlData(const std::string &name, THMControl *ctrl)
Declare control data of type T and name &#39;name&#39;, if it does not exist it will be created.
Definition: Simulation.h:311
THMControl::_sim
THMProblem * _sim
Definition: THMControl.h:90

◆ execute()

void PIDControl::execute ( )
virtual

Implements Control.

Definition at line 48 of file PIDControl.C.

49 {
50  _error = _set_point - _value;
51  _integral = _integral_old + _K_i * (_error * _dt);
52  _output = _K_p * _error + _integral + _K_d * (_error - _error_old) / _dt;
53 }
PIDControl::_K_d
const Real & _K_d
The coefficient for the derivative term.
Definition: PIDControl.h:37
Control::_dt
Real & _dt
PIDControl::_output
Real & _output
The output computed by the PID controller.
Definition: PIDControl.h:39
PIDControl::_integral_old
const Real & _integral_old
The old value of _integral.
Definition: PIDControl.h:45
PIDControl::_K_i
const Real & _K_i
The coefficient for the integral term.
Definition: PIDControl.h:35
PIDControl::_value
const Real & _value
input data
Definition: PIDControl.h:29
PIDControl::_integral
Real & _integral
The integral value accumulated over time.
Definition: PIDControl.h:43
PIDControl::_set_point
const Real & _set_point
set point
Definition: PIDControl.h:31
PIDControl::_error_old
const Real & _error_old
The old value of the error.
Definition: PIDControl.h:49
PIDControl::_error
Real & _error
The current value of the error.
Definition: PIDControl.h:47
PIDControl::_K_p
const Real & _K_p
The coefficient for the proportional term.
Definition: PIDControl.h:33

◆ 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 }
Control::name
virtual const std::string & name() const

◆ 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
ControlData
Concrete definition of a parameter value for a specified type.
Definition: ControlData.h:91
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
THMControl::_sim
THMProblem * _sim
Definition: THMControl.h:90
Simulation::getControlData
ControlData< T > * getControlData(const std::string &name)
Get control data of type T and name &#39;name&#39;, if it does not exist it will be created.
Definition: Simulation.h:290
Control::mooseError
void mooseError(Args &&... args) const

◆ 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.

Referenced by Simulation::controlDataIntegrityCheck().

27  {
28  return _control_data_depends_on;
29  }
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

◆ 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
ControlData
Concrete definition of a parameter value for a specified type.
Definition: ControlData.h:91
THMControl::_sim
THMProblem * _sim
Definition: THMControl.h:90
Simulation::getControlData
ControlData< T > * getControlData(const std::string &name)
Get control data of type T and name &#39;name&#39;, if it does not exist it will be created.
Definition: Simulation.h:290
Control::mooseError
void mooseError(Args &&... args) const

◆ init()

virtual void THMControl::init ( )
inlinevirtualinherited

Reimplemented in ParsedFunctionControl, and UnitTripControl.

Definition at line 21 of file THMControl.h.

Referenced by Simulation::controlDataIntegrityCheck().

21 {}

◆ validParams()

InputParameters PIDControl::validParams ( )
static

Definition at line 15 of file PIDControl.C.

16 {
17  InputParameters params = THMControl::validParams();
18  params.addRequiredParam<std::string>("input", "The name of the control data that we read in.");
19  params.addRequiredParam<std::string>("set_point",
20  "The name of the control data with the set point.");
21  params.addRequiredParam<Real>("initial_value", "The initial value for the integral part.");
22  params.addRequiredParam<Real>("K_p", "The coefficient for the proportional term.");
23  params.addRequiredParam<Real>("K_i", "The coefficient for the integral term.");
24  params.addRequiredParam<Real>("K_d", "The coefficient for the derivative term.");
25  params.addClassDescription("Declares a control data named 'output' and uses Proportional "
26  "Integral Derivative logic on the 'value' control data to set it.");
27  return params;
28 }
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
THMControl::validParams
static InputParameters validParams()
Definition: THMControl.C:13
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

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().

◆ _error

Real& PIDControl::_error
protected

The current value of the error.

Definition at line 47 of file PIDControl.h.

Referenced by execute().

◆ _error_old

const Real& PIDControl::_error_old
protected

The old value of the error.

Definition at line 49 of file PIDControl.h.

Referenced by execute().

◆ _initial_value

const Real& PIDControl::_initial_value
protected

Initial value.

Definition at line 41 of file PIDControl.h.

Referenced by PIDControl().

◆ _integral

Real& PIDControl::_integral
protected

The integral value accumulated over time.

Definition at line 43 of file PIDControl.h.

Referenced by execute(), and PIDControl().

◆ _integral_old

const Real& PIDControl::_integral_old
protected

The old value of _integral.

Definition at line 45 of file PIDControl.h.

Referenced by execute().

◆ _K_d

const Real& PIDControl::_K_d
protected

The coefficient for the derivative term.

Definition at line 37 of file PIDControl.h.

Referenced by execute().

◆ _K_i

const Real& PIDControl::_K_i
protected

The coefficient for the integral term.

Definition at line 35 of file PIDControl.h.

Referenced by execute().

◆ _K_p

const Real& PIDControl::_K_p
protected

The coefficient for the proportional term.

Definition at line 33 of file PIDControl.h.

Referenced by execute().

◆ _output

Real& PIDControl::_output
protected

The output computed by the PID controller.

Definition at line 39 of file PIDControl.h.

Referenced by execute().

◆ _set_point

const Real& PIDControl::_set_point
protected

set point

Definition at line 31 of file PIDControl.h.

Referenced by execute().

◆ _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().

◆ _value

const Real& PIDControl::_value
protected

input data

Definition at line 29 of file PIDControl.h.

Referenced by execute().

The documentation for this class was generated from the following files:
Generated on Fri Jul 18 2025 13:49:43 for https://mooseframework.inl.gov by   doxygen 1.8.14