Category Mechanica, Object ProMechconstr

Function ProMechconvectiondataCsysGet


Description
Note: This function is deprecated. Creo Simulate now permits separate csys references to be used for the film coefficient and bulk temperature values governed by external files. See ProMechconvectiondataBulktempGet() ProMechconvectiondataFilmcoefficientGet() ProMechvariationTypeGet() ProMechvariationExternalfielddataGet() ProMechexternalfielddataCsysGet()

In the case where both the bulk temperature and film coefficient are governed by the same csys reference, this function will return that value. Otherwise, this function will return an error, and you should look at the ProMechVariation property of the ProMechValue extracted for both the bulk temperature and film coefficient. If either of these is set to PRO_MECH_VARIATION_EXTERNAL_FIELD, then that property is governed by an external file referencing the given csys.

Obtains the coordinate system used to determine the convection data.

Licensing Requirement
TOOLKIT for Mechanica
Synopsis
#include <ProMechConstraint.h>
ProErrorProMechconvectiondataCsysGet(
ProMechConvectionData data
/* (In)
The data.
*/
ProMechGeomref* csys
/* (Out)
The coordinate system. Free this using ProMechgeomrefFree().
*/
)
Returns
PRO_TK_NO_ERRORThe function succeeded.
PRO_TK_BAD_INPUTSOne or more input arguments are invalid.
PRO_TK_BAD_CONTEXTThe Creo Simulate session is not initialized.
PRO_TK_E_NOT_FOUNDNeither the bulk temperature nor the film coefficient are governed by an external file.
PRO_TK_OUT_OF_MEMORYNot enough memory to allocate data.