Functions
The functions described in this section provide access to the data and contents of Creo Simulate function items.
Function items use the ProType field in the ProMechitem structure as PRO_SIMULATION_FUNCTION.
Functions Introduced:
The function
ProMechfuncCsysGet() gets the reference co-ordinate system for the specified
Creo Simulate function item. Use the function
ProMechfuncCsysSet() to set the reference co-ordinate system for the specified
Creo Simulate function item.
The function
ProMechfuncDataGet() returns the handle to the function data of the
Creo Simulate item. Use the function
ProMechfuncDataSet() to set the value of the function data from the
Creo Simulate function item
The function
ProMechfuncDescriptionGet() returns the description of the
Creo Simulate function item. Use the function
ProMechfuncDescriptionSet() to set the function description of the
Creo Simulate item
The function
ProMechfuncVartypeGet() gets the function variation type of the
Creo Simulate item. Use the function
ProMechfuncVartypeSet() to set the function variation type for the
Creo Simulate item.
The function variation types are defined by the enumerated type ProMechfuncVarType, which has the following values:
• PRO_MECH_FUNC_UNIVERSAL—Specifies the default function type for the load.
• PRO_MECH_FUNC_COORD—Specifies the load as a function of the current coordinate system.
• PRO_MECH_FUNC_TIME—Specifies the load as a function of time.
• PRO_MECH_FUNC_TEMPERATURE—Specifies the load as a function of temperature.
• PRO_MECH_FUNC_DEFLECTION—Specifies the load as a function of deflection.
• PRO_MECH_FUNC_ARCLENGTH—Specifies the load as a function of arc length.
• PRO_MECH_FUNC_COORDS_TIME—Specifies the load as a combination of spatial (function of current coordinate system) and temporal (function of time) functions.
• PRO_MECH_FUNC_ARCLENGTH_TIME—Specifies the load as a combination of spatial (function of arc length) and temporal (function of time) functions.
The function
ProMechfuncdataTypeGet() determines the type of the function used to create the
Creo Simulate item. Specify the handle to the function data as the input for this function.
The output argument value specifies the type of the function and can have the following values:
• PRO_MECH_FUNCTION_SYMBOLIC—Specifies a symbolic expression for a function.
• PRO_MECH_FUNCTION_TABLE—Specifies a function created using data from an interpolation table.
Use the function
ProMechfuncdataTypeSet() to set the function type to be used to create the
Creo Simulate item.
The function
ProMechfuncdataExpressionGet() returns the symbolic expression for the specified symbolic function. Use the function
ProMechfuncdataExpressionSet() to set the symbolic expression for the specified symbolic function.
The function
ProMechfuncdataFuncvalueinterpGet() specifies the interpolation method used for the function value of the tabular function. The output argument
value can have the following values:
• PRO_MECH_TABLE_LINEAR—This method linearly interpolates the variable between the values.
• PRO_MECH_TABLE_LOGARITHMIC—This method linearly interpolates the log of the variable between values.
Use the function
ProMechfuncdataFuncvalueinterpSet() to set the interpolation method for the function value of the tabular function.
The function
ProMechfuncdataIndependentvarGet() returns the type of the independent variable for the specified tabular function. The independent variable corresponds to the coordinate system axes and has the following values:
• PRO_MECH_INDEP_VAR_X—Specifies the value of the X-axis in the Cartesian coordinate system.
• PRO_MECH_INDEP_VAR_Y—Specifies the value of the Y-axis in Cartesian coordinate system
• PRO_MECH_INDEP_VAR_Z—Specifies the value of the Z-axis in the Cartesian or cylindrical coordinate system.
• PRO_MECH_INDEP_VAR_R—Specifies the value of the radius in a cylindrical or spherical coordinate system.
• PRO_MECH_INDEP_VAR_THETA—Specifies the value of the angle in a cylindrical or spherical coordinate system.
• PRO_MECH_INDEP_VAR_PHI—Specifies the value of the second angle in a spherical coordinate system.
• PRO_MECH_INDEP_VAR_TIME—Specifies the value of the time variable (for a time-dependent function).
Use the function
ProMechfuncdataIndependentvarSet() to set the independent variable type for the specified tabular function.
The function
ProMechfuncdataIndepvarinterpGet() specifies the interpolation method used for the independent variable of the tabular function. Use the function
ProMechfuncdataIndepvarinterpSet() to set the interpolation method to be used for the independent variable of the tabular function.
The function
ProMechfuncdataMirrordeflectionflagGet() gets the value of the mirror flag for negative deflections from the function data.
Use the function
ProMechfuncdataMirrordeflectionflagSet() to set the value of the mirror flag for the negative deflections in the function data
The function
ProMechfuncdataFunctableGet() returns an array of table entries for the specified tabular function. Free the array of table entries using the function
ProMechtablentryProarrayFree(). Use the function
ProMechfuncdataFunctableSet() to set an array of table entries for the specified tabular function.
The function
ProMechtablentryFunctionvalueGet() returns the value of the specified function in the table entry. Use the function
ProMechtablentryFunctionvalueSet() to set the value of the specified function in the table entry.
The function
ProMechtablentryIndependentvarGet() returns the value for the specified independent variable in the table entry. Use the function
ProMechtablentryIndependentvarSet() to set the value for the specified independent variable in the table entry.
Use the function
ProMechfuncdataFree() to free the array containing the function data.