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=ANALYSIS,

queue='',

waitHours=0,

waitMinutes=0,

atTime='',

echoPrint=0,

contactPrint=0,

modelPrint=0,

historyPrint=0,

scratch='',

userSubroutine='',

numCpus=1,

memory=90,

memoryUnits=PERCENTAGE,

explicitPrecision=SINGLE,

nodalOutputPrecision=SINGLE,

parallelizationMethodExplicit=DOMAIN,

numDomains=1,

activateLoadBalancing=0,

multiprocessingMode=DEFAULT,

licenseType=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/2019.

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=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=''¶: 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=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=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=''¶: 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=0¶: A Boolean specifying whether an echo of the input data is printed. The default value is OFF.
contactPrint=0¶: A Boolean specifying whether contact constraint data are printed. The default value is OFF.
modelPrint=0¶: A Boolean specifying whether model definition data are printed. The default value is OFF.
historyPrint=0¶: 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=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=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=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=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=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=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=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=0¶: 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=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=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.

Returns:¶

A ModelJob object.

Return type:¶

ModelJob

Raises:¶

AbaqusException –

Create queues in Session¶

JobSession.Queue( name, queueName, hostName='', fileCopy=1, directory='', driver='', remotePlatform=LINUX, filesToCopy=ALL, deleteAfterCopy=0, 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/2019.

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=1¶: 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=LINUX¶: A SymbolicConstant specifying the type of operating system on the remote machine. The default value is Linux.
filesToCopy=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=0¶: 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.

Return type:¶

Queue

Raises:¶

Exception – Remote queue host name is not set, If fileCopy = ON and hostName is empty. Directory in which to run the job on the remote computer is not set, If fileCopy = ON and directory is empty.

Other Classes¶

class Coexecution[source]¶

Bases: object

The Coexecution object contains a set of jobs as associated parameters to define a co-simulation analysis.

Note

This object can be accessed by:

import job
mdb.coexecutions[name]

The corresponding analysis keywords are:

HEADING
PREPRINT

Note

Check Coexecution on help.3ds.com/2019.

Member Details:

atTime : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the time at which to submit the co-execution. 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 Coexecution object on a Windows workstation; however, the at command is available only on Linux platforms.

jobs : --is-rst--:py:class:`dict`\ \[:py:class:`str`, :py:class:`~abaqus.Job.Job.Job`] = {}[source]¶: A repository of Job objects specifying the jobs that comprise this co-execution.

kill()[source]¶: This method kills the analysis of a co-execution.

masterAnalysisProduct : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'ABAQUS'[source]¶: A SymbolicConstant specifying the analysis product type of the master model for the co-execution. The default value is ABAQUS.

masterModel : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the name of the master model for the co-execution.

name : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the name of the new job. The name must be a valid Abaqus/CAE object name.

queue : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the name of the queue to which to submit the co-execution. The default value is an empty string. Note: You can use the queue argument when creating a Coexecution object on a Windows workstation; however, remote queues are available only on Linux platforms.

slaveAnalysisProducts : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` | :py:obj:`None` = None[source]¶: A tuple of SymbolicConstants specifying the analysis product types of the slave models for the co-execution. The default value is an empty sequence.

slaveModels : --is-rst--:py:class:`tuple`\ \[:py:class:`str`, :py:data:`...<Ellipsis>`] = ()[source]¶: A tuple of Strings specifying the names of the secondary models for the co-execution.

Changed in version 2022: The slaveModels attribute was changed to secondaryModels.

status : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`[source]¶: A SymbolicConstant specifying the status of the co-execution. Possible values are SUBMITTED, RUNNING, ABORTED, TERMINATED, COMPLETED, CHECK_SUBMITTED, CHECK_RUNNING, and CHECK_COMPLETED.If the message member of all the jobs are empty, status is set to NONE.

submit(consistencyChecking=1, datacheckJob=False, continueJob=False)[source]¶

This method submits a co-execution for analysis.

Note

Check Coexecution.submit on help.3ds.com/2019.

Parameters:¶

consistencyChecking=1¶: A Boolean specifying whether to perform consistency checking for the individual jobs. The default value is ON. It is not recommended to turn the consistency checking off unless you are absolutely sure the models are all consistent.
datacheckJob=False¶: A Boolean specifying whether to run the co-execution as a datacheck analysis. The default value is False. The datacheckJob and continueJob arguments cannot both be True.
continueJob=False¶: A Boolean specifying whether to run the co-execution as a continuation analysis. The default value is False. The datacheckJob and continueJob arguments cannot both be True.

type : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'ANALYSIS'[source]¶: A SymbolicConstant specifying the type of analysis to execute for the co-execution. Possible values are ANALYSIS, SYNTAXCHECK, RECOVER, and RESTART. The default value is ANALYSIS.

waitForCompletion()[source]¶

This method interrupts the execution of the script until the end of all the analyses.

If you call the waitForCompletion method and the status member is neither SUBMITTED nor RUNNING, Abaqus assumes the analysis has either completed or aborted and returns immediately.

waitHours : --is-rst--:py:class:`int` = 0[source]¶: An Int specifying the number of hours to wait before submitting the co-execution. 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 : --is-rst--:py:class:`int` = 0[source]¶: 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.

writeInput(consistencyChecking=1)[source]¶

This method writes an input file for each analysis in the co-execution.

Note

Check Coexecution.writeInput on help.3ds.com/2019.

Parameters:¶

consistencyChecking=1¶: A Boolean specifying whether to perform consistency checking for the individual jobs. The default value is ON. It is not recommended to turn the consistency checking off unless you are absolutely sure the models are all consistent.

class JobFromInputFile( name, inputFileName, type=ANALYSIS, queue='', waitHours=0, waitMinutes=0, atTime='', scratch='', userSubroutine='', numCpus=1, memory=90, memoryUnits=PERCENTAGE, explicitPrecision=SINGLE, nodalOutputPrecision=SINGLE, parallelizationMethodExplicit=DOMAIN, numDomains=1, activateLoadBalancing=0, multiprocessingMode=DEFAULT, )[source]¶

Bases: Job

The JobFromInputFile object defines a Job object which analyzes a model contained in an input file. The JobFromInputFile object is derived from the Job object.

Note

This object can be accessed by:

import job
mdb.jobs[name]

Note

Check JobFromInputFile on help.3ds.com/2019.

Member Details:

activateLoadBalancing : --is-rst--Boolean = 0[source]¶: 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.

analysis : --is-rst--Literal[C.STANDARD, C.EXPLICIT, C.UNKNOWN][source]¶: A SymbolicConstant specifying whether 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.

atTime : --is-rst--str = ''[source]¶: 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.

environment : --is-rst--tuple[str, ...] = ()[source]¶: A tuple of Strings specifying the environment variables and their values.

explicitPrecision : --is-rst--Literal[C.SINGLE, C.FORCE_SINGLE, C.DOUBLE, C.DOUBLE_CONSTRAINT_ONLY, C.DOUBLE_PLUS_PACK] = 'SINGLE'[source]¶: 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.

getMemoryFromAnalysis : --is-rst--Boolean = 1[source]¶: 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.

inputFileName : --is-rst--str[source]¶: A String specifying the input file to read. Possible values are any valid file name. If the .inp extension is not included in the value of the argument, the system will append it for the user.

memory : --is-rst--int = 90[source]¶: 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 : --is-rst--Literal[C.PERCENTAGE, C.MEGA_BYTES, C.GIGA_BYTES] = 'PERCENTAGE'[source]¶: 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.

messages : --is-rst--MessageArray = [][source]¶: A MessageArray object specifying the messages received during an analysis.

multiprocessingMode : --is-rst--Literal[C.DEFAULT, C.THREADS, C.MPI] = 'DEFAULT'[source]¶: 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.

nodalOutputPrecision : --is-rst--Literal[C.SINGLE, C.FULL] = 'SINGLE'[source]¶: 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.

numCpus : --is-rst--int = 1[source]¶: 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.

numDomains : --is-rst--int = 1[source]¶: 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.

parallelizationMethodExplicit : --is-rst--Literal[C.LOOP, C.DOMAIN] = 'DOMAIN'[source]¶: A SymbolicConstant specifying the parallelization method for Abaqus/Explicit. Possible values are LOOP and DOMAIN. The default value is DOMAIN.

Changed in version 2017: The default value for parallelizationMethodExplicit is now DOMAIN

queue : --is-rst--str = ''[source]¶: 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.

scratch : --is-rst--str = ''[source]¶: A String specifying the location of the scratch directory. The default value is an empty string.

setValues( type=ANALYSIS, queue='', waitHours=0, waitMinutes=0, atTime='', scratch='', userSubroutine='', numCpus=1, memory=90, memoryUnits=PERCENTAGE, explicitPrecision=SINGLE, nodalOutputPrecision=SINGLE, parallelizationMethodExplicit=DOMAIN, numDomains=1, activateLoadBalancing=0, multiprocessingMode=DEFAULT, )[source]¶

This method modifies the JobFromInputFile object.

Note

Check JobFromInputFile.setValues on help.3ds.com/2019.

Parameters:¶

type=ANALYSIS¶

A SymbolicConstant specifying the type of job. Possible values are ANALYSIS, SYNTAXCHECK, and RECOVER. The default value is ANALYSIS.For theJobFromInputFile object, type = RESTART is not currently supported.

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=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=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=''¶

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=''¶

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=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=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=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=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=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=DOMAIN¶

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

Changed in version 2017: The default value for parallelizationMethodExplicit is now DOMAIN

numDomains=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=0¶

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=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.

status : --is-rst--Literal[C.SUBMITTED, C.RUNNING, C.ABORTED, C.TERMINATED, C.COMPLETED, C.CHECK_RUNNING, C.CHECK_COMPLETED][source]¶: 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.

type : --is-rst--Literal[C.ANALYSIS, C.SYNTAXCHECK, C.RECOVER] = 'ANALYSIS'[source]¶: A SymbolicConstant specifying the type of job. Possible values are ANALYSIS, SYNTAXCHECK, and RECOVER. The default value is ANALYSIS.For theJobFromInputFile object, type = RESTART is not currently supported.

userSubroutine : --is-rst--str = ''[source]¶: A String specifying the file containing the user’s subroutine definitions. The default value is an empty string.

waitHours : --is-rst--int = 0[source]¶: 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 : --is-rst--int = 0[source]¶: 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.

class JobMdb(pathName='')[source]¶

Bases: MdbBase

The Mdb object is the high-level Abaqus model database. A model database stores models and analysis controls.

Note

This object can be accessed by:

mdb

Note

Check JobMdb on help.3ds.com/2019.

Member Details:

Job(

name,

model,

description='',

type=ANALYSIS,

queue='',

waitHours=0,

waitMinutes=0,

atTime='',

echoPrint=0,

contactPrint=0,

modelPrint=0,

historyPrint=0,

scratch='',

userSubroutine='',

numCpus=1,

memory=90,

memoryUnits=PERCENTAGE,

explicitPrecision=SINGLE,

nodalOutputPrecision=SINGLE,

parallelizationMethodExplicit=DOMAIN,

numDomains=1,

activateLoadBalancing=0,

multiprocessingMode=DEFAULT,

licenseType=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/2019.

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=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=''¶: 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=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=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=''¶: 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=0¶: A Boolean specifying whether an echo of the input data is printed. The default value is OFF.
contactPrint=0¶: A Boolean specifying whether contact constraint data are printed. The default value is OFF.
modelPrint=0¶: A Boolean specifying whether model definition data are printed. The default value is OFF.
historyPrint=0¶: 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=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=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=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=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=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=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=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=0¶: 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=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=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.

Returns:¶

A ModelJob object.

Return type:¶

ModelJob

Raises:¶

AbaqusException –

JobFromInputFile( name, inputFileName, type=ANALYSIS, queue='', waitHours=0, waitMinutes=0, atTime='', scratch='', userSubroutine='', numCpus=1, memory=90, memoryUnits=PERCENTAGE, explicitPrecision=SINGLE, nodalOutputPrecision=SINGLE, parallelizationMethodExplicit=DOMAIN, numDomains=1, activateLoadBalancing=0, multiprocessingMode=DEFAULT, licenseType=DEFAULT, getMemoryFromAnalysis=1, numGPUs=0, resultsFormat=ODB, )[source]¶

This method creates an analysis job using an input file for the model definition.

Note

This function can be accessed by:

mdb.JobFromInputFile

Note

Check JobFromInputFile on help.3ds.com/2019.

Parameters:¶

name¶: A String specifying the name of the new job. The name must be a valid Abaqus/CAE object name.
inputFileName¶: A String specifying the input file to read. Possible values are any valid file name. If the .inp extension is not included in the value of the argument, the system will append it for the user.
type=ANALYSIS¶: A SymbolicConstant specifying the type of job. Possible values are ANALYSIS, SYNTAXCHECK, and RECOVER. The default value is ANALYSIS.For theJobFromInputFile object, type = RESTART is not currently supported.
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=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=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=''¶: 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=''¶: 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=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=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=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=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=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=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=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=0¶: 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=DEFAULT¶: A SymbolicConstant specifying whether an analysis is decomposed into threads or into multiple processes that communicate through a message
licenseType=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.
getMemoryFromAnalysis=1¶: 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.
numGPUs=0¶: An Int specifying the number of GPUs to use for this analysis if parallel processing is available. Possible values are numCpus >= 0. The default value is 0.
resultsFormat=ODB¶: This option specifies the results output format: ODB, SIM, or BOTH. The default value is ODB.

OptimizationProcess( name, model, task, prototypeJob, description='', maxDesignCycle=15, dataSaveFrequency=OPT_DATASAVE_SPECIFY_CYCLE, saveInitial=True, saveFirst=True, saveLast=True, saveEvery=None, )[source]¶

This method creates an OptimizationProcess object.

Note

This function can be accessed by:

mdb.OptimizationProcess

Note

Check OptimizationProcess on help.3ds.com/2019.

Parameters:¶

name¶: A String specifying name of the optimization process.
model¶: A String specifying name of the model to be used for the optimization process.
task¶: A String specifying name of the optimization task to be used for the optimization process.
prototypeJob¶: A String specifying name of the job to be used as the prototype for all analysis jobs run by the optimization process.
description=''¶: A String specifying a description of the optimization process.
maxDesignCycle=15¶: An Int specifying the maximum number of allowed design cycles for the optimization process. The default value is 15.
dataSaveFrequency=OPT_DATASAVE_SPECIFY_CYCLE¶: An Enum specifying whether Abaqus should save every iteration file in the optimization process or a selection of iteration files saved at a user-specified frequency. If you set dataSaveFrequency = OPT_DATASAVE_EVERY_CYCLE, Abaqus saves every iteration file; if you set dataSaveFrequency = OPT_DATASAVE_SPECIFY_CYCLE, Abaqus saves iteration files according to the frequency defined by the saveEvery parameter. The default value is OPT_DATASAVE_SPECIFY_CYCLE.
saveInitial=True¶: A Boolean specifying whether the initial cycle should be saved when dataSaveFrequency is OPT_DATASAVE_SPECIFY_CYCLE. The default value is True.
saveFirst=True¶: A Boolean specifying whether the first cycle should be saved when dataSaveFrequency is OPT_DATASAVE_SPECIFY_CYCLE. The default value is True.
saveLast=True¶: A Boolean specifying whether the last cycle should be saved when dataSaveFrequency is OPT_DATASAVE_SPECIFY_CYCLE. The default value is True.
saveEvery=None¶: An Int specifying every nth cycle iterations to be saved when dataSaveFrequency is OPT_DATASAVE_SPECIFY_CYCLE. Abaqus saves file iterations for every nth iteration after iteration 1; if you set saveEvery = 3, Abaqus saves file iterations for cycles 1, 4, 7, and so on. The default value is None.

Returns:¶

An OptimizationProcess object.

Return type:¶

OptimizationProcess

Raises:¶

AbaqusException –

class ModelJob(

name,

model,

description='',

type=ANALYSIS,

queue='',

waitHours=0,

waitMinutes=0,

atTime='',

echoPrint=0,

contactPrint=0,

modelPrint=0,

historyPrint=0,

scratch='',

userSubroutine='',

numCpus=1,

memory=90,

memoryUnits=PERCENTAGE,

explicitPrecision=SINGLE,

nodalOutputPrecision=SINGLE,

parallelizationMethodExplicit=DOMAIN,

numDomains=1,

activateLoadBalancing=0,

multiprocessingMode=DEFAULT,

*args,

**kwargs,

)[source]¶

Bases: Job

The ModelJob object defines a Job object which analyzes a model on a model database (MDB). The ModelJob object is derived from the Job object.

Note

This object can be accessed by:

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

Note

Check ModelJob on help.3ds.com/2019.

Member Details:

activateLoadBalancing : --is-rst--Boolean = 0[source]¶: 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.

analysis : --is-rst--Literal[C.STANDARD, C.EXPLICIT, C.UNKNOWN][source]¶: A SymbolicConstant specifying whether 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.

atTime : --is-rst--str = ''[source]¶: 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.

contactPrint : --is-rst--Boolean = 0[source]¶: A Boolean specifying whether contact constraint data are printed. The default value is OFF.

description : --is-rst--str = ''[source]¶: A String specifying a description of the job.

echoPrint : --is-rst--Boolean = 0[source]¶: A Boolean specifying whether an echo of the input data is printed. The default value is OFF.

environment : --is-rst--tuple[str, ...] = ()[source]¶: A tuple of Strings specifying the environment variables and their values.

explicitPrecision : --is-rst--Literal[C.SINGLE, C.FORCE_SINGLE, C.DOUBLE, C.DOUBLE_CONSTRAINT_ONLY, C.DOUBLE_PLUS_PACK] = 'SINGLE'[source]¶: 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.

getMemoryFromAnalysis : --is-rst--Boolean = 1[source]¶: 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.

historyPrint : --is-rst--Boolean = 0[source]¶: A Boolean specifying whether history data are printed. The default value is OFF.

memory : --is-rst--int = 90[source]¶: 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 : --is-rst--Literal[C.PERCENTAGE, C.MEGA_BYTES, C.GIGA_BYTES] = 'PERCENTAGE'[source]¶: 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.

messages : --is-rst--MessageArray = [][source]¶: A MessageArray object specifying the messages received during an analysis.

model : --is-rst--str = ''[source]¶: A String specifying the name of the model to be analyzed or a Model object specifying the model to be analyzed.

modelPrint : --is-rst--Boolean = 0[source]¶: A Boolean specifying whether model definition data are printed. The default value is OFF.

multiprocessingMode : --is-rst--Literal[C.DEFAULT, C.THREADS, C.MPI] = 'DEFAULT'[source]¶: 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.

name : --is-rst--str = ''[source]¶: A String specifying the name of the new job. The name must be a valid Abaqus/CAE object name.

nodalOutputPrecision : --is-rst--Literal[C.SINGLE, C.FULL] = 'SINGLE'[source]¶: 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.

numCpus : --is-rst--int = 1[source]¶: 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.

numDomains : --is-rst--int = 1[source]¶: 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.

parallelizationMethodExplicit : --is-rst--Literal[C.LOOP, C.DOMAIN] = 'DOMAIN'[source]¶: A SymbolicConstant specifying the parallelization method for Abaqus/Explicit. Possible values are LOOP and DOMAIN. The default value is DOMAIN.

Changed in version 2017: The default value for parallelizationMethodExplicit is now DOMAIN

queue : --is-rst--str = ''[source]¶: 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.

scratch : --is-rst--str = ''[source]¶: A String specifying the location of the scratch directory. The default value is an empty string.

setValues(*args, **kwargs)[source]¶: This method modifies the ModelJob object.

status : --is-rst--Literal[C.SUBMITTED, C.RUNNING, C.ABORTED, C.TERMINATED, C.COMPLETED, C.CHECK_RUNNING, C.CHECK_COMPLETED][source]¶: 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.

type : --is-rst--Literal[C.ANALYSIS, C.SYNTAXCHECK, C.RECOVER, C.RESTART] = 'ANALYSIS'[source]¶: 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.

userSubroutine : --is-rst--str = ''[source]¶: A String specifying the file containing the user’s subroutine definitions. The default value is an empty string.

waitHours : --is-rst--int = 0[source]¶: 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 : --is-rst--int = 0[source]¶: 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.

writeInput(consistencyChecking=1)[source]¶

This method writes an input file.

Note

Check ModelJob.writeInput on help.3ds.com/2019.

Parameters:¶

consistencyChecking=1¶: A Boolean specifying whether to perform consistency checking for the job. The default value is ON.It is not recommended to turn the consistency checking off unless you are absolutely sure the model is consistent.

class OptimizationProcess( name, model, task, prototypeJob, description='', maxDesignCycle=15, dataSaveFrequency=OPT_DATASAVE_SPECIFY_CYCLE, saveInitial=True, saveFirst=True, saveLast=True, saveEvery=None, )[source]¶

Bases: object

The OptimizationProcess object defines a process to perform an optimization of a model defined using an optimization task.

Note

This object can be accessed by:

import job
mdb.optimizationProcesses[name]

Note

Check OptimizationProcess on help.3ds.com/2019.

Member Details:

dataSaveFrequency : --is-rst--:py:class:`str` = 'OPT_DATASAVE_SPECIFY_CYCLE'[source]¶: An Enum specifying whether Abaqus should save every iteration file in the optimization process or a selection of iteration files saved at a user-specified frequency. If you set dataSaveFrequency = OPT_DATASAVE_EVERY_CYCLE, Abaqus saves every iteration file; if you set dataSaveFrequency = OPT_DATASAVE_SPECIFY_CYCLE, Abaqus saves iteration files according to the frequency defined by the saveEvery parameter. The default value is OPT_DATASAVE_SPECIFY_CYCLE.

description : --is-rst--:py:class:`str` = ''[source]¶: A String specifying a description of the optimization process.

extract( outputFileName, designCycle, isoValue=0, smoothCycles=5, reductionPercent=0, reductionAngle='', targetVolume=0, extractFormat=OPT_EXTRACT_SMOOTH_ABAQUS_INPUT_FILE, resultFiltering=0, instances='', )[source]¶

This method extracts a surface mesh from the optimized model.

Note

Check OptimizationProcess.extract on help.3ds.com/2019.

Parameters:¶

outputFileName¶: Name of the output file for the extracted surface mesh.
designCycle¶: The design cycle number for which the surface mesh should be extracted.
isoValue=0¶: Value used to determine the positions on the element edges where the new nodes are created. Value between 0 and 1. The default value is 0.3.
smoothCycles=5¶: Number of smoothing cycles; if set to 0, no smoothing is performed. The default value is 5.
reductionPercent=0¶: Defines the percent of faces that should be removed during the data reduction. If set to 0, no data reduction occurs. If set to 100, the data reduction stops when no faces can be removed (that is checked using reductionAngle parameter). Value between 0 and 100. The default value is 0.
reductionAngle=''¶: Defines the maximal angle between adjacent faces at a node such that the node may be removed during the data reduction. Value in degrees between 0 and 90. The default value is15.
targetVolume=0¶: Defines the target volume that is to be achieved iteratively by varying the isovalue. Value between 0 and 1. The default value is 0.
extractFormat=OPT_EXTRACT_SMOOTH_ABAQUS_INPUT_FILE¶: Tuple for the types of format of the output. Values are (OPT_EXTRACT_SMOOTH_ABAQUS_INPUT_FILE, OPT_EXTRACT_SMOOTH_STL). Default: OPT_EXTRACT_SMOOTH_ABAQUS_INPUT_FILE
resultFiltering=0¶: Possible string values are OFF or MODERATE or FULL. Defines if the element material values are to be filtered (averaged locally) before the isocut, and to what extent. The default value is OFF.
instances=''¶: Defines a list of names of part instances to be used for surface extraction. One file (according to extractFormat) is created for each part instance. If the argument is not specified, no part instance is selected and surface is generated for the whole model.

maxDesignCycle : --is-rst--:py:class:`int` = 15[source]¶: An Int specifying the maximum number of allowed design cycles for the optimization process. The default value is 15.

model : --is-rst--:py:class:`str`[source]¶: A String specifying name of the model to be used for the optimization process.

name : --is-rst--:py:class:`str`[source]¶: A String specifying name of the optimization process.

prototypeJob : --is-rst--:py:class:`str`[source]¶: A String specifying name of the job to be used as the prototype for all analysis jobs run by the optimization process.

saveEvery : --is-rst--:py:class:`int` | :py:obj:`None` = None[source]¶: An Int specifying every nth cycle iterations to be saved when dataSaveFrequency is OPT_DATASAVE_SPECIFY_CYCLE. Abaqus saves file iterations for every nth iteration after iteration 1; if you set saveEvery = 3, Abaqus saves file iterations for cycles 1, 4, 7, and so on. The default value is None.

saveFirst : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = True[source]¶: A Boolean specifying whether the first cycle should be saved when dataSaveFrequency is OPT_DATASAVE_SPECIFY_CYCLE. The default value is True.

saveInitial : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = True[source]¶: A Boolean specifying whether the initial cycle should be saved when dataSaveFrequency is OPT_DATASAVE_SPECIFY_CYCLE. The default value is True.

saveLast : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = True[source]¶: A Boolean specifying whether the last cycle should be saved when dataSaveFrequency is OPT_DATASAVE_SPECIFY_CYCLE. The default value is True.

setValues( description='', maxDesignCycle=15, dataSaveFrequency=OPT_DATASAVE_SPECIFY_CYCLE, saveInitial=True, saveFirst=True, saveLast=True, saveEvery=None, )[source]¶

This method modifies the OptimizationProcess object.

Note

Check OptimizationProcess.setValues on help.3ds.com/2019.

Parameters:¶

description=''¶: A String specifying a description of the optimization process.
maxDesignCycle=15¶: An Int specifying the maximum number of allowed design cycles for the optimization process. The default value is 15.
dataSaveFrequency=OPT_DATASAVE_SPECIFY_CYCLE¶: An Enum specifying whether Abaqus should save every iteration file in the optimization process or a selection of iteration files saved at a user-specified frequency. If you set dataSaveFrequency = OPT_DATASAVE_EVERY_CYCLE, Abaqus saves every iteration file; if you set dataSaveFrequency = OPT_DATASAVE_SPECIFY_CYCLE, Abaqus saves iteration files according to the frequency defined by the saveEvery parameter. The default value is OPT_DATASAVE_SPECIFY_CYCLE.
saveInitial=True¶: A Boolean specifying whether the initial cycle should be saved when dataSaveFrequency is OPT_DATASAVE_SPECIFY_CYCLE. The default value is True.
saveFirst=True¶: A Boolean specifying whether the first cycle should be saved when dataSaveFrequency is OPT_DATASAVE_SPECIFY_CYCLE. The default value is True.
saveLast=True¶: A Boolean specifying whether the last cycle should be saved when dataSaveFrequency is OPT_DATASAVE_SPECIFY_CYCLE. The default value is True.
saveEvery=None¶: An Int specifying every nth cycle iterations to be saved when dataSaveFrequency is OPT_DATASAVE_SPECIFY_CYCLE. Abaqus saves file iterations for every nth iteration after iteration 1; if you set saveEvery = 3, Abaqus saves file iterations for cycles 1, 4, 7, and so on. The default value is None.

submit(validate=False)[source]¶

This method submits an optimization process.

Note

Check OptimizationProcess.submit on help.3ds.com/2019.

Parameters:¶

validate=False¶: A Boolean specifying whether Abaqus should perform the validation of the optimization process only. The default value is False.

task : --is-rst--:py:class:`str`[source]¶: A String specifying name of the optimization task to be used for the optimization process.

waitForCompletion()[source]¶

This method interrupts the execution of the script until the end of all the analyses.

If you call the waitForCompletion method and the status member is neither SUBMITTED nor RUNNING, Abaqus assumes the analysis has either completed or aborted and returns immediately.

writeParAndInputFiles()[source]¶: This method allows you to write par and input files for an optimization task.

class JobSession[source]¶

Bases: SessionBase

Member Details:

Queue( name, queueName, hostName='', fileCopy=1, directory='', driver='', remotePlatform=LINUX, filesToCopy=ALL, deleteAfterCopy=0, 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/2019.

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=1¶: 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=LINUX¶: A SymbolicConstant specifying the type of operating system on the remote machine. The default value is Linux.
filesToCopy=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=0¶: 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.

Return type:¶

Queue

Raises:¶

class Queue( name, queueName, hostName='', fileCopy=1, directory='', driver='', remotePlatform=LINUX, filesToCopy=ALL, deleteAfterCopy=0, description='', )[source]¶

Bases: object

A Queue object tells the job where and how to submit a job remotely. A Queue object can be used as the queue argument to the Job method.

Note

This object can be accessed by:

import job
session.queues[name]

Note

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

Member Details:

deleteAfterCopy : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]¶: A Boolean specifying whether remote files are to be deleted after they are copied to the local machine. The default value is OFF.

description : --is-rst--:py:class:`str` = ''[source]¶: A String specifying a description of the queue. The default value is an empty string.

directory : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the remote location for the execution of the simulation. The default value is an empty string.

driver : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the designation of the remote driver. The default value is “abaqus”.

fileCopy : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying if the results files are to be copied from the remote machine to the local machine. The default value is ON.

filesToCopy : --is-rst--:py:class:`str` = 'ALL'[source]¶: 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.

hostName : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the name of the remote host. The default value is an empty string.

name : --is-rst--:py:class:`str`[source]¶: A String specifying the name of the new Queue object.

queueName : --is-rst--:py:class:`str`[source]¶: A String specifying the name of the remote analysis queue.

remotePlatform : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'LINUX'[source]¶: A SymbolicConstant specifying the type of operating system on the remote machine. The default value is Linux.

class Message[source]¶

Bases: object

The Message object contains information about a given phase of the simulation. Job messages are not returned if a script is run without the Abaqus/CAE GUI (using the noGUI option).

Note

This object can be accessed by:

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

Note

Check Message on help.3ds.com/2019.

Member Details:

data : --is-rst--:py:class:`dict` | :py:obj:`None` = None[source]¶: A Dictionary object specifying the data returned by the analysis product. The value depends on the message returned. For a list of the possible entries, see the members of DataObject.

type : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`[source]¶

A SymbolicConstant specifying the type of message. 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
STARTED
STATE_FRAME
STATUS
STEP
WARNING