Load

A specific type of load object and a specific type of load state object are designed for each type of load. A load object stores the nonpropagating data of a load as well as a number of instances of the corresponding load state object, each of which stores the propagating data of the load in a single step. Instances of the load state object are created and deleted internally by its corresponding load object.

Load Case commands are used for configuring load cases in specific types of steps that may use them.

Load

The Load object is the abstract base type for other Load objects. The Load object has no explicit constructor. The methods and members of the Load object are common to all objects derived from Load.

Create loads

class LoadModel(name, description='', stefanBoltzmann=None, absoluteZero=None, waveFormulation=abaqusConstants.NOT_SET, modelType=abaqusConstants.STANDARD_EXPLICIT, universalGas=None, copyConstraints=1, copyConnectors=1, copyInteractions=1)

Bases: ModelBase

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

Note

This object can be accessed by:

mdb.models[name]

Note

Check LoadModel on help.3ds.com/2023.

This method creates a Model object.

Note

This function can be accessed by:

mdb.Model

Parameters:

• name (str) – A String specifying the repository key.

• description (str, default: '') – A String specifying the purpose and contents of the Model object. The default value is an empty string.

• stefanBoltzmann (Optional[float], default: None) – None or a Float specifying the Stefan-Boltzmann constant. The default value is None.

• absoluteZero (Optional[float], default: None) – None or a Float specifying the absolute zero constant. The default value is None.

• waveFormulation (Literal[SCATTERED, NOT_SET, TOTAL], default: NOT_SET) – A SymbolicConstant specifying the type of incident wave formulation to be used in acoustic problems. Possible values are NOT_SET, SCATTERED, and TOTAL. The default value is NOT_SET.

• modelType (Literal[STANDARD_EXPLICIT, ELECTROMAGNETIC], default: STANDARD_EXPLICIT) – A SymbolicConstant specifying the analysis model type. Possible values are STANDARD_EXPLICIT and ELECTROMAGNETIC. The default is STANDARD_EXPLICIT.

• universalGas (Optional[float], default: None) – None or a Float specifying the universal gas constant. The default value is None.

• copyConstraints (Union[AbaqusBoolean, bool], default: 1) – A boolean specifying whether to copy the constraints created in the model to the model that instances this model. The default value is ON.

• copyConnectors (Union[AbaqusBoolean, bool], default: 1) – A boolean specifying whether to copy the connectors created in the model to the model that instances this model. The default value is ON.

• copyInteractions (Union[AbaqusBoolean, bool], default: 1) – A boolean specifying whether to copy the interactions created in the model to the model that instances this model. The default value is ON.

Returns:

A Model object.

Return type:

Model

Public Data Attributes:

Inherited from ModelBase

name	A String specifying the repository key.
stefanBoltzmann	None or a Float specifying the Stefan-Boltzmann constant.
absoluteZero	None or a Float specifying the absolute zero constant.
waveFormulation	A SymbolicConstant specifying the type of incident wave formulation to be used in acoustic problems.
universalGas	None or a Float specifying the universal gas constant.
noPartsInputFile	A Boolean specifying whether an input file should be written without parts and assemblies.
endRestartStep	A Boolean specifying that the step specified by restartStep should be terminated at the increment specified by restartIncrement.
shellToSolid	A Boolean specifying that a shell global model drives a solid submodel.
lastChangedCount	A Float specifying the time stamp that indicates when the model was last changed.
description	A String specifying the purpose and contents of the Model object.
restartJob	A String specifying the name of the job that generated the restart data.
restartStep	A String specifying the name of the step where the restart analysis will start.
globalJob	A String specifying the name of the job that generated the results for the global model.
copyConstraints	A boolean specifying the status of constraints created in a model, in the model which instances this model.
copyConnectors	A boolean specifying the status of connectors created in a model, in the model which instances this model.
copyInteractions	A boolean specifying the status of interactions created in a model, in the model which instances this model.
keywordBlock	A KeywordBlock object.
rootAssembly	An Assembly object.
amplitudes	A repository of Amplitude objects.
profiles	A repository of Profile objects.
boundaryConditions	A repository of BoundaryCondition objects.
constraints	A repository of ConstrainedSketchConstraint objects.
analyticalFields	A repository of AnalyticalField objects.
discreteFields	A repository of DiscreteField objects.
predefinedFields	A repository of PredefinedField objects.
interactions	A repository of Interaction objects.
interactionProperties	A repository of InteractionProperty objects.
contactControls	A repository of ContactControl objects.
contactInitializations	A repository of ContactInitialization objects.
contactStabilizations	A repository of ContactStabilization objects.
linkedInstances	A tuple of tuples of Strings specifying the linked child PartInstance name in the current model to the corresponding parent PartInstance name in a different model.
linkedParts	A tuple of tuples of Strings specifying the linked child Part name in the current model to the corresponding parent Part name in a different model.
loads	A repository of Load objects.
materials	A repository of Material objects.
calibrations	A repository of Calibration objects.
sections	A repository of Section objects.
remeshingRules	A repository of RemeshingRule objects.
sketches	A repository of ConstrainedSketch objects.
parts	A repository of Part objects.
steps	A repository of Step objects.
featureOptions	A FeatureOptions object.
adaptiveMeshConstraints	A repository of AdaptiveMeshConstraint objects.
adaptiveMeshControls	A repository of AdaptiveMeshControl objects.
timePoints	A repository of TimePoint objects.
filters	A repository of Filter objects.
integratedOutputSections	A repository of IntegratedOutputSection objects.
fieldOutputRequests	A repository of FieldOutputRequest objects.
historyOutputRequests	A repository of HistoryOutputRequest objects.
optimizationTasks	A repository of OptimizationTask objects.
tableCollections	A repository of TableCollection objects.
eventSeriesTypes	A repository of EventSeriesType objects.
eventSeriesDatas	A repository of EventSeriesData objects.
restartIncrement	An Int specifying the increment, interval, iteration or cycle where the restart analysis will start.

Public Methods:

BodyCharge(name, createStepName, region, ...)	This method creates a BodyCharge object.
BodyConcentrationFlux(name, createStepName, ...)	This method creates a BodyConcentrationFlux object.
BodyCurrent(name, createStepName, region, ...)	This method creates a BodyCurrent object.
BodyCurrentDensity(name, createStepName, ...)	This method creates a BodyCurrentDensity object.
BodyForce(name, createStepName, region[, ...])	This method creates a BodyForce object.
BodyHeatFlux(name, createStepName, region, ...)	This method creates a BodyHeatFlux object.
BoltLoad(name, createStepName, region, ...)	This method creates a BoltLoad object.
ConcCharge(name, createStepName, region, ...)	This method creates a ConcCharge object.
ConcConcFlux(name, createStepName, region, ...)	This method creates a ConcConcFlux object.
ConcCurrent(name, createStepName, region, ...)	This method creates a ConcCurrent object.
ConcentratedForce(name, createStepName, region)	This method creates a ConcentratedForce object.
ConcentratedHeatFlux(name, createStepName, ...)	This method creates a ConcentratedHeatFlux object.
ConcPoreFluid(name, createStepName, region, ...)	This method creates a ConcPoreFluid object.
ConnectorForce(name, createStepName[, ...])	This method creates a ConnectorForce object on a wire region.
ConnectorMoment(name, createStepName[, ...])	This method creates a ConnectorMoment object on a wire region.
CoriolisForce(name, createStepName, region, ...)	This method creates a CoriolisForce object.
Gravity(name, createStepName[, ...])	This method creates a Gravity object.
InertiaRelief(name, createStepName[, u1, ...])	This method creates an InertiaRelief object.
InwardVolAccel(name, createStepName, region, ...)	This method creates a InwardVolAccel object.
LineLoad(name, createStepName, region[, ...])	This method creates a LineLoad object.
Moment(name, createStepName, region[, cm1, ...])	This method creates a Moment object.
PEGLoad(name, createStepName, region[, ...])	This method creates a PEGLoad object.
PipePressure(name, createStepName, region, ...)	This method creates a Pressure object.
Pressure(name, createStepName, region[, ...])	This method creates a Pressure object.
RotationalBodyForce(name, createStepName, ...)	This method creates a RotationalBodyForce object.
ShellEdgeLoad(name, createStepName, region, ...)	This method creates a ShellEdgeLoad object.
SubmodelSB(name, createStepName, region, ...)	This method creates a SubmodelSB object.
SubstructureLoad(name, createStepName, ...)	This method creates a SubstructureLoad object.
SurfaceCharge(name, createStepName, region, ...)	This method creates a SurfaceCharge object.
SurfaceConcentrationFlux(name, ...[, field, ...])	This method creates a SurfaceConcentrationFlux object.
SurfaceCurrent(name, createStepName, region, ...)	This method creates a SurfaceCurrent object.
SurfaceCurrentDensity(name, createStepName, ...)	This method creates a SurfaceCurrentDensity object.
SurfaceHeatFlux(name, createStepName, ...[, ...])	This method creates a SurfaceHeatFlux object.
SurfacePoreFluid(name, createStepName, ...)	This method creates a SurfacePoreFluid object.
SurfaceTraction(name, createStepName, ...[, ...])	This method creates a SurfaceTraction object.

Inherited from ModelBase

__init__(name[, description, ...])	This method creates a Model object.
ModelFromInputFile(name, inputFileName)	This method creates a Model object by reading the keywords in an input file and creating the corresponding Abaqus/CAE objects.
ModelFromOdbFile(name, odbFileName)	This method creates a Model object by reading an output database and creating any corresponding Abaqus/CAE objects.
ModelFromNastranFile(modelName, inputFileName)	This method creates a Model object by reading the keywords in a Nastran bulk data file or Nastran input file and creating any corresponding Abaqus/CAE objects.
setValues([description, noPartsInputFile, ...])	This method modifies the Model object.

---

Member Details:

BodyCharge(name, createStepName, region, magnitude, amplitude=abaqusConstants.UNSET, distributionType=abaqusConstants.UNIFORM, field='')

This method creates a BodyCharge object.

Note

This function can be accessed by:

mdb.models[name].BodyCharge

Note

Check BodyCharge on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created. This must be the first analysis step name.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the load magnitude.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

Returns:

A BodyCharge object.

Return type:

BodyCharge

BodyConcentrationFlux(name, createStepName, region, magnitude, field='', distributionType=abaqusConstants.UNIFORM, amplitude=abaqusConstants.UNSET)

This method creates a BodyConcentrationFlux object.

Note

This function can be accessed by:

mdb.models[name].BodyConcentrationFlux

Note

