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, model, description='', type=abaqusConstants.ANALYSIS, queue='', waitHours=0, waitMinutes=0, atTime='', echoPrint=OFF, contactPrint=OFF, modelPrint=OFF, historyPrint=OFF, scratch='', userSubroutine='', numCpus=1, memory=90, memoryUnits=abaqusConstants.PERCENTAGE, explicitPrecision=abaqusConstants.SINGLE, nodalOutputPrecision=abaqusConstants.SINGLE, parallelizationMethodExplicit=abaqusConstants.DOMAIN, numDomains=1, activateLoadBalancing=OFF, multiprocessingMode=abaqusConstants.DEFAULT, licenseType=abaqusConstants.DEFAULT, *args, **kwargs)[source]

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

Note

This function can be accessed by:

mdb.Job

Note

Check Job on help.3ds.com/0.1..

Parameters:

name (str) – A String specifying the name of the new job. The name must be a valid Abaqus/CAE object name.
model (str) – A String specifying the name of the model to be analyzed or a Model object specifying the model to be analyzed.
description (str, default: '') – A String specifying a description of the job.
type (SymbolicConstant, default: ANALYSIS) – 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 (str, default: '') – 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 (int, default: 0) – 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, default: 0) – 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 (str, default: '') – 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 (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether an echo of the input data is printed. The default value is OFF.
contactPrint (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether contact constraint data are printed. The default value is OFF.
modelPrint (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether model definition data are printed. The default value is OFF.
historyPrint (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether history data are printed. The default value is OFF.
scratch (str, default: '') – A String specifying the location of the scratch directory. The default value is an empty string.
userSubroutine (str, default: '') – A String specifying the file containing the user’s subroutine definitions. The default value is an empty string.
numCpus (int, default: 1) – 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, default: 90) – 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, default: PERCENTAGE) – 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 (SymbolicConstant, default: SINGLE) – 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, default: SINGLE) – 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, default: DOMAIN) – 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, default: 1) – 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 (Union[AbaqusBoolean, bool], default: OFF) – 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, default: DEFAULT) – 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 (SymbolicConstant, default: DEFAULT) –
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.

Changed in version 2022: The licenseType argument was added.

Returns:

A ModelJob object.

Return type:

ModelJob

Raises:

AbaqusException –

Public Data Attributes:

Inherited from MdbBase

`version`	An Int specifying the release number of the Mdb object in memory.
`lastChangedCount`	A Float specifying the value of a counter associated with the Mdb object.
`jobs`	A repository of Job objects.
`adaptivityProcesses`	A repository of AdaptivityProcess objects.
`coexecutions`	A repository of Coexecution objects.
`optimizationProcesses`	A repository of OptimizationProcess objects.
`meshEditOptions`	A `MeshEditOptions` object specifying the undo/redo behavior when editing meshes on parts or part instances.
`models`	A repository of Model objects.
`customData`	A `RepositorySupport` object.
`annotations`	A repository of Annotation objects.

Public Methods:

`Job`(name, model[, description, type, queue, ...])	This method creates an analysis job using a model on a model database (MDB) for the model definition.
`JobFromInputFile`(name, inputFileName[, ...])	This method creates an analysis job using an input file for the model definition.
`OptimizationProcess`(name, model, task, ...)	This method creates an OptimizationProcess object.

Inherited from MdbBase

`__init__`([pathName])	This constructor creates an empty Mdb object.
`importDxf`(fileName)	This method creates a ConstrainedSketch object from a file containing dxf-format (AutoCAD) geometry.
`openMdb`(pathName)	This method opens an existing model database file.
`close`()	This method closes an open Mdb object but does not save the Mdb object to disk.
`save`()	This method saves an Mdb object to disk at the location specified by pathName (pathName is a member of the Mdb object).
`saveAs`(pathName)	This method saves an Mdb object to disk at the specified location.
`openAuxMdb`(pathName)	This method opens an auxiliary Mdb object on the disk at the specified location.
`closeAuxMdb`()	This method closes the auxiliary Mdb which had been opened earlier using the openAuxMdb command.
`getAuxMdbModelNames`()	This method returns a list of model names present in the auxiliary Mdb which had been opened earlier using the openAuxMdb command.
`copyAuxMdbModel`(fromName[, toName])	This method copies a specified model from the auxiliary Mdb which had been opened earlier using the openAuxMdb command.

Create queues in Session#

JobSession.Queue(name, queueName, hostName='', fileCopy=ON, directory='', driver='', remotePlatform='Linux', filesToCopy=abaqusConstants.ALL, deleteAfterCopy=OFF, description='')[source]

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

Note

This function can be accessed by:

session.Queue

Note

Check Queue on help.3ds.com/0.1..

Parameters:

