Output Request#

Step output commands are used for configuring output requests, integrated output sections, diagnostic printing, monitoring, and restart.

Create output requests for Model#

class OutputModel(name: str, description: str = '', stefanBoltzmann: float | None = None, absoluteZero: float | None = None, waveFormulation: SymbolicConstantType = 'NOT_SET', modelType: SymbolicConstantType = 'STANDARD_EXPLICIT', universalGas: float | None = None, copyConstraints: BooleanType = 1, copyConnectors: BooleanType = 1, copyInteractions: BooleanType = 1)[source]#

Abaqus creates a Model object named Model-1 when a session is started.

Notes

This object can be accessed by:

mdb.models[name]

Methods

FieldOutputRequest(name, createStepName[, ...])

This method creates a FieldOutputRequest object.

HistoryOutputRequest(name, createStepName[, ...])

This method creates a HistoryOutputRequest object.

IntegratedOutputSection(name[, surface, ...])

This method creates an IntegratedOutputSection object.

TimePoint(name, points)

This method creates a TimePoint object.

FieldOutputRequest(name: str, createStepName: str, region: SymbolicConstantType = 'MODEL', variables: SymbolicConstantType = 'PRESELECT', frequency: SymbolicConstantType = 1, modes: SymbolicConstantType = 'ALL', timeInterval: SymbolicConstantType | float = 'EVERY_TIME_INCREMENT', numIntervals: int = 20, timeMarks: BooleanType = 0, boltLoad: str = '', sectionPoints: SymbolicConstantType = 'DEFAULT', interactions: str | None = None, rebar: SymbolicConstantType = 'EXCLUDE', filter: SymbolicConstantType | None = None, directions: BooleanType = 1, fasteners: str = '', assembledFastener: str = '', assembledFastenerSet: str = '', exteriorOnly: BooleanType = 0, layupNames: str = '', layupLocationMethod: str = 'SPECIFIED', outputAtPlyTop: BooleanType = False, outputAtPlyMid: BooleanType = True, outputAtPlyBottom: BooleanType = False, position: SymbolicConstantType = 'INTEGRATION_POINTS')[source]#

This method creates a FieldOutputRequest object.

Parameters:
name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which the object is created.

region

The SymbolicConstant MODEL or a Region object specifying the region from which output is requested. The SymbolicConstant MODEL represents the whole model. The default value is MODEL.

variables

A sequence of Strings specifying output request variable or component names, or the SymbolicConstant PRESELECT or ALL. PRESELECT represents all default output variables for the given step. ALL represents all valid output variables. The default value is PRESELECT.

frequency

The SymbolicConstant LAST_INCREMENT or an Int specifying the output frequency in increments. The default value is 1.

modes

The SymbolicConstant ALL or a sequence of Ints specifying a list of eigenmodes for which output is desired. The default value is ALL.

timeInterval

The SymbolicConstant EVERY_TIME_INCREMENT or a Float specifying the time interval at which the output states are to be written. The default value is EVERY_TIME_INCREMENT.

numIntervals

An Int specifying the number of intervals during the step at which output database states are to be written. The default value is 20.

timeMarks

A Boolean specifying when to write results to the output database. OFF indicates that output is written immediately after the time dictated by the specified number of intervals. ON indicates that output is written at the exact times dictated by the specified number of intervals. The default value is OFF.

boltLoad

A String specifying a bolt load from which output is requested.

sectionPoints

The SymbolicConstant DEFAULT or a sequence of Ints specifying the section points for which output requested. The default is DEFAULT.

interactions

None or a sequence of Strings specifying the interaction names. The default value is None.The sequence can contain only one String.

rebar

A SymbolicConstant specifying whether output is requested for rebar. Possible values are EXCLUDE, INCLUDE, and ONLY. The default value is EXCLUDE.

filter

The SymbolicConstant ANTIALIASING or a String specifying the name of an output filter object. The default value is None.

directions

A Boolean specifying whether to output directions of the local material coordinate system. The default value is ON.

fasteners

A String specifying the fastener name. The default value is an empty string.

assembledFastener

A String specifying the assembled fastener name. The default value is an empty string.

assembledFastenerSet

A String specifying the set name from the model referenced by the assembled fastener, assembledFastener. The default value is an empty string.

exteriorOnly

A Boolean specifying whether the output domain is restricted to the exterior of the model. This argument is only valid if *region*=MODEL. The default value is OFF.

layupNames

A List of Composite Layer Names.

layupLocationMethod

A Symbolic constant specifying the method used to indicate the output locations for composite layups. Possible values are ALL_LOCATIONS, SPECIFIED and TYPED_IN. The default value is SPECIFIED.

outputAtPlyTop

A Boolean specifying whether to output at the ply top section point. The default value is False.

outputAtPlyMid

A Boolean specifying whether to output at the ply mid section point. The default value is True.

outputAtPlyBottom

A Boolean specifying whether to output at the ply bottom section point. The default value is False.

position

A SymbolicConstant specifying the position on an element where output needs to be written. Possible values are INTEGRATION_POINTS, AVERAGED_AT_NODES, CENTROIDAL, and NODES. The default value is INTEGRATION_POINTS.

Returns:
A FieldOutputRequest object.

Notes

This function can be accessed by:

