Tasks Manager¶
The GEOSX tasks manager allows a user to specify tasks to be executed. These tasks are compatible targets for the Event Management.
The tasks manager is configured via the Tasks
block in an input .xml file, i.e.:
<Tasks>
<PackCollection name="historyCollection" objectPath="nodeManager" fieldName="Velocity" />
</Tasks>
Tasks Manager Configuration¶
Task¶
The children of the Tasks block define different Tasks to be triggered by events specified in the Event Management during the execution of the simulation. At present the only supported task is the PackCollection
used to collect time history data for output by a TimeHistory output.
Name | Type | Default | Description |
---|---|---|---|
PackCollection | node | Element: PackCollection |
PackCollection¶
The PackCollection
Task is used to collect time history information from fields. Either the entire field or specified named sets of indices in the field can be collected.
Name | Type | Default | Description |
---|---|---|---|
fieldName | string | required | The name of the (packable) field associated with the specified object to retrieve data from |
minSetSize | localIndex | -1 | The minimum size of the set(s) to be collected (use for sets that expand during the simulation). |
name | string | required | A name is required for any non-unique nodes |
objectPath | string | required | The name of the object from which to retrieve field values. |
setNames | string_array | {} | The set(s) for which to retrieve data. |
Note: The time history information collected via this task is buffered internally until it is output by a linked TimeHistory Output.
Triggering the Tasks¶
Tasks can be triggered using the Event Management.
Recurring tasks sould use a <PeriodicEvent>
and one-time tasks should use a <SoloEvent>:
<PeriodicEvent name="historyCollectEvent"
timeFrequency="1.0"
targetExactTimeset="1"
target="/Tasks/historyCollection" />
The keyword target
has to match the name
of a Task specified as a child of the <Tasks>
block.