name (str) – A String specifying the name of the new Queue object.
queueName (str) – A String specifying the name of the remote analysis queue.
hostName (str, default: '') – A String specifying the name of the remote host. The default value is an empty string.
fileCopy (Union[AbaqusBoolean, bool], default: ON) – 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 (str, default: '') – A String specifying the remote location for the execution of the simulation. The default value is an empty string.
driver (str, default: '') – A String specifying the designation of the remote driver. The default value is “abaqus”.
remotePlatform (SymbolicConstant, default: 'Linux') – A SymbolicConstant specifying the type of operating system on the remote machine. The default value is Linux.
filesToCopy (str, default: ALL) – 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 (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether remote files are to be deleted after they are copied to the local machine. The default value is OFF.
description (str, default: '') – A String specifying a description of the queue. The default value is an empty string.

Returns:

A Queue object.

Return type:

Queue

Raises:

Remote queue host name is not set – If fileCopy = ON and hostName is empty.

:raises Directory in which` to :class:`run the job on the remote computer is not set: If fileCopy = ON and directory is empty.

Public Data Attributes:

Inherited from SessionBase

`attachedToGui`	A Boolean specifying whether an Abaqus interactive session is running.
`replayInProgress`	A Boolean specifying whether Abaqus is executing a replay file.
`kernelMemoryFootprint`	A Float specifying the memory usage value for the Abaqus/CAE kernel process in megabytes.
`kernelMemoryMaxFootprint`	A Float specifying the maximum value for the memory usage for the Abaqus/CAE kernel process in megabytes.
`kernelMemoryLimit`	A Float specifying the limit for the memory use for the Abaqus/CAE kernel process in megabytes.
`colors`	A repository of Color objects.
`journalOptions`	A `JournalOptions` object specifying how to record selection of geometry in the journal and replay files.
`memoryReductionOptions`	A `MemoryReductionOptions` object specifying options for running in reduced memory mode.
`nodeQuery`	A `NodeQuery` object specifying nodes and their coordinates in a path.
`sketcherOptions`	A `ConstrainedSketcherOptions` object specifying common options for all sketches.
`viewerOptions`	A `ViewerOptions` object.
`animationOptions`	An `AnimationOptions` object.
`aviOptions`	An `AVIOptions` object.
`imageAnimationOptions`	An `ImageAnimationOptions` object.
`imageAnimation`	An `ImageAnimation` object.
`quickTimeOptions`	A `QuickTimeOptions` object.
`viewports`	A repository of Viewport objects.
`customData`	A `RepositorySupport` object.
`defaultFieldReportOptions`	A `FieldReportOptions` object.
`defaultFreeBodyReportOptions`	A `FreeBodyReportOptions` object.
`fieldReportOptions`	A `FieldReportOptions` object.
`freeBodyReportOptions`	A `FreeBodyReportOptions` object.
`odbs`	A repository of Odb objects.
`scratchOdbs`	A repository of ScratchOdb objects.
`defaultOdbDisplay`	A `DefaultOdbDisplay` object.
`defaultPlot`	A `DefaultPlot` object.
`defaultChartOptions`	A `DefaultChartOptions` object.
`odbData`	A repository of OdbData objects.
`mdbData`	A repository of MdbData objects.
`paths`	A repository of Path objects.
`freeBodies`	A repository of FreeBody objects.
`streams`	A repository of Stream objects.
`spectrums`	A repository of Spectrum objects.
`currentProbeValues`	A `CurrentProbeValues` object.
`defaultProbeOptions`	A `ProbeOptions` object.
`probeOptions`	A `ProbeOptions` object.
`probeReport`	A `ProbeReport` object.
`defaultProbeReport`	A `ProbeReport` object.
`selectedProbeValues`	A `SelectedProbeValues` object.
`printOptions`	A `PrintOptions` object.
`epsOptions`	An `EpsOptions` object.
`pageSetupOptions`	A `PageSetupOptions` object.
`pngOptions`	A `PngOptions` object.
`psOptions`	A `PsOptions` object.
`svgOptions`	A `SvgOptions` object.
`tiffOptions`	A `TiffOptions` object.
`autoColors`	An `AutoColors` object specifying the color palette to be used for color coding.
`xyColors`	An `AutoColors` object specifying the color palette to be used forXYCurve objects.
`xyDataObjects`	A repository of XYData objects.
`curves`	A repository of XYCurve objects.
`xyPlots`	A repository of XYPlot objects.
`charts`	A repository of Chart objects.
`defaultXYReportOptions`	An `XYReportOptions` object.
`xyReportOptions`	An `XYReportOptions` object.
`views`	A repository of View objects.
`networkDatabaseConnectors`	A repository of NetworkDatabaseConnector objects.
`displayGroups`	A repository of DisplayGroup objects.
`graphicsInfo`	A `GraphicsInfo` object.
`defaultGraphicsOptions`	A `GraphicsOptions` object.
`graphicsOptions`	A `GraphicsOptions` object.
`defaultViewportAnnotationOptions`	A `ViewportAnnotationOptions` object.
`queues`	A repository of Queue objects.
`currentViewportName`	A String specifying the name of the current viewport.
`sessionState`	A Dictionary object specifying the viewports and their associated models.
`images`	A repository of Image objects.
`movies`	A repository of Movie objects.
`defaultLightOptions`	A `LightOptions` object.
`drawingArea`	A `DrawingArea` object.
`defaultMesherOptions`	A `MesherOptions` object specifying how to control default settings in the Mesh module.
`drawings`	A repository of Drawing objects.

Public Methods:

Queue(name, queueName[, hostName, fileCopy, ...])

This method creates a Queue object.

Inherited from SessionBase

`setValues`([kernelMemoryLimit])	This method modifies the Session object.
`enableCADConnection`(CADName[, portNum])	This method enables the Abaqus/CAE listening port for the specified CAD system.
`isCADConnectionEnabled`()	This method checks the status of CAD Connection.
`disableCADConnection`(CADName)	This method disables an associative import CAD connection that was enabled.
`enableParameterUpdate`(CADName, CADVersion[, ...])	This method enables parameter updates for ProE and NX by establishing a connection with the listening port previously setup by the CAD application.
`setCADPortNumber`(CADName, Port)	This method enables parameter updates for CATIA V5 and CATIA V6 by establishing a connection with the listening port previously setup by the CAD application.
`updateCADParameters`(modelName, CADName, ...)	This method updates the parameters for the specified model using the specified parameter file.
`disableParameterUpdate`(CADName)	This method disables an associative CAD connection using parameters.
`printToFile`(fileName[, format, ...])	This method prints canvas objects to a file using the attributes stored in the PrintOptions object and the appropriate format options object.
`printToPrinter`([printCommand, numCopies, ...])	This method prints canvas objects to a Windows printer or to a PostScript printer.
`saveOptions`(directory)	This method saves your customized display settings.
`writeVrmlFile`(fileName[, format, canvasObjects])	This method exports the current viewport objects to a file.
`write3DXMLFile`(fileName[, format, canvasObjects])	This method exports the current viewport objects to a file.
`writeOBJFile`(fileName[, canvasObjects])	This method exports the current viewport objects to a file.
`openOdb`(name[, path, readOnly])	This method opens an existing output database (.odb) file and creates a new Odb object. This method is accessed only via the session object inside Abaqus/CAE and adds the new Odb object to the session.odbs repository. This method allows you to open multiple output databases at the same time and to use the repository key to specify a particular output database. For example::.

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.

Note

This object can be accessed by:

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

The corresponding analysis keywords are:

HEADING
PREPRINT

Note

Check Job on help.3ds.com/0.1..

Public Data Attributes:

`name`	A String specifying the name of the new job.
`type`	A SymbolicConstant specifying the type of job.
`waitHours`	An Int specifying the number of hours to wait before submitting the job.
`waitMinutes`	An Int specifying the number of minutes to wait before submitting the job.
`numCpus`	An Int specifying the number of CPUs to use for this analysis if parallel processing is available.
`memory`	An Int specifying the amount of memory available to Abaqus analysis.
`memoryUnits`	A SymbolicConstant specifying the units for the amount of memory used in an Abaqus analysis.
`getMemoryFromAnalysis`	A Boolean specifying whether to retrieve the recommended memory settings from the last datacheck or analysis run and use those values in subsequent submissions.
`explicitPrecision`	A SymbolicConstant specifying whether to use the double precision version of Abaqus/Explicit.
`nodalOutputPrecision`	A SymbolicConstant specifying the precision of the nodal output written to the output database.
`parallelizationMethodExplicit`	A SymbolicConstant specifying the parallelization method for Abaqus/Explicit.
`numDomains`	An Int specifying the number of domains for parallel execution in Abaqus/Explicit.
`activateLoadBalancing`	A Boolean specifying whether to activate dyanmic load balancing for jobs running on multiple processors with multiple domains in Abaqus/Explicit.
`multiprocessingMode`	A SymbolicConstant specifying whether an analysis is decomposed into threads or into multiple processes that communicate through a message passing interface (MPI).
`numThreadsPerMpiProcess`	An Int specifying the number of threads per MPI process to use for this analysis if parallel processing is available.
`analysis`	A SymbolicConstant specifying whether the job will be analyzed by Abaqus/Standard or Abaqus/Explicit.
`status`	A SymbolicConstant specifying the status of the analysis.
`queue`	A String specifying the name of the queue to which to submit the job.
`atTime`	A String specifying the time at which to submit the job.
`scratch`	A String specifying the location of the scratch directory.
`userSubroutine`	A String specifying the file containing the user's subroutine definitions.
`messages`	A `MessageArray` object specifying the messages received during an analysis.
`environment`	A tuple of Strings specifying the environment variables and their values.
`licenseType`	A SymbolicConstant specifying the type of license type being used in the case of the DSLS SimUnit license model.

Public Methods:

`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.
`clearMessage`()	This method clears messages and sets the status to NONE.