mdb.models[name].FieldOutputRequest
HistoryOutputRequest(name: str, createStepName: str, region: SymbolicConstantType = 'MODEL', variables: SymbolicConstantType = 'PRESELECT', frequency: SymbolicConstantType = 1, modes: SymbolicConstantType = 'ALL', timeInterval: SymbolicConstantType | float = 'EVERY_TIME_INCREMENT', numIntervals: int = 20, boltLoad: str = '', sectionPoints: SymbolicConstantType = 'DEFAULT', stepName: str = '', interactions: str | None = None, contourIntegral: str | None = None, numberOfContours: int = 0, stressInitializationStep: str | None = None, contourType: SymbolicConstantType = 'J_INTEGRAL', kFactorDirection: SymbolicConstantType = 'MTS', rebar: SymbolicConstantType = 'EXCLUDE', integratedOutputSection: str = '', springs: tuple | None = None, filter: SymbolicConstantType | None = None, fasteners: str = '', assembledFastener: str = '', assembledFastenerSet: str = '', sensor: BooleanType = 0, useGlobal: BooleanType = True)[source]#

This method creates a HistoryOutputRequest object.

Parameters:
name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which the object is created.

region

The SymbolicConstant MODEL or a Region object specifying the region from which output is requested. The SymbolicConstant MODEL represents the whole model. The default value is MODEL.If the region is a surface region, the surface must lie within the general contact surface domain.

variables

A sequence of Strings specifying output request variable or component names, or the SymbolicConstant PRESELECT or ALL. PRESELECT represents all default output variables for the given step. ALL represents all valid output variables. The default value is PRESELECT.

frequency

The SymbolicConstant LAST_INCREMENT or an Int specifying the output frequency in increments. The default value is 1.

modes

The SymbolicConstant ALL or a sequence of Ints specifying a list of eigenmodes for which output is desired. The default value is ALL.

timeInterval

The SymbolicConstant EVERY_TIME_INCREMENT or a Float specifying the time interval at which the output states are to be written. The default value is EVERY_TIME_INCREMENT.

numIntervals

An Int specifying the number of intervals during the step at which output database states are to be written. The default value is 20.

boltLoad

A String specifying a bolt load from which output is requested. The default value is an empty string.

sectionPoints

The SymbolicConstant DEFAULT or a sequence of Ints specifying the section points for which output is requested. The default value is DEFAULT.

stepName

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

interactions

None or a sequence of Strings specifying the interaction names. The default value is None.The sequence can contain only one String.

contourIntegral

A String specifying the contour integral name. The default value is None.

numberOfContours

An Int specifying the number of contour integrals to output for the contour integral object. The default value is 0.

stressInitializationStep

A String specifying the name of the stress initialization step. The default value is None.

contourType

A SymbolicConstant specifying the type of contour integral. Possible values are J_INTEGRAL, C_INTEGRAL, T_STRESS, and K_FACTORS. The default value is J_INTEGRAL.

kFactorDirection

A SymbolicConstant specifying the stress intensity factor direction. Possible values are MTS, MERR, and K110. The kFactorDirection argument is valid only if *contourType*=K_FACTORS. The default value is MTS.

rebar

A SymbolicConstant specifying whether output is requested for rebar. Possible values are EXCLUDE, INCLUDE, and ONLY. The default value is EXCLUDE.

integratedOutputSection

A String specifying the integrated output section. The default value is an empty string.

springs

A sequence of Strings specifying the springs/dashpots names. The default value is None. The sequence can contain only one String.

filter

The SymbolicConstant ANTIALIASING or a String specifying the name of an output filter object. The default value is None.

fasteners

A String specifying the fastener name. The default value is an empty string.

assembledFastener

A String specifying the assembled fastener name. The default value is an empty string.

assembledFastenerSet

A String specifying the set name from the model referenced by the assembled fastener, assembledFastener. The default value is an empty string.

sensor

A Boolean specifying whether to associate the output request with a sensor definition. The default value is OFF.

useGlobal

A Boolean specifying whether to output vector-valued nodal variables in the global directions. The default value is True.

Returns:
A HistoryOutputRequest object.

Notes

This function can be accessed by:

mdb.models[name].HistoryOutputRequest
IntegratedOutputSection(name: str, surface: ~abaqus.Region.Region.Region = <abaqus.Region.Region.Region object>, refPoint: ~abaqusConstants.SymbolicConstantType | None = None, refPointAtCenter: ~abaqusConstants.BooleanType = 0, refPointMotion: ~abaqusConstants.SymbolicConstantType = 'INDEPENDENT', localCsys: str | None = None, projectOrientation: ~abaqusConstants.BooleanType = 0) IntegratedOutputSection[source]#

This method creates an IntegratedOutputSection object.

Parameters:
name

A String specifying the repository key.

surface

A Region object specifying the surface over which the output is based.

refPoint

None or a Region object specifying the anchor point about which the integrated moment over the output region is computed or the SymbolicConstant None representing the global origin. The default value is None.

refPointAtCenter

A Boolean specifying that the refPoint be adjusted so that it coincides with the center of the output region in the initial configuration. This argument is valid only when you include the refPoint argument. The default value is OFF.

refPointMotion

A SymbolicConstant specifying how to relate the motion of refPoint to the average motion of the output region. A value of INDEPENDENT will allow the refPoint to move independent of the output region. A value of AVERAGE_TRANSLATION will set the displacement of the refPoint equal to the average translation of the output region. A value of AVERAGE will set the displacement and rotation of the refPoint equal to the average translation of the output region. The default value is INDEPENDENT.This argument is valid only when you include the refPoint argument.

localCsys

None or a DatumCsys object specifying the local coordinate system used to express vector output. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

projectOrientation

