IoProcess
The GeMA I/O Process Plugin
Loading...
Searching...
No Matches
Saving options

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 (NF, XDMF) Supported by (NF, XDMF)
split When set to true, all saved vector values will be split into scalar values and saved as scalars. Boolean false, true Yes, Yes
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, nil Yes, Yes
saveDisplacements When set to true, includes a nodal displacement section on the saved neutral file. The displacement vector must be 'u' attribute. bool nil Yes, No
discontinuitySet Defines which associated discontinuitySet should be saved. String nil, nil No, Yes
discontinuityMode When discontinuitySet attribute is set, defines which discontinuitySet data is saved, can be one of the values {"original", "intersection", "both"}. String "original", nil No, Yes
scaleFactorX A scale factor applied over the X node coordinate (savedX = scaleFactorX * X + offsetX). Number 1.0 Yes, Yes
scaleFactorY A scale factor applied over the Y node coordinate (savedY = scaleFactorY * Y + offsetY). Number 1.0 Yes, Yes
scaleFactorZ A scale factor applied over the Z node coordinate (savedZ = scaleFactorZ * Z + offsetZ). Number 1.0 Yes, Yes
offsetX An offset added to the X node coordinate (savedX = scaleFactorX * X + offsetX). Number 0.0 Yes, Yes
offsetY An offset added to the Y node coordinate (savedY = scaleFactorY * Y + offsetY). Number 0.0 Yes, Yes
offsetZ An offset added to the Z node coordinate (savedZ = scaleFactorZ * Z + offsetZ). Number 0.0 Yes, Yes
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, nil Yes, Yes
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, 0 (present state) Yes, Yes
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, false Yes, Yes
activeOnly When set to true, only active cells will be saved. Boolean false, false Yes, Yes
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, false Yes, Yes
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 Yes, No
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, false Yes, Yes
saveNodeId Saves extra attribute column with node index. Boolean true*, false Yes, Yes
saveIntNodeId Saves extra attribute column with node indexing used internally (reordered). Boolean false, false Yes, Yes
saveNodeBcTags Saves extra attribute column with node boundary condition tags. Boolean false, false No, Yes
saveCellId Saves extra attribute column with cell index. Boolean false, false Yes, Yes
saveIntCellId Saves extra attribute column with cell indexing used internally (reordered). Boolean false, false Yes, Yes
saveCellType Saves extra attribute column with cell types. Boolean false, false Yes, Yes
saveCellActive Saves extra attribute column with cell active flag. Boolean false, false Yes, Yes
saveCellMaterial Saves extra attribute column with cell material. Boolean true*, false Yes, Yes
saveGaussId Saves extra attribute column with gauss point index. Boolean true*, false Yes, Yes
saveMinMax Saves the minimum and maximum vaules for each meshData attribute. Boolean false, false No, Yes
savePartialXdmf Saves partial xdmf files separated (XDMF only). Boolean false, false No, Yes
splitDataFile Saves each time step in a separated file (XDMF only). Boolean false, false No, Yes
singlePrecision Saves data in single precision float instead of double (XDMF only). Boolean false, false No, Yes