Abaqus Job#

The Job object is the abstract base type for other Job objects. The Job object has no explicit constructor. The methods and members of the Job object are common to all objects derived from Job.

Create jobs#

JobMdb.Job(name: str, model: str, description: str = '', type: SymbolicConstantType = 'ANALYSIS', queue: str = '', waitHours: int = 0, waitMinutes: int = 0, atTime: str = '', echoPrint: BooleanType = 0, contactPrint: BooleanType = 0, modelPrint: BooleanType = 0, historyPrint: BooleanType = 0, scratch: str = '', userSubroutine: str = '', numCpus: int = 1, memory: int = 90, memoryUnits: SymbolicConstantType = 'PERCENTAGE', explicitPrecision: SymbolicConstantType = 'SINGLE', nodalOutputPrecision: SymbolicConstantType = 'SINGLE', parallelizationMethodExplicit: SymbolicConstantType = 'DOMAIN', numDomains: int = 1, activateLoadBalancing: BooleanType = 0, multiprocessingMode: SymbolicConstantType = 'DEFAULT', licenseType: SymbolicConstantType = 'DEFAULT', *args, **kwargs) ModelJob[source]

This method creates an analysis job using a model on a model database (MDB) for the model definition.

Parameters:
name

A String specifying the name of the new job. The name must be a valid Abaqus/CAE object name.

model

A String specifying the name of the model to be analyzed or a Model object specifying the model to be analyzed.

description

A String specifying a description of the job.

type

A SymbolicConstant specifying the type of job. Possible values are ANALYSIS, SYNTAXCHECK, RECOVER, and RESTART. The default value is ANALYSIS.If the object has the type JobFromInputFile, *type*=RESTART is not available.

queue

A String specifying the name of the queue to which to submit the job. The default value is an empty string.Note:You can use the queue argument when creating a Job object on a Windows workstation; however, remote queues are available only on Linux platforms.

waitHours

An Int specifying the number of hours to wait before submitting the job. This argument is ignored if queue is set. The default value is 0.This argument works in conjunction with waitMinutes. waitHours and atTime are mutually exclusive.

waitMinutes

An Int specifying the number of minutes to wait before submitting the job. This argument is ignored if queue is set. The default value is 0.This argument works in conjunction with waitHours. waitMinutes and atTime are mutually exclusive.

atTime

A String specifying the time at which to submit the job. If queue is empty, the string syntax must be valid for the Linux at command. If queue is set, the syntax must be valid according to the system administrator. The default value is an empty string.Note:You can use the atTime argument when creating a Job object on a Windows workstation; however, the at command is available only on Linux platforms.

echoPrint

A Boolean specifying whether an echo of the input data is printed. The default value is OFF.

contactPrint

A Boolean specifying whether contact constraint data are printed. The default value is OFF.

modelPrint

A Boolean specifying whether model definition data are printed. The default value is OFF.

historyPrint

A Boolean specifying whether history data are printed. The default value is OFF.

scratch

A String specifying the location of the scratch directory. The default value is an empty string.

userSubroutine

A String specifying the file containing the user’s subroutine definitions. The default value is an empty string.

numCpus

An Int specifying the number of CPUs to use for this analysis if parallel processing is available. Possible values are numCpus >> 0. The default value is 1.

memory

An Int specifying the amount of memory available to Abaqus analysis. The value should be expressed in the units supplied in memoryUnits. The default value is 90.

memoryUnits

A SymbolicConstant specifying the units for the amount of memory used in an Abaqus analysis. Possible values are PERCENTAGE, MEGA_BYTES, and GIGA_BYTES. The default value is PERCENTAGE.

explicitPrecision

A SymbolicConstant specifying whether to use the double precision version of Abaqus/Explicit. Possible values are SINGLE, FORCE_SINGLE, DOUBLE, DOUBLE_CONSTRAINT_ONLY, and DOUBLE_PLUS_PACK. The default value is SINGLE.

nodalOutputPrecision

A SymbolicConstant specifying the precision of the nodal output written to the output database. Possible values are SINGLE and FULL. The default value is SINGLE.

parallelizationMethodExplicit