A Boolean specifying that the coordinate system be projected onto the surface such that the 1–axis is normal to the surface. Projection onto a planar surface is such that the 1-axis is normal to the surface, and a projection onto a nonplanar surface is such that a least-squares fit surface will be used. The default value is OFF.

Returns:
An IntegratedOutputSection object.

Notes

This function can be accessed by:

mdb.models[name].IntegratedOutputSection
TimePoint(name: str, points: tuple) TimePoint[source]#

This method creates a TimePoint object.

Parameters:
name

A String specifying the repository key.

points

A sequence of sequences of Floats specifying time points at which data are written to the output database or restart files.

Returns:
A TimePoint object.
Raises:
InvalidNameError
RangeError

Notes

This function can be accessed by:

mdb.models[name].TimePoint

Create DiagnosticPrint, Monitor and Restart information for Step#

class OutputStep[source]#

The Step object stores the parameters that determine the context of the step. The Step object is the abstract base type for other Step objects. The Step object has no explicit constructor. The methods and members of the Step object are common to all objects derived from the Step.

Notes

This object can be accessed by:

import step
mdb.models[name].steps[name]

Methods

DiagnosticPrint([allke, criticalElement, ...])

This method creates a DiagnosticPrint object.

Monitor(node, dof, frequency)

This method creates a request for a degree of freedom to be monitored in a general or modal procedure.

Restart([numberIntervals, timeMarks, ...])

This method creates a restart request.

DiagnosticPrint(allke: BooleanType = 1, criticalElement: BooleanType = 1, dmass: BooleanType = 0, etotal: BooleanType = 0, contact: BooleanType = 1, modelChange: BooleanType = 0, plasticity: BooleanType = 0, residual: BooleanType = 1, frequency: int = 1, solve: BooleanType = 1, mass: BooleanType = 0) DiagnosticPrint[source]#

This method creates a DiagnosticPrint object.

Parameters:
allke

A Boolean specifying a request for a column containing the total kinetic energy. This argument is valid only for an Abaqus/Explicit analysis. The default value is ON.

criticalElement

A Boolean specifying a request for a column containing the element that has the smallest stable time increment and a column listing the value. This argument is valid only for an Abaqus/Explicit analysis. The default value is ON.

dmass

A Boolean specifying a request for a column containing the percent change in total mass of the model as a result of mass scaling. This argument is valid only for an Abaqus/Explicit analysis. The default value is OFF unless mass scaling is present in the model.

etotal

A Boolean specifying a request for a column containing the energy balance of the model. This argument is valid only for an Abaqus/Explicit analysis. The default value is OFF.

contact

A Boolean specifying a request for detailed output of points that are contacting or separating in interface and gap problems. This argument is valid only for an Abaqus/Standard analysis. The default value is ON.

modelChange

A Boolean specifying a request for detailed output of which elements are being removed or reactivated in the step. This argument is valid only for an Abaqus/Standard analysis. The default value is OFF.

plasticity

A Boolean specifying a request for detailed output of element and integration point numbers for which the plasticity algorithms have failed to converge in the material routines. This argument is valid only for an Abaqus/Standard analysis. The default value is OFF.

residual

A Boolean specifying a request for output of equilibrium residuals during the equilibrium iterations. This argument is valid only for an Abaqus/Standard analysis. The default value is ON.

frequency

An Int specifying the frequency of output, in increments. The default value is 1.

solve

A Boolean specifying a request for information regarding the actual number of equations and the wavefront in each iteration. This argument is valid only for an Abaqus/Standard analysis. The default value is ON.

mass

A Boolean specifying a request for a column containing the total mass of the model as a result of mass scaling. This argument is valid only for an Abaqus/Explicit analysis. The default value is OFF.

Returns:
diagnosticPrint: DiagnosticPrint

A DiagnosticPrint object

Notes

This function can be accessed by:

mdb.models[name].steps[name].DiagnosticPrint
Monitor(node: str, dof: SymbolicConstantType, frequency: int) Monitor[source]#

This method creates a request for a degree of freedom to be monitored in a general or modal procedure.

Parameters:
node

A String specifying the name of the region to be monitored.

dof

A SymbolicConstant specifying the degree of freedom to be monitored at the node. Possible values are: - U1 - U2 - U3 - UR1 - UR2 - UR3 - WARP - FLUID_PRESSURE - ELECTRICAL_POTENTIAL - NT11 - NT30 - NN11 - NN30 The NT identifiers are not available for mass diffusion. The NN identifiers are available only for mass diffusion.

frequency

An Int specifying the output frequency in increments. This argument is valid only for an Abaqus/Standard analysis.

Returns:
monitor: Monitor

A Monitor object

Notes

This function can be accessed by:

mdb.models[name].steps[name].Monitor
Restart(numberIntervals: int = 0, timeMarks: BooleanType = 0, overlay: BooleanType = 0, frequency: int = 0) Restart[source]#

This method creates a restart request.

Parameters:
numberIntervals

An Int specifying the number of intervals during the step at which restart information will be written. The default value is 0. The default value is 1.

timeMarks

A Boolean specifying whether to use exact time marks for writing during an analysis. The default value is OFF. The default value is OFF.

overlay

A Boolean specifying that only one increment per step should be retained on the restart file, thus minimizing the size of the restart file. The default value is OFF. The default value is ON.

frequency

An Int specifying the increments at which restart information will be written. The default value is 0. The default value is 0.This argument applies only to Abaqus/Standard analyses.

Returns:
restart: Restart

A Restart object

Raises:
RangeError.

Notes

This function can be accessed by:

