AddPeriodicControllers

buildconstruction:Undocumented Action Class

The AddPeriodicControllers has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

This Action automatically adds multiply 'TimePeriod' controllers forthe purpose of enabling and disabling multiple objects during multiple cycles.(Ideally for periodic accelerations)

Overview

Example Input File Syntax

This Action automatically adds multiply 'TimePeriod' controllers forthe purpose of enabling and disabling multiple objects during multiple cycles.(Ideally for periodic accelerations)

Input Parameters

  • cycle_frequencyThe cycle's frequency in Hz

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The cycle's frequency in Hz

  • nameCustom name for the 'PeriodicControllers'.

    C++ Type:std::string

    Unit:(no unit assumed)

    Controllable:No

    Description:Custom name for the 'PeriodicControllers'.

  • num_controller_setThe number of controller sets(e.g. the number of accelerations)

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The number of controller sets(e.g. the number of accelerations)

Required Parameters

  • Disable_at_cycle_endA list of objects names to disable at the end of the cycle.

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

    Unit:(no unit assumed)

    Controllable:No

    Description:A list of objects names to disable at the end of the cycle.

  • Disable_at_cycle_startA list of objects names to disable at the start of the cycle.

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

    Unit:(no unit assumed)

    Controllable:No

    Description:A list of objects names to disable at the start of the cycle.

  • Disable_during_cycleA list of objects names to disable during the cycle.

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

    Unit:(no unit assumed)

    Controllable:No

    Description:A list of objects names to disable during the cycle.

  • Enable_at_cycle_endA list of objects names to enable at the end of the cycle.

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

    Unit:(no unit assumed)

    Controllable:No

    Description:A list of objects names to enable at the end of the cycle.

  • Enable_at_cycle_startA list of objects names to enable at the start of the cycle.

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

    Unit:(no unit assumed)

    Controllable:No

    Description:A list of objects names to enable at the start of the cycle.

  • Enable_during_cycleA list of objects names to enable during the cycle.

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

    Unit:(no unit assumed)

    Controllable:No

    Description:A list of objects names to enable during the cycle.

  • active__all__ If specified only the blocks named will be visited and made active

    Default:__all__

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

    Unit:(no unit assumed)

    Controllable:No

    Description:If specified only the blocks named will be visited and made active

  • cycles_between_controls1The number of cycles between controllers(e.g. the number of cycles between accelerations)

    Default:1

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The number of cycles between controllers(e.g. the number of cycles between accelerations)

  • familyLAGRANGESpecifies the family of FE shape functions to use for this variable

    Default:LAGRANGE

    C++ Type:MooseEnum

    Unit:(no unit assumed)

    Options:LAGRANGE, MONOMIAL, HERMITE, SCALAR, HIERARCHIC, CLOUGH, XYZ, SZABAB, BERNSTEIN, L2_LAGRANGE, L2_HIERARCHIC, NEDELEC_ONE, LAGRANGE_VEC, MONOMIAL_VEC, RAVIART_THOMAS, RATIONAL_BERNSTEIN, SIDE_HIERARCHIC, L2_HIERARCHIC_VEC, L2_LAGRANGE_VEC, L2_RAVIART_THOMAS

    Controllable:No

    Description:Specifies the family of FE shape functions to use for this variable

  • inactiveIf specified blocks matching these identifiers will be skipped.

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

    Unit:(no unit assumed)

    Controllable:No

    Description:If specified blocks matching these identifiers will be skipped.

  • initial_conditionSpecifies a constant initial condition for this variable

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Specifies a constant initial condition for this variable

  • orderFIRSTSpecifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)

    Default:FIRST

    C++ Type:MooseEnum

    Unit:(no unit assumed)

    Options:CONSTANT, FIRST, SECOND, THIRD, FOURTH

    Controllable:No

    Description:Specifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)

  • scalingSpecifies a scaling factor to apply to this variable

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Specifies a scaling factor to apply to this variable

  • starting_cycle0The number of the cycles before starting the control scheme

    Default:0

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The number of the cycles before starting the control scheme

Optional Parameters

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

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

    Unit:(no unit assumed)

    Controllable:No

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

  • isObjectActionTrueIndicates that this is a MooseObjectAction.

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Indicates that this is a MooseObjectAction.

Advanced Parameters