pycatia.abq_automation_interfaces.abq_job

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-09-25 14:34:21.593357

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.abq_automation_interfaces.abq_job.ABQJob(com_object)

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
ABQJob

Represents an Abaqus job (ABQJob) object.
Role: Access an Abaqus job object or determine its properties.
property computation_dir: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ComputationDir() As CATBSTR

Sets or returns the computation directory.

Returns:
The computation directory.

Example:
This example sets the computation directory for the myJob job to
“D:CompDir”.

myJob.ComputationDir = “D:CompDir”
Return type:

str

property contact_print: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ContactPrint() As boolean

Returns or sets whether contact constraint data are
printed.

Returns:
A boolean specifying whether contact constraint data will be
printed.

Example:
This example sets the printing of contact constraint data for the
myJob job to False.

myJob.ContactPrint = False
Return type:

bool

property description: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Description() As CATBSTR

Returns or sets the job description.

Example:
This example sets the job description for the myJob job to
“AutomatedJob”.

myJob.Description = “AutomatedJob”
Return type:

str

property echo_print: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property EchoPrint() As boolean

Sets or returns whether an echo of the input data is
printed.

Returns:
A boolen specifying whether the input data will be
printed.

Example:
This example sets the printing of echo of the input data for the
myJob job to True.

myJob.EchoPrint = True
Return type:

bool

property history_print: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property HistoryPrint() As boolean

Sets or returns whether history data are printed.

Returns:
A boolean specifying whether the the history data will be
printed.

Example:
This example sets the printing of history data for the myJob job to
True.

myJob.HistoryPrint = True
Return type:

bool

property input_file_format: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property InputFileFormat() As boolean

Sets or returns the format of the input file generated by the
job.

Returns:
The input file format.


Legal values:
False (an assembly of separate parts)
True (a single part)


Example:
This example sets the input file format for the myJob job to a
single part.

myJob.InputFileFormat = True
Return type:

bool

property max_memory: float

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property MaxMemory() As double

Sets or returns the amount of memory (in percent or MB) available to the
solver

Returns:
The amount of memory.

Example:
This example sets the amount of memory available to the solver for
myJob job to 60.

myJob.MaxMemory = 60
Return type:

float

property memory_unit: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property MemoryUnit() As MemoryUnit_Type

Sets or returns the units to be used for specifying the maximum memory to
be used by the solver.

Returns:
The unit.

Legal values:
PERCENT
MEGABYTES

Example:
This example sets the unit for the myJob job to
PERCENT.

myJob.MemoryUnit = PERCENT
Returns:

enum memory_unit_type

Return type:

int

property model_consistency_check: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ModelConsistencyCheck() As boolean

Sets or returns whether a model consistency check should be
performed.

Returns:
A boolean specifying whether a consistency check will be
performed.

Example:
This example sets the Model consistency check for the myJob job to
False.

myJob.ModelConsistencyCheck = False
Return type:

bool

property model_print: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ModelPrint() As boolean

Sets or returns or sets whether model definition data is
printed.

Returns:
A boolean specifying whether the model definition data will be
printed.

Example:
This example sets the printing of model definition data for the
myJob job to False.

myJob.ModelPrint = False
Return type:

bool

property num_cpus: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property NumCpus() As short

Sets or returns the number of CPUs to use for this
analysis.

Returns:
The number of CPUs.

Example:
This example sets the number of CPUs to use myJob job to
3.

myJob.NumCpus = 3
Return type:

int

property parallelization_method_standard: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property ParallelizationMethodStandard() As
ParallelMethodStd_Type

Sets or returns the parallelization method for the Abaqus/Standard direct
solver.

Returns:
The parallelization method.


Legal values:
TREE
SUPERNODE


Example:
This example sets the parallelization method for the myJob job to
TREE.

myJob.ParallelizationMethodStandard = TREE
Returns:

enum parallel_method_std_type

Return type:

int

property restart_read_interval: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property RestartReadInterval() As short

Sets or returns the interval of restart read requests. This is only valid
if RestartReadOption is RESTART_INTERVAL The value must be greater than
0.

Returns:
The interval of restart read requests.

Example:
This example sets the restart read request interval for myJob job
to 10.

myJob.RestartReadInterval = 10
Return type:

int

property restart_read_job: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property RestartReadJob() As CATBSTR

Sets or returns or the path to the original job (*.odb)
file.

Returns:
The path to the original job (*.odb) file.

Example:
This example sets the original job for the myJob job to
“D:myoriginaljob.odb”.

myJob.RestartReadJob = “D:myoriginaljob.odb”
Return type:

str

property restart_read_option: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property RestartReadOption() As short

Sets or returns the restart read option. This is only valid if
RestartReadOption is ABQ_STEP_OBJECT

Returns:
The option of restart read requests.


Legal values:
ABQ_RESTART_END_OF_STEP - The current step is terminated from which
restart
is being made and restarts from end of that
step.
ABQ_RESTART_INTERVAL- Analysis will restart from the specified
interval
number within the specified step.


Example:
This example sets the restart read option for myJob job to end of
step.

myJob.RestartReadOption = ABQ_RESTART_END_OF_STEP
Returns:

enum abq_restart_read_option

Return type:

int

property restart_read_step: ABQStep

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property RestartReadStep() As ABQStep