mdb.models[name].steps[name].Restart

Object features#

DiagnosticPrint#

class DiagnosticPrint(allke: BooleanType = 1, criticalElement: BooleanType = 1, dmass: BooleanType = 0, etotal: BooleanType = 0, contact: BooleanType = 1, modelChange: BooleanType = 0, plasticity: BooleanType = 0, residual: BooleanType = 1, frequency: int = 1, solve: BooleanType = 1, mass: BooleanType = 0)[source]#

The DiagnosticPrint object is used to request detailed diagnostic output or to disable specific diagnostic checks

Notes

This object can be accessed by:

import step
mdb.models[name].steps[name].diagnosticPrint

The corresponding analysis keywords are:

  • DIAGNOSTICS

Methods

setValues()

This method modifies the DiagnosticPrint object.

setValues()[source]#

This method modifies the DiagnosticPrint object.

FieldOutputRequest#

class FieldOutputRequest(name: str, createStepName: str, region: SymbolicConstantType = 'MODEL', variables: SymbolicConstantType = 'PRESELECT', frequency: SymbolicConstantType = 1, modes: SymbolicConstantType = 'ALL', timeInterval: SymbolicConstantType | float = 'EVERY_TIME_INCREMENT', numIntervals: int = 20, timeMarks: BooleanType = 0, boltLoad: str = '', sectionPoints: SymbolicConstantType = 'DEFAULT', interactions: str | None = None, rebar: SymbolicConstantType = 'EXCLUDE', filter: SymbolicConstantType | None = None, directions: BooleanType = 1, fasteners: str = '', assembledFastener: str = '', assembledFastenerSet: str = '', exteriorOnly: BooleanType = 0, layupNames: str = '', layupLocationMethod: str = 'SPECIFIED', outputAtPlyTop: BooleanType = False, outputAtPlyMid: BooleanType = True, outputAtPlyBottom: BooleanType = False, position: SymbolicConstantType = 'INTEGRATION_POINTS')[source]#

The FieldOutputRequest object defines a field output request.

Notes

This object can be accessed by:

import step
mdb.models[name].fieldOutputRequests[name]

The corresponding analysis keywords are:

  • CONTACT OUTPUT
    • ELEMENT OUTPUT

    • ENERGY OUTPUT

    • INCREMENTATION OUTPUT

    • MODAL OUTPUT

    • NODE OUTPUT

    • OUTPUT

    • RADIATION OUTPUT

Attributes:
boltLoad: str

A String specifying a bolt load from which output is requested.

region: SymbolicConstant

The SymbolicConstant MODEL or a Region object specifying the region from which output is requested. The SymbolicConstant MODEL represents the whole model. The default value is MODEL.

interactions: tuple

None or a tuple of Strings specifying the interaction names. The default value is None.The sequence can contain only one String.

Methods

deactivate(stepName)

This method deactivates the field output request in the specified step and all its subsequent steps.

move(fromStepName, toStepName)

This method moves the field output request state object from one step to a different step.

reset(stepName)

This method resets the field output request state of the specified step to the state of the previous step.

resume()

This method resumes the field output request that was previously suppressed.

setValues([region, variables, frequency, ...])

This method modifies the data for an existing FieldOutputRequest object in the step where it is created.

setValuesInStep(stepName[, variables, ...])

This method modifies the propagating data for an existing FieldOutputRequest object in the specified step.

suppress()

This method suppresses the field output request.

deactivate(stepName: str)[source]#

This method deactivates the field output request in the specified step and all its subsequent steps.

Parameters:
stepName

A String specifying the name of the step in which the field output request is deactivated.

move(fromStepName: str, toStepName: str)[source]#

This method moves the field output request state object from one step to a different step.

Parameters:
fromStepName

A String specifying the name of the step from which the field output request state is moved.

toStepName

A String specifying the name of the step to which the field output request state is moved.

reset(stepName: str)[source]#

This method resets the field output request state of the specified step to the state of the previous step.

Parameters:
stepName

A String specifying the name of the step in which the field output request state is reset.

resume()[source]#

This method resumes the field output request that was previously suppressed.

setValues(region: SymbolicConstantType = 'MODEL', variables: SymbolicConstantType = 'PRESELECT', frequency: SymbolicConstantType = 1, modes: SymbolicConstantType = 'ALL', timeInterval: SymbolicConstantType | float = 'EVERY_TIME_INCREMENT', numIntervals: int = 20, timeMarks: BooleanType = 0, boltLoad: str = '', sectionPoints: SymbolicConstantType = 'DEFAULT', interactions: str | None = None, rebar: SymbolicConstantType = 'EXCLUDE', filter: SymbolicConstantType | None = None, directions: BooleanType = 1, fasteners: str = '', assembledFastener: str = '', assembledFastenerSet: str = '', exteriorOnly: BooleanType = 0, layupNames: str = '', layupLocationMethod: str = 'SPECIFIED', outputAtPlyTop: BooleanType = False, outputAtPlyMid: BooleanType = True, outputAtPlyBottom: BooleanType = False, position: SymbolicConstantType = 'INTEGRATION_POINTS')[source]#

This method modifies the data for an existing FieldOutputRequest object in the step where it is created.

Parameters:
region

The SymbolicConstant MODEL or a Region object specifying the region from which output is requested. The SymbolicConstant MODEL represents the whole model. The default value is MODEL.

variables

A sequence of Strings specifying output request variable or component names, or the SymbolicConstant PRESELECT or ALL. PRESELECT represents all default output variables for the given step. ALL represents all valid output variables. The default value is PRESELECT.