Check BodyConcentrationFlux on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the body concentration flux magnitude. magnitude is optional if distributionType = USER_DEFINED.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• distributionType (Literal[USER_DEFINED, FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the body concentration flux is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A BodyConcentrationFlux object.

Return type:

BodyConcentrationFlux

BodyCurrent(name, createStepName, region, magnitude, amplitude=abaqusConstants.UNSET, distributionType=abaqusConstants.UNIFORM, field='')

This method creates a BodyCurrent object.

Note

This function can be accessed by:

mdb.models[name].BodyCurrent

Note

Check BodyCurrent on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created. This must be the first analysis step name.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the load magnitude.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

Returns:

A BodyCurrent object.

Return type:

BodyCurrent

BodyCurrentDensity(name, createStepName, region, comp1, comp2, comp3, amplitude=abaqusConstants.UNSET, distributionType=abaqusConstants.UNIFORM)

This method creates a BodyCurrentDensity object.

Note

This function can be accessed by:

mdb.models[name].BodyCurrentDensity

Note

Check BodyCurrentDensity on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created. This must be the first analysis step name.

• region (Region) – A Region object specifying the region to which the load is applied.

• comp1 (str) – A Complex specifying the first component of the load.

• comp2 (str) – A Complex specifying the second component of the load.

• comp3 (str) – A Complex specifying the third component of the load.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

• distributionType (Literal[USER_DEFINED, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM.

Returns:

A BodyCurrentDensity object.

Return type:

BodyCurrentDensity

BodyForce(name, createStepName, region, field='', distributionType=abaqusConstants.UNIFORM, comp1=None, comp2=None, comp3=None, amplitude=abaqusConstants.UNSET)

This method creates a BodyForce object.

Note

This function can be accessed by:

mdb.models[name].BodyForce

Note

Check BodyForce on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created.

• region (Region) – A Region object specifying the region to which the load is applied.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• distributionType (Literal[USER_DEFINED, FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

• comp1 (Optional[float], default: None) – A Float or a Complex specifying the body force component in the 1-direction. Note: Although comp1, comp2, and comp3 are optional arguments, at least one of them must be nonzero unless distributionType = USER_DEFINED.

• comp2 (Optional[float], default: None) – A Float or a Complex specifying the body force component in the 2-direction.

• comp3 (Optional[float], default: None) – A Float or a Complex specifying the body force component in the 3-direction.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A BodyForce object.

Return type:

BodyForce

BodyHeatFlux(name, createStepName, region, magnitude, field='', distributionType=abaqusConstants.UNIFORM, amplitude=abaqusConstants.UNSET)

This method creates a BodyHeatFlux object.

Note

This function can be accessed by:

mdb.models[name].BodyHeatFlux

Note

Check BodyHeatFlux on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the body heat flux magnitude. magnitude is optional if distributionType = USER_DEFINED.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• distributionType (Literal[USER_DEFINED, FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the body heat flux is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A BodyHeatFlux object.

Return type:

BodyHeatFlux

BoltLoad(name, createStepName, region, magnitude, datumAxis, boltMethod=abaqusConstants.APPLY_FORCE, amplitude=abaqusConstants.UNSET, preTenSecPartLevel=False)

This method creates a BoltLoad object.

Note

This function can be accessed by:

mdb.models[name].BoltLoad

Note

Check BoltLoad on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created. This must be the first analysis step name.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the bolt load magnitude.

• datumAxis (DatumAxis) – A DatumAxis object specifying the orientation of the pre-tension section normal. Note: datumAxis is applicable only for Solid and Shell regions; it has no meaning for Wire regions.

• boltMethod (Literal[APPLY_FORCE, ADJUST_LENGTH], default: APPLY_FORCE) – A SymbolicConstant specifying the method of applying the bolt load. Possible values are APPLY_FORCE and ADJUST_LENGTH. The default value is APPLY_FORCE.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

• preTenSecPartLevel (Union[AbaqusBoolean, bool], default: False) –

  A Boolean specifying whether the pre-tension section is to be defined at the part level. The default value is False. You should provide the preTenSecPartLevel argument only if the selected region belongs to a dependent part instance. A pre-tension section cannot be defined at the part level for independent and model instances.

  New in version 2018: The preTenSecPartLevel argument was added.

Returns:

A BoltLoad object.

Return type:

BoltLoad

Raises:

TextError –

ConcCharge(name, createStepName, region, magnitude, distributionType=abaqusConstants.UNIFORM, field='', amplitude=abaqusConstants.UNSET)

This method creates a ConcCharge object.

Note

This function can be accessed by:

mdb.models[name].ConcCharge

Note

Check ConcCharge on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created. This must be the first analysis step name.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the load magnitude.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A ConcCharge object.

Return type:

ConcCharge

ConcConcFlux(name, createStepName, region, magnitude, distributionType=abaqusConstants.UNIFORM, field='', amplitude=abaqusConstants.UNSET)

This method creates a ConcConcFlux object.

Note

This function can be accessed by:

mdb.models[name].ConcConcFlux

Note

Check ConcConcFlux on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created. This must be the first analysis step name.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the load magnitude.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A ConcConcFlux object.

Return type:

ConcConcFlux

ConcCurrent(name, createStepName, region, magnitude, distributionType=abaqusConstants.UNIFORM, field='', amplitude=abaqusConstants.UNSET)

This method creates a ConcCurrent object.

Note

This function can be accessed by:

mdb.models[name].ConcCurrent

Note

Check ConcCurrent on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created. This must be the first analysis step name.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the load magnitude.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A ConcCurrent object.

Return type:

ConcCurrent

ConcPoreFluid(name, createStepName, region, magnitude, distributionType=abaqusConstants.UNIFORM, field='', amplitude=abaqusConstants.UNSET)

This method creates a ConcPoreFluid object.

Note

This function can be accessed by:

mdb.models[name].ConcPoreFluid

Note

Check ConcPoreFluid on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created. This must be the first analysis step name.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the load magnitude.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A ConcPoreFluid object.

Return type:

ConcPoreFluid

ConcentratedForce(name, createStepName, region, distributionType=abaqusConstants.UNIFORM, field='', cf1=None, cf2=None, cf3=None, amplitude=abaqusConstants.UNSET, follower=0, localCsys=None)

This method creates a ConcentratedForce object.

Note

This function can be accessed by:

mdb.models[name].ConcentratedForce

Note

Check ConcentratedForce on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created.

• region (Region) – A Region object specifying the region to which the load is applied.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• cf1 (Optional[float], default: None) – A Float or a Complex specifying the concentrated force component in the 1-direction. Although cf1, cf2, and cf3 are optional arguments, at least one of them must be nonzero.

• cf2 (Optional[float], default: None) – A Float or a Complex specifying the concentrated force component in the 2-direction.

• cf3 (Optional[float], default: None) – A Float or a Complex specifying the concentrated force component in the 3-direction.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

• follower (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether the direction of the force rotates with the rotation at each node of the region. You should provide the follower argument only if it is valid for the specified step. The default value is OFF.

• localCsys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system of the load’s degrees of freedom. If localCsys = None, the degrees of freedom are defined in the global coordinate system. When this member is queried, it returns an Int. The default value is None.

Returns:

A ConcentratedForce object.

Return type:

ConcentratedForce

ConcentratedHeatFlux(name, createStepName, region, magnitude, distributionType=abaqusConstants.UNIFORM, field='', amplitude=abaqusConstants.UNSET, dof=11)

This method creates a ConcentratedHeatFlux object.

Note

This function can be accessed by:

mdb.models[name].ConcentratedHeatFlux

Note

Check ConcentratedHeatFlux on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created. This must be the first analysis step name.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the load magnitude.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

• dof (int, default: 11) – An Int specifying the degree of freedom of the node, to which the concentrated heat flux should be applied. The default value is 11.

Returns:

A ConcentratedHeatFlux object.

Return type:

ConcentratedHeatFlux

ConnectorForce(name, createStepName, region='', fastenerName='', fastenerSetName='', f1=None, f2=None, f3=None, amplitude=abaqusConstants.UNSET)

This method creates a ConnectorForce object on a wire region. Alternatively, the load may also be applied to a wire set referenced from an assembled fastener template model.

Note

This function can be accessed by:

mdb.models[name].ConnectorForce

Note

Check ConnectorForce on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created.

• region (str, default: '') – The wire region to which the load is applied. This argument is not valid when fastenerName and fastenerSetName are specified.

• fastenerName (str, default: '') – A String specifying the name of the assembled fastener to which the load will be applied. This argument is not valid when region is specified. When this argument is specified, fastenerSetName must also be specified. The default value is an empty string.

• fastenerSetName (str, default: '') – A String specifying the assembled fastener template model set to which the load will be applied. This argument is not valid when region is specified. When this argument is specified, fastenerName must also be specified. The default value is an empty string.

• f1 (Optional[float], default: None) – A Float or a Complex specifying the connector force component in the connector’s local 1-direction. Note: Although f1, f2, and f3 are optional arguments, at least one of them must be nonzero.

• f2 (Optional[float], default: None) – A Float or a Complex specifying the connector force component in the connector’s local 2-direction.

• f3 (Optional[float], default: None) – A Float or a Complex specifying the connector force component in the connector’s local 3-direction.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A ConnectorForce object.

Return type:

ConnectorForce

ConnectorMoment(name, createStepName, region='', fastenerName='', fastenerSetName='', m1=None, m2=None, m3=None, amplitude=abaqusConstants.UNSET)

This method creates a ConnectorMoment object on a wire region. Alternatively, the load may also be applied to a wire set referenced from an assembled fastener template model.

Note

This function can be accessed by:

mdb.models[name].ConnectorMoment

Note

Check ConnectorMoment on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created.

• region (str, default: '') – The wire region to which the load is applied. This argument is not valid when fastenerName and fastenerSetName are specified.

• fastenerName (str, default: '') – A String specifying the name of the assembled fastener to which the load will be applied. This argument is not valid when region is specified. When this argument is specified, fastenerSetName must also be specified. The default value is an empty string.

• fastenerSetName (str, default: '') – A String specifying the assembled fastener template model set to which the load will be applied. This argument is not valid when region is specified. When this argument is specified, fastenerName must also be specified. The default value is an empty string.

• m1 (Optional[float], default: None) – A Float or a Complex specifying the moment component in the connector’s local 4-direction.

• m2 (Optional[float], default: None) – A Float or a Complex specifying the moment component in the connector’s local 5-direction.

• m3 (Optional[float], default: None) – A Float or a Complex specifying the moment component in the connector’s local 6-direction.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A ConnectorMoment object.

Return type:

ConnectorMoment

CoriolisForce(name, createStepName, region, magnitude, point1, point2, amplitude=abaqusConstants.UNSET, distributionType=abaqusConstants.UNIFORM, field='')

This method creates a CoriolisForce object.

Note

This function can be accessed by:

mdb.models[name].CoriolisForce

Note

Check CoriolisForce on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created. This must be the first analysis step name.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the load magnitude.

• point1 (tuple) – A sequence of Floats specifying the first point on the axis of rotation for the load.

• point2 (tuple) – A sequence of Floats specifying the second point on the axis of rotation for the load.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

Returns:

A CoriolisForce object.

Return type:

CoriolisForce

Gravity(name, createStepName, distributionType=abaqusConstants.UNIFORM, field='', region=None, comp1=None, comp2=None, comp3=None, amplitude=abaqusConstants.UNSET)

This method creates a Gravity object.

Note

This function can be accessed by:

mdb.models[name].Gravity

Note

Check Gravity on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• region (Optional[Region], default: None) – A Region object specifying the region to which the load is applied.

• comp1 (Optional[float], default: None) – A Float or a Complex specifying the component of the load in the 1-direction. Note: Although comp1, comp2, and comp3 are optional arguments, at least one of them must be nonzero.

• comp2 (Optional[float], default: None) – A Float or a Complex specifying the component of the load in the 2-direction.

• comp3 (Optional[float], default: None) – A Float or a Complex specifying the component of the load in the 3-direction.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A Gravity object.

Return type:

Gravity

InertiaRelief(name, createStepName, u1=0, u2=0, u3=0, ur1=0, ur2=0, ur3=0, referencePoint=(), localCoordinates=None)

This method creates an InertiaRelief object.

Note

This function can be accessed by:

mdb.models[name].InertiaRelief

Note

Check InertiaRelief on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created.

• u1 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying the 1-direction as a free direction. Note: Although u1, u2, u3, ur1, ur2, and ur3 are optional arguments, at least one of them must be specified. Further, any specified set of free directions cannot include only two rotational degrees of freedom.

• u2 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying the 2-direction as a free direction.

• u3 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying the 3-direction as a free direction.

• ur1 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying the rotation about the 1-direction as a free direction.

• ur2 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying the rotation about the 2-direction as a free direction.

• ur3 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying the rotation about the 3-direction as a free direction.

• referencePoint (tuple, default: ()) – A sequence of Floats specifying the X, Y and Z coordinates of a fixed rotation point or a point on the rotation axis or a point on the symmetry line, about which rotations are defined. Such a point must be specified only for certain combinations of free directions.

• localCoordinates (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system of the rigid body degrees of freedom for the inertia relief load. If localCoordinates = None, the free directions are defined in the global coordinate system. When this member is queried, it returns an Int. The default value is None.

Returns:

An InertiaRelief object.

Return type:

InertiaRelief

InwardVolAccel(name, createStepName, region, magnitude, distributionType=abaqusConstants.UNIFORM, field='', amplitude=abaqusConstants.UNSET)

This method creates a InwardVolAccel object.

Note

This function can be accessed by:

mdb.models[name].InwardVolAccel

Note

Check InwardVolAccel on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created. This must be the name of the first analysis step.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the load magnitude.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

An InwardVolAccel object.

Return type:

InwardVolAccel

LineLoad(name, createStepName, region, distributionType=abaqusConstants.UNIFORM, field='', comp1=None, comp2=None, comp3=None, amplitude=abaqusConstants.UNSET, system=abaqusConstants.GLOBAL)

This method creates a LineLoad object.

Note

This function can be accessed by:

mdb.models[name].LineLoad

Note

Check LineLoad on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created.

• region (Region) – A Region object specifying the region to which the load is applied.

• distributionType (Literal[USER_DEFINED, FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• comp1 (Optional[float], default: None) – A Float or a Complex specifying the component of the load in the global or the beam local 1-direction. Note: Although comp1, comp2, and comp3 are optional arguments, at least one of them must be nonzero unless distributionType = USER_DEFINED.

• comp2 (Optional[float], default: None) – A Float or a Complex specifying the component of the load in the global or the beam local 2-direction.

• comp3 (Optional[float], default: None) – A Float or a Complex specifying the component of the load in the global 3-direction.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

• system (Literal[LOCAL, GLOBAL], default: GLOBAL) – A SymbolicConstant specifying whether the load is applied in a global or the beam local frame of reference. Possible values are GLOBAL and LOCAL. The default value is GLOBAL.

Returns:

A LineLoad object.

Return type:

LineLoad

Moment(name, createStepName, region, cm1=None, cm2=None, cm3=None, amplitude=abaqusConstants.UNSET, follower=0, localCsys=None, distributionType=abaqusConstants.UNIFORM, field='')

This method creates a Moment object.

Note

This function can be accessed by:

mdb.models[name].Moment

Note

Check Moment on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created.

• region (Region) – A Region object specifying the region to which the load is applied.

• cm1 (Optional[float], default: None) – A Float or a Complex specifying the load component in the 4-direction. Note: Although comp1, comp2, and comp3 are optional arguments, at least one of them must be nonzero.

• cm2 (Optional[float], default: None) – A Float or a Complex specifying the load component in the 5- direction.

• cm3 (Optional[float], default: None) – A Float or a Complex specifying the load component in the 6-direction.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

• follower (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether the direction of the force rotates with the rotation of the node. You should provide the follower argument only if it is valid for the specified step. The default value is OFF.

• localCsys (Optional[int], default: None) – None or a DatumCsys object specifying the ID of the Datum coordinate system used as the local coordinate system of the load. If localCsys = None, the load is defined in the global coordinate system. When this member is queried, it returns an Int. The default value is None.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

Returns:

A Moment object.

Return type:

Moment

PEGLoad(name, createStepName, region, distributionType=abaqusConstants.UNIFORM, field='', comp1=None, comp2=None, comp3=None, amplitude=abaqusConstants.UNSET)

This method creates a PEGLoad object.

Note

This function can be accessed by:

mdb.models[name].PEGLoad

Note

Check PEGLoad on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created.

• region (Region) – A Region object specifying the region to which the load is applied.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• comp1 (Optional[float], default: None) – A Float or a Complex specifying the load component at dof 1 of reference node 1. Note: Although comp1, comp2, and comp3 are optional arguments, at least one of them must be nonzero.

• comp2 (Optional[float], default: None) – A Float or a Complex specifying the load component at dof 1 of reference node 2.

• comp3 (Optional[float], default: None) – A Float or a Complex specifying the load component at dof 2 of reference node 2.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A PEGLoad object.

Return type:

PEGLoad

PipePressure(name, createStepName, region, magnitude, diameter, hZero, hReference, field='', amplitude=abaqusConstants.UNSET, distributionType=abaqusConstants.UNIFORM, side=abaqusConstants.INTERNAL)

This method creates a Pressure object.

Note

This function can be accessed by:

mdb.models[name].PipePressure

Note

Check PipePressure on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the pressure is created.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the pressure magnitude. Note: magnitude is optional if distributionType = USER_DEFINED.

• diameter (float) – A Float specifying the effective inner or outer diameter.

• hZero (float) – A Float specifying the height of the zero pressure level when distributionType = HYDROSTATIC.

• hReference (float) – A Float specifying the height of the reference pressure level when distributionType = HYDROSTATIC.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

• distributionType (Literal[USER_DEFINED, HYDROSTATIC, UNIFORM, FIELD], default: UNIFORM) – A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM, HYDROSTATIC, USER_DEFINED, and FIELD. The default value is UNIFORM.

• side (Literal[EXTERNAL, INTERNAL], default: INTERNAL) – A SymbolicConstant specifying whether the pressure is applied internally or externally. Possible values are INTERNAL and EXTERNAL. The default value is INTERNAL.

Returns:

A PipePressure object.

Return type:

PipePressure

Pressure(name, createStepName, region, magnitude=0.0, hZero=0.0, hReference=0.0, field='', refPoint='', distributionType=abaqusConstants.UNIFORM, amplitude=abaqusConstants.UNSET)

This method creates a Pressure object.

Note

This function can be accessed by:

mdb.models[name].Pressure

Note

Check Pressure on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the pressure is created.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float, default: 0.0) – A Float or a Complex specifying the pressure magnitude. Note: magnitude is optional if distributionType = USER_DEFINED.

• hZero (float, default: 0.0) – A Float specifying the height of the zero pressure level when distributionType = HYDROSTATIC.

• hReference (float, default: 0.0) – A Float specifying the height of the reference pressure level when distributionType = HYDROSTATIC.

• field (str, default: '') – A String specifying the name of the AnalyticalField or DiscreteField object associated with this load. The field argument applies only when distributionType = FIELD or distributionType = DISCRETE_FIELD. The default value is an empty string.

• refPoint (str, default: '') – A Region specifying the reference point from which the relative velocity is determined when distributionType = STAGNATION or VISCOUS.

• distributionType (Literal[FIELD, DISCRETE_FIELD, STAGNATION, VISCOUS, TOTAL_FORCE, HYDROSTATIC, UNIFORM, USER_DEFINED], default: UNIFORM) – A SymbolicConstant specifying how the pressure is distributed spatially. Possible values are UNIFORM, USER_DEFINED, FIELD, HYDROSTATIC, STAGNATION, VISCOUS, TOTAL_FORCE, and DISCRETE_FIELD. The default value is UNIFORM.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A Pressure object.

Return type:

Pressure

RotationalBodyForce(name, createStepName, region, magnitude, point1, point2, distributionType=abaqusConstants.UNIFORM, field='', centrifugal=0, rotaryAcceleration=0, amplitude=abaqusConstants.UNSET)

This method creates a RotationalBodyForce object.

Note

This function can be accessed by:

mdb.models[name].RotationalBodyForce

Note

Check RotationalBodyForce on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created. This must be the first analysis step name.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the load magnitude.

• point1 (tuple) – A sequence of Floats specifying the first point on the axis of rotation for the load.

• point2 (tuple) – A sequence of Floats specifying the second point on the axis of rotation for the load.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• centrifugal (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether or not the effect of the load is centrifugal. The default value is OFF. Note: At least one of centrifugal or rotaryAcceleration must be specified and only one must have the value ON.

• rotaryAcceleration (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether or not the effect of the load is rotary acceleration. The default value is OFF. Note: At least one of centrifugal or rotaryAcceleration must be specified and only one must have the value ON.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A RotationalBodyForce object.

Return type:

RotationalBodyForce

ShellEdgeLoad(name, createStepName, region, magnitude, distributionType=abaqusConstants.UNIFORM, field='', amplitude=abaqusConstants.UNSET, angle=0, axis=abaqusConstants.AXIS_1, localCsys=abaqusConstants.GENERAL, userCsys=abaqusConstants.GENERAL, directionVector=(), follower=1, resultant=0, traction=abaqusConstants.NORMAL)

This method creates a ShellEdgeLoad object.

Note

This function can be accessed by:

mdb.models[name].ShellEdgeLoad

Note

Check ShellEdgeLoad on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float or Complex specifying the load magnitude. magnitude is optional if distributionType = USER_DEFINED

• distributionType (Literal[USER_DEFINED, FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the shell edge load is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

• angle (float, default: 0) – A Float specifying an additional rotation of directionVector about an axis. The default value is 0.This parameter is available only if traction is GENERAL.

• axis (Literal[AXIS_1, AXIS_3, AXIS_2, GENERAL], default: AXIS_1) – A SymbolicConstant specifying the axis about which to apply an additional rotation of directionVector. Possible values are AXIS_1, AXIS_2, AXIS_3. The default value is AXIS_1.This parameter is available only if traction is GENERAL.

• localCsys (int, default: GENERAL) – A DatumCsys object specifying the local coordinate system of the load’s degrees of freedom. The default value is None, indicating that the degrees of freedom are defined in the global coordinate system or by the userCsys parameter if defined. This parameter is available only if traction is GENERAL. When this member is queried, it returns an Int.

• userCsys (str, default: GENERAL) – A String specifying a CSYS defined by a user-subroutine. The default value is None, indicating that the degrees of freedom are defined in the global coordinate system or by the localCsys parameter if defined. This parameter is available only if traction is GENERAL.

• directionVector (tuple, default: ()) – A tuple of two points specifying the direction of the load. Each point is specified as a point region or a tuple of coordinates. If traction is SHEAR, then directionVector will be projected onto the region surface. This parameter is available only if traction is GENERAL.

• follower (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether the direction of the force changes with rotation. The default value is ON. This parameter may be modified only if traction is GENERAL. You should provide the follower argument only if it is valid for the specified step.

• resultant (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to maintain a constant resultant force by defining traction per unit undeformed area. If resultant is OFF, traction is defined per unit deformed area. The default value is OFF. You should provide the resultant argument only if it is valid for the specified step.

• traction (Literal[TRANSVERSE, SHEAR, GENERAL, NORMAL, MOMENT], default: NORMAL) – A SymbolicConstant specifying how to apply surface traction. Possible values are NORMAL, TRANSVERSE, SHEAR, MOMENT and GENERAL. The default value is NORMAL.

Returns:

A ShellEdgeLoad object.

Return type:

ShellEdgeLoad

SubmodelSB(name, createStepName, region, globalStep, globalDrivingRegion='', absoluteExteriorTolerance=None, exteriorTolerance=0, globalIncrement=0)

This method creates a SubmodelSB object.

Note

This function can be accessed by:

mdb.models[name].SubmodelSB

Note

Check SubmodelSB on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created.

• region (Region) – A Region object specifying the region to which the load is applied.

• globalStep (str) – A String specifying the step in the global model from which Abaqus reads the values of the variables that will drive the submodel analysis. The String indicates the position of the step in the sequence of analysis steps. For example, globalStep = ‘1’ indicates the first step.

• globalDrivingRegion (str, default: '') – A String specifying the element set in the global model that will be searched for elements whose responses will be used to drive the submodel. An empty string indicates that the entire global model will be searched. The default value is an empty string.

• absoluteExteriorTolerance (Optional[float], default: None) – None or a Float specifying the absolute value by which a driven node of the submodel can lie outside the region of the elements of the global model. The default value is None.

• exteriorTolerance (float, default: 0) – None or a Float specifying the fraction of the average element size in the global model by which a driven node of the submodel can lie outside the region of the elements of the global model. The default value is 0.05.

• globalIncrement (int, default: 0) – An Int specifying the increment number in the global model step from which the solution will be used to specify the values of the driven variables. If globalIncrement = 0, the solution from the last increment will be used. The globalIncrement argument is applicable only for linear perturbation steps. The default value is 0.

Returns:

A SubmodelSB object.

Return type:

SubmodelSB

SubstructureLoad(name, createStepName, region, loadCaseNames, magnitude, amplitude=abaqusConstants.UNSET)

This method creates a SubstructureLoad object.

Note

This function can be accessed by:

mdb.models[name].SubstructureLoad

Note

Check SubstructureLoad on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the substructure load is created.

• region (Region) – A Region object specifying the region to which the load is applied.

• loadCaseNames (str) – A list of names of the load cases that should be activated by this substructure load.

• magnitude (float) – A Float specifying the multiplier for the load case magnitude.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A SubstructureLoad object.

Return type:

SubstructureLoad

SurfaceCharge(name, createStepName, region, magnitude, distributionType=abaqusConstants.UNIFORM, field='', amplitude=abaqusConstants.UNSET)

This method creates a SurfaceCharge object.

Note

This function can be accessed by:

mdb.models[name].SurfaceCharge

Note

Check SurfaceCharge on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created. This must be the first analysis step name.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the load magnitude.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A SurfaceCharge object.

Return type:

SurfaceCharge

SurfaceConcentrationFlux(name, createStepName, region, magnitude, field='', distributionType=abaqusConstants.UNIFORM, amplitude=abaqusConstants.UNSET)

This method creates a SurfaceConcentrationFlux object.

Note

This function can be accessed by:

mdb.models[name].SurfaceConcentrationFlux

Note

Check SurfaceConcentrationFlux on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the surface concentration flux magnitude. magnitude is optional if distributionType = USER_DEFINED.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• distributionType (Literal[USER_DEFINED, FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the surface concentration flux is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A SurfaceConcentrationFlux object.

Return type:

SurfaceConcentrationFlux

SurfaceCurrent(name, createStepName, region, magnitude, distributionType=abaqusConstants.UNIFORM, field='', amplitude=abaqusConstants.UNSET)

This method creates a SurfaceCurrent object.

Note

This function can be accessed by:

mdb.models[name].SurfaceCurrent

Note

Check SurfaceCurrent on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created. This must be the first analysis step name.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the load magnitude.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A SurfaceCurrent object.

Return type:

SurfaceCurrent

SurfaceCurrentDensity(name, createStepName, region, comp1, comp2, comp3, distributionType=abaqusConstants.UNIFORM, amplitude=abaqusConstants.UNSET)

This method creates a SurfaceCurrentDensity object.

Note

This function can be accessed by:

mdb.models[name].SurfaceCurrentDensity

Note

Check SurfaceCurrentDensity on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created. This must be the first analysis step name.

• region (Region) – A Region object specifying the region to which the load is applied.

• comp1 (str) – A Complex specifying the first component of the load.

• comp2 (str) – A Complex specifying the second component of the load.

• comp3 (str) – A Complex specifying the third component of the load.

• distributionType (Literal[USER_DEFINED, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A SurfaceCurrentDensity object.

Return type:

SurfaceCurrentDensity

SurfaceHeatFlux(name, createStepName, region, magnitude, field='', distributionType=abaqusConstants.UNIFORM, amplitude=abaqusConstants.UNSET)

This method creates a SurfaceHeatFlux object.

Note

This function can be accessed by:

mdb.models[name].SurfaceHeatFlux

Note

Check SurfaceHeatFlux on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the surface heat flux magnitude. magnitude is optional if distributionType = USER_DEFINED.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• distributionType (Literal[USER_DEFINED, FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the surface heat flux is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A SurfaceHeatFlux object.

Return type:

SurfaceHeatFlux

SurfacePoreFluid(name, createStepName, region, magnitude, field='', distributionType=abaqusConstants.UNIFORM, amplitude=abaqusConstants.UNSET)

This method creates a SurfacePoreFluid object.

Note

This function can be accessed by:

mdb.models[name].SurfacePoreFluid

Note

Check SurfacePoreFluid on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the surface pore fluid flow magnitude. magnitude is optional if distributionType = USER_DEFINED.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• distributionType (Literal[USER_DEFINED, FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A SurfacePoreFluid object.

Return type:

SurfacePoreFluid

SurfaceTraction(name, createStepName, region, magnitude, distributionType=abaqusConstants.UNIFORM, field='', amplitude=abaqusConstants.UNSET, angle=0, axis=abaqusConstants.AXIS_1, localCsys=None, userCsys='', directionVector=(), follower=1, resultant=0, traction=abaqusConstants.SHEAR)

This method creates a SurfaceTraction object.

Note

This function can be accessed by:

mdb.models[name].SurfaceTraction

Note

Check SurfaceTraction on help.3ds.com/2023.

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float or Complex specifying the load magnitude. magnitude is optional if distributionType = USER_DEFINED.

• distributionType (Literal[USER_DEFINED, FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the surface traction is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

• angle (float, default: 0) – A Float specifying an additional rotation of directionVector about an axis. The default value is 0.0.

• axis (Literal[AXIS_1, AXIS_3, AXIS_2], default: AXIS_1) – A SymbolicConstant specifying the axis about which to apply an additional rotation of directionVector. Possible values are AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_1.

• localCsys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system of the load’s degrees of freedom. If localCsys = None, the degrees of freedom are defined in the global coordinate system or by the userCsys parameter if defined. When this member is queried, it returns an Int. The default value is None.

• userCsys (str, default: '') – A String specifying a CSYS defined by a user-subroutine. If userCsys = None, the degrees of freedom are defined in the global coordinate system or by the localCsys parameter if defined. The default value is “None”.

• directionVector (tuple, default: ()) – A VertexArray object of length 2 specifying the direction of the load. Instead of through a ConstrainedSketchVertex, each point may be specified through a tuple of coordinates. If traction is SHEAR, then directionVector will be projected onto the region surface. This parameter is available only if traction is GENERAL or SHEAR.

• follower (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether the direction of the force changes with rotation. The default value is ON.This parameter may be modified only if traction is GENERAL. You should provide the follower argument only if it is valid for the specified step.

• resultant (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether the to maintain a constant resultant force by defining traction per unit undeformed area. If resultant is OFF, traction is defined per unit deformed area. The default value is OFF.You should provide the resultant argument only if it is valid for the specified step.

• traction (Literal[SHEAR, GENERAL], default: SHEAR) – A SymbolicConstant specifying how to apply surface traction. Possible values are SHEAR and GENERAL. The default value is SHEAR.

Returns:

A SurfaceTraction object.

Return type:

SurfaceTraction

Other Classes

class BodyCharge(name, createStepName, region, magnitude, amplitude=abaqusConstants.UNSET, distributionType=abaqusConstants.UNIFORM, field='')

Bases: Load

The BodyCharge object stores the data for a body charge. The BodyCharge object is derived from the Load object.

Note

This object can be accessed by:

import load
mdb.models[name].loads[name]

Note

Check BodyCharge on help.3ds.com/2023.

This method creates a BodyCharge object.

Note

This function can be accessed by:

mdb.models[name].BodyCharge

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created. This must be the first analysis step name.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the load magnitude.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

Returns:

A BodyCharge object.

Return type:

BodyCharge

Member Details:

distributionType: SymbolicConstant = 'UNIFORM'

A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

field: str = ''

A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

name: str = ''

A String specifying the load repository key.

region: Region = <abaqus.Region.Region.Region object>

A Region object specifying the region to which the load is applied.

setValues(amplitude=abaqusConstants.UNSET, distributionType=abaqusConstants.UNIFORM, field='')

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

Note

Check BodyCharge.setValues on help.3ds.com/2023.

Parameters:

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

setValuesInStep(stepName, magnitude=None, amplitude='')

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

Note

Check BodyCharge.setValuesInStep on help.3ds.com/2023.

Parameters:

• stepName (str) – A String specifying the name of the step in which the load is modified.

• magnitude (Optional[float], default: None) – A Float specifying the load magnitude.

• amplitude (str, default: '') – A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the amplitude is propagated from the previous static analysis step. FREED should be used if the load is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

class Load

Bases: object

The Load object is the abstract base type for other Load objects. The Load object has no explicit constructor. The methods and members of the Load object are common to all objects derived from Load.

Note

This object can be accessed by:

import load
mdb.models[name].loads[name]

Note

Check Load on help.3ds.com/2023.

Member Details:

deactivate(stepName)

This method deactivates the load in the specified step and all its subsequent steps.

Note

Check Load.deactivate on help.3ds.com/2023.

Parameters:

stepName (str) – A String specifying the name of the step in which the load is deactivated.

delete(indices)

This method allows you to delete existing loads.

Note

Check Load.delete on help.3ds.com/2023.

Parameters:

indices (tuple) – A sequence of Ints specifying the index of each load to delete.

move(fromStepName, toStepName)

This method moves the load state object from one step to a different step.

Note

Check Load.move on help.3ds.com/2023.

Parameters:

• fromStepName (str) – A String specifying the name of the step from which the load state is moved.

• toStepName (str) – A String specifying the name of the step to which the load state is moved.

name: str = ''

A String specifying the load repository key.

region: Region = <abaqus.Region.Region.Region object>

A Region object specifying the region to which the load is applied.

reset(stepName)

This method resets the load state of the specified step to the state of the previous general analysis step.

Note

Check Load.reset on help.3ds.com/2023.

Parameters:

stepName (str) – A String specifying the name of the step in which the load state is reset.

resume()

This method resumes the load that was previously suppressed.

suppress()

This method suppresses the load.

class BodyChargeState

Bases: LoadState

The BodyChargeState object stores the propagating data of a body charge in a step. One instance of this object is created internally by the BodyCharge object for each step. The instance is also deleted internally by the BodyCharge object. The BodyChargeState object has no constructor or methods. The BodyChargeState object is derived from the LoadState object.

Note

This object can be accessed by:

import load
mdb.models[name].steps[name].loadStates[name]

The corresponding analysis keywords are:

• DECHARGE

Note

Check BodyChargeState on help.3ds.com/2023.

Member Details:

amplitude: str = ''

A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference.

amplitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the amplitude member. Possible values are UNSET, SET, UNCHANGED, and FREED.

magnitude: Optional[float] = None

A Float specifying the load magnitude.

magnitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the load magnitude. Possible values are UNSET, SET, UNCHANGED, and FREED.

status: SymbolicConstant

A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:

• NOT_YET_ACTIVE

• CREATED

• PROPAGATED

• MODIFIED

• DEACTIVATED

• NO_LONGER_ACTIVE

• TYPE_NOT_APPLICABLE

• INSTANCE_NOT_APPLICABLE

• BUILT_INTO_BASE_STATE

class LoadState

Bases: object

The LoadState object is the abstract base type for other LoadState objects. The LoadState object has no explicit constructor or methods. The members of the LoadState object are common to all objects derived from LoadState.

Note

This object can be accessed by:

import load
mdb.models[name].steps[name].loadStates[name]

Note

Check LoadState on help.3ds.com/2023.

Member Details:

amplitude: str = ''

A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference.

amplitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the amplitude member. Possible values are UNSET, SET, UNCHANGED, and FREED.

status: SymbolicConstant

A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:

• NOT_YET_ACTIVE

• CREATED

• PROPAGATED

• MODIFIED

• DEACTIVATED

• NO_LONGER_ACTIVE

• TYPE_NOT_APPLICABLE

• INSTANCE_NOT_APPLICABLE

• BUILT_INTO_BASE_STATE

class BodyConcentrationFlux(name, createStepName, region, magnitude, field='', distributionType=abaqusConstants.UNIFORM, amplitude=abaqusConstants.UNSET)

Bases: Load

The BodyConcentrationFlux object defines body concentration flux from a region or into a region. The BodyConcentrationFlux object is derived from the Load object.

Note

This object can be accessed by:

import load
mdb.models[name].loads[name]

Note

Check BodyConcentrationFlux on help.3ds.com/2023.

This method creates a BodyConcentrationFlux object.

Note

This function can be accessed by:

mdb.models[name].BodyConcentrationFlux

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the body concentration flux magnitude. magnitude is optional if distributionType = USER_DEFINED.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• distributionType (Literal[USER_DEFINED, FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the body concentration flux is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A BodyConcentrationFlux object.

Return type:

BodyConcentrationFlux

Member Details:

distributionType: SymbolicConstant = 'UNIFORM'

A SymbolicConstant specifying how the body concentration flux is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

field: str = ''

A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

name: str = ''

A String specifying the load repository key.

region: Region = <abaqus.Region.Region.Region object>

A Region object specifying the region to which the load is applied.

setValues(field='', distributionType=abaqusConstants.UNIFORM, amplitude=abaqusConstants.UNSET)

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

Note

Check BodyConcentrationFlux.setValues on help.3ds.com/2023.

Parameters:

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• distributionType (Literal[USER_DEFINED, FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the body concentration flux is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

setValuesInStep(stepName, magnitude=None, amplitude='')

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

Note

Check BodyConcentrationFlux.setValuesInStep on help.3ds.com/2023.

Parameters:

• stepName (str) – A String specifying the name of the step in which the Body heat flux is modified.

• magnitude (Optional[float], default: None) – A Float specifying the Body concentration flux magnitude.

• amplitude (str, default: '') – A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the amplitude is propagated from the previous analysis step. FREED should be used if the load has no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

class BodyConcentrationFluxState

Bases: LoadState

The BodyConcentrationFluxState object stores the propagating data for a BodyConcentrationFlux object in a step. One instance of this object is created internally by the BodyConcentrationFlux object for each step. The instance is also deleted internally by the BodyConcentrationFlux object. The BodyConcentrationFluxState object has no constructor or methods. The BodyConcentrationFluxState object is derived from the LoadState object.

Note

This object can be accessed by:

import load
mdb.models[name].steps[name].loadStates[name]

The corresponding analysis keywords are:

• CFLUX

Note

Check BodyConcentrationFluxState on help.3ds.com/2023.

Member Details:

amplitude: str = ''

A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference.

amplitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the amplitude member. Possible values are UNSET, SET, UNCHANGED, and FREED.

magnitude: Optional[float] = None

A Float specifying the body concentration flux magnitude.

magnitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the body concentration flux magnitude. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.

status: SymbolicConstant

A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:

• NOT_YET_ACTIVE

• CREATED

• PROPAGATED

• MODIFIED

• DEACTIVATED

• NO_LONGER_ACTIVE

• TYPE_NOT_APPLICABLE

• INSTANCE_NOT_APPLICABLE

• BUILT_INTO_BASE_STATE

class BodyCurrent(name, createStepName, region, magnitude, amplitude=abaqusConstants.UNSET, distributionType=abaqusConstants.UNIFORM, field='')

Bases: Load

The BodyCurrent object stores the data for a body current. The BodyCurrent object is derived from the Load object.

Note

This object can be accessed by:

import load
mdb.models[name].loads[name]

Note

Check BodyCurrent on help.3ds.com/2023.

This method creates a BodyCurrent object.

Note

This function can be accessed by:

mdb.models[name].BodyCurrent

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created. This must be the first analysis step name.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the load magnitude.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

Returns:

A BodyCurrent object.

Return type:

BodyCurrent

Member Details:

distributionType: SymbolicConstant = 'UNIFORM'

A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

field: str = ''

A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

name: str = ''

A String specifying the load repository key.

region: Region = <abaqus.Region.Region.Region object>

A Region object specifying the region to which the load is applied.

setValues(amplitude=abaqusConstants.UNSET, distributionType=abaqusConstants.UNIFORM, field='')

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

Note

Check BodyCurrent.setValues on help.3ds.com/2023.

Parameters:

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

setValuesInStep(stepName, magnitude=None, amplitude='')

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

Note

Check BodyCurrent.setValuesInStep on help.3ds.com/2023.

Parameters:

• stepName (str) – A String specifying the name of the step in which the load is modified.

• magnitude (Optional[float], default: None) – A Float specifying the load magnitude.

• amplitude (str, default: '') – A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the amplitude is propagated from the previous static analysis step. FREED should be used if the load is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

class BodyCurrentDensity(name, createStepName, region, comp1, comp2, comp3, amplitude=abaqusConstants.UNSET, distributionType=abaqusConstants.UNIFORM)

Bases: Load

The BodyCurrentDensity object stores the data for a body current. The BodyCurrentDensity object is derived from the Load object.

Note

This object can be accessed by:

import load
mdb.models[name].loads[name]

Note

Check BodyCurrentDensity on help.3ds.com/2023.

This method creates a BodyCurrentDensity object.

Note

This function can be accessed by:

mdb.models[name].BodyCurrentDensity

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created. This must be the first analysis step name.

• region (Region) – A Region object specifying the region to which the load is applied.

• comp1 (str) – A Complex specifying the first component of the load.

• comp2 (str) – A Complex specifying the second component of the load.

• comp3 (str) – A Complex specifying the third component of the load.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

• distributionType (Literal[USER_DEFINED, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM.

Returns:

A BodyCurrentDensity object.

Return type:

BodyCurrentDensity

Member Details:

distributionType: SymbolicConstant = 'UNIFORM'

A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM.

name: str = ''

A String specifying the load repository key.

region: Region = <abaqus.Region.Region.Region object>

A Region object specifying the region to which the load is applied.

setValues(amplitude=abaqusConstants.UNSET, distributionType=abaqusConstants.UNIFORM)

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

Note

Check BodyCurrentDensity.setValues on help.3ds.com/2023.

Parameters:

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

• distributionType (Literal[USER_DEFINED, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM.

setValuesInStep(stepName, comp1='', comp2='', comp3='', amplitude='')

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

Note

Check BodyCurrentDensity.setValuesInStep on help.3ds.com/2023.

Parameters:

• stepName (str) – A String specifying the name of the step in which the load is modified.

• comp1 (str, default: '') – A Complex specifying the first component of the load.

• comp2 (str, default: '') – A Complex specifying the second component of the load.

• comp3 (str, default: '') – A Complex specifying the third component of the load.

• amplitude (str, default: '') – A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the amplitude is propagated from the previous static analysis step. FREED should be used if the load is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

class BodyCurrentState

Bases: LoadState

The BodyCurrentState object stores the propagating data of a body current in a step. One instance of this object is created internally by the BodyCurrent object for each step. The instance is also deleted internally by the BodyCurrent object. The BodyCurrentState object has no constructor or methods. The BodyCurrentState object is derived from the LoadState object.

Note

This object can be accessed by:

import load
mdb.models[name].steps[name].loadStates[name]

The corresponding analysis keywords are:

• DECURRENT

Note

Check BodyCurrentState on help.3ds.com/2023.

Member Details:

amplitude: str = ''

A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference.

amplitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the amplitude member. Possible values are UNSET, SET, UNCHANGED, and FREED.

magnitude: Optional[float] = None

A Float specifying the load magnitude.

magnitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the load magnitude. Possible values are UNSET, SET, UNCHANGED, and FREED.

status: SymbolicConstant

A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:

• NOT_YET_ACTIVE

• CREATED

• PROPAGATED

• MODIFIED

• DEACTIVATED

• NO_LONGER_ACTIVE

• TYPE_NOT_APPLICABLE

• INSTANCE_NOT_APPLICABLE

• BUILT_INTO_BASE_STATE

class BodyForce(name, createStepName, region, field='', distributionType=abaqusConstants.UNIFORM, comp1=None, comp2=None, comp3=None, amplitude=abaqusConstants.UNSET)

Bases: Load

The BodyForce object defines a distributed load. The BodyForce object is derived from the Load object.

Note

This object can be accessed by:

import load
mdb.models[name].loads[name]

The corresponding analysis keywords are:

• DLOAD

Note

Check BodyForce on help.3ds.com/2023.

This method creates a BodyForce object.

Note

This function can be accessed by:

mdb.models[name].BodyForce

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created.

• region (Region) – A Region object specifying the region to which the load is applied.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• distributionType (Literal[USER_DEFINED, FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

• comp1 (Optional[float], default: None) – A Float or a Complex specifying the body force component in the 1-direction. Note: Although comp1, comp2, and comp3 are optional arguments, at least one of them must be nonzero unless distributionType = USER_DEFINED.

• comp2 (Optional[float], default: None) – A Float or a Complex specifying the body force component in the 2-direction.

• comp3 (Optional[float], default: None) – A Float or a Complex specifying the body force component in the 3-direction.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A BodyForce object.

Return type:

BodyForce

Member Details:

distributionType: SymbolicConstant = 'UNIFORM'

A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

field: str = ''

A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

name: str = ''

A String specifying the load repository key.

region: Region = <abaqus.Region.Region.Region object>

A Region object specifying the region to which the load is applied.

setValues(field='', distributionType=abaqusConstants.UNIFORM, comp1=None, comp2=None, comp3=None, amplitude=abaqusConstants.UNSET)

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

Note

Check BodyForce.setValues on help.3ds.com/2023.

Parameters:

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• distributionType (Literal[USER_DEFINED, FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

• comp1 (Optional[float], default: None) – A Float or a Complex specifying the body force component in the 1-direction. Note: Although comp1, comp2, and comp3 are optional arguments, at least one of them must be nonzero unless distributionType = USER_DEFINED.

• comp2 (Optional[float], default: None) – A Float or a Complex specifying the body force component in the 2-direction.

• comp3 (Optional[float], default: None) – A Float or a Complex specifying the body force component in the 3-direction.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

setValuesInStep(stepName, comp1=Ellipsis, comp2=Ellipsis, comp3=Ellipsis, amplitude='')

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

Note

Check BodyForce.setValuesInStep on help.3ds.com/2023.

Parameters:

• stepName (str) – A String specifying the name of the step in which the load is modified.

• comp1 (Union[Literal[UNCHANGED], float], default: Ellipsis) – A Float, a Complex, or the SymbolicConstant UNCHANGED specifying the body force component in the 1-direction. UNCHANGED should be used if the body force component is propagated from the previous analysis step.

• comp2 (Union[Literal[UNCHANGED], float], default: Ellipsis) – A Float, a Complex, or the SymbolicConstant UNCHANGED specifying the body force component in the 2-direction. UNCHANGED should be used if the body force component is propagated from the previous analysis step.

• comp3 (Union[Literal[UNCHANGED], float], default: Ellipsis) – A Float, a Complex, or the SymbolicConstant UNCHANGED specifying the body force component in the 3-direction. UNCHANGED should be used if the body force component is propagated from the previous analysis step.

• amplitude (str, default: '') – A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the amplitude is propagated from the previous analysis step. FREED should be used if the load is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

class BodyForceState

Bases: LoadState

The BodyForceState object stores the propagating data of a body force in a step. One instance of this object is created internally by the BodyForce object for each step. The instance is also deleted internally by the BodyForce object. The BodyForceState object has no constructor or methods. The BodyForceState object is derived from the LoadState object.

Note

This object can be accessed by:

import load
mdb.models[name].steps[name].loadStates[name]

The corresponding analysis keywords are:

• DLOAD

Note

Check BodyForceState on help.3ds.com/2023.

Member Details:

amplitude: str = ''

A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference.

amplitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the amplitude member. Possible values are UNSET, SET, UNCHANGED, and FREED.

comp1: Optional[float] = None

A Float or a Complex specifying the body force component in the 1-direction.

comp1State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the body force component in the 1-direction. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.

comp2: Optional[float] = None

A Float or a Complex specifying the body force component in the 2-direction.

comp2State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the body force component in the 2-direction. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.

comp3: Optional[float] = None

A Float or a Complex specifying the body force component in the 3-direction.

comp3State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the body force component in the 3-direction. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.

status: SymbolicConstant

A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:

• NOT_YET_ACTIVE

• CREATED

• PROPAGATED

• MODIFIED

• DEACTIVATED

• NO_LONGER_ACTIVE

• TYPE_NOT_APPLICABLE

• INSTANCE_NOT_APPLICABLE

• BUILT_INTO_BASE_STATE

class BodyHeatFlux(name, createStepName, region, magnitude, field='', distributionType=abaqusConstants.UNIFORM, amplitude=abaqusConstants.UNSET)

Bases: Load

The BodyHeatFlux object defines body heat flux from a region or into a region. The BodyHeatFlux object is derived from the Load object.

Note

This object can be accessed by:

import load
mdb.models[name].loads[name]

Note

Check BodyHeatFlux on help.3ds.com/2023.

This method creates a BodyHeatFlux object.

Note

This function can be accessed by:

mdb.models[name].BodyHeatFlux

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the body heat flux magnitude. magnitude is optional if distributionType = USER_DEFINED.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• distributionType (Literal[USER_DEFINED, FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the body heat flux is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A BodyHeatFlux object.

Return type:

BodyHeatFlux

Member Details:

distributionType: SymbolicConstant = 'UNIFORM'

A SymbolicConstant specifying how the body heat flux is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

field: str = ''

A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

name: str = ''

A String specifying the load repository key.

region: Region = <abaqus.Region.Region.Region object>

A Region object specifying the region to which the load is applied.

setValues(field='', distributionType=abaqusConstants.UNIFORM, amplitude=abaqusConstants.UNSET)

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

Note

Check BodyHeatFlux.setValues on help.3ds.com/2023.

Parameters:

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• distributionType (Literal[USER_DEFINED, FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the body heat flux is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

setValuesInStep(stepName, magnitude=None, amplitude='')

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

Note

Check BodyHeatFlux.setValuesInStep on help.3ds.com/2023.

Parameters:

• stepName (str) – A String specifying the name of the step in which the body heat flux is modified.

• magnitude (Optional[float], default: None) – A Float specifying the body heat flux magnitude.

• amplitude (str, default: '') – A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the amplitude is propagated from the previous analysis step. FREED should be used if the load has no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

class BodyHeatFluxState

Bases: LoadState

The BodyHeatFluxState object stores the propagating data for a Body BodyHeatFlux object in a step. One instance of this object is created internally by the BodyHeatFlux object for each step. The instance is also deleted internally by the BodyHeatFlux object. The BodyHeatFluxState object has no constructor or methods. The BodyHeatFluxState object is derived from the LoadState object.

Note

This object can be accessed by:

import load
mdb.models[name].steps[name].loadStates[name]

The corresponding analysis keywords are:

• DFLUX

Note

Check BodyHeatFluxState on help.3ds.com/2023.

Member Details:

amplitude: str = ''

A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference.

amplitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the amplitude member. Possible values are UNSET, SET, UNCHANGED, and FREED.

magnitude: Optional[float] = None

A Float specifying the Body heat flux magnitude.

magnitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the Body heat flux magnitude. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.

status: SymbolicConstant

A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:

• NOT_YET_ACTIVE

• CREATED

• PROPAGATED

• MODIFIED

• DEACTIVATED

• NO_LONGER_ACTIVE

• TYPE_NOT_APPLICABLE

• INSTANCE_NOT_APPLICABLE

• BUILT_INTO_BASE_STATE

class BoltLoad(name, createStepName, region, magnitude, datumAxis, boltMethod=abaqusConstants.APPLY_FORCE, amplitude=abaqusConstants.UNSET, preTenSecPartLevel=False)

Bases: Load

The BoltLoad object defines a bolt load. The BoltLoad object is derived from the Load object.

Note

This object can be accessed by:

import load
mdb.models[name].loads[name]

The corresponding analysis keywords are:

• PRE-TENSION SECTION

  • NODE

• NSET

Note

Check BoltLoad on help.3ds.com/2023.

This method creates a BoltLoad object.

Note

This function can be accessed by:

mdb.models[name].BoltLoad

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created. This must be the first analysis step name.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the bolt load magnitude.

• datumAxis (DatumAxis) – A DatumAxis object specifying the orientation of the pre-tension section normal. Note: datumAxis is applicable only for Solid and Shell regions; it has no meaning for Wire regions.

• boltMethod (Literal[APPLY_FORCE, ADJUST_LENGTH], default: APPLY_FORCE) – A SymbolicConstant specifying the method of applying the bolt load. Possible values are APPLY_FORCE and ADJUST_LENGTH. The default value is APPLY_FORCE.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

• preTenSecPartLevel (Union[AbaqusBoolean, bool], default: False) –

  A Boolean specifying whether the pre-tension section is to be defined at the part level. The default value is False. You should provide the preTenSecPartLevel argument only if the selected region belongs to a dependent part instance. A pre-tension section cannot be defined at the part level for independent and model instances.

  New in version 2018: The preTenSecPartLevel argument was added.

Returns:

A BoltLoad object.

Return type:

BoltLoad

Raises:

TextError –

Member Details:

datumAxis: DatumAxis = <abaqus.Datum.DatumAxis.DatumAxis object>

A DatumAxis object specifying the orientation of the pre-tension section normal. Note: datumAxis is required only for Solid and Shell regions; it has no meaning for Wire regions.

name: str = ''

A String specifying the load repository key.

region: Region = <abaqus.Region.Region.Region object>

A Region object specifying the region to which the load is applied.

setValues(boltMethod=abaqusConstants.APPLY_FORCE, datumAxis=None, amplitude=abaqusConstants.UNSET, preTenSecPartLevel=False)

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

Note

Check BoltLoad.setValues on help.3ds.com/2023.

Parameters:

• boltMethod (Literal[APPLY_FORCE, ADJUST_LENGTH], default: APPLY_FORCE) – A SymbolicConstant specifying the method of applying the bolt load. Possible values are APPLY_FORCE and ADJUST_LENGTH. The default value is APPLY_FORCE.

• datumAxis (Optional[DatumAxis], default: None) – A DatumAxis object specifying the orientation of the pre-tension section normal. Note: datumAxis is applicable only for Solid and Shell regions; it has no meaning for Wire regions.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

• preTenSecPartLevel (Union[AbaqusBoolean, bool], default: False) – A Boolean specifying whether the pre-tension section is to be defined at the part level. The default value is False. You should provide the preTenSecPartLevel argument only if the selected region belongs to a dependent part instance. A pre-tension section cannot be defined at the part level for independent and model instances.

setValuesInStep(stepName, boltMethod=abaqusConstants.APPLY_FORCE, magnitude=None, amplitude='')

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

Note

Check BoltLoad.setValuesInStep on help.3ds.com/2023.

Parameters:

• stepName (str) – A String specifying the name of the step in which the load is modified.

• boltMethod (Literal[FIX_LENGTH, APPLY_FORCE, ADJUST_LENGTH], default: APPLY_FORCE) – A SymbolicConstant specifying the type of bolt load. Possible values are APPLY_FORCE, ADJUST_LENGTH, and FIX_LENGTH. The default is APPLY_FORCE.

• magnitude (Optional[float], default: None) – A Float specifying the bolt load magnitude.

• amplitude (str, default: '') – A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the amplitude is propagated from the previous analysis step. FREED should be used if the load is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

class BoltLoadState

Bases: LoadState

The BoltLoadState object stores the propagating data of a bolt load in a step. One instance of this object is created internally by the BoltLoad object for each step. The instance is also deleted internally by the BoltLoad object. The BoltLoadState object has no constructor or methods. The BoltLoadState object is derived from the LoadState object.

Note

This object can be accessed by:

import load
mdb.models[name].steps[name].loadStates[name]

The corresponding analysis keywords are:

• CLOAD

• BOUNDARY

Note

Check BoltLoadState on help.3ds.com/2023.

Member Details:

amplitude: str = ''

A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference.

amplitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the amplitude member. Possible values are UNSET, SET, UNCHANGED, and FREED.

boltMethod: SymbolicConstant

A SymbolicConstant specifying the type of bolt load. Possible values are APPLY_FORCE, ADJUST_LENGTH, and FIX_LENGTH.

boltMethodState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the bolt load type. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.

magnitude: Optional[float] = None

A Float specifying the bolt load magnitude.

magnitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the bolt load magnitude. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.

status: SymbolicConstant

A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:

• NOT_YET_ACTIVE

• CREATED

• PROPAGATED

• MODIFIED

• DEACTIVATED

• NO_LONGER_ACTIVE

• TYPE_NOT_APPLICABLE

• INSTANCE_NOT_APPLICABLE

• BUILT_INTO_BASE_STATE

class ConcCharge(name, createStepName, region, magnitude, distributionType=abaqusConstants.UNIFORM, field='', amplitude=abaqusConstants.UNSET)

Bases: Load

The ConcCharge object stores the data for a concentrated charge. The ConcCharge object is derived from the Load object.

Note

This object can be accessed by:

import load
mdb.models[name].loads[name]

Note

Check ConcCharge on help.3ds.com/2023.

This method creates a ConcCharge object.

Note

This function can be accessed by:

mdb.models[name].ConcCharge

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created. This must be the first analysis step name.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the load magnitude.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A ConcCharge object.

Return type:

ConcCharge

Member Details:

distributionType: SymbolicConstant = 'UNIFORM'

A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

field: str = ''

A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

name: str = ''

A String specifying the load repository key.

region: Region = <abaqus.Region.Region.Region object>

A Region object specifying the region to which the load is applied.

setValues(distributionType=abaqusConstants.UNIFORM, field='', amplitude=abaqusConstants.UNSET)

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

Note

Check ConcCharge.setValues on help.3ds.com/2023.

Parameters:

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

setValuesInStep(stepName, magnitude=None, amplitude='')

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

Note

Check ConcCharge.setValuesInStep on help.3ds.com/2023.

Parameters:

• stepName (str) – A String specifying the name of the step in which the load is modified.

• magnitude (Optional[float], default: None) – A Float specifying the load magnitude.

• amplitude (str, default: '') – A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the amplitude is propagated from the previous static analysis step. FREED should be used if the load is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

class ConcConcFlux(name, createStepName, region, magnitude, distributionType=abaqusConstants.UNIFORM, field='', amplitude=abaqusConstants.UNSET)

Bases: Load

The ConcConcFlux object stores the data for a concentrated concentration flux. The ConcConcFlux object is derived from the Load object.

Note

This object can be accessed by:

import load
mdb.models[name].loads[name]

Note

Check ConcConcFlux on help.3ds.com/2023.

This method creates a ConcConcFlux object.

Note

This function can be accessed by:

mdb.models[name].ConcConcFlux

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created. This must be the first analysis step name.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the load magnitude.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A ConcConcFlux object.

Return type:

ConcConcFlux

Member Details:

distributionType: SymbolicConstant = 'UNIFORM'

A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

field: str = ''

A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

name: str = ''

A String specifying the load repository key.

region: Region = <abaqus.Region.Region.Region object>

A Region object specifying the region to which the load is applied.

setValues(distributionType=abaqusConstants.UNIFORM, field='', amplitude=abaqusConstants.UNSET)

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

Note

Check ConcConcFlux.setValues on help.3ds.com/2023.

Parameters:

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

setValuesInStep(stepName, magnitude=None, amplitude='')

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

Note

Check ConcConcFlux.setValuesInStep on help.3ds.com/2023.

Parameters:

• stepName (str) – A String specifying the name of the step in which the load is modified.

• magnitude (Optional[float], default: None) – A Float specifying the load magnitude.

• amplitude (str, default: '') – A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the amplitude is propagated from the previous static analysis step. FREED should be used if the load is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

class ConcCurrent(name, createStepName, region, magnitude, distributionType=abaqusConstants.UNIFORM, field='', amplitude=abaqusConstants.UNSET)

Bases: Load

The ConcCurrent object stores the data for a concentrated current. The ConcCurrent object is derived from the Load object.

Note

This object can be accessed by:

import load
mdb.models[name].loads[name]

Note

Check ConcCurrent on help.3ds.com/2023.

This method creates a ConcCurrent object.

Note

This function can be accessed by:

mdb.models[name].ConcCurrent

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created. This must be the first analysis step name.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the load magnitude.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A ConcCurrent object.

Return type:

ConcCurrent

Member Details:

distributionType: SymbolicConstant = 'UNIFORM'

A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

field: str = ''

A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

name: str = ''

A String specifying the load repository key.

region: Region = <abaqus.Region.Region.Region object>

A Region object specifying the region to which the load is applied.

setValues(distributionType=abaqusConstants.UNIFORM, field='', amplitude=abaqusConstants.UNSET)

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

Note

Check ConcCurrent.setValues on help.3ds.com/2023.

Parameters:

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

setValuesInStep(stepName, magnitude=None, amplitude='')

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

Note

Check ConcCurrent.setValuesInStep on help.3ds.com/2023.

Parameters:

• stepName (str) – A String specifying the name of the step in which the load is modified.

• magnitude (Optional[float], default: None) – A Float specifying the load magnitude.

• amplitude (str, default: '') – A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the amplitude is propagated from the previous static analysis step. FREED should be used if the load is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

class ConcCurrentState

Bases: LoadState

The ConcCurrentState object stores the propagating data of a concentrated current in a step. One instance of this object is created internally by the ConcCurrent object for each step. The instance is also deleted internally by the ConcCurrent object. The ConcCurrentState object has no constructor or methods. The ConcCurrentState object is derived from the LoadState object.

Note

This object can be accessed by:

import load
mdb.models[name].steps[name].loadStates[name]

The corresponding analysis keywords are:

• CECURRENT

Note

Check ConcCurrentState on help.3ds.com/2023.

Member Details:

amplitude: str = ''

A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference.

amplitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the amplitude member. Possible values are UNSET, SET, UNCHANGED, and FREED.

magnitude: Optional[float] = None

A Float specifying the load magnitude.

magnitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the load magnitude. Possible values are UNSET, SET, UNCHANGED, and FREED.

status: SymbolicConstant

A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:

• NOT_YET_ACTIVE

• CREATED

• PROPAGATED

• MODIFIED

• DEACTIVATED

• NO_LONGER_ACTIVE

• TYPE_NOT_APPLICABLE

• INSTANCE_NOT_APPLICABLE

• BUILT_INTO_BASE_STATE

class ConcPoreFluid(name, createStepName, region, magnitude, distributionType=abaqusConstants.UNIFORM, field='', amplitude=abaqusConstants.UNSET)

Bases: Load

The ConcPoreFluid object stores the data for a concentrated pore fluid flow load. The ConcPoreFluid object is derived from the Load object.

Note

This object can be accessed by:

import load
mdb.models[name].loads[name]

Note

Check ConcPoreFluid on help.3ds.com/2023.

This method creates a ConcPoreFluid object.

Note

This function can be accessed by:

mdb.models[name].ConcPoreFluid

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created. This must be the first analysis step name.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the load magnitude.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A ConcPoreFluid object.

Return type:

ConcPoreFluid

Member Details:

distributionType: SymbolicConstant = 'UNIFORM'

A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

field: str = ''

A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

name: str = ''

A String specifying the load repository key.

region: Region = <abaqus.Region.Region.Region object>

A Region object specifying the region to which the load is applied.

setValues(distributionType=abaqusConstants.UNIFORM, field='', amplitude=abaqusConstants.UNSET)

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

Note

Check ConcPoreFluid.setValues on help.3ds.com/2023.

Parameters:

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

setValuesInStep(stepName, magnitude=None, amplitude='')

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

Note

Check ConcPoreFluid.setValuesInStep on help.3ds.com/2023.

Parameters:

• stepName (str) – A String specifying the name of the step in which the load is modified.

• magnitude (Optional[float], default: None) – A Float specifying the load magnitude.

• amplitude (str, default: '') – A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the amplitude is propagated from the previous static analysis step. FREED should be used if the load is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

class ConcentratedChargeState

Bases: LoadState

The ConcentratedChargeState object stores the propagating data of a concentrated charge in a step. One instance of this object is created internally by the ConcCharge object for each step. The instance is also deleted internally by the ConcCharge object. The ConcentratedChargeState object has no constructor or methods. The ConcentratedChargeState object is derived from the LoadState object.

Note

This object can be accessed by:

import load
mdb.models[name].steps[name].loadStates[name]

The corresponding analysis keywords are:

• CECHARGE

Note

Check ConcentratedChargeState on help.3ds.com/2023.

Member Details:

amplitude: str = ''

A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference.

amplitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the amplitude member. Possible values are UNSET, SET, UNCHANGED, and FREED.

magnitude: Optional[float] = None

A Float specifying the load magnitude.

magnitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the load magnitude. Possible values are UNSET, SET, UNCHANGED, and FREED.

status: SymbolicConstant

A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:

• NOT_YET_ACTIVE

• CREATED

• PROPAGATED

• MODIFIED

• DEACTIVATED

• NO_LONGER_ACTIVE

• TYPE_NOT_APPLICABLE

• INSTANCE_NOT_APPLICABLE

• BUILT_INTO_BASE_STATE

class ConcentratedConcentrationFluxState

Bases: LoadState

The ConcentratedConcentrationFluxState object stores the propagating data of a concentrated concentration flux in a step. One instance of this object is created internally by the ConcConcFlux object for each step. The instance is also deleted internally by the ConcConcFlux object. The ConcentratedConcentrationFluxState object has no constructor or methods. The ConcentratedConcentrationFluxState object is derived from the LoadState object.

Note

This object can be accessed by:

import load
mdb.models[name].steps[name].loadStates[name]

The corresponding analysis keywords are:

• CFLUX

Note

Check ConcentratedConcentrationFluxState on help.3ds.com/2023.

Member Details:

amplitude: str = ''

A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference.

amplitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the amplitude member. Possible values are UNSET, SET, UNCHANGED, and FREED.

magnitude: Optional[float] = None

A Float specifying the load magnitude.

magnitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the load magnitude. Possible values are UNSET, SET, UNCHANGED, and FREED.

status: SymbolicConstant

A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:

• NOT_YET_ACTIVE

• CREATED

• PROPAGATED

• MODIFIED

• DEACTIVATED

• NO_LONGER_ACTIVE

• TYPE_NOT_APPLICABLE

• INSTANCE_NOT_APPLICABLE

• BUILT_INTO_BASE_STATE

class ConcentratedForce(name, createStepName, region, distributionType=abaqusConstants.UNIFORM, field='', cf1=None, cf2=None, cf3=None, amplitude=abaqusConstants.UNSET, follower=0, localCsys=None)

Bases: Load

The ConcentratedForce object defines a concentrated force. The ConcentratedForce object is derived from the Load object.

Note

This object can be accessed by:

import load
mdb.models[name].loads[name]

Note

Check ConcentratedForce on help.3ds.com/2023.

This method creates a ConcentratedForce object.

Note

This function can be accessed by:

mdb.models[name].ConcentratedForce

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created.

• region (Region) – A Region object specifying the region to which the load is applied.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• cf1 (Optional[float], default: None) – A Float or a Complex specifying the concentrated force component in the 1-direction. Although cf1, cf2, and cf3 are optional arguments, at least one of them must be nonzero.

• cf2 (Optional[float], default: None) – A Float or a Complex specifying the concentrated force component in the 2-direction.

• cf3 (Optional[float], default: None) – A Float or a Complex specifying the concentrated force component in the 3-direction.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

• follower (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether the direction of the force rotates with the rotation at each node of the region. You should provide the follower argument only if it is valid for the specified step. The default value is OFF.

• localCsys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system of the load’s degrees of freedom. If localCsys = None, the degrees of freedom are defined in the global coordinate system. When this member is queried, it returns an Int. The default value is None.

Returns:

A ConcentratedForce object.

Return type:

ConcentratedForce

Member Details:

distributionType: SymbolicConstant = 'UNIFORM'

A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

field: str = ''

A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

follower: Union[AbaqusBoolean, bool] = 0

A Boolean specifying whether the direction of the force rotates with the rotation at each node of the region. You should provide the follower argument only if it is valid for the specified step. The default value is OFF.

localCsys: Optional[int] = None

None or a DatumCsys object specifying the local coordinate system of the load’s degrees of freedom. If localCsys = None, the degrees of freedom are defined in the global coordinate system. When this member is queried, it returns an Int. The default value is None.

name: str = ''

A String specifying the load repository key.

region: Region = <abaqus.Region.Region.Region object>

A Region object specifying the region to which the load is applied.

setValues(distributionType=abaqusConstants.UNIFORM, field='', cf1=None, cf2=None, cf3=None, amplitude=abaqusConstants.UNSET, follower=0, localCsys=None)

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

Note

Check ConcentratedForce.setValues on help.3ds.com/2023.

Parameters:

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• cf1 (Optional[float], default: None) – A Float or a Complex specifying the concentrated force component in the 1-direction. Although cf1, cf2, and cf3 are optional arguments, at least one of them must be nonzero.

• cf2 (Optional[float], default: None) – A Float or a Complex specifying the concentrated force component in the 2-direction.

• cf3 (Optional[float], default: None) – A Float or a Complex specifying the concentrated force component in the 3-direction.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

• follower (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether the direction of the force rotates with the rotation at each node of the region. You should provide the follower argument only if it is valid for the specified step. The default value is OFF.

• localCsys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system of the load’s degrees of freedom. If localCsys = None, the degrees of freedom are defined in the global coordinate system. When this member is queried, it returns an Int. The default value is None.

setValuesInStep(stepName, cf1=Ellipsis, cf2=Ellipsis, cf3=Ellipsis, amplitude='')

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

Note

Check ConcentratedForce.setValuesInStep on help.3ds.com/2023.

Parameters:

• stepName (str) – A String specifying the name of the step in which the load is modified.

• cf1 (Union[Literal[UNCHANGED], float], default: Ellipsis) – A Float, a Complex, or the SymbolicConstant UNCHANGED specifying the concentrated force component in the 1-direction. UNCHANGED should be used if the concentrated force component is propagated from the previous analysis step.

• cf2 (Union[Literal[UNCHANGED], float], default: Ellipsis) – A Float, a Complex, or the SymbolicConstant UNCHANGED specifying the concentrated force component in the 2-direction. UNCHANGED should be used if the concentrated force component is propagated from the previous analysis step.

• cf3 (Union[Literal[UNCHANGED], float], default: Ellipsis) – A Float, a Complex, or the SymbolicConstant UNCHANGED specifying the concentrated force component in the 3-direction. UNCHANGED should be used if the concentrated force component is propagated from the previous analysis step.

• amplitude (str, default: '') – A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the amplitude is propagated from the previous analysis step. FREED should be used if the load is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

class ConcentratedForceState

Bases: LoadState

The ConcentratedForceState object stores the propagating data for a concentrated force in a step. One instance of this object is created internally by the ConcentratedForce object for each step. The instance is also deleted internally by the ConcentratedForce object. The ConcentratedForceState object has no constructor or methods. The ConcentratedForceState object is derived from the LoadState object.

Note

This object can be accessed by:

import load
mdb.models[name].steps[name].loadStates[name]

The corresponding analysis keywords are:

• CLOAD

Note

Check ConcentratedForceState on help.3ds.com/2023.

Member Details:

amplitude: str = ''

A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference. - NOT_YET_ACTIVE - CREATED - PROPAGATED - MODIFIED - DEACTIVATED - NO_LONGER_ACTIVE - TYPE_NOT_APPLICABLE - INSTANCE_NOT_APPLICABLE - BUILT_INTO_BASE_STATE

amplitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the amplitude member. Possible values are UNSET, SET, UNCHANGED, and FREED.

cf1: Optional[float] = None

A Float or a Complex specifying the concentrated force component in the 1-direction. Although cf1, cf2, and cf3 are optional arguments, at least one of them must be nonzero.

cf1State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the concentrated force component in the 1-direction. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.

cf2: Optional[float] = None

A Float or a Complex specifying the concentrated force component in the 2-direction.

cf2State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the concentrated force component in the 2-direction. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.

cf3: Optional[float] = None

A Float or a Complex specifying the concentrated force component in the 3-direction.

cf3State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the concentrated force component in the 3-direction. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.

status: SymbolicConstant

A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:

class ConcentratedHeatFlux(name, createStepName, region, magnitude, distributionType=abaqusConstants.UNIFORM, field='', amplitude=abaqusConstants.UNSET, dof=11)

Bases: Load

The ConcentratedHeatFlux object stores the data for a concentrated heat flux load. The ConcentratedHeatFlux object is derived from the Load object.

Note

This object can be accessed by:

import load
mdb.models[name].loads[name]

Note

Check ConcentratedHeatFlux on help.3ds.com/2023.

This method creates a ConcentratedHeatFlux object.

Note

This function can be accessed by:

mdb.models[name].ConcentratedHeatFlux

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created. This must be the first analysis step name.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the load magnitude.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

• dof (int, default: 11) – An Int specifying the degree of freedom of the node, to which the concentrated heat flux should be applied. The default value is 11.

Returns:

A ConcentratedHeatFlux object.

Return type:

ConcentratedHeatFlux

Member Details:

distributionType: SymbolicConstant = 'UNIFORM'

A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

dof: int = 11

An Int specifying the degree of freedom of the node, to which the concentrated heat flux should be applied. The default value is 11.

field: str = ''

A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

name: str = ''

A String specifying the load repository key.

region: Region = <abaqus.Region.Region.Region object>

A Region object specifying the region to which the load is applied.

setValues(distributionType=abaqusConstants.UNIFORM, field='', amplitude=abaqusConstants.UNSET, dof=11)

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

Note

Check ConcentratedHeatFlux.setValues on help.3ds.com/2023.

Parameters:

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

• dof (int, default: 11) – An Int specifying the degree of freedom of the node, to which the concentrated heat flux should be applied. The default value is 11.

setValuesInStep(stepName, magnitude=None, amplitude='')

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

Note

Check ConcentratedHeatFlux.setValuesInStep on help.3ds.com/2023.

Parameters:

• stepName (str) – A String specifying the name of the step in which the load is modified.

• magnitude (Optional[float], default: None) – A Float specifying the load magnitude.

• amplitude (str, default: '') – A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the amplitude is propagated from the previous static analysis step. FREED should be used if the load is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

class ConcentratedHeatFluxState

Bases: LoadState

The ConcentratedHeatFluxState object stores the propagating data of a concentrated heat flux load in a step. One instance of this object is created internally by the ConcentratedHeatFlux object for each step. The instance is also deleted internally by the ConcentratedHeatFlux object. The ConcentratedHeatFluxState object has no constructor or methods. The ConcentratedHeatFluxState object is derived from the LoadState object.

Note

This object can be accessed by:

import load
mdb.models[name].steps[name].loadStates[name]

The corresponding analysis keywords are:

• CFLUX

Note

Check ConcentratedHeatFluxState on help.3ds.com/2023.

Member Details:

amplitude: str = ''

A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference.

amplitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the amplitude member. Possible values are UNSET, SET, UNCHANGED, and FREED.

magnitude: Optional[float] = None

A Float specifying the load magnitude.

magnitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the load magnitude. Possible values are UNSET, SET, UNCHANGED, and FREED.

status: SymbolicConstant

A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:

• NOT_YET_ACTIVE

• CREATED

• PROPAGATED

• MODIFIED

• DEACTIVATED

• NO_LONGER_ACTIVE

• TYPE_NOT_APPLICABLE

• INSTANCE_NOT_APPLICABLE

• BUILT_INTO_BASE_STATE

class ConcentratedPoreFluidState

Bases: LoadState

The ConcentratedPoreFluidState object stores the propagating data of a concentrated pore fluid flow load in a step. One instance of this object is created internally by the ConcPoreFluid object for each step. The instance is also deleted internally by the ConcPoreFluid object. The ConcentratedPoreFluidState object has no constructor or methods. The ConcentratedPoreFluidState object is derived from the LoadState object.

Note

This object can be accessed by:

import load
mdb.models[name].steps[name].loadStates[name]

The corresponding analysis keywords are:

• CLOAD

Note

Check ConcentratedPoreFluidState on help.3ds.com/2023.

Member Details:

amplitude: str = ''

A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference.

amplitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the amplitude member. Possible values are UNSET, SET, UNCHANGED, and FREED.

magnitude: Optional[float] = None

A Float specifying the load magnitude.

magnitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the load magnitude. Possible values are UNSET, SET, UNCHANGED, and FREED.

status: SymbolicConstant

A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:

• NOT_YET_ACTIVE

• CREATED

• PROPAGATED

• MODIFIED

• DEACTIVATED

• NO_LONGER_ACTIVE

• TYPE_NOT_APPLICABLE

• INSTANCE_NOT_APPLICABLE

• BUILT_INTO_BASE_STATE

class ConnectorForce(name, createStepName, region='', fastenerName='', fastenerSetName='', f1=None, f2=None, f3=None, amplitude=abaqusConstants.UNSET)

Bases: Load

The ConnectorForce object defines a connector force. The ConnectorForce object is derived from the Load object.

Note

This object can be accessed by:

import load
mdb.models[name].loads[name]

Note

Check ConnectorForce on help.3ds.com/2023.

This method creates a ConnectorForce object on a wire region. Alternatively, the load may also be applied to a wire set referenced from an assembled fastener template model.

Note

This function can be accessed by:

mdb.models[name].ConnectorForce

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created.

• region (str, default: '') – The wire region to which the load is applied. This argument is not valid when fastenerName and fastenerSetName are specified.

• fastenerName (str, default: '') – A String specifying the name of the assembled fastener to which the load will be applied. This argument is not valid when region is specified. When this argument is specified, fastenerSetName must also be specified. The default value is an empty string.

• fastenerSetName (str, default: '') – A String specifying the assembled fastener template model set to which the load will be applied. This argument is not valid when region is specified. When this argument is specified, fastenerName must also be specified. The default value is an empty string.

• f1 (Optional[float], default: None) – A Float or a Complex specifying the connector force component in the connector’s local 1-direction. Note: Although f1, f2, and f3 are optional arguments, at least one of them must be nonzero.

• f2 (Optional[float], default: None) – A Float or a Complex specifying the connector force component in the connector’s local 2-direction.

• f3 (Optional[float], default: None) – A Float or a Complex specifying the connector force component in the connector’s local 3-direction.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A ConnectorForce object.

Return type:

ConnectorForce

Member Details:

fastenerName: str = ''

A String specifying the name of the assembled fastener to which the load will be applied. This argument is not valid when region is specified. When this argument is specified, fastenerSetName must also be specified. The default value is an empty string.

fastenerSetName: str = ''

A String specifying the assembled fastener template model set to which the load will be applied. This argument is not valid when region is specified. When this argument is specified, fastenerName must also be specified. The default value is an empty string.

name: str = ''

A String specifying the load repository key.

region: Region = <abaqus.Region.Region.Region object>

A Region object specifying the region to which the load is applied.

setValues(region='', fastenerName='', fastenerSetName='', f1=None, f2=None, f3=None, amplitude=abaqusConstants.UNSET)

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

Note

Check ConnectorForce.setValues on help.3ds.com/2023.

Parameters:

• region (str, default: '') – The wire region to which the load is applied. This argument is not valid when fastenerName and fastenerSetName are specified.

• fastenerName (str, default: '') – A String specifying the name of the assembled fastener to which the load will be applied. This argument is not valid when region is specified. When this argument is specified, fastenerSetName must also be specified. The default value is an empty string.

• fastenerSetName (str, default: '') – A String specifying the assembled fastener template model set to which the load will be applied. This argument is not valid when region is specified. When this argument is specified, fastenerName must also be specified. The default value is an empty string.

• f1 (Optional[float], default: None) – A Float or a Complex specifying the connector force component in the connector’s local 1-direction. Note: Although f1, f2, and f3 are optional arguments, at least one of them must be nonzero.

• f2 (Optional[float], default: None) – A Float or a Complex specifying the connector force component in the connector’s local 2-direction.

• f3 (Optional[float], default: None) – A Float or a Complex specifying the connector force component in the connector’s local 3-direction.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

setValuesInStep(stepName, f1=Ellipsis, f2=Ellipsis, f3=Ellipsis, amplitude='')

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

Note

Check ConnectorForce.setValuesInStep on help.3ds.com/2023.

Parameters:

• stepName (str) – A String specifying the name of the step in which the load is modified.

• f1 (Union[Literal[UNCHANGED], float], default: Ellipsis) – A Float, a Complex, or the SymbolicConstant UNCHANGED specifying the connector force component in the connector’s local 1-direction. UNCHANGED should be used if the connector force component is propagated from the previous analysis step.

• f2 (Union[Literal[UNCHANGED], float], default: Ellipsis) – A Float, a Complex, or the SymbolicConstant UNCHANGED specifying the connector force component in the connector’s local 2-direction. UNCHANGED should be used if the connector force component is propagated from the previous analysis step.

• f3 (Union[Literal[UNCHANGED], float], default: Ellipsis) – A Float, a Complex, or the SymbolicConstant UNCHANGED specifying the connector force component in the connector’s local 3-direction. UNCHANGED should be used if the connector force component is propagated from the previous analysis step.

• amplitude (str, default: '') – A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the amplitude is propagated from the previous analysis step. FREED should be used if the load is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

class ConnectorForceState

Bases: LoadState

The ConnectorForceState object stores the propagating data for a connector force in a step. One instance of this object is created internally by the ConnectorForce object for each step. The instance is also deleted internally by the ConnectorForce object. The ConnectorForceState object has no constructor or methods. The ConnectorForceState object is derived from the LoadState object.

Note

This object can be accessed by:

import load
mdb.models[name].steps[name].loadStates[name]

The corresponding analysis keywords are:

• CONNECTOR LOAD

Note

Check ConnectorForceState on help.3ds.com/2023.

Member Details:

amplitude: str = ''

A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference.

amplitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the amplitude member. Possible values are UNSET, SET, UNCHANGED, and FREED.

f1: Optional[float] = None

A Float or a Complex specifying the connector force component in the connector’s local 1-direction.

f1State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the connector force component in the connector’s local 1-direction. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.

f2: Optional[float] = None

A Float or a Complex specifying the connector force component in the connector’s local 2-direction.

f2State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the connector force component in the connector’s local 2-direction. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.

f3: Optional[float] = None

A Float or a Complex specifying the connector force component in the connector’s local 3-direction.

f3State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the connector force component in the connector’s local 3-direction. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.

status: SymbolicConstant

A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:

• NOT_YET_ACTIVE

• CREATED

• PROPAGATED

• MODIFIED

• DEACTIVATED

• NO_LONGER_ACTIVE

• TYPE_NOT_APPLICABLE

• INSTANCE_NOT_APPLICABLE

• BUILT_INTO_BASE_STATE

class ConnectorMoment(name, createStepName, region='', fastenerName='', fastenerSetName='', m1=None, m2=None, m3=None, amplitude=abaqusConstants.UNSET)

Bases: Load

The ConnectorMoment object stores the data for a connector moment. The ConnectorMoment object is derived from the Load object.

Note

This object can be accessed by:

import load
mdb.models[name].loads[name]

Note

Check ConnectorMoment on help.3ds.com/2023.

This method creates a ConnectorMoment object on a wire region. Alternatively, the load may also be applied to a wire set referenced from an assembled fastener template model.

Note

This function can be accessed by:

mdb.models[name].ConnectorMoment

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created.

• region (str, default: '') – The wire region to which the load is applied. This argument is not valid when fastenerName and fastenerSetName are specified.

• fastenerName (str, default: '') – A String specifying the name of the assembled fastener to which the load will be applied. This argument is not valid when region is specified. When this argument is specified, fastenerSetName must also be specified. The default value is an empty string.

• fastenerSetName (str, default: '') – A String specifying the assembled fastener template model set to which the load will be applied. This argument is not valid when region is specified. When this argument is specified, fastenerName must also be specified. The default value is an empty string.

• m1 (Optional[float], default: None) – A Float or a Complex specifying the moment component in the connector’s local 4-direction.

• m2 (Optional[float], default: None) – A Float or a Complex specifying the moment component in the connector’s local 5-direction.

• m3 (Optional[float], default: None) – A Float or a Complex specifying the moment component in the connector’s local 6-direction.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A ConnectorMoment object.

Return type:

ConnectorMoment

Member Details:

fastenerName: str = ''

A String specifying the name of the assembled fastener to which the load will be applied. This argument is not valid when region is specified. When this argument is specified, fastenerSetName must also be specified. The default value is an empty string.

fastenerSetName: str = ''

A String specifying the assembled fastener template model set to which the load will be applied. This argument is not valid when region is specified. When this argument is specified, fastenerName must also be specified. The default value is an empty string.

name: str = ''

A String specifying the load repository key.

region: Region = <abaqus.Region.Region.Region object>

A Region object specifying the region to which the load is applied.

setValues(region='', fastenerName='', fastenerSetName='', m1=None, m2=None, m3=None, amplitude=abaqusConstants.UNSET)

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

Note

Check ConnectorMoment.setValues on help.3ds.com/2023.

Parameters:

• region (str, default: '') – The wire region to which the load is applied. This argument is not valid when fastenerName and fastenerSetName are specified.

• fastenerName (str, default: '') – A String specifying the name of the assembled fastener to which the load will be applied. This argument is not valid when region is specified. When this argument is specified, fastenerSetName must also be specified. The default value is an empty string.

• fastenerSetName (str, default: '') – A String specifying the assembled fastener template model set to which the load will be applied. This argument is not valid when region is specified. When this argument is specified, fastenerName must also be specified. The default value is an empty string.

• m1 (Optional[float], default: None) – A Float or a Complex specifying the moment component in the connector’s local 4-direction.

• m2 (Optional[float], default: None) – A Float or a Complex specifying the moment component in the connector’s local 5-direction.

• m3 (Optional[float], default: None) – A Float or a Complex specifying the moment component in the connector’s local 6-direction.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

setValuesInStep(stepName, m1=Ellipsis, m2=Ellipsis, m3=Ellipsis, amplitude='')

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

Note

Check ConnectorMoment.setValuesInStep on help.3ds.com/2023.

Parameters:

• stepName (str) – A String specifying the name of the step in which the load is modified.

• m1 (Union[Literal[FREED, UNCHANGED], float], default: Ellipsis) – A Float, a Complex, or a SymbolicConstant specifying the moment component in the connector’s local 4-direction. Possible values for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the load component is propagated from the previous static analysis step. Use FREED to remove a previously defined load component.

• m2 (Union[Literal[FREED, UNCHANGED], float], default: Ellipsis) – A Float, a Complex, or a SymbolicConstant specifying the moment component in the connector’s local 5-direction. Possible values for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the load component is propagated from the previous static analysis step. Use FREED to remove a previously defined load component.

• m3 (Union[Literal[FREED, UNCHANGED], float], default: Ellipsis) – A Float, a Complex, or a SymbolicConstant specifying the moment component in the connector’s local 6-direction. Possible values for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the load component is propagated from the previous static analysis step. Use FREED to remove a previously defined load component.

• amplitude (str, default: '') – A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the amplitude is propagated from the previous static analysis step. FREED should be used if the load is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

class ConnectorMomentState

Bases: LoadState

The ConnectorMomentState object stores the propagating data for a connector moment in a step. One instance of this object is created internally by the ConnectorMoment object for each step. The instance is also deleted internally by the ConnectorMoment object. The ConnectorMomentState object has no constructor or methods. The ConnectorMomentState object is derived from the LoadState object.

Note

This object can be accessed by:

import load
mdb.models[name].steps[name].loadStates[name]

The corresponding analysis keywords are:

• CONNECTOR LOAD

Note

Check ConnectorMomentState on help.3ds.com/2023.

Member Details:

amplitude: str = ''

A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference.

amplitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the amplitude member. Possible values are UNSET, SET, UNCHANGED, and FREED.

m1: Optional[float] = None

A Float or a Complex specifying the connector moment component in the connector’s local 4-direction. Although m1, m2, and m3 are optional arguments, at least one of them must be nonzero.

m1State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the load component in the connector’s local 4-direction. Possible values are UNSET, SET, UNCHANGED, and FREED.

m2: Optional[float] = None

A Float or a Complex specifying the connector moment component in the connector’s local 5direction.

m2State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the load component in the connector’s local 5-direction. Possible values are UNSET, SET, UNCHANGED, and FREED.

m3: Optional[float] = None

A Float or a Complex specifying the connector moment component in the connector’s local 6-direction.

m3State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the load component in the connector’s local 6-direction. Possible values are UNSET, SET, UNCHANGED, and FREED.

status: SymbolicConstant

A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:

• NOT_YET_ACTIVE

• CREATED

• PROPAGATED

• MODIFIED

• DEACTIVATED

• NO_LONGER_ACTIVE

• TYPE_NOT_APPLICABLE

• INSTANCE_NOT_APPLICABLE

• BUILT_INTO_BASE_STATE

class CoriolisForce(name, createStepName, region, magnitude, point1, point2, amplitude=abaqusConstants.UNSET, distributionType=abaqusConstants.UNIFORM, field='')

Bases: Load

The CoriolisForce object stores the data for a coriolis force. The CoriolisForce object is derived from the Load object.

Note

This object can be accessed by:

import load
mdb.models[name].loads[name]

Note

Check CoriolisForce on help.3ds.com/2023.

This method creates a CoriolisForce object.

Note

This function can be accessed by:

mdb.models[name].CoriolisForce

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created. This must be the first analysis step name.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the load magnitude.

• point1 (tuple) – A sequence of Floats specifying the first point on the axis of rotation for the load.

• point2 (tuple) – A sequence of Floats specifying the second point on the axis of rotation for the load.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

Returns:

A CoriolisForce object.

Return type:

CoriolisForce

Member Details:

distributionType: SymbolicConstant = 'UNIFORM'

A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

field: str = ''

A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

name: str = ''

A String specifying the load repository key.

point1: Optional[float] = None

A tuple of Floats specifying the first point on the axis of rotation for the load.

point2: Optional[float] = None

A tuple of Floats specifying the second point on the axis of rotation for the load.

region: Region = <abaqus.Region.Region.Region object>

A Region object specifying the region to which the load is applied.

setValues(amplitude=abaqusConstants.UNSET, distributionType=abaqusConstants.UNIFORM, field='')

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

Note

Check CoriolisForce.setValues on help.3ds.com/2023.

Parameters:

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

setValuesInStep(stepName, magnitude=None, amplitude='')

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

Note

Check CoriolisForce.setValuesInStep on help.3ds.com/2023.

Parameters:

• stepName (str) – A String specifying the name of the step in which the load is modified.

• magnitude (Optional[float], default: None) – A Float specifying the load magnitude.

• amplitude (str, default: '') – A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the amplitude is propagated from the previous static analysis step. FREED should be used if the load is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

class CoriolisForceState

Bases: LoadState

The CoriolisForceState object stores the propagating data of a coriolis force in a step. One instance of this object is created internally by the CoriolisForce object for each step. The instance is also deleted internally by the CoriolisForce object. The CoriolisForceState object has no constructor or methods. The CoriolisForceState object is derived from the LoadState object.

Note

This object can be accessed by:

import load
mdb.models[name].steps[name].loadStates[name]

The corresponding analysis keywords are:

• DLOAD

Note

Check CoriolisForceState on help.3ds.com/2023.

Member Details:

amplitude: str = ''

A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference.

amplitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the amplitude member. Possible values are UNSET, SET, UNCHANGED, and FREED.

magnitude: Optional[float] = None

A Float specifying the load magnitude.

magnitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the load magnitude. Possible values are UNSET, SET, UNCHANGED, and FREED.

status: SymbolicConstant

A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:

• NOT_YET_ACTIVE

• CREATED

• PROPAGATED

• MODIFIED

• DEACTIVATED

• NO_LONGER_ACTIVE

• TYPE_NOT_APPLICABLE

• INSTANCE_NOT_APPLICABLE

• BUILT_INTO_BASE_STATE

class Gravity(name, createStepName, distributionType=abaqusConstants.UNIFORM, field='', region=None, comp1=None, comp2=None, comp3=None, amplitude=abaqusConstants.UNSET)

Bases: Load

The Gravity object stores the data of a gravity load. The Gravity object is derived from the Load object.

Note

This object can be accessed by:

import load
mdb.models[name].loads[name]

Note

Check Gravity on help.3ds.com/2023.

This method creates a Gravity object.

Note

This function can be accessed by:

mdb.models[name].Gravity

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• region (Optional[Region], default: None) – A Region object specifying the region to which the load is applied.

• comp1 (Optional[float], default: None) – A Float or a Complex specifying the component of the load in the 1-direction. Note: Although comp1, comp2, and comp3 are optional arguments, at least one of them must be nonzero.

• comp2 (Optional[float], default: None) – A Float or a Complex specifying the component of the load in the 2-direction.

• comp3 (Optional[float], default: None) – A Float or a Complex specifying the component of the load in the 3-direction.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

A Gravity object.

Return type:

Gravity

Member Details:

distributionType: SymbolicConstant = 'UNIFORM'

A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

field: str = ''

A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

name: str = ''

A String specifying the load repository key.

region: Region = <abaqus.Region.Region.Region object>

A Region object specifying the region to which the load is applied.

setValues(distributionType=abaqusConstants.UNIFORM, field='', region=None, comp1=None, comp2=None, comp3=None, amplitude=abaqusConstants.UNSET)

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

Note

Check Gravity.setValues on help.3ds.com/2023.

Parameters:

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• region (Optional[Region], default: None) – A Region object specifying the region to which the load is applied.

• comp1 (Optional[float], default: None) – A Float or a Complex specifying the component of the load in the 1-direction. Note: Although comp1, comp2, and comp3 are optional arguments, at least one of them must be nonzero.

• comp2 (Optional[float], default: None) – A Float or a Complex specifying the component of the load in the 2-direction.

• comp3 (Optional[float], default: None) – A Float or a Complex specifying the component of the load in the 3-direction.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

setValuesInStep(stepName, comp1=Ellipsis, comp2=Ellipsis, comp3=Ellipsis, amplitude='')

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

Note

Check Gravity.setValuesInStep on help.3ds.com/2023.

Parameters:

• stepName (str) – A String specifying the name of the step in which the load is modified.

• comp1 (Union[Literal[FREED, UNCHANGED], float], default: Ellipsis) – A Float, a Complex, or a SymbolicConstant specifying the load component in the 1-direction. Possible values for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the load component is propagated from the previous static analysis step. Use FREED to remove a previously defined load component.

• comp2 (Union[SymbolicConstant, float], default: Ellipsis) – A Float, a Complex, or a SymbolicConstant specifying the load component in the 2-direction. For details see comp1.

• comp3 (Union[SymbolicConstant, float], default: Ellipsis) – A Float, a Complex, or a SymbolicConstant specifying the load component in the 3-direction. For details see comp1.

• amplitude (str, default: '') – A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the amplitude is propagated from the previous static analysis step. FREED should be used if the load is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

class GravityState

Bases: LoadState

The GravityState object stores the propagating data for a gravity load in a step. One instance of this object is created internally by the Gravity object for each step. The instance is also deleted internally by the Gravity object. The GravityState object has no constructor or methods. The GravityState object is derived from the LoadState object.

Note

This object can be accessed by:

import load
mdb.models[name].steps[name].loadStates[name]

The corresponding analysis keywords are:

• DLOAD

Note

Check GravityState on help.3ds.com/2023.

Member Details:

amplitude: str = ''

A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference.

amplitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the amplitude member. Possible values are UNSET, SET, UNCHANGED, and FREED.

comp1: Optional[float] = None

A Float or a Complex specifying the load component in the 1-direction.

comp1State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the load component in the 1-direction. Possible values are UNSET, SET, UNCHANGED, and FREED.

comp2: Optional[float] = None

A Float or a Complex specifying the load component in the 2-direction.

comp2State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the load component in the 2-direction. Possible values are UNSET, SET, UNCHANGED, and FREED.

comp3: Optional[float] = None

A Float or a Complex specifying the load component in the 3-direction.

comp3State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the load component in the 3-direction. Possible values are UNSET, SET, UNCHANGED, and FREED.

status: SymbolicConstant

A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:

• NOT_YET_ACTIVE

• CREATED

• PROPAGATED

• MODIFIED

• DEACTIVATED

• NO_LONGER_ACTIVE

• TYPE_NOT_APPLICABLE

• INSTANCE_NOT_APPLICABLE

• BUILT_INTO_BASE_STATE

class HydrostaticFluidFlowState

Bases: LoadState

The HydrostaticFluidFlowState object stores the propagating data for a concentrated HydrostaticFluidFlow object in a step. One instance of this object is created internally by the HydrostaticFluidFlow object for each step. The instance is also deleted internally by the HydrostaticFluidFlow object. The HydrostaticFluidFlowState object has no constructor or methods. The HydrostaticFluidFlowState object is derived from the LoadState object.

Note

This object can be accessed by:

import load
mdb.models[name].steps[name].loadStates[name]

The corresponding analysis keywords are:

• FLUID FLUX

Note

Check HydrostaticFluidFlowState on help.3ds.com/2023.

Member Details:

amplitude: str = ''

A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference.

amplitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the amplitude member. Possible values are UNSET, SET, UNCHANGED, and FREED.

magnitude: Optional[float] = None

A Float specifying the load magnitude.

magnitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the load magnitude. Possible values are UNSET, SET, UNCHANGED, and FREED.

status: SymbolicConstant

A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:

• NOT_YET_ACTIVE

• CREATED

• PROPAGATED

• MODIFIED

• DEACTIVATED

• NO_LONGER_ACTIVE

• TYPE_NOT_APPLICABLE

• INSTANCE_NOT_APPLICABLE

• BUILT_INTO_BASE_STATE

class InertiaRelief(name, createStepName, u1=0, u2=0, u3=0, ur1=0, ur2=0, ur3=0, referencePoint=(), localCoordinates=None)

Bases: Load

The InertiaRelief object defines an inertia relief load. The InertiaRelief object is derived from the Load object.

Note

This object can be accessed by:

import load
mdb.models[name].loads[name]

Note

Check InertiaRelief on help.3ds.com/2023.

This method creates an InertiaRelief object.

Note

This function can be accessed by:

mdb.models[name].InertiaRelief

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created.

• u1 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying the 1-direction as a free direction. Note: Although u1, u2, u3, ur1, ur2, and ur3 are optional arguments, at least one of them must be specified. Further, any specified set of free directions cannot include only two rotational degrees of freedom.

• u2 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying the 2-direction as a free direction.

• u3 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying the 3-direction as a free direction.

• ur1 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying the rotation about the 1-direction as a free direction.

• ur2 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying the rotation about the 2-direction as a free direction.

• ur3 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying the rotation about the 3-direction as a free direction.

• referencePoint (tuple, default: ()) – A sequence of Floats specifying the X, Y and Z coordinates of a fixed rotation point or a point on the rotation axis or a point on the symmetry line, about which rotations are defined. Such a point must be specified only for certain combinations of free directions.

• localCoordinates (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system of the rigid body degrees of freedom for the inertia relief load. If localCoordinates = None, the free directions are defined in the global coordinate system. When this member is queried, it returns an Int. The default value is None.

Returns:

An InertiaRelief object.

Return type:

InertiaRelief

Member Details:

localCoordinates: Optional[int] = None

None or a DatumCsys object specifying the local coordinate system of the rigid body degrees of freedom for the inertia relief load. If localCoordinates = None, the free directions are defined in the global coordinate system. When this member is queried, it returns an Int. The default value is None.

name: str = ''

A String specifying the load repository key.

region: Region = <abaqus.Region.Region.Region object>

A Region object specifying the region to which the load is applied.

setValues(u1=0, u2=0, u3=0, ur1=0, ur2=0, ur3=0, referencePoint=(), localCoordinates=None)

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

Note

Check InertiaRelief.setValues on help.3ds.com/2023.

Parameters:

• u1 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying the 1-direction as a free direction. Note: Although u1, u2, u3, ur1, ur2, and ur3 are optional arguments, at least one of them must be specified. Further, any specified set of free directions cannot include only two rotational degrees of freedom.

• u2 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying the 2-direction as a free direction.

• u3 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying the 3-direction as a free direction.

• ur1 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying the rotation about the 1-direction as a free direction.

• ur2 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying the rotation about the 2-direction as a free direction.

• ur3 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying the rotation about the 3-direction as a free direction.

• referencePoint (tuple, default: ()) – A sequence of Floats specifying the X, Y and Z coordinates of a fixed rotation point or a point on the rotation axis or a point on the symmetry line, about which rotations are defined. Such a point must be specified only for certain combinations of free directions.

• localCoordinates (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system of the rigid body degrees of freedom for the inertia relief load. If localCoordinates = None, the free directions are defined in the global coordinate system. When this member is queried, it returns an Int. The default value is None.

setValuesInStep(stepName, u1=0, u2=0, u3=0, ur1=0, ur2=0, ur3=0, referencePoint=(), fixed=0)

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

Note

Check InertiaRelief.setValuesInStep on help.3ds.com/2023.

Parameters:

• stepName (str) – A String specifying the name of the step in which the load is modified.

• u1 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying the 1-direction as a free direction.

• u2 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying the 2-direction as a free direction.

• u3 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying the 3-direction as a free direction.

• ur1 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying the rotation about the 1-direction as a free direction.

• ur2 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying the rotation about the 2-direction as a free direction.

• ur3 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying the rotation about the 3-direction as a free direction.

• referencePoint (tuple, default: ()) –

  A sequence of Floats specifying the point about which rotations are defined. The point can be specified only for certain combinations of free directions. The referencePoint argument can be one of the following:

  • The X, Y and Z coordinates of a fixed rotation point.

  • A point on the rotation axis.

  • A point on the symmetry line.

• fixed (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether the inertia relief loading should remain fixed at the current loading at the start of the step. The default value is OFF.

class InertiaReliefState

Bases: LoadState

The InertiaReliefState object stores the propagating data for an inertia relief load in a step. One instance of this object is created internally by the InertiaRelief object for each step. The instance is also deleted internally by the InertiaRelief object. The InertiaReliefState object has no constructor or methods. The InertiaReliefState object is derived from the LoadState object.

Note

This object can be accessed by:

import load
mdb.models[name].steps[name].loadStates[name]

The corresponding analysis keywords are:

• INERTIA RELIEF

Note

Check InertiaReliefState on help.3ds.com/2023.

Member Details:

amplitude: str = ''

A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference.

amplitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the amplitude member. Possible values are UNSET, SET, UNCHANGED, and FREED.

fixed: Union[AbaqusBoolean, bool] = 0

A Boolean specifying whether the inertia relief loading should remain fixed at the current loading at the start of the step. The default value is OFF.

fixedState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the Boolean that identifies whether the inertia relief load should remain fixed at current level at the start of the step. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.

referencePoint: Optional[float] = None

A tuple of Floats specifying the point about which rotations are defined. The point can be specified only for certain combinations of free directions. The referencePoint argument can be one of the following: - The X, Y and Z coordinates of a fixed rotation point. - A point on the rotation axis. - A point on the symmetry line.

referencePointState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the reference point of the inertia relief load. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.

status: SymbolicConstant

A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:

• NOT_YET_ACTIVE

• CREATED

• PROPAGATED

• MODIFIED

• DEACTIVATED

• NO_LONGER_ACTIVE

• TYPE_NOT_APPLICABLE

• INSTANCE_NOT_APPLICABLE

• BUILT_INTO_BASE_STATE

u1: Union[AbaqusBoolean, bool] = 0

A Boolean specifying the 1-direction as a free direction.

u1State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the Boolean that identifies the local 1-direction as a free direction. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.

u2: Union[AbaqusBoolean, bool] = 0

A Boolean specifying the 2-direction as a free direction.

u2State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the Boolean that identifies the local 2-direction as a free direction. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.

u3: Union[AbaqusBoolean, bool] = 0

A Boolean specifying the 3-direction as a free direction.

u3State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the Boolean that identifies the local the 3-direction as a free direction. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.

ur1: Union[AbaqusBoolean, bool] = 0

A Boolean specifying the rotation about the 1-direction as a free direction.

ur1State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the Boolean that identifies rotation about the local 1-direction as a free direction. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.

ur2: Union[AbaqusBoolean, bool] = 0

A Boolean specifying the rotation about the 2-direction as a free direction.

ur2State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the Boolean that identifies the rotation about the local the 2-direction as a free direction. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.

ur3: Union[AbaqusBoolean, bool] = 0

A Boolean specifying the rotation about the 3-direction as a free direction.

ur3State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the Boolean that identifies the rotation about the local the 3-direction as a free direction. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.

class InwardVolAccel(name, createStepName, region, magnitude, distributionType=abaqusConstants.UNIFORM, field='', amplitude=abaqusConstants.UNSET)

Bases: Load

The InwardVolAccel object stores the data for an inward volume acceleration acoustic load. The InwardVolAccel object is derived from the Load object.

Note

This object can be accessed by:

import load
mdb.models[name].loads[name]

Note

Check InwardVolAccel on help.3ds.com/2023.

This method creates a InwardVolAccel object.

Note

This function can be accessed by:

mdb.models[name].InwardVolAccel

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created. This must be the name of the first analysis step.

• region (Region) – A Region object specifying the region to which the load is applied.

• magnitude (float) – A Float specifying the load magnitude.

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

Returns:

An InwardVolAccel object.

Return type:

InwardVolAccel

Member Details:

distributionType: SymbolicConstant = 'UNIFORM'

A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

field: str = ''

A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

name: str = ''

A String specifying the load repository key.

region: Region = <abaqus.Region.Region.Region object>

A Region object specifying the region to which the load is applied.

setValues(distributionType=abaqusConstants.UNIFORM, field='', amplitude=abaqusConstants.UNSET)

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

Note

Check InwardVolAccel.setValues on help.3ds.com/2023.

Parameters:

• distributionType (Literal[FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• amplitude (str, default: UNSET) – A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the load has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

setValuesInStep(stepName, magnitude=None, amplitude='')

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

Note

Check InwardVolAccel.setValuesInStep on help.3ds.com/2023.

Parameters:

• stepName (str) – A String specifying the name of the step in which the load is modified.

• magnitude (Optional[float], default: None) – A Float specifying the load magnitude.

• amplitude (str, default: '') – A String or a SymbolicConstant specifying the name of the amplitude reference. Possible values for the SymbolicConstant are UNCHANGED and FREED. UNCHANGED should be used if the amplitude is propagated from the previous static analysis step. FREED should be used if the load is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

class InwardVolAccelState

Bases: LoadState

The InwardVolAccelState object stores the propagating data of an inward volume acceleration acoustic load in a step. One instance of this object is created internally by the InwardVolAccel object for each step. The instance is also deleted internally by the InwardVolAccel object. The InwardVolAccelState object has no constructor or methods. The InwardVolAccelState object is derived from the LoadState object.

Note

This object can be accessed by:

import load
mdb.models[name].steps[name].loadStates[name]

The corresponding analysis keywords are:

• CLOAD

Note

Check InwardVolAccelState on help.3ds.com/2023.

Member Details:

amplitude: str = ''

A String specifying the name of the amplitude reference. The String is empty if the load has no amplitude reference.

amplitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the amplitude member. Possible values are UNSET, SET, UNCHANGED, and FREED.

magnitude: Optional[float] = None

A Float specifying the load magnitude.

magnitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the load magnitude. Possible values are UNSET, SET, UNCHANGED, and FREED.

status: SymbolicConstant

A SymbolicConstant specifying the propagation state of the LoadState object. Possible values are:

• NOT_YET_ACTIVE

• CREATED

• PROPAGATED

• MODIFIED

• DEACTIVATED

• NO_LONGER_ACTIVE

• TYPE_NOT_APPLICABLE

• INSTANCE_NOT_APPLICABLE

• BUILT_INTO_BASE_STATE

class LineLoad(name, createStepName, region, distributionType=abaqusConstants.UNIFORM, field='', comp1=None, comp2=None, comp3=None, amplitude=abaqusConstants.UNSET, system=abaqusConstants.GLOBAL)

Bases: Load

The LineLoad object stores the data of an applied line load. The LineLoad object is derived from the Load object.

Note

This object can be accessed by:

import load
mdb.models[name].loads[name]

Note

Check LineLoad on help.3ds.com/2023.

This method creates a LineLoad object.

Note

This function can be accessed by:

mdb.models[name].LineLoad

Parameters:

• name (str) – A String specifying the load repository key.

• createStepName (str) – A String specifying the name of the step in which the load is created.

• region (Region) – A Region object specifying the region to which the load is applied.

• distributionType (Literal[USER_DEFINED, FIELD, UNIFORM], default: UNIFORM) – A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

• field (str, default: '') – A String specifying the name of the AnalyticalField object associated with this load. The field argument applies only when distributionType = FIELD. The default value is an empty string.

• comp1 (Optional[float], default: None) – A Float or a Complex specifying the component of the load in the global or the beam local 1-direction. Note: Although comp1, comp2, and comp3 are optional arguments, at least one of them must be nonzero unless distributionType = USER_DEFINED.

• comp2 (Optional[float], default: None) – A Float or a Complex specifying the component of the load in the global or the beam local 2-direction.

• comp3 (Optional[