poICFD SetMaxStepLength

Syntax

poICFD_handle SetMaxStepLength step_mode step_length

Application

HyperView Tcl Modify

Description

This command specifies the maximum integration step length used in the process of the streamline creation in the CFD Plot/Streamlines panel, and returns success (if successful). Note that the step length actually used in the integration could be smaller than the value specified by this command, and that the step_mode must be on of the supported modes. You can get a list of supported modes from the CFD Plot/Streamlines panel by calling the GetIntegrationStepLengthModeList command.

Inputs

step_mode: The mode in which the maximum step length is defined. The only current valid mode is Element-fraction, which specifies that the maximum integration step length is defined based on a fraction of the current element size (the diagonal of the bounding box of the element).
step_length: The value used to define the maximum integration step length. The step mode of Element-fraction specifies the maximum step length as a fraction of the current element size. The minimum valid value is 0.002.

Example

To specify the maximum integration step length to be "0.25" of the current element size:

hwi OpenStack
hwi GetSessionHandle session_handle
session_handle GetProjectHandle project_handle
project_handle GetPageHandle page_handle [project_handle GetActivePage]
page_handle GetWindowHandle window_handle [page_handle GetActiveWindow]
window_handle GetClientHandle client_handle
client_handle GetModelHandle model_handle [client_handle GetActiveModel]
model_handle GetResultCtrlHandle result_handle
result_handle GetCFDCtrlHandle CFD_handle
CFD_handle SetMaxStepLength 0.25
hwi CloseStack

Error

Returns HW_InvalidArgs if the specified step_mode or step_length is not valid.