frequency

The SymbolicConstant LAST_INCREMENT or an Int specifying the output frequency in increments. The default value is 1.

modes

The SymbolicConstant ALL or a sequence of Ints specifying a list of eigenmodes for which output is desired. The default value is ALL.

timeInterval

The SymbolicConstant EVERY_TIME_INCREMENT or a Float specifying the time interval at which the output states are to be written. The default value is EVERY_TIME_INCREMENT.

numIntervals

An Int specifying the number of intervals during the step at which output database states are to be written. The default value is 20.

timeMarks

A Boolean specifying when to write results to the output database. OFF indicates that output is written immediately after the time dictated by the specified number of intervals. ON indicates that output is written at the exact times dictated by the specified number of intervals. The default value is OFF.

boltLoad

A String specifying a bolt load from which output is requested.

sectionPoints

The SymbolicConstant DEFAULT or a sequence of Ints specifying the section points for which output requested. The default is DEFAULT.

interactions

None or a sequence of Strings specifying the interaction names. The default value is None.The sequence can contain only one String.

rebar

A SymbolicConstant specifying whether output is requested for rebar. Possible values are EXCLUDE, INCLUDE, and ONLY. The default value is EXCLUDE.

filter

The SymbolicConstant ANTIALIASING or a String specifying the name of an output filter object. The default value is None.

directions

A Boolean specifying whether to output directions of the local material coordinate system. The default value is ON.

fasteners

A String specifying the fastener name. The default value is an empty string.

assembledFastener

A String specifying the assembled fastener name. The default value is an empty string.

assembledFastenerSet

A String specifying the set name from the model referenced by the assembled fastener, assembledFastener. The default value is an empty string.

exteriorOnly

A Boolean specifying whether the output domain is restricted to the exterior of the model. This argument is only valid if *region*=MODEL. The default value is OFF.

layupNames

A List of Composite Layer Names.

layupLocationMethod

A Symbolic constant specifying the method used to indicate the output locations for composite layups. Possible values are ALL_LOCATIONS, SPECIFIED and TYPED_IN. The default value is SPECIFIED.

outputAtPlyTop

A Boolean specifying whether to output at the ply top section point. The default value is False.

outputAtPlyMid

A Boolean specifying whether to output at the ply mid section point. The default value is True.

outputAtPlyBottom

A Boolean specifying whether to output at the ply bottom section point. The default value is False.

position

A SymbolicConstant specifying the position on an element where output needs to be written. Possible values are INTEGRATION_POINTS, AVERAGED_AT_NODES, CENTROIDAL, and NODES. The default value is INTEGRATION_POINTS.

setValuesInStep(stepName: str, variables: SymbolicConstantType | None = None, frequency: SymbolicConstantType = 1, modes: SymbolicConstantType = 'ALL', timeInterval: SymbolicConstantType | float = 'EVERY_TIME_INCREMENT', numIntervals: int = 20, timePoint: str | None = None, timeMarks: BooleanType = 0)[source]#

This method modifies the propagating data for an existing FieldOutputRequest object in the specified step.

Parameters:
stepName

A String specifying the name of the step in which the field output request is modified.

variables

A sequence of Strings specifying output request variable or component names, or the SymbolicConstant PRESELECT or ALL. PRESELECT represents all default output variables for the given step. ALL represents all valid output variables.

frequency

The SymbolicConstant LAST_INCREMENT or an Int specifying the output frequency in increments. The default value is 1.

modes

The SymbolicConstant ALL or a sequence of Ints specifying a list of eigenmodes for which output is desired. The default value is ALL.

timeInterval

The SymbolicConstant EVERY_TIME_INCREMENT or a Float specifying the time interval at which the output states are to be written. The default value is EVERY_TIME_INCREMENT.

numIntervals

An Int equal to the number of intervals during the step at which output database states are to be written. The default value is 20.

timePoint

A String specifying the name of a time point object. The default value is equal to the number of intervals during the step at which output database states are to be written. The default value is None.

timeMarks

A Boolean specifying when to write results to the output database. The default value is OFF.

suppress()[source]#

This method suppresses the field output request.

FieldOutputRequestState#

class FieldOutputRequestState[source]#

The FieldOutputRequestState object stores the propagating data of a field output request current in a step. One instance of this object is created internally by the FieldOutputRequest object for each step. The instance is also deleted internally by the FieldOutputRequest object. The FieldOutputRequestState object has no constructor or methods.

Notes

This object can be accessed by:

import step
mdb.models[name].steps[name].fieldOutputRequestState[name]
Attributes:
variablesState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the field output request variables. Possible values are UNSET, SET, and UNCHANGED.

frequency: SymbolicConstant

The SymbolicConstant LAST_INCREMENT or an Int specifying the output frequency in increments. The default value is 1.

frequencyState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the field output request frequency. Possible values are UNSET, SET, and UNCHANGED.

modesState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the field output request modes. Possible values are UNSET, SET, and UNCHANGED.

timeInterval: typing.Union[SymbolicConstant, float]

The SymbolicConstant EVERY_TIME_INCREMENT or a Float specifying the time interval at which the output states are to be written. The default value is EVERY_TIME_INCREMENT.

timeIntervalState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the field output request time interval. Possible values are UNSET, SET, and UNCHANGED.

numIntervals: int

An Int specifying the number of intervals during the step at which output database states are to be written. The default value is 20.

numIntervalsState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the field output request. Possible values are UNSET, SET, and UNCHANGED.

