You can use the addMessageCallback method to associate an event-driven function with a particular message that is retrieved from ABAQUS/Standard or ABAQUS/Explicit. When ABAQUS/CAE retrieves the specific message from ABAQUS/Standard or ABAQUS/Explicit, the function executes and takes the necessary action. This type of function is called a callback function. The addMessageCallback method specifies which callback function to use for which message. The arguments to addMessageCallback are:

The interface definition of the callback function is

def functionName(jobName, messageType, data, userData)

The following script is an example of how you can use the messaging capability of the ABAQUS Scripting Interface. The callback function will intercept all jobs from all messages from ABAQUS/Standard or ABAQUS/Explicit and print the messages in the ABAQUS/CAE command line interface. Use the following command to retrieve the example script:

abaqus fetch job=simpleMonitor

"""
simpleMonitor.py

Print all messages issued during an ABAQUS 
analysis to the ABAQUS/CAE command line interface
"""

from abaqus import *
from abaqusConstants import *  
from jobMessage import ANY_JOB, ANY_MESSAGE_TYPE

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
def simpleCB(jobName, messageType, data, userData):
    """
    This callback prints out all the
    members of the data objects
    """

    format = '%-18s  %-18s  %s'
    
    print 'Message type: %s'%(messageType)
    print
    print 'data members:'
    print format%('member', 'type', 'value')
    
    members =  dir(data)
    for member in members:
        memberValue = getattr(data, member)
        memberType = type(memberValue).__name__
        print format%(member, memberType, memberValue)
    
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
def printMessages(start=ON):
    """
    Switch message printing ON or OFF
    """
    
    if start:
        monitorManager.addMessageCallback(ANY_JOB, 
            ANY_MESSAGE_TYPE, simpleCB, None)
    else:
        monitorManager.removeMessageCallback(ANY_JOB, 
            ANY_MESSAGE_TYPE, simpleCB, None)

You can use the Job object's waitForCompletion method to synchronize your script with a job that has been submitted. If you call the waitForCompletion method after you submit a job, the script waits until the analysis is complete before continuing. When the script continues, you should check the status of the job to ensure that the job completed successfully and did not abort. For example, the script described in “Reproducing the cantilever beam tutorial,” Section 7.1, uses waitForCompletion to ensure that the analysis job has finished executing successfully before the script opens the resulting output database and displays a contour plot of the results.

You can use an optional timeOut argument with the waitForCompletion method. The timeOut argument specifies the time in seconds that the script should wait for the job to complete until the script continues. If the job has not completed before the interval specified by the timeOut argument, the waitForCompletion method throws an AbaqusException exception. You must include a try statement to catch the exception thrown by a time out.

myJob1.submit()
try:
    myJob1.waitForCompletion(6000)
except AbaqusException, message:
    print "Job timed out", message

In the following example, the script submits myJob1 and waits for it to complete before submitting myJob2.

myJob1 = mdb.Job(name='Job-1')
myJob2 = mdb.Job(name='Job-2')
myJob1.submit()
myJob1.waitForCompletion()
myJob2.submit()
myJob2.waitForCompletion()

myJob1 = mdb.Job(name='Job-1')
myJob2 = mdb.Job(name='Job-2')
myJob1.submit()
myJob2.submit()
myJob1.waitForCompletion()
myJob2.waitForCompletion()

If the job submission is delayed using either the at or wait arguments, the interval specified by the timeOut argument includes both the time required to wait and the time required to execute. It is possible for the waitForCompletion method to time-out before the job is submitted. If this occurs, the script continues, and the waitForCompletion method throws an exception to indicate that the job did not run to completion because of a time-out; however, the computer system will still submit the job. As a result, if you use the at argument, you should add statements that check the status of the job and proceed accordingly.

The following section describes how you can use a callback function as an alternative to the waitForCompletion method described in “Waiting for a job to complete,” Section 6.8.2. The example uses messaging commands to synchronize a script with an ABAQUS/Standard or ABAQUS/Explicit analysis. Messaging commands set up a callback function that monitors messages from ABAQUS/Standard and ABAQUS/Explicit. When the desired message is received, the callback function executes.

The example uses a callback function that responds to all messages from ABAQUS/Standard and ABAQUS/Explicit. The function decides what action to take based on the messages received from a job called Deform. If the message indicates that the analysis job is complete, the function opens the output database created by the job and displays a default contour plot.

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# Define the callback function

from abaqus import *
from abaqusConstants import *

import visualization

def onMessage(jobName, messageType, data, viewport):
   if ((messageType==ABORTED) or (messageType==ERROR)):
       print 'Solver problem; stop execution of callback function'
   elif (messageType==JOB_COMPLETED):
       odb = visualization.openOdb(path=jobName + '.odb')
       viewport.setValues(displayedObject=odb)
       viewport.odbDisplay.setPlotMode(plotMode=CONTOUR)
     

The following statements show how the example script can be modified to use the callback function. After the first statement is executed, the callback function responds to all messages from the job named Deform. The final two statements create the job and submit it for analysis; the example script has now finished executing. When the job is complete, the callback function opens the resulting output database and displays a contour plot.

...
myJobName = 'Deform'
monitorManager.addMessageCallback(jobName='myJobName',
    messageType=ANY_MESSAGE_TYPE, callback=onMessage,
    userData=myViewport)
myJob = mdb.Job(name=myJobName, model='Beam',
    description=jobDescription)
myJob.submit()
# End of example script.

You can use the removeMessageCallback method at the end of the callback function to remove it from the system. The arguments to the removeMessageCallback method must be identical to the arguments to the corresponding addMessageCallback command that set up the callback function.