Difference between revisions of "HistoryArchive Custom Task"
(Created page with "A custom task to archive material history data in an alternate format. == Introduction == The [[MPMArchiving Options|<tt>ToArchive</tt> comm...") |
|||
Line 23: | Line 23: | ||
. . . | . . . | ||
</Schedule> | </Schedule> | ||
where the first two parameters, both of which are optional, are | |||
* <tt>(timeInterval)</tt> - Enter the time interval (in ms) between saving of VTK archives. If this parameter is omitted, the VTK archive files are written on the same steps as the [[MPM Archiving Options}particle archives]]. The one exception is that no VTK archive is written before the first step. | |||
* <tt>(firstTime)</tt> - Enter the time to save the first results (in ms). After this time is reached, subsequent archives will be spaced by the entered <tt>(timeInterval)</tt> This parameter is ignored unless the <tt>(timeInterval)</tt> parameter is set as well. To get a VTK archive after the first step, enter <tt>(firstTime)</tt> of zero. | |||
The remaining parameters each specify a <tt>(number)</tt> corresponding to a material history variable number. | |||
== Output Tab-Deliminted File == | |||
When this task is activated, the history data on each particle will be written to tab-delimited text files in the output results folder. The name of the file will include the archive path and will be followed by "_History_#.txt", where "#" is the step number. The file will begin with short header giving step number, step time, and column labels. Each row that follows will have data for one particle. It will include particle number, current particle position (in mm), and each requested history variable. |
Revision as of 09:07, 25 December 2013
A custom task to archive material history data in an alternate format.
Introduction
The ToArchive command options can only archive material history variables 1 through 4 for each particle. This custom task provides a method to archive more history variables and also provides an alternate format for archiving history variables 1 through 4.
Task Scheduling
In scripted files, a VTKArchive custom tasks is scheduled using
CustomTask HistoryArchive Parameter archiveTime,(timeInterval) Parameter firstArchiveTime,(firstTime) Parameter (number) . . .
In XML files, this tasks is scheduled using a Schedule element, which must be within the single <CustomTasks> block:
<Schedule name='HistoryArchive'> <Parameter name='archiveTime'>(timeInterval)</Parameter> <Parameter name='firstArchiveTime'>(firstTime)</Parameter> <Parameter name='(number)'/> . . . </Schedule>
where the first two parameters, both of which are optional, are
- (timeInterval) - Enter the time interval (in ms) between saving of VTK archives. If this parameter is omitted, the VTK archive files are written on the same steps as the [[MPM Archiving Options}particle archives]]. The one exception is that no VTK archive is written before the first step.
- (firstTime) - Enter the time to save the first results (in ms). After this time is reached, subsequent archives will be spaced by the entered (timeInterval) This parameter is ignored unless the (timeInterval) parameter is set as well. To get a VTK archive after the first step, enter (firstTime) of zero.
The remaining parameters each specify a (number) corresponding to a material history variable number.
Output Tab-Deliminted File
When this task is activated, the history data on each particle will be written to tab-delimited text files in the output results folder. The name of the file will include the archive path and will be followed by "_History_#.txt", where "#" is the step number. The file will begin with short header giving step number, step time, and column labels. Each row that follows will have data for one particle. It will include particle number, current particle position (in mm), and each requested history variable.