timeMarks: Boolean

A Boolean specifying when to write results to the output database. The default value is OFF.

timeMarksState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the field output request. Possible values are UNSET, SET, and UNCHANGED.

timePointState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the field output request. Possible values are UNSET, SET, and UNCHANGED.

status: SymbolicConstant

A SymbolicConstant specifying the propagation state of the FieldOutputRequestState object. Possible values are NOT_YET_ACTIVE, CREATED, PROPAGATED, MODIFIED, DEACTIVATED, NO_LONGER_ACTIVE, TYPE_NOT_APPLICABLE, and INSTANCE_NOT_APPLICABLE.

variables: SymbolicConstant

A tuple of Strings specifying output request variable or component names, or the SymbolicConstant PRESELECT or ALL. PRESELECT represents all default output variables for the given step. ALL represents all valid output variables.

modes: SymbolicConstant

The SymbolicConstant ALL or a tuple of Ints specifying a list of eigenmodes for which output is desired. The default value is ALL.

timePoint: str

A String specifying the name of a time point object used to determine which output database states are to be written. The default value is an empty string.

frequencyType: str

A String specifying a read-only SymbolicConstant describing which type of frequency of output is used. Possible values areFREQUENCY, NUMBER_INTERVALS, TIME_INTERVAL, TIME_POINT and MODES. The default value depends on the procedure. The default value is an empty string.

HistoryOutputRequest#

class HistoryOutputRequest(name: str, createStepName: str, region: SymbolicConstantType = 'MODEL', variables: SymbolicConstantType = 'PRESELECT', frequency: SymbolicConstantType = 1, modes: SymbolicConstantType = 'ALL', timeInterval: SymbolicConstantType | float = 'EVERY_TIME_INCREMENT', numIntervals: int = 20, boltLoad: str = '', sectionPoints: SymbolicConstantType = 'DEFAULT', stepName: str = '', interactions: str | None = None, contourIntegral: str | None = None, numberOfContours: int = 0, stressInitializationStep: str | None = None, contourType: SymbolicConstantType = 'J_INTEGRAL', kFactorDirection: SymbolicConstantType = 'MTS', rebar: SymbolicConstantType = 'EXCLUDE', integratedOutputSection: str = '', springs: tuple | None = None, filter: SymbolicConstantType | None = None, fasteners: str = '', assembledFastener: str = '', assembledFastenerSet: str = '', sensor: BooleanType = 0, useGlobal: BooleanType = True)[source]#

The HistoryOutputRequest object defines a history output request.

Notes

This object can be accessed by:

import step
mdb.models[name].historyOutputRequests[name]

The corresponding analysis keywords are:

  • CONTACT OUTPUT
    • ELEMENT OUTPUT

    • ENERGY OUTPUT

    • INCREMENTATION OUTPUT

    • MODAL OUTPUT

    • NODE OUTPUT

    • OUTPUT

    • RADIATION OUTPUT

Attributes:
boltLoad: str

A String specifying a bolt load from which output is requested. The default value is an empty string.

region: SymbolicConstant

The SymbolicConstant MODEL or a Region object specifying the region from which output is requested. The SymbolicConstant MODEL represents the whole model. The default value is MODEL.If the region is a surface region, the surface must lie within the general contact surface domain.

sectionPoints: SymbolicConstant

The SymbolicConstant DEFAULT or a tuple of Ints specifying the section points for which output is requested. The default value is DEFAULT.

interactions: tuple

None or a tuple of Strings specifying the interaction names. The default value is None.The sequence can contain only one String.

Methods

deactivate(stepName)

This method deactivates the history output request in the specified step and all subsequent steps.

move(fromStepName, toStepName)

This method moves the history output request state object from one step to a different step.

reset(stepName)

This method resets the history output request state of the specified step to the state of the previous step.

resume()

This method resumes the history output request that was previously suppressed.

setValues([region, variables, frequency, ...])

This method modifies the data for an existing HistoryOutputRequest object in the step where it is created.

setValuesInStep(stepName[, variables, ...])

This method modifies the propagating data for an existing HistoryOutputRequest object in the specified step.

suppress()

This method suppresses the history output request.

deactivate(stepName: str)[source]#

This method deactivates the history output request in the specified step and all subsequent steps.

Parameters:
stepName

A String specifying the name of the step in which the history output request is deactivated.

move(fromStepName: str, toStepName: str)[source]#

This method moves the history output request state object from one step to a different step.

Parameters:
fromStepName

A String specifying the name of the step from which the history output request state is moved.

toStepName

A String specifying the name of the step to which the history output request state is moved.

reset(stepName: str)[source]#

This method resets the history output request state of the specified step to the state of the previous step.

Parameters:
stepName

A String specifying the name of the step in which the history output request state is reset.

resume()[source]#

This method resumes the history output request that was previously suppressed.

setValues(region: SymbolicConstantType = 'MODEL', variables: SymbolicConstantType = 'PRESELECT', frequency: SymbolicConstantType = 1, modes: SymbolicConstantType = 'ALL', timeInterval: SymbolicConstantType | float = 'EVERY_TIME_INCREMENT', numIntervals: int = 20, boltLoad: str = '', sectionPoints: SymbolicConstantType = 'DEFAULT', stepName: str = '', interactions: str | None = None, contourIntegral: str | None = None, numberOfContours: int = 0, stressInitializationStep: str | None = None, contourType: SymbolicConstantType = 'J_INTEGRAL', kFactorDirection: SymbolicConstantType = 'MTS', rebar: SymbolicConstantType = 'EXCLUDE', integratedOutputSection: str = '', springs: tuple | None = None, filter: SymbolicConstantType | None = None, fasteners: str = '', assembledFastener: str = '', assembledFastenerSet: str = '', sensor: BooleanType = 0, useGlobal: BooleanType = True)[source]#

