PIDControl

buildconstruction:Undocumented Class

The PIDControl has not been documented. The content contained on this page includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

Input Parameters

  • K_dThe coefficient for the derivative term.

    C++ Type:double

    Controllable:No

    Description:The coefficient for the derivative term.

  • K_iThe coefficient for the integral term.

    C++ Type:double

    Controllable:No

    Description:The coefficient for the integral term.

  • K_pThe coefficient for the proportional term.

    C++ Type:double

    Controllable:No

    Description:The coefficient for the proportional term.

  • initial_valueThe initial value for the integral part.

    C++ Type:double

    Controllable:No

    Description:The initial value for the integral part.

  • inputThe name of the control data that we read in.

    C++ Type:std::string

    Controllable:No

    Description:The name of the control data that we read in.

  • set_pointThe name of the control data with the set point.

    C++ Type:std::string

    Controllable:No

    Description:The name of the control data with the set point.

Required Parameters

  • depends_onThe Controls that this control relies upon (i.e. must execute before this one)

    C++ Type:std::vector<std::string>

    Controllable:No

    Description:The Controls that this control relies upon (i.e. must execute before this one)

Optional Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector<std::string>

    Controllable:No

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Set the enabled status of the MooseObject.

  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Determines whether this object is calculated using an implicit or explicit form

Advanced Parameters

Input Files

References

No citations exist within this document.