A SymbolicConstant specifying the parallelization method for Abaqus/Explicit. This value is ignored for Abaqus/Standard. Possible values are DOMAIN and LOOP. The default value is DOMAIN.

numDomains

An Int specifying the number of domains for parallel execution in Abaqus/Explicit. When parallelizationMethodExplicit*=DOMAIN, *numDomains must be a multiple of numCpus. The default value is 1.

activateLoadBalancing

A Boolean specifying whether to activate dyanmic load balancing for jobs running on multiple processors with multiple domains in Abaqus/Explicit. The default value is OFF.

multiprocessingMode

A SymbolicConstant specifying whether an analysis is decomposed into threads or into multiple processes that communicate through a message passing interface (MPI). Possible values are DEFAULT, THREADS, and MPI. The default value is DEFAULT.

licenseType

A SymbolicConstant specifying the type of license type being used in the case of the DSLS SimUnit license model. Possible values are DEFAULT, TOKEN, and CREDIT. The default value is DEFAULT.If the license model is not the DSLS SimUnit, the licenseType is not available.

Returns:
A ModelJob object.
Raises:
AbaqusException.

Notes

This function can be accessed by:

mdb.Job

Create queues in Session#

JobSession.Queue(name: str, queueName: str, hostName: str = '', fileCopy: BooleanType = 1, directory: str = '', driver: str = '', remotePlatform: SymbolicConstantType = 'Linux', filesToCopy: str = 'ALL', deleteAfterCopy: BooleanType = 0, description: str = '') Queue[source]

This method creates a Queue object. Note:Remote queues are available only on Linux platforms.

Parameters:
name

A String specifying the name of the new Queue object.

queueName

A String specifying the name of the remote analysis queue.

hostName

A String specifying the name of the remote host. The default value is an empty string.

fileCopy

A Boolean specifying if the results files are to be copied from the remote machine to the local machine. The default value is ON.

directory

A String specifying the remote location for the execution of the simulation. The default value is an empty string.

driver

A String specifying the designation of the remote driver. The default value is “abaqus”.

remotePlatform

A SymbolicConstant specifying the type of operating system on the remote machine. The default value is Linux.

filesToCopy

A list of Strings specifying the files to be copied from the remote location to the local machine, or ALL. Strings specified in a list are the extensions of the job files that will be copied, such as (‘log’, ‘dat’, ‘msg’, ‘sta’, ‘odb’). The default value is ALL.

deleteAfterCopy

A Boolean specifying whether remote files are to be deleted after they are copied to the local machine. The default value is OFF.

description

A String specifying a description of the queue. The default value is an empty string.

Returns:
A Queue object.
Raises:
  • If fileCopy*=ON :obj:`and` *hostName is empty:

    Remote queue host name is not set.

  • If fileCopy*=ON :obj:`and` *directory is empty:

    Directory in which to run the job on the remote computer is not set.

Notes

This function can be accessed by:

session.Queue

Job#

class Job[source]

The Job object is the abstract base type for other Job objects. The Job object has no explicit constructor. The methods and members of the Job object are common to all objects derived from Job.

Notes

This object can be accessed by:

import job
mdb.coexecutions[name].jobs[name]
mdb.jobs[name]

The corresponding analysis keywords are:

  • HEADING
    • PREPRINT

Attributes:
name: str

A String specifying the name of the new job. The name must be a valid Abaqus/CAE object name.

type: SymbolicConstant

A SymbolicConstant specifying the type of job. Possible values are ANALYSIS, SYNTAXCHECK, RECOVER, and RESTART. The default value is ANALYSIS.If the object has the type JobFromInputFile, type=RESTART is not available.

waitHours: int

An Int specifying the number of hours to wait before submitting the job. This argument is ignored if queue is set. The default value is 0.This argument works in conjunction with waitMinutes. waitHours and atTime are mutually exclusive.

waitMinutes: int

An Int specifying the number of minutes to wait before submitting the job. This argument is ignored if queue is set. The default value is 0.This argument works in conjunction with waitHours. waitMinutes and atTime are mutually exclusive.

numCpus: int

An Int specifying the number of CPUs to use for this analysis if parallel processing is available. Possible values are numCpus >> 0. The default value is 1.

memory: int