This method modifies the data for an existing HistoryOutputRequest object in the step where it is created.

Parameters:
region

The SymbolicConstant MODEL or a Region object specifying the region from which output is requested. The SymbolicConstant MODEL represents the whole model. The default value is MODEL.If the region is a surface region, the surface must lie within the general contact surface domain.

variables

A sequence of Strings specifying output request variable or component names, or the SymbolicConstant PRESELECT or ALL. PRESELECT represents all default output variables for the given step. ALL represents all valid output variables. The default value is PRESELECT.

frequency

The SymbolicConstant LAST_INCREMENT or an Int specifying the output frequency in increments. The default value is 1.

modes

The SymbolicConstant ALL or a sequence of Ints specifying a list of eigenmodes for which output is desired. The default value is ALL.

timeInterval

The SymbolicConstant EVERY_TIME_INCREMENT or a Float specifying the time interval at which the output states are to be written. The default value is EVERY_TIME_INCREMENT.

numIntervals

An Int specifying the number of intervals during the step at which output database states are to be written. The default value is 20.

boltLoad

A String specifying a bolt load from which output is requested. The default value is an empty string.

sectionPoints

The SymbolicConstant DEFAULT or a sequence of Ints specifying the section points for which output is requested. The default value is DEFAULT.

stepName

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

interactions

None or a sequence of Strings specifying the interaction names. The default value is None.The sequence can contain only one String.

contourIntegral

A String specifying the contour integral name. The default value is None.

numberOfContours

An Int specifying the number of contour integrals to output for the contour integral object. The default value is 0.

stressInitializationStep

A String specifying the name of the stress initialization step. The default value is None.

contourType

A SymbolicConstant specifying the type of contour integral. Possible values are J_INTEGRAL, C_INTEGRAL, T_STRESS, and K_FACTORS. The default value is J_INTEGRAL.

kFactorDirection

A SymbolicConstant specifying the stress intensity factor direction. Possible values are MTS, MERR, and K110. The kFactorDirection argument is valid only if *contourType*=K_FACTORS. The default value is MTS.

rebar

A SymbolicConstant specifying whether output is requested for rebar. Possible values are EXCLUDE, INCLUDE, and ONLY. The default value is EXCLUDE.

integratedOutputSection

A String specifying the integrated output section. The default value is an empty string.

springs

A sequence of Strings specifying the springs/dashpots names. The default value is None. The sequence can contain only one String.

filter

The SymbolicConstant ANTIALIASING or a String specifying the name of an output filter object. The default value is None.

fasteners

A String specifying the fastener name. The default value is an empty string.

assembledFastener

A String specifying the assembled fastener name. The default value is an empty string.

assembledFastenerSet

A String specifying the set name from the model referenced by the assembled fastener, assembledFastener. The default value is an empty string.

sensor

A Boolean specifying whether to associate the output request with a sensor definition. The default value is OFF.

useGlobal

A Boolean specifying whether to output vector-valued nodal variables in the global directions. The default value is True.

setValuesInStep(stepName: str, variables: SymbolicConstantType | None = None, frequency: SymbolicConstantType = 1, modes: SymbolicConstantType = 'ALL', timeInterval: SymbolicConstantType | float = 'EVERY_TIME_INCREMENT', numIntervals: int = 20, timePoints: str | None = None)[source]#

This method modifies the propagating data for an existing HistoryOutputRequest object in the specified step.

Parameters:
stepName

A String specifying the name of the step in which the history output request is modified.

variables

A sequence of Strings specifying output request variable or component names or the SymbolicConstant PRESELECT or ALL. PRESELECT represents all default output variables for the given step. ALL represents all valid output variables.

frequency

The SymbolicConstant LAST_INCREMENT or an Int specifying the output frequency in increments. The default value is 1.

modes

The SymbolicConstant ALL or a sequence of Ints specifying a list of eigenmodes for which output is desired. The default value is ALL.

timeInterval

The SymbolicConstant EVERY_TIME_INCREMENT or a Float specifying the time interval at which the output states are to be written. The default value is EVERY_TIME_INCREMENT.

numIntervals

An Int specifying the number of intervals during the step at which output database states are to be written. The default value is 20.

timePoints

A String specifying the name of a time point object. The default value is equal to the number of intervals during the step at which output database states are to be written. The default value is None.

suppress()[source]#

This method suppresses the history output request.

HistoryOutputRequestState#

class HistoryOutputRequestState[source]#

The HistoryOutputRequestState object stores the propagating data of a History output request current in a step. One instance of this object is created internally by the HistoryOutputRequest object for each step. The instance is also deleted internally by the HistoryOutputRequest object. The HistoryOutputRequestState object has no constructor or methods.

Notes

This object can be accessed by:

import step
mdb.models[name].steps[name].historyOutputRequestState[name]
Attributes:
variablesState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the history output request variables. Possible values are UNSET, SET, and UNCHANGED.

frequency: SymbolicConstant

The SymbolicConstant LAST_INCREMENT or an Int specifying the output frequency in increments. The default value is 1.

frequencyState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the history output request frequency. Possible values are UNSET, SET, and UNCHANGED.

modesState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the history output request modes. Possible values are UNSET, SET, and UNCHANGED.

