TimeRampFunction

Ramps up to a value from another value over time.

Input Parameters

  • final_valueFinal value

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Final value

  • initial_valueInitial value

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Initial value

  • ramp_durationDuration, in seconds, of the ramp

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Duration, in seconds, of the ramp

Required Parameters

  • initial_time0Initial time (necessary if not equal to zero)

    Default:0

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Initial time (necessary if not equal to zero)

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.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Set the enabled status of the MooseObject.

Advanced Parameters

References

No citations exist within this document.