C_CreateFatigue

C_CreateFatigue is used to create a new OrcaFlex fatigue analysis object prior to performing a fatigue analysis using the functions C_CalculateFatigue, C_LoadFatigue, C_SaveFatigue, and C_DestroyFatigue.

A typical sequence of calls used to run a fatigue analysis is as follows:

• Call C_CreateFatigue to obtain a handle to a new fatigue analysis object.
• Optionally call C_LoadFatigue if you wish to open an existing OrcaFlex fatigue file.
• Set or modify the fatigue analysis data and load cases, as described below.
• Optionally call C_SaveFatigue if you wish to save the fatigue data to an OrcaFlex fatigue file.
• Call C_CalculateFatigue to perform the fatigue calculation and save the results.
• Optionally call C_SaveFatigue if you wish to save the fatigue results to an OrcaFlex fatigue file.
• Optionally call C_GetFatigueOutput to obtain fatigue results.
• Finally, call C_DestroyFatigue to dispose of the resources associated with the handle.

Setting the fatigue data

The data items required for a fatigue calculation are set in the same way as data items are set for model objects. Use the functions C_SetDataInteger, C_SetDataDouble, or C_SetDataString to set the data item values. The data item names are obtained from the Fatigue Analysis data form by selecting the data item of interest and pressing F7 or opening the popup menu and selecting the 'data names' option.

Data items in tables (for example LoadCaseFileName) require an index value for each row, the first row has an index of 1. To set indexed data you must first set the table size by calling C_SetDataInteger with the data name of the count variable for that table.

Some indexed data items have their own associated table data. To access these data you need to first select the relevant row in the parent table and then subsequent calls to the associated data items will apply to this selected object. For example, for S-N Curves, call C_SetDataString to set the data item SelectedSNcurve with the name of the S-N curve you want to edit the data for. Equivalently, you may call C_SetDataInteger to set the data item SelectedSNcurveIndex with the index of the required S-N curve in the list of such curves owned by the fatigue analysis object.

The data-setting functions have corresponding data-getting functions: C_GetDataInteger, C_GetDataDouble, and C_GetDataString.

See Model building: Setting the data and Model building: More complex data for more explanation and examples for similar data items.

Parameters

lpFatigueHandle (OUT)

Pointer to a TOrcFxAPIHandle variable in which the handle to the new fatigue analysis object is returned.

lpStatus (OUT)

Points to a variable in which the status result for the function call will be returned.

See also

C_CalculateFatigue, C_LoadFatigue, C_SaveFatigue, and C_DestroyFatigue.