timeInterval: typing.Union[SymbolicConstant, float]

The SymbolicConstant EVERY_TIME_INCREMENT or a Float specifying the time interval at which the output states are to be written. The default value is EVERY_TIME_INCREMENT.

timeIntervalState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the history output request time interval. Possible values are UNSET, SET, and UNCHANGED.

numIntervals: int

An Int specifying the number of intervals during the step at which output database states are to be written. The default value is 20.

timePointState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the history output request. Possible values are UNSET, SET, and UNCHANGED.

numIntervalsState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the history output request. Possible values are UNSET, SET, and UNCHANGED.

status: SymbolicConstant

A SymbolicConstant specifying the propagation state of the HistoryOutputRequestState object. Possible values are NOT_YET_ACTIVE, CREATED, PROPAGATED, MODIFIED, DEACTIVATED, NO_LONGER_ACTIVE, TYPE_NOT_APPLICABLE, and INSTANCE_NOT_APPLICABLE.

variables: SymbolicConstant

A tuple of Strings specifying output request variable or component names, or the SymbolicConstant PRESELECT or ALL. PRESELECT represents all default output variables for the given step. ALL represents all valid output variables.

modes: SymbolicConstant

The SymbolicConstant ALL or a tuple of Ints specifying a list of eigenmodes for which output is desired. The default value is ALL.

timePoint: str

A String specifying the name of a time point object used to determine at which :py:class:`~.point`s in the time period data is written to the output database. The default value is an empty string.

frequencyType: str

A String specifying a read-only SymbolicConstant describing which type of frequency of output is used. Possible values areFREQUENCY, NUMBER_INTERVALS, TIME_INTERVAL, TIME_POINT and MODES. The default value depends on the procedure. The default value is an empty string.

IntegratedOutputSection#

class IntegratedOutputSection(name: str, surface: ~abaqus.Region.Region.Region = <abaqus.Region.Region.Region object>, refPoint: ~abaqusConstants.SymbolicConstantType | None = None, refPointAtCenter: ~abaqusConstants.BooleanType = 0, refPointMotion: ~abaqusConstants.SymbolicConstantType = 'INDEPENDENT', localCsys: str | None = None, projectOrientation: ~abaqusConstants.BooleanType = 0)[source]#

The IntegratedOutputSection object specifies parameters used for integrated output.

Notes

This object can be accessed by:

import step
mdb.models[name].integratedOutputSections[name]

Methods

setValues([surface, refPoint, ...])

This method modifies the IntegratedOutputSection object.

setValues(surface: ~abaqus.Region.Region.Region = <abaqus.Region.Region.Region object>, refPoint: ~abaqusConstants.SymbolicConstantType | None = None, refPointAtCenter: ~abaqusConstants.BooleanType = 0, refPointMotion: ~abaqusConstants.SymbolicConstantType = 'INDEPENDENT', localCsys: str | None = None, projectOrientation: ~abaqusConstants.BooleanType = 0)[source]#

This method modifies the IntegratedOutputSection object.

Parameters:
surface

A Region object specifying the surface over which the output is based.

refPoint

None or a Region object specifying the anchor point about which the integrated moment over the output region is computed or the SymbolicConstant None representing the global origin. The default value is None.

refPointAtCenter

A Boolean specifying that the refPoint be adjusted so that it coincides with the center of the output region in the initial configuration. This argument is valid only when you include the refPoint argument. The default value is OFF.

refPointMotion

A SymbolicConstant specifying how to relate the motion of refPoint to the average motion of the output region. A value of INDEPENDENT will allow the refPoint to move independent of the output region. A value of AVERAGE_TRANSLATION will set the displacement of the refPoint equal to the average translation of the output region. A value of AVERAGE will set the displacement and rotation of the refPoint equal to the average translation of the output region. The default value is INDEPENDENT.This argument is valid only when you include the refPoint argument.

localCsys

None or a DatumCsys object specifying the local coordinate system used to express vector output. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

projectOrientation

A Boolean specifying that the coordinate system be projected onto the surface such that the 1–axis is normal to the surface. Projection onto a planar surface is such that the 1-axis is normal to the surface, and a projection onto a nonplanar surface is such that a least-squares fit surface will be used. The default value is OFF.

Monitor#

class Monitor(node: str, dof: SymbolicConstantType, frequency: int)[source]#

The Monitor object defines a degree of freedom to monitor.

Notes

This object can be accessed by:

import step
mdb.models[name].steps[name].monitor

The corresponding analysis keywords are:

  • MONITOR

Methods

setValues()

This method modifies the Monitor object.

setValues()[source]#

This method modifies the Monitor object.

Raises:
RangeError

Restart#

class Restart(numberIntervals: int = 0, timeMarks: BooleanType = 0, overlay: BooleanType = 0, frequency: int = 0)[source]#

The Restart object defines a restart request.

Notes

This object can be accessed by:

import step
mdb.models[name].steps[name].restart

The corresponding analysis keywords are:

  • RESTART

Methods

setValues()

This method modifies the Restart object.

setValues()[source]#

This method modifies the Restart object.

Raises:
RangeError

TimePoint#

class TimePoint(name: str, points: tuple)[source]#

The TimePoint object defines time points at which data are written to the output database or restart files.

Notes

This object can be accessed by:

import step
mdb.models[name].timePoints[name]

The corresponding analysis keywords are:

  • TIME POINTS

Methods

setValues()

This method modifies the TimePoint object.

setValues()[source]#

This method modifies the TimePoint object.

Raises:
RangeError