Difference between revisions of "LoadControl Custom Task"
Line 1: | Line 1: | ||
A [[MPM Input Files#Custom Tasks|custom task]] to | A [[MPM Input Files#Custom Tasks|custom task]] to adjust velocity of Rigid particles to match an inputted function. | ||
__TOC__ | __TOC__ | ||
== Introduction == | == Introduction == | ||
A <tt>LoadControl</tt> custom task can | A <tt>LoadControl</tt> custom task can either monitor [[MPM Global Archiving Options|global archive quantity]] and responds as follows: | ||
# Crack length monitoring: Once any crack or a specified crack reaches a specified crack length, all [[Crack Propagation Commands|crack propagation]] stops and the task's action is triggered | |||
# Global quantity monitoring: Once the specified global quantity passes a critical value, the task's action is triggered. | |||
The possible task actions are to reverse various boundary conditions, hold at current boundary conditions, stop the analysis, or continue (with no change except crack propagation stops). | |||
== Task Scheduling == | == Task Scheduling == | ||
In scripted files, a <tt> | In scripted files, a <tt>ReverseLoad</tt> custom task based on crack lengths or on a [[MPM Global Archiving Options|global archive quantity]] are scheduled with one of the two following blocks: | ||
CustomTask LoadControl | |||
Parameter maxLength,(length) | |||
Parameter crackNumber,(number) | |||
Parameter style,(style) | |||
Parameter hold,(holdTIme) | |||
CustomTask ReverseLoad | |||
Parameter quantity,(quant) | |||
Parameter material,(matOrBCID) | |||
Parameter maxValue,(value) | |||
Parameter style,(style) | |||
Parameter hold,(holdTIme) | |||
In <tt>XML</tt> files, these two task options are scheduled using <tt><Schedule></tt> elements, which must be within the single <tt><CustomTasks></tt> block: | |||
<Schedule name='ReverseLoad'> | |||
<Parameter name='maxLength'>(length)</Parameter> | |||
<Parameter name='crackNumber'>(number)</Parameter> | |||
<Parameter name='style'>(styleNumber)</Parameter> | |||
<Parameter name='hold'>(holdTime)</Parameter> | |||
</Schedule> | |||
<Schedule name='ReverseLoad'> | |||
<Parameter name='global (quant)'/> | |||
<Parameter name='mat'>(matOrBCNum)</Parameter> | |||
<Parameter name='maxValue'>(value)</Parameter> | |||
<Parameter name='style'>(styleNumber)</Parameter> | |||
<Parameter name='hold'>(holdTime)</Parameter> | |||
</Schedule> | |||
When the task triggers on crack length, these two parameters determine its trigger point: | |||
* <tt>(length)</tt> - specifies the maximum crack length (in [[ConsistentUnits Command#Legacy and Consistent Units|length units]]). Once this length is reached, all crack propagation will stop. | |||
* <tt>(number)</tt> - gives the crack number to watch. When that crack reaches the specified maximum length, the task will take effect. Alternatively, <tt>(number)</tt> can be zero which causes the task to take effect when any crack reaches the specified maximum length. The default value is 0 or to watch all cracks. | |||
When the task triggers on a [[MPM Global Archiving Options|global archive quantity]], these parameters determine its trigger point | |||
* <tt>(quant)</tt> - gives the name of the [[MPM Global Archiving Options|global archive quantity]] to use a trigger. In <tt>XML</tt> files, the quantiy name must be embedded in the parameter name, such as <tt>'global sxx'</tt>. | |||
* <tt>(matOrBCID)</tt> - if the desired [[MPM Global Archiving Options|global archive quantity]] is defined for a specific material or for a specific boundary condition, you must enter that [[Material Command Block|material ID]] or [[Setting Velocity, Temperature, and Concentration#Boundary Condition ID|boundary condition ID]] in this parameter (otherwise the entered quantity will not match the [[MPM Global Archiving Options|global archive quantity]]). | |||
* <tt>(matOrBCNum)</tt> - in <tt>XML</tt> files, the specific material or boundary condition ID must be specified by number (in cannot use a [[Material Command Block|material ID]]). | |||
* <tt>(value)</tt> - specifies the critical value for the [[MPM Global Archiving Options|global archive quantity]] to trigger the task action. If the number is positive, the action is triggered when the quantity reaches the value; if it is negative, the action is triggered when the quantity become more negative than the value. | |||
=== Task Action === | |||
Once the specified crack length is reached (and all crack propagation stops) or the critical [[MPM Global Archiving Options|global archive quantity]] is reached, the task performs various actions specified by the <tt>(style)</tt> and <tt>(hold)</tt> parameters. Scripted files can enter text for the style, but <tt>XML</tt> files must use the <tt>(styleNumber)</tt>: | |||
* <tt>reverse</tt> (or 0): Reverses all linearly increasing [[Setting Forces and Fluxes|loads or tractions]] (see [[Boundary Condition Styles|"linear" style]] in particle loads) and reverses direction of all [[Rigid Material|boundary-condition rigid particles]] moving at constant velocity (''i.e''., they have [[Rigid Material#Material Properties|set direction 1 to 7]] and do not use any [[Rigid Material#Material Properties|setting functions]]). This style will unload until the load or traction (on loaded particles) or displacement (on moving rigid particles) returns to zero at which point the analysis will stop (the analysis, however, may stop sooner if the [[MPM Methods and Simulation Timing#Input Commands|maximum time]] is reached before loading returns to zero). | |||
* <tt>hold</tt> (or 1): Stops all linearly increasing [[Setting Forces and Fluxes|loads or tractions]] (see [[Boundary Condition Styles|"linear" style]] in particle loads) at the current values and sets all [[Rigid Material|boundary-condition rigid particles]] moving at constant velocity (''i.e''., they have [[Rigid Material#Material Properties|set direction 1 to 7]] and do not use any [[Rigid Material#Material Properties|setting functions]]) to zero velocity. The analysis continues until [[MPM Methods and Simulation Timing#Input Commands|maximum time]] is reached. | |||
* <tt>continue</tt> (or 2): All loads, tractions, and rigid particles continue unchanged. Only the crack propagation stops. Because this action only stops crack propagation, it is meaningless when the tasks is triggered on a [[MPM Global Archiving Options|global archive quantity]], and is therefore not allowed for such tasks. | |||
* <tt>abort</tt> (or 3): The analysis terminates. | |||
The default <tt>(style)</tt> is to reverse loads, tractions, and particles to unload the specimen (as implied by the task name). Notice that <tt>reverse</tt> and <tt>hold</tt> affects only selected types of boundary conditions. The task has no affect on other types of [[MPM Input Files#Boundary Conditions|boundary conditions]]. | |||
If <tt>(holdTime)</tt> is set to a positive number, it gives a time (in [[ConsistentUnits Command#Legacy and Consistent Units|alt time units]]) to hold at current conditions before applying the task's action. The <tt>(hold)</tt> parameter only applies when <tt>(style)</tt> is <tt>reverse</tt> or <tt>abort</tt>. The hold phase will only hold boundary conditions that can be reversed (see <tt>reverse</tt> optoins above). After the hold phase is done, the <tt>reverse</tt> style will unload to zero as described above and the <tt>abort</tt> style will stop the analysis. The default <tt>(holdTime)</tt> is zero (or no hold phase). |
Revision as of 14:24, 26 April 2016
A custom task to adjust velocity of Rigid particles to match an inputted function.
Introduction
A LoadControl custom task can either monitor global archive quantity and responds as follows:
- Crack length monitoring: Once any crack or a specified crack reaches a specified crack length, all crack propagation stops and the task's action is triggered
- Global quantity monitoring: Once the specified global quantity passes a critical value, the task's action is triggered.
The possible task actions are to reverse various boundary conditions, hold at current boundary conditions, stop the analysis, or continue (with no change except crack propagation stops).
Task Scheduling
In scripted files, a ReverseLoad custom task based on crack lengths or on a global archive quantity are scheduled with one of the two following blocks:
CustomTask LoadControl Parameter maxLength,(length) Parameter crackNumber,(number) Parameter style,(style) Parameter hold,(holdTIme) CustomTask ReverseLoad Parameter quantity,(quant) Parameter material,(matOrBCID) Parameter maxValue,(value) Parameter style,(style) Parameter hold,(holdTIme)
In XML files, these two task options are scheduled using <Schedule> elements, which must be within the single <CustomTasks> block:
<Schedule name='ReverseLoad'> <Parameter name='maxLength'>(length)</Parameter> <Parameter name='crackNumber'>(number)</Parameter> <Parameter name='style'>(styleNumber)</Parameter> <Parameter name='hold'>(holdTime)</Parameter> </Schedule> <Schedule name='ReverseLoad'> <Parameter name='global (quant)'/> <Parameter name='mat'>(matOrBCNum)</Parameter> <Parameter name='maxValue'>(value)</Parameter> <Parameter name='style'>(styleNumber)</Parameter> <Parameter name='hold'>(holdTime)</Parameter> </Schedule>
When the task triggers on crack length, these two parameters determine its trigger point:
- (length) - specifies the maximum crack length (in length units). Once this length is reached, all crack propagation will stop.
- (number) - gives the crack number to watch. When that crack reaches the specified maximum length, the task will take effect. Alternatively, (number) can be zero which causes the task to take effect when any crack reaches the specified maximum length. The default value is 0 or to watch all cracks.
When the task triggers on a global archive quantity, these parameters determine its trigger point
- (quant) - gives the name of the global archive quantity to use a trigger. In XML files, the quantiy name must be embedded in the parameter name, such as 'global sxx'.
- (matOrBCID) - if the desired global archive quantity is defined for a specific material or for a specific boundary condition, you must enter that material ID or boundary condition ID in this parameter (otherwise the entered quantity will not match the global archive quantity).
- (matOrBCNum) - in XML files, the specific material or boundary condition ID must be specified by number (in cannot use a material ID).
- (value) - specifies the critical value for the global archive quantity to trigger the task action. If the number is positive, the action is triggered when the quantity reaches the value; if it is negative, the action is triggered when the quantity become more negative than the value.
Task Action
Once the specified crack length is reached (and all crack propagation stops) or the critical global archive quantity is reached, the task performs various actions specified by the (style) and (hold) parameters. Scripted files can enter text for the style, but XML files must use the (styleNumber):
- reverse (or 0): Reverses all linearly increasing loads or tractions (see "linear" style in particle loads) and reverses direction of all boundary-condition rigid particles moving at constant velocity (i.e., they have set direction 1 to 7 and do not use any setting functions). This style will unload until the load or traction (on loaded particles) or displacement (on moving rigid particles) returns to zero at which point the analysis will stop (the analysis, however, may stop sooner if the maximum time is reached before loading returns to zero).
- hold (or 1): Stops all linearly increasing loads or tractions (see "linear" style in particle loads) at the current values and sets all boundary-condition rigid particles moving at constant velocity (i.e., they have set direction 1 to 7 and do not use any setting functions) to zero velocity. The analysis continues until maximum time is reached.
- continue (or 2): All loads, tractions, and rigid particles continue unchanged. Only the crack propagation stops. Because this action only stops crack propagation, it is meaningless when the tasks is triggered on a global archive quantity, and is therefore not allowed for such tasks.
- abort (or 3): The analysis terminates.
The default (style) is to reverse loads, tractions, and particles to unload the specimen (as implied by the task name). Notice that reverse and hold affects only selected types of boundary conditions. The task has no affect on other types of boundary conditions.
If (holdTime) is set to a positive number, it gives a time (in alt time units) to hold at current conditions before applying the task's action. The (hold) parameter only applies when (style) is reverse or abort. The hold phase will only hold boundary conditions that can be reversed (see reverse optoins above). After the hold phase is done, the reverse style will unload to zero as described above and the abort style will stop the analysis. The default (holdTime) is zero (or no hold phase).