THMOutputVectorVelocityAction

This action creates a user parameter "velocity_as_vector" in the [Outputs] block. This parameter can be used to output the velocity variable as a vector-valued or scalar-valued field. The vector-valued option is on by default.

Input Parameters

  • 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

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

  • velocity_as_vectorTrueTrue for vector-valued velocity, false for scalar velocity.

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:True for vector-valued velocity, false for scalar velocity.

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.

Advanced Parameters

References

No citations exist within this document.