Creo Simulate Spring Property Items
The functions described in this section provide access to the data and contents of the Creo Simulate spring property items. Spring properties use the ProType field in the ProMechitem structure as PRO_SIMULATION_SPRING_PROPS.
Functions Introduced:
• ProMechspringpropsDescriptionGet()
• ProMechspringpropsDescriptionSet()
• ProMechSpringpropsBooleanGet()
• ProMechSpringpropsBooleanSet()
• ProMechSpringpropsMatrixGet()
• ProMechSpringpropsMatrixSet()
• ProMechSpringpropsVectorGet()
• ProMechSpringpropsVectorSet()
Functions Superseded:
• ProMechspringpropsdataAlloc()
• ProMechspringpropsDataGet()
• ProMechspringpropsDataSet()
• ProMechspringpropsdataDampingcoefficientsGet()
• ProMechspringpropsdataDampingcoefficientsSet()
• ProMechspringpropsdataExtensionalcoefficientsGet()
• ProMechspringpropsdataExtensionalcoefficientsSet()
• ProMechspringpropsdataTorsionalcoefficientsGet()
• ProMechspringpropsdataTorsionalcoefficientsSet()
• ProMechspringpropsdataCouplingcoefficientsGet()
• ProMechspringpropsdataCouplingcoefficientsSet()
• ProMechspringpropsdataAutocouplingGet()
• ProMechspringpropsdataAutocouplingSet()
• ProMechspringpropsdataFree()
The function ProMechspringpropsDataGet() provides access to the data structure containing the Spring Properties data. The function ProMechspringpropsDataGet() has been deprecated. Use either ProMechspringpropsMatrixGet() or ProMechspringpropsVectorGet() instead.
The functions listed above provide read and write access to the definition of the spring properties. You can access the name, description, extensional, torsional and coupling stiffness, and the damping coefficients for the spring properties.
The function ProMechspringpropsDescriptionGet() returns the description for the spring property. Use the function ProMechspringpropsDescriptionSet() to set the description for the spring property.
The functions ProMechSpringpropsBooleanGet/Set, ProMechSpringpropsMatrixGet/Set, and ProMechSpringpropsVectorGet/Set use the enumerated type ProMechSpringpropsPropertyType to define the spring property type.
The enumerated type ProMechSpringpropsPropertyType has the following values:
• PRO_MECH_SPRINGPROPS_EXTENSIONAL
• PRO_MECH_SPRINGPROPS_TORSIONAL
• PRO_MECH_SPRINGPROPS_COUPLING
• PRO_MECH_SPRINGPROPS_DAMPING
• PRO_MECH_SPRINGPROPS_AUTOCOUPLING
The function ProMechSpringpropsBooleanGet() gets the Boolean value for the autocoupling option. Use the function ProMechSpringpropsBooleanSet() to set the Boolean value for the autocoupling option.
The function
ProMechSpringpropsMatrixGet() returns the
Creo Simulate matrix handle
ProMechMatrix. Use the function
ProMechSpringpropsMatrixSet() to set the handle to
ProMechMatrix. The functions
ProMechMatrixComponentGet/Set provide read and write access to the individual matrix components. For more information about handling matrix components, see
Creo Simulate Matrix Functions.
The output matrix gets the following values depending on the spring property type:
• Extensional coefficients (Kxx,Kyy,Kzz,Kxy,Kxz,Kyz)
• Torsional coefficients (Txx,Tyy,Tzz,Txy,Txz,Tyz)
• Coupling coefficients (KTxx, KTxy, KTxz, KTyx, KTyy, KTyz, KTzx, KTzy, KTzz)
The function ProMechSpringpropsMatrixGet() automatically allocates memory for the Creo Simulate matrix handle. Use the function ProMechMatrixFree() to free the assigned memory.
The function
ProMechSpringpropsVectorGet() returns the
Creo Simulate vector handle
ProMechVector. Use the function
ProMechSpringpropsVectorSet() to set the handle to
ProMechVector. The functions
ProMechVectorComponentGet/Set provide read and write access to the individual vector components. For more information about handling vector components, see
Creo Simulate Vector Functions.. The vector returns the damping coefficients (Cxx, Cyy, Czz) as output. The function
ProMechSpringpropsVectorGet() automatically allocates the memory for the
Creo Simulate vector handle. Use the function
ProMechVectorFree() to free the memory.