Field Names
The Field names drop-down menu allows you to select fields to be used in a Templex expression. The available options change depending on the attachment type selected from the Attach to drop-down menu, as well as the post-processing that has been applied.
Each field name has a Templex expression assigned to it. Below is a brief description of the Templex expressions that relate to the Window and Entity attachment types.
For Templex expressions that return a numeric value, the format and precision can be controlled by the user. Simply set the desired format and precision value before clicking Insert Field so that the expression with the proper syntax is inserted into the note box.
Window
- {window.modeltitle}
- The title of the currently loaded model.
- {window.loadcase}
- The label of the current subcase.
- {window.simulationstep}
- The label of the current simulation step.
- {window.modelfilename}
- Displays the path of the current model file.
- {window.shortmodelfilename}
- Displays the current model file name only (without the path).
- {window.resultfilename}
- Displays the path of the current result file.
- {window.shortresultfilename}
- Displays the current result file name only (without the path).
- {window.loadcasefilename}
- Displays the path of the file name for the current loadcase. This option is useful
when loading multiple result files on a single model.Note: In the case of a derived loadcase, which could be created from several result files, the expressions are shown as N/A.
- {window.shortloadcasefilename}
- Displays the file name (without the path) for the current loadcase. This option is
useful when loading multiple result files on a single model.Note: In the case of a derived loadcase, which could be created from several result files, the expressions are shown as N/A.
- {window.frame}
- Displays the current result frame number for the model.
- {for (i = 0; i != numpts(window.modeltitlelist); ++i) }
- {window.modelidlist[i]}: {window.modeltitlelist[i]}
- {window.loadcaselist[i]} : {window.simulationsteplist[i]} : {window.framelist[i]}
- Displays information about all of the models loaded in a window. This expression
block is located within a for loop.Note:
- The individual expressions within the loop are similar in syntax to the ones used for displaying information related to the current model, with the addition of a list[i] at the end. For example, to request the model title, the expression for the current model is {window.modeltitle}, whereas to request the titles of all of the models, the expression is {window.modeltitlelist[i]}.
- {window.modelidlist[i]} is a new expression.
- In previous versions, changes have been made to the model info content as a result of which the result file name is no longer shown by default. This can be easily modified should you wish to do so by adding the expression {window.resultfilenamelist[i]} within the for loop. This modification can be done either at the session level, or globally in the Preference file.
- {window.modelid}: {window.modeltitle}
- {window.loadcase} : {window.simulationstep} : {window.frame}
- Displays important information about the current model.
Entity
- {entity.id}
- The ID of the entity the note is attached to.
- {entity.label}
- The label of the entity the note is attached to. Returns “Element” for element, “Node” for node, and the label of the "part" for part (component).
- {entity.pool}
- The pool name to which the entity belongs to.
- {entity.coords}
- The global coordinates of the entity the note is attached to. In the case of parts
and elements, it is the centroid coordinates of the entity.Note: Format and precision for this field can be modified. If you would like to change the format and precision, set it before inserting the field in the note box.
- {parent.id}
- The ID of the parent of the entity the notes is attached to. For example, part (component) is the parent for nodes and assembly is the parent to part (component).
- {parent.label}
- The label of the parent of the entity the note is attached to.
- {parent.pool}
- The pool name of the parent of the entity the note is attached to.
- {entity.contour_val}
- The contour value of the entity the note is attached to.Note: From version 2019, this expression returns the underlying numeric value instead of subcase or simulation information in the case of envelope subcase/simulation trace plot.
To display subcase or simulation information in a note use the new expressions
entity.envelope_subcase
orentity.envelope_simulation
.Older session files, when loaded in version 2019, will automatically be updated to use the new expressions.
Note: Format and precision for this field can be modified. If you would like to change the format and precision, set it before inserting the field in the note box. In the case of a MaxLayer, MinLayer, ExtremeLayer or Top/Bottom contour plot the evaluated expression returns a string and not a numeric value. In this case, format and precision are not available. - {entity.contour_max}
- For a "part" (component) entity type, it corresponds to the max contour value of the
entity the note is attached to.
This does not have any significance for nodes/elements. It is the same as the contour value at that node/element.
Note: Format and precision for this field can be modified. If you would like to change the format and precision, set it before inserting the field in the note box. - {entity.contour_min}
- For a "part" (component) entity type, it corresponds to the min contour value of the
entity the note is attached to.
This does not have any significance for nodes/elements. It is the same as the contour value at that node/element.
Note: Format and precision for this field can be modified. If you would like to change the format and precision, set it before inserting the field in the note box. - {entity.contour_top}
- For a top/bottom layer contour, it corresponds to the top layer's contour value of
the entity the note is attached to.
This does not have any significance for a single layer contour. It just shows the layer's contour value.
Note: Format and precision for this field can be modified. If you would like to change the format and precision, set it before inserting the field in the note box. - {entity.contour_bottom}
- For a top/bottom layer contour, it corresponds to the bottom layer's contour value
of the entity the note is attached to.
This does not have any significance for a single layer contour. It just shows the layer's contour value.
Note: Format and precision for this field can be modified. If you would like to change the format and precision, set it before inserting the field in the note box. - {contour.datatype}
- The name of the data type which is contoured currently (for example: Displacement).
- {contour.component}
- The data type component which is contoured currently (for example: Mag).
- {contour.layer}
- Returns the layer name for which the result is contoured (for example: z1, z2, mid).
- {contour.layer_top}
- Returns the layer name for the top layer of the contour result (for example: z1, z2, mid).
- {contour.layer_bottom}
- Returns the layer name for the bottom layer of the contour result (for example: z1, z2, mid).
- {contour.legend_min}
- The current minimum of the static legend in the contour panel.Note: Format and precision for this field can be modified. If you would like to change the format and precision, set it before inserting the field in the note box.
- {contour.legend_max}
- The current maximum of the static legend in the contour panel.Note: Format and precision for this field can be modified. If you would like to change the format and precision, set it before inserting the field in the note box.
- {contour.legend_localmin}
- The current minimum of the dynamic legend in the contour panel.Note: Format and precision for this field can be modified. If you would like to change the format and precision, set it before inserting the field in the note box.
- {contour.legend_localmax}
- The current maximum of the dynamic legend in the contour panel.Note: Format and precision for this field can be modified. If you would like to change the format and precision, set it before inserting the field in the note box.
- {entity.envelope_subcase}
- The subcase to which the value belongs. Applicable only in the case of envelope load case trace plots.
- {entity.envelope_simulation}
- The simulation to which the value belongs. Applicable only in the case of envelope load case trace plots (except for a subcase trace plot).
- {component.id}
- The component ID of the entity the note is attached to.
- {Component.label}
- The component label of the entity the note is attached to.
- {entity.materialid}
- The material ID of the entity the note is attached to.
- {entity.materialname}
- The material label of the entity the note is attached to.
- {entity.propertyid}
- The property ID of the entity the note is attached to.
- {entity.propertyname}
- The property label of the entity the note is attached to.
- {element.corner}
- The element corner IDs of the element.
- {entity.originalPosition}
- The global coordinates of the entity the note is attached to, at model step. In the case of parts and elements, it is the centroid coordinates of the entity.
- {entity.position@step}
- The global coordinates of the entity the note is attached to, at given step ID. In the case of parts and elements, it is the centroid coordinates of the entity.
- {entity.contour_max_componentID}
- The component ID of the entity for which maximum contour value exists. This would be useful when there is a shared node and there are multiple contour values coming from different components.
- {entity.contour_min_componentID}
- The component ID of the entity for which minimum contour value exists. This would be useful when there is a shared node and there are multiple contour values coming from different components.
- {entity.contour_val.result}
- The contour value of the given result definition id and of the entity the note is attached to. This is used in the HyperView - MultiCore profile only.
- {entity.vector_val.result}
- The vector value of the given result definition id and of the entity the note is attached to. This is used in the HyperView - MultiCore profile only.
- {entity.tensor_val.result}
- The tensor value of the given result definition id and of the entity the note is attached to. This is used in the HyperView - MultiCore profile only.