CosineHumpFunction

Computes a cosine hump of a user-specified width and height

This function is a hump generated by one period of a cosine function, with a user-defined minimum, maximum, location, and width. It is useful for generating smoothly varying functions, for instance, for initial conditions.

Input Parameters

  • axisCoordinate axis on which the hump occurs

    C++ Type:MooseEnum

    Unit:(no unit assumed)

    Options:x, y, z

    Controllable:No

    Description:Coordinate axis on which the hump occurs

  • hump_begin_valueValue before and after the hump

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Value before and after the hump

  • hump_center_positionHump center position on selected axis

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Hump center position on selected axis

  • hump_center_valueValue at the center of the hump

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Value at the center of the hump

  • hump_widthWidth of the hump

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Width of the hump

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