An Int specifying the amount of memory available to Abaqus analysis. The value should be expressed in the units supplied in memoryUnits. The default value is 90.

memoryUnits: SymbolicConstant

A SymbolicConstant specifying the units for the amount of memory used in an Abaqus analysis. Possible values are PERCENTAGE, MEGA_BYTES, and GIGA_BYTES. The default value is PERCENTAGE.

getMemoryFromAnalysis: Boolean

A Boolean specifying whether to retrieve the recommended memory settings from the last datacheck or analysis run and use those values in subsequent submissions. The default value is ON.

explicitPrecision: SymbolicConstant

A SymbolicConstant specifying whether to use the double precision version of Abaqus/Explicit. Possible values are SINGLE, FORCE_SINGLE, DOUBLE, DOUBLE_CONSTRAINT_ONLY, and DOUBLE_PLUS_PACK. The default value is SINGLE.

nodalOutputPrecision: SymbolicConstant

A SymbolicConstant specifying the precision of the nodal output written to the output database. Possible values are SINGLE and FULL. The default value is SINGLE.

parallelizationMethodExplicit: SymbolicConstant

A SymbolicConstant specifying the parallelization method for Abaqus/Explicit. This value is ignored for Abaqus/Standard. Possible values are DOMAIN and LOOP. The default value is DOMAIN.

numDomains: int

An Int specifying the number of domains for parallel execution in Abaqus/Explicit. When parallelizationMethodExplicit=DOMAIN, numDomains must be a multiple of numCpus. The default value is 1.

activateLoadBalancing: Boolean

A Boolean specifying whether to activate dyanmic load balancing for jobs running on multiple processors with multiple domains in Abaqus/Explicit. The default value is OFF.

multiprocessingMode: SymbolicConstant

A SymbolicConstant specifying whether an analysis is decomposed into threads or into multiple processes that communicate through a message passing interface (MPI). Possible values are DEFAULT, THREADS,MPI, and HYBRID. The default value is DEFAULT.

numThreadsPerMpiProcess: int

An Int specifying the number of threads per MPI process to use for this analysis if parallel processing is available. Possible values are numThreadsPerMpiProcess >> 0. The default value is 1.

analysis: SymbolicConstant

A SymbolicConstant specifying whe:py:class:~.the`r :py:class:`~.the job will be analyzed by Abaqus/Standard or Abaqus/Explicit. Possible values are STANDARD, EXPLICIT, and UNKNOWN.If the object has the type JobFromInputFile, analysis=UNKNOWN.

status: SymbolicConstant

A SymbolicConstant specifying the status of the analysis. Possible values are SUBMITTED, RUNNING, ABORTED, TERMINATED, COMPLETED, CHECK_RUNNING, and CHECK_COMPLETED.If the message member is empty, status is set to NONE.

queue: str

A String specifying the name of the queue to which to submit the job. The default value is an empty string.Note:You can use the queue argument when creating a Job object on a Windows workstation; however, remote queues are available only on Linux platforms.

atTime: str

A String specifying the time at which to submit the job. If queue is empty, the string syntax must be valid for the Linux at command. If queue is set, the syntax must be valid according to the system administrator. The default value is an empty string.Note:You can use the atTime argument when creating a Job object on a Windows workstation; however, the at command is available only on Linux platforms.

scratch: str

A String specifying the location of the scratch directory. The default value is an empty string.

userSubroutine: str

A String specifying the file containing the user’s subroutine definitions. The default value is an empty string.

messages: MessageArray

A MessageArray object specifying the messages received during an analysis.

environment: tuple

A tuple of Strings specifying the environment variables and their values.

licenseType: SymbolicConstant

A SymbolicConstant specifying the type of license type being used in the case of the DSLS SimUnit license model. Possible values are DEFAULT, TOKEN, and CREDIT. The default value is DEFAULT.If the license model is not the DSLS SimUnit, the licenseType is not available.

Methods

clearMessage()

This method clears messages and sets the status to NONE.

kill()

This method kills the analysis of a job.

submit([consistencyChecking, datacheckJob, ...])

This method submits a job for analysis.

waitForCompletion()

This method interrupts the execution of the script until the end of the analysis.