Sets or returns the Step.

Returns:
The Step of restart read requests.

Example:
This example sets the step for myJob job to 2.

myJob.RestartReadStep = 2
Return type:

ABQStep

property restart_read_step_number: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property RestartReadStepNumber() As short

Sets or returns the step number of restart read requests. This is only
valid if RestartReadOption is ABQ_STEP_NUMBER The value must be greater than or
equal to 1 and less than total number of steps.

Returns:
The step number of restart read requests.

Example:
This example sets the step number for myJob job to
2.

myJob.RestartReadStepNumber = 2
Return type:

int

property restart_read_step_selection_option: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property RestartReadStepSelectionOption() As short

Sets or returns the step selection option for restart
read.

Returns:
The step selection option of restart read requests.


Legal values:
ABQ_STEP_OBJECT - Selects step object
ABQ_STEP_NUMBER- Selects step by step number


Example:
This example sets the step selection option for myJob job to end of
step.

myJob.RestartReadStepSelectionOption = ABQ_STEP_OBJECT
Returns:

enum abq_restart_read_step_sel_option

Return type:

int

property restart_request_frequency: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property RestartRequestFrequency() As short

DEPRECATED - please use RestartRequestOption instead. Sets or returns the
frequency of restart requests.

Returns:
The frequency of restart requests.


Legal values:
0 (None)
1 (After each increment)
999 (After the last increment in each step and after the last
increment of the analysis)


Example:
This example sets the restart request frequency for myJob job to
999.

myJob.RestartRequestFrequency = 999
Return type:

int

property restart_request_frequency_value: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property RestartRequestFrequencyValue() As short

Sets or returns the frequencey value of restart requests. This is only
valid if RestartRequestOption is ABQ_RESTART_SPECINT. The value must be greater
than 0.

Returns:
The frequency value of restart requests.

Example:
This example sets the restart request frequency value for myJob job
to 10.

myJob.RestartRequestFrequencyValue = 10
Return type:

int

property restart_request_interval_value: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property RestartRequestIntervalValue() As short

Sets or returns the interval of restart requests. This is only valid if
RestartRequestOption is ABQ_RESTART_NUMINT The value must be greater than
0.

Returns:
The interval of restart requests.

Example:
This example sets the restart request interval for myJob job to
10.

myJob.RestartRequestIntervalValue = 10
Return type:

int

property restart_request_option: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property RestartRequestOption() As short

Sets or returns the restart request option.

Returns:
The option of restart requests.

Legal values:
ABQ_RESTART_NONE - No restart data.
ABQ_RESTART_EVERYINC- Collect on every increment.
ABQ_RESTART_SPECINC - Used to define the frequency to collect the
data.
Used in conjunction with
RestartRequestFrequencyValue.
ABQ_RESTART_NUMINT - Used to define the interval to collect the
data.
Used in conjunction with
RestartRequestIntervalValue.
ABQ_RESTART_LASTINC - Collect after the last increment in each step
and
after the last increment of the
analysis.

Example:
This example sets the restart option for myJob job to every
increment.

myJob.RestartRequestOption = RESTART_EVERYINC
Returns:

enum ABQ_RESTART_NONE

Return type:

int

property restart_request_overlay: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property RestartRequestOverlay() As boolean

Sets or returns the overlay option for the restart
request.

Returns:
A boolean specifying whether the to use the overlay
option.

Example:
This example sets the overlay option for the restart request for
myJob job to True.

myJob.RestartRequestOverlay = True
Return type:

bool

property restart_request_time_marks: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property RestartRequestTimeMarks() As boolean

Sets or returns the time marks flag for restart requests. This is only
valid if the RestartRequestOption is ABQ_RESTART_NUMINT.

Returns:
The time marks flag for restart requests.

Example:
This example sets the time marks flag for myJob job to
10.

myJob.RestartRequestTimeMarks = True
Return type:

bool

property scratch: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Scratch() As CATBSTR

Sets or returns or the path to the scratch directory.

Returns:
The path to the scratch directory.

Example:
This example sets the scratch directory for the myJob job to
“D:Scratch”.

myJob.Scratch = “D:Scratch”
Return type:

str

property source: bool

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Source() As boolean

Sets or returns the source for analysis.

Returns:
The source (model or input file).

Example:
This example sets the time marks flag for myJob job to From
Model.

myJob.Source = True
Return type:

bool

submit_job() → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub SubmitJob()

Submits the job.
Return type:

None

property type: int

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property Type() As Job_Type

Returns or sets the job type.

Returns:
The job type.


Legal values:
ANALYSIS
DATACHECK
CONTINUE
SYNTAXCHECK
RESTART


Example:
This example sets the job type for the myJob job to
ANALYSIS.

myJob.Type = ANALYSIS
Returns:

enum job_type

Return type:

int

property user_subroutine: str

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357)
o Property UserSubroutine() As CATBSTR

Sets or returns the user subroutine file path.

Returns:
The user subroutine file path.

Example:
This example sets the user subroutine path for the myJob job to
“D:/UserSub”.

myJob.UserSubroutine = “D:/UserSub”
Return type:

str

write_input_file() → None

Note

CAA V5 Visual Basic Help (2020-09-25 14:34:21.593357))
o Sub WriteInputFile()

Writes the input file for the job.
Return type:

None