import typing
from abaqusConstants import *
[docs]class HistoryOutputRequest:
"""The HistoryOutputRequest object defines a history output request.
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 :py:class:`~abaqus.Region.Region.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.
Notes
-----
This object can be accessed by:
.. code-block:: python
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
"""
# A String specifying a bolt load from which output is requested. The default value is an
# empty string.
boltLoad: str = ''
# 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.
region: SymbolicConstant = MODEL
# The SymbolicConstant DEFAULT or a tuple of Ints specifying the section points for which
# output is requested. The default value is DEFAULT.
sectionPoints: SymbolicConstant = DEFAULT
# None or a tuple of Strings specifying the interaction names. The default value is
# None.The sequence can contain only one String.
interactions: tuple = None
def __init__(self, name: str, createStepName: str, region: SymbolicConstant = MODEL,
variables: SymbolicConstant = PRESELECT, frequency: SymbolicConstant = 1,
modes: SymbolicConstant = ALL,
timeInterval: typing.Union[SymbolicConstant, float] = EVERY_TIME_INCREMENT,
numIntervals: int = 20, boltLoad: str = '', sectionPoints: SymbolicConstant = DEFAULT,
stepName: str = '', interactions: str = None, contourIntegral: str = None,
numberOfContours: int = 0, stressInitializationStep: str = None,
contourType: SymbolicConstant = J_INTEGRAL, kFactorDirection: SymbolicConstant = MTS,
rebar: SymbolicConstant = EXCLUDE, integratedOutputSection: str = '',
springs: tuple = None, filter: SymbolicConstant = None, fasteners: str = '',
assembledFastener: str = '', assembledFastenerSet: str = '', sensor: Boolean = OFF,
useGlobal: Boolean = True):
"""This method creates a HistoryOutputRequest object.
Notes
-----
This function can be accessed by:
.. code-block:: python
mdb.models[name].HistoryOutputRequest
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.
"""
pass
[docs] def deactivate(self, stepName: str):
"""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.
"""
pass
[docs] def move(self, fromStepName: str, toStepName: str):
"""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.
"""
pass
[docs] def reset(self, stepName: str):
"""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.
"""
pass
[docs] def resume(self):
"""This method resumes the history output request that was previously suppressed.
"""
pass
[docs] def suppress(self):
"""This method suppresses the history output request.
"""
pass
[docs] def setValues(self, region: SymbolicConstant = MODEL, variables: SymbolicConstant = PRESELECT,
frequency: SymbolicConstant = 1, modes: SymbolicConstant = ALL,
timeInterval: typing.Union[SymbolicConstant, float] = EVERY_TIME_INCREMENT,
numIntervals: int = 20, boltLoad: str = '', sectionPoints: SymbolicConstant = DEFAULT,
stepName: str = '', interactions: str = None, contourIntegral: str = None,
numberOfContours: int = 0, stressInitializationStep: str = None,
contourType: SymbolicConstant = J_INTEGRAL, kFactorDirection: SymbolicConstant = MTS,
rebar: SymbolicConstant = EXCLUDE, integratedOutputSection: str = '',
springs: tuple = None, filter: SymbolicConstant = None, fasteners: str = '',
assembledFastener: str = '', assembledFastenerSet: str = '', sensor: Boolean = OFF,
useGlobal: Boolean = True):
"""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.
"""
pass
[docs] def setValuesInStep(self, stepName: str, variables: SymbolicConstant = None, frequency: SymbolicConstant = 1,
modes: SymbolicConstant = ALL,
timeInterval: typing.Union[SymbolicConstant, float] = EVERY_TIME_INCREMENT,
numIntervals: int = 20, timePoints: str = None):
"""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.
"""
pass