![]() |
IoProcess
The GeMA I/O Process Plugin
|
The options
table, optionally supplied as a parameter to the file saving process functions, controls the final format of the resulting file. When filling this table, keep in mind that only options different from the default are needed. When an option is not present in the table, its default value will be used. Since not every option is supported by every file format, the last column lists the formats that support the given option. The supported options are:
Attribute | Description | Type | Def. Value | Supported by |
---|---|---|---|---|
split | When set to true, all saved vector values will be splitted into scalar values and saved as scalars. | Boolean | false | Medit and Neutral file |
materialPropertySet | Defines which property set, among those associated with the saved mesh, should be used to define the material index associated with mesh cells. | String | nil | Medit and Neutral file |
saveDisplacements | When set to true, includes a nodal displacement section on the saved neutral file. Must be used together with "split = true" and the displacement vector must be the first entry in the nodeValues list. | String | nil | Neutral file |
scaleFactorX | A scale factor applied over the X node coordinate (savedX = scaleFactorX * X + offsetX). | Number | 1.0 | All |
scaleFactorY | A scale factor applied over the Y node coordinate (savedY = scaleFactorY * Y + offsetY). | Number | 1.0 | All |
scaleFactorZ | A scale factor applied over the Z node coordinate (savedZ = scaleFactorZ * Z + offsetZ). | Number | 1.0 | All |
offsetX | An offset added to the X node coordinate (savedX = scaleFactorX * X + offsetX). | Number | 0.0 | All |
offsetY | An offset added to the Y node coordinate (savedY = scaleFactorY * Y + offsetY). | Number | 0.0 | All |
offsetZ | An offset added to the Z node coordinate (savedZ = scaleFactorZ * Z + offsetZ). | Number | 0.0 | All |
coordAttribute | The name of a node attribte that will be used to replace the mesh coordinate in the saved file. If empty, the mesh coordinate will be used. | String | nil | All |
state | The state number used to find values when an attribute / state variable has an associated history. If the state is invalid for a saved data, the default will be used for it. | Integer | 0 (present state) | All |
allStates | When set to true, all the history states associated with the saved attributes / state variables will be saved to the file. Makes sense only if all variables share the same number of states (or have exactly one state which will be used for all states). | Boolean | false | Neutral file |
activeOnly | When set to true, only active cells will be saved. | Boolean | false | Medit |
activeNodesOnly | When set to true and activeOnly is also set to true, only nodes that belong to active cells will be saved to the file. This option will trigger a node reordering on the saved file. | Boolean | false | Medit |
tempFileMask | The file mask used when creating a temporary file for saving multiple results on a Neutral file. The file mask must be a file path, which can include path macros, where the file name includes a "XXXXXX" (6 X characters) part that will be replaced by a unique string. If this option is missing, the default will be "$SIMULATIONDIR/$SIMULATIONNAME_nf_XXXXXX.tmp" . | String | See description | Neutral file |
forDumping | When set to true while saving multiple results to a Neutral file, the resulting temporary file will not be erased after the saving is completed since it will take part on a state dump. | Boolean | false | Neutral file |