Messaging#

Messaging commands are available only if Abaqus/CAE is run interactively using the GUI.

Object features#

DataObject#

class DataObject[source]#

An instance of the DataObject object is passed to each callback. The DataObject object has no methods. The members of a DataObject object depend on the type of the object. All DataObject instances have the following members, regardless of type:

Notes

This object can be accessed by:

Attributes:

phase: SymbolicConstant: A SymbolicConstant specifying the phase of the analysis. Possible values are BATCHPRE_PHASE, PACKAGER_PHASE, STANDARD_PHASE, EXPLICIT_PHASE, CALCULATOR_PHASE, and UNKNOWN_PHASE.
processId: int: An Int specifying the process ID of the analysis product.
threadId: int: An Int specifying the thread ID of the analysis product. Threads are used for parallel or multiprocessing; in most cases threadId is set to zero.
timeStamp: int: An Int specifying the time the message was sent in seconds since 00:00:00 UTC, January 1, 1970.
attempts: int: An Int specifying the number of attempts made to reach equilibrium during this step.
dof: int: An Int specifying the degree of freedom requested for monitoring the output.
equilibrium: int: An Int specifying the number of equilibrium iterations made during this increment.
increment: int: An Int specifying the increment of the analysis.
iterations: int: An Int specifying the number of iterations in the step.
node: int: An Int specifying the node number requested for monitoring output.
severe: int: An Int specifying the number of severe discontinuity iterations completed during this increment.
step: int: An Int specifying the current step number. Step number 1 corresponds to the first step.
stepId: int: An Int specifying the ID of the step.
stepTime: float: A Float specifying the step time corresponding to the current increment.
time: float: A Float specifying the total time corresponding to the monitor data.
timeIncrement: float: A Float specifying the time increment used in the current step.
totalTime: float: A Float specifying the total time completed in the analysis.
value: float: A Float specifying the current value of the degree of freedom requested for monitoring.
clientHost: str: A String specifying the host name of the machine that is running the analysis.
clientName: str: A String specifying the name of the client that responded to the callback function. Possible values are BatchPre, Packager, Standard, Explicit, and Calculator.
file: str: A String specifying the full path of the output database.
heading: str: A String specifying the job heading.
message: str: A String specifying the job heading.
nset: str: A String specifying the node set specified for monitoring output.
stepName: str: A String specifying the name of the step.

MonitorMgr#

class MonitorMgr[source]#

An instance of the MonitorMgr object is created when you import the abaqus module. No other instance of the MonitorMgr object is required. (This MonitorMgr object is not to be confused with the degree of freedom (DOF) monitor that is constructed from the Step object.)

Notes

This object can be accessed by:

monitorManager

Methods

`addMessageCallback`(jobName, messageType, ...)	This method specifies a callback function that will be called when the specified message is received from the analysis product.
`checkMonitorStatus`()	This method raises a MonitorError exception if the monitoring status is not ENABLED.
`removeMessageCallback`(jobName, messageType, ...)	This method removes a callback function.

addMessageCallback(jobName: str, messageType: SymbolicConstantType, callback: SymbolicConstantType, userData: str = '')[source]#

This method specifies a callback function that will be called when the specified message is received from the analysis product. For more information, see An example of a callback function.

Parameters:

jobName: A String specifying the name of the job to be monitored or the SymbolicConstant ANY_JOB.
messageType: A SymbolicConstant specifying which message type will call this callback. Possible values are:ABORTEDANY_JOBANY_MESSAGE_TYPECOMPLETEDEND_STEPERRORHEADINGHEALER_JOBHEALER_TYPEINTERRUPTEDITERATIONJOB_ABORTEDJOB_COMPLETEDJOB_INTERRUPTEDJOB_SUBMITTEDMONITOR_DATAODB_FILEODB_FRAMESIMULATION_ABORTEDSIMULATION_COMPLETEDSIMULATION_INTERRUPTEDSIMULATION_SUBMITTEDSTARTEDSTATUSSTEPWARNING
callback: A Python function to be called. The interface definition of the callback function is :`def onMessage(jobName, messageType, data, userData)`*jobName* is a String.*messageType* is a SymbolicConstant with possible values as listed previously for the addMessageCallback method.*data* is a DataObject object.*userData* is the object passed as the userData argument to the addMessageCallback method.
userData: Any Python object or None. This object is passed to the callback function.

checkMonitorStatus()[source]#

This method raises a MonitorError exception if the monitoring status is not ENABLED.

Raises:

MonitorError: Status is not ENABLED

removeMessageCallback(jobName: str, messageType: SymbolicConstantType, callback: str, userData: str)[source]#

This method removes a callback function. You specify the callback function to remove using the same arguments you used to add the callback.

Parameters:

jobName: A String specifying the name of the job to be monitored or the SymbolicConstant ANY_JOB.
messageType: A SymbolicConstant specifying which message type will call this callback. Possible values are: - ABORTED - ANY_JOB - ANY_MESSAGE_TYPE - COMPLETED - END_STEP - ERROR - HEADING - HEALER_JOB - HEALER_TYPE - INTERRUPTED - ITERATION - JOB_ABORTED - JOB_COMPLETED - JOB_INTERRUPTED - JOB_SUBMITTED - MONITOR_DATA - ODB_FILE - ODB_FRAME - SIMULATION_ABORTED - SIMULATION_COMPLETED - SIMULATION_INTERRUPTED - SIMULATION_SUBMITTED - STARTED - STATUS - STEP - WARNING
callback: A Python function to be called; it must be the same as the callback argument specified in the original call to addMessageCallback.
userData: Any Python object or None; it must be the same as the userData argument specified in the original call to addMessageCallback.