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: str, description: str = '', stefanBoltzmann: float | None = None, absoluteZero: float | None = None, waveFormulation: SymbolicConstantType = 'NOT_SET', modelType: SymbolicConstantType = 'STANDARD_EXPLICIT', universalGas: float | None = None, copyConstraints: BooleanType = 1, copyConnectors: BooleanType = 1, copyInteractions: BooleanType = 1)[source]#

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

Notes

This object can be accessed by:

mdb.models[name]

Methods

`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, magnitude)	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.
`ConcPoreFluid`(name, createStepName, region, ...)	This method creates a ConcPoreFluid object.
`ConcentratedForce`(name, createStepName, region)	This method creates a ConcentratedForce object.
`ConcentratedHeatFlux`(name, createStepName, ...)	This method creates a ConcentratedHeatFlux 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.

BodyCharge(name: str, createStepName: str, region: Region, magnitude: float, amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM', field: str = '') → BodyCharge[source]#

This method creates a BodyCharge object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created. This must be the first analysis step name.
region: A Region object specifying the region to which the load is applied.
magnitude: A Float specifying the load magnitude.
amplitude: 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: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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.

Notes

This function can be accessed by:

mdb.models[name].BodyCharge

BodyConcentrationFlux(name: str, createStepName: str, region: Region, magnitude: float, field: str = '', distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET') → BodyConcentrationFlux[source]#

This method creates a BodyConcentrationFlux object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created.
region: A Region object specifying the region to which the load is applied.
magnitude: A Float specifying the body concentration flux magnitude. magnitude is optional if *distributionType*=USER_DEFINED.
field: 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: 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: 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.

Notes

This function can be accessed by:

mdb.models[name].BodyConcentrationFlux

BodyCurrent(name: str, createStepName: str, region: Region, magnitude: float, amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM', field: str = '') → BodyCurrent[source]#

This method creates a BodyCurrent object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created. This must be the first analysis step name.
region: A Region object specifying the region to which the load is applied.
magnitude: A Float specifying the load magnitude.
amplitude: 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: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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.

Notes

This function can be accessed by:

mdb.models[name].BodyCurrent

BodyCurrentDensity(name: str, createStepName: str, region: Region, comp1: str, comp2: str, comp3: str, amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM') → BodyCurrentDensity[source]#

This method creates a BodyCurrentDensity object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created. This must be the first analysis step name.
region: A Region object specifying the region to which the load is applied.
comp1: A Complex specifying the first component of the load.
comp2: A Complex specifying the second component of the load.
comp3: A Complex specifying the third component of the load.
amplitude: 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: 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.

Notes

This function can be accessed by:

mdb.models[name].BodyCurrentDensity

BodyForce(name: str, createStepName: str, region: Region, field: str = '', distributionType: SymbolicConstantType = 'UNIFORM', comp1: float | None = None, comp2: float | None = None, comp3: float | None = None, amplitude: str = 'UNSET') → BodyForce[source]#

This method creates a BodyForce object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created.
region: A Region object specifying the region to which the load is applied.
field: 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: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
comp1: 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: A Float or a Complex specifying the body force component in the 2-direction.
comp3: A Float or a Complex specifying the body force component in the 3-direction.
amplitude: 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.

Notes

This function can be accessed by:

mdb.models[name].BodyForce

BodyHeatFlux(name: str, createStepName: str, region: Region, magnitude: float, field: str = '', distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET') → BodyHeatFlux[source]#

This method creates a BodyHeatFlux object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created.
region: A Region object specifying the region to which the load is applied.
magnitude: A Float specifying the body heat flux magnitude. magnitude is optional if *distributionType*=USER_DEFINED.
field: 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: 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: 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.

Notes

This function can be accessed by:

mdb.models[name].BodyHeatFlux

BoltLoad(name: str, createStepName: str, region: ~abaqus.Region.Region.Region, magnitude: float, boltMethod: ~abaqusConstants.SymbolicConstantType = 'APPLY_FORCE', datumAxis: ~abaqus.Datum.DatumAxis.DatumAxis = <abaqus.Datum.DatumAxis.DatumAxis object>, amplitude: str = 'UNSET', preTenSecPartLevel: ~abaqusConstants.BooleanType = False) → BoltLoad[source]#

This method creates a BoltLoad object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created. This must be the first analysis step name.
region: A Region object specifying the region to which the load is applied.
magnitude: A Float specifying the bolt load magnitude.
boltMethod: 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: 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: 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: 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.

Returns:

A BoltLoad object.

Raises:

TextError.

Notes

This function can be accessed by:

mdb.models[name].BoltLoad

ConcCharge(name: str, createStepName: str, region: Region, magnitude: float, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET') → ConcCharge[source]#

This method creates a ConcCharge object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created. This must be the first analysis step name.
region: A Region object specifying the region to which the load is applied.
magnitude: A Float specifying the load magnitude.
distributionType: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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: 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.

Notes

This function can be accessed by:

mdb.models[name].ConcCharge

ConcConcFlux(name: str, createStepName: str, region: Region, magnitude: float, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET') → ConcConcFlux[source]#

This method creates a ConcConcFlux object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created. This must be the first analysis step name.
region: A Region object specifying the region to which the load is applied.
magnitude: A Float specifying the load magnitude.
distributionType: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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: 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.

Notes

This function can be accessed by:

mdb.models[name].ConcConcFlux

ConcCurrent(name: str, createStepName: str, region: Region, magnitude: float, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET') → ConcCurrent[source]#

This method creates a ConcCurrent object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created. This must be the first analysis step name.
region: A Region object specifying the region to which the load is applied.
magnitude: A Float specifying the load magnitude.
distributionType: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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: 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.

Notes

This function can be accessed by:

mdb.models[name].ConcCurrent

ConcPoreFluid(name: str, createStepName: str, region: Region, magnitude: float, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET') → ConcPoreFluid[source]#

This method creates a ConcPoreFluid object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created. This must be the first analysis step name.
region: A Region object specifying the region to which the load is applied.
magnitude: A Float specifying the load magnitude.
distributionType: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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: 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.

Notes

This function can be accessed by:

mdb.models[name].ConcPoreFluid

ConcentratedForce(name: str, createStepName: str, region: Region, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', cf1: float | None = None, cf2: float | None = None, cf3: float | None = None, amplitude: str = 'UNSET', follower: BooleanType = 0, localCsys: int | None = None) → ConcentratedForce[source]#

This method creates a ConcentratedForce object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created.
region: A Region object specifying the region to which the load is applied.
distributionType: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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: 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: A Float or a Complex specifying the concentrated force component in the 2-direction.
cf3: A Float or a Complex specifying the concentrated force component in the 3-direction.
amplitude: 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: 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: 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.

Notes

This function can be accessed by:

mdb.models[name].ConcentratedForce

ConcentratedHeatFlux(name: str, createStepName: str, region: Region, magnitude: float, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET', dof: int = 11) → ConcentratedHeatFlux[source]#

This method creates a ConcentratedHeatFlux object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created. This must be the first analysis step name.
region: A Region object specifying the region to which the load is applied.
magnitude: A Float specifying the load magnitude.
distributionType: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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: 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: 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.

Notes

This function can be accessed by:

mdb.models[name].ConcentratedHeatFlux

ConnectorForce(name: str, createStepName: str, region: str = '', fastenerName: str = '', fastenerSetName: str = '', f1: float | None = None, f2: float | None = None, f3: float | None = None, amplitude: str = 'UNSET') → ConnectorForce[source]#

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.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created.
region: The wire region to which the load is applied. This argument is not valid when fastenerName and fastenerSetName are specified.
fastenerName: 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: 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: 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: A Float or a Complex specifying the connector force component in the connector’s local 2-direction.
f3: A Float or a Complex specifying the connector force component in the connector’s local 3-direction.
amplitude: 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.

Notes

This function can be accessed by:

mdb.models[name].ConnectorForce

ConnectorMoment(name: str, createStepName: str, region: str = '', fastenerName: str = '', fastenerSetName: str = '', m1: float | None = None, m2: float | None = None, m3: float | None = None, amplitude: str = 'UNSET') → ConnectorMoment[source]#

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.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created.
region: The wire region to which the load is applied. This argument is not valid when fastenerName and fastenerSetName are specified.
fastenerName: 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: 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: A Float or a Complex specifying the moment component in the connector’s local 4-direction.
m2: A Float or a Complex specifying the moment component in the connector’s local 5-direction.
m3: A Float or a Complex specifying the moment component in the connector’s local 6-direction.
amplitude: 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.

Notes

This function can be accessed by:

mdb.models[name].ConnectorMoment

CoriolisForce(name: str, createStepName: str, region: Region, magnitude: float, point1: tuple, point2: tuple, amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM', field: str = '') → CoriolisForce[source]#

This method creates a CoriolisForce object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created. This must be the first analysis step name.
region: A Region object specifying the region to which the load is applied.
magnitude: A Float specifying the load magnitude.
point1: A sequence of Floats specifying the first point on the axis of rotation for the load.
point2: A sequence of Floats specifying the second point on the axis of rotation for the load.
amplitude: 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: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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.

Notes

This function can be accessed by:

mdb.models[name].CoriolisForce

Gravity(name: str, createStepName: str, distributionType: ~abaqusConstants.SymbolicConstantType = 'UNIFORM', field: str = '', region: ~abaqus.Region.Region.Region = <abaqus.Region.Region.Region object>, comp1: float | None = None, comp2: float | None = None, comp3: float | None = None, amplitude: str = 'UNSET') → Gravity[source]#

This method creates a Gravity object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created.
distributionType: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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: A Region object specifying the region to which the load is applied.
comp1: 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: A Float or a Complex specifying the component of the load in the 2-direction.
comp3: A Float or a Complex specifying the component of the load in the 3-direction.
amplitude: 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.

Notes

This function can be accessed by:

mdb.models[name].Gravity

InertiaRelief(name: str, createStepName: str, u1: BooleanType = 0, u2: BooleanType = 0, u3: BooleanType = 0, ur1: BooleanType = 0, ur2: BooleanType = 0, ur3: BooleanType = 0, referencePoint: tuple = (), localCoordinates: int | None = None) → InertiaRelief[source]#

This method creates an InertiaRelief object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created.
u1: 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: A Boolean specifying the 2-direction as a free direction.
u3: A Boolean specifying the 3-direction as a free direction.
ur1: A Boolean specifying the rotation about the 1–direction as a free direction.
ur2: A Boolean specifying the rotation about the 2–direction as a free direction.
ur3: A Boolean specifying the rotation about the 3–direction as a free direction.
referencePoint: 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: 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.

Notes

This function can be accessed by:

mdb.models[name].InertiaRelief

InwardVolAccel(name: str, createStepName: str, region: Region, magnitude: float, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET') → InwardVolAccel[source]#

This method creates a InwardVolAccel object.

Parameters:

name: A String specifying the load repository key.
createStepName: 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: A Region object specifying the region to which the load is applied.
magnitude: A Float specifying the load magnitude.
distributionType: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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: 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.

Notes

This function can be accessed by:

mdb.models[name].InwardVolAccel

LineLoad(name: str, createStepName: str, region: Region, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', comp1: float | None = None, comp2: float | None = None, comp3: float | None = None, amplitude: str = 'UNSET', system: SymbolicConstantType = 'GLOBAL') → LineLoad[source]#

This method creates a LineLoad object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created.
region: A Region object specifying the region to which the load is applied.
distributionType: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
field: 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: 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: A Float or a Complex specifying the component of the load in the global or the beam local 2-direction.
comp3: A Float or a Complex specifying the component of the load in the global 3-direction.
amplitude: 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: 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.

Notes

This function can be accessed by:

mdb.models[name].LineLoad

Moment(name: str, createStepName: str, region: Region, cm1: float | None = None, cm2: float | None = None, cm3: float | None = None, amplitude: str = 'UNSET', follower: BooleanType = 0, localCsys: int | None = None, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '') → Moment[source]#

This method creates a Moment object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created.
region: A Region object specifying the region to which the load is applied.
cm1: 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: A Float or a Complex specifying the load component in the 5- direction.
cm3: A Float or a Complex specifying the load component in the 6-direction.
amplitude: 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: 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: 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: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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.

Notes

This function can be accessed by:

mdb.models[name].Moment

PEGLoad(name: str, createStepName: str, region: Region, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', comp1: float | None = None, comp2: float | None = None, comp3: float | None = None, amplitude: str = 'UNSET') → PEGLoad[source]#

This method creates a PEGLoad object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created.
region: A Region object specifying the region to which the load is applied.
distributionType: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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: 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: A Float or a Complex specifying the load component at dof 1 of reference node 2.
comp3: A Float or a Complex specifying the load component at dof 2 of reference node 2.
amplitude: 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.

Notes

This function can be accessed by:

mdb.models[name].PEGLoad

PipePressure(name: str, createStepName: str, region: Region, magnitude: float, diameter: float, hZero: float, hReference: float, field: str = '', amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM', side: SymbolicConstantType = 'INTERNAL') → PipePressure[source]#

This method creates a Pressure object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the pressure is created.
region: A Region object specifying the region to which the load is applied.
magnitude: A Float specifying the pressure magnitude.Note:magnitude is optional if *distributionType*=USER_DEFINED.
diameter: A Float specifying the effective inner or outer diameter.
hZero: A Float specifying the height of the zero pressure level when *distributionType*=HYDROSTATIC.
hReference: A Float specifying the height of the reference pressure level when *distributionType*=HYDROSTATIC.
field: 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: 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: A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM, HYDROSTATIC, USER_DEFINED, and FIELD. The default value is UNIFORM.
side: 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.

Notes

This function can be accessed by:

mdb.models[name].PipePressure

Pressure(name: str, createStepName: str, region: Region, magnitude: float = 0.0, hZero: float = 0.0, hReference: float = 0.0, field: str = '', refPoint: str = '', distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET') → Pressure[source]#

This method creates a Pressure object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the pressure is created.
region: A Region object specifying the region to which the load is applied.
magnitude: A Float or a Complex specifying the pressure magnitude.Note:magnitude is optional if *distributionType*=USER_DEFINED.
hZero: A Float specifying the height of the zero pressure level when *distributionType*=HYDROSTATIC.
hReference: A Float specifying the height of the reference pressure level when *distributionType*=HYDROSTATIC.
field: 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: A Region specifying the reference point from which the relative velocity is determined when *distributionType*=STAGNATION or VISCOUS.
distributionType: 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: 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.

Notes

This function can be accessed by:

mdb.models[name].Pressure

RotationalBodyForce(name: str, createStepName: str, region: Region, magnitude: float, point1: tuple, point2: tuple, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', centrifugal: BooleanType = 0, rotaryAcceleration: BooleanType = 0, amplitude: str = 'UNSET') → RotationalBodyForce[source]#

This method creates a RotationalBodyForce object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created. This must be the first analysis step name.
region: A Region object specifying the region to which the load is applied.
magnitude: A Float specifying the load magnitude.
point1: A sequence of Floats specifying the first point on the axis of rotation for the load.
point2: A sequence of Floats specifying the second point on the axis of rotation for the load.
distributionType: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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: 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: 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: 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.

Notes

This function can be accessed by:

mdb.models[name].RotationalBodyForce

ShellEdgeLoad(name: str, createStepName: str, region: Region, magnitude: float, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET', angle: float = 0, axis: SymbolicConstantType = 'AXIS_1', localCsys: int = 'GENERAL', userCsys: str = 'GENERAL', directionVector: tuple = (), follower: BooleanType = 1, resultant: BooleanType = 0, traction: SymbolicConstantType = 'NORMAL') → ShellEdgeLoad[source]#

This method creates a ShellEdgeLoad object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created.
region: A Region object specifying the region to which the load is applied.
magnitude: A Float or Complex specifying the load magnitude. magnitude is optional if *distributionType*=USER_DEFINED
distributionType: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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.

Notes

This function can be accessed by:

mdb.models[name].ShellEdgeLoad

SubmodelSB(name: str, createStepName: str, region: Region, globalStep: str, globalDrivingRegion: str = '', absoluteExteriorTolerance: float | None = None, exteriorTolerance: float = 0, globalIncrement: int = 0) → SubmodelSB[source]#

This method creates a SubmodelSB object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created.
region: A Region object specifying the region to which the load is applied.
globalStep: 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: 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: 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: 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: 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.

Notes

This function can be accessed by:

mdb.models[name].SubmodelSB

SubstructureLoad(name: str, createStepName: str, region: Region, loadCaseNames: str, magnitude: float, amplitude: str = 'UNSET') → SubstructureLoad[source]#

This method creates a SubstructureLoad object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the substructure load is created.
region: A Region object specifying the region to which the load is applied.
loadCaseNames: A list of names of the load cases that should be activated by this substructure load.
magnitude: A Float specifying the multiplier for the load case magnitude.
amplitude: 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.

Notes

This function can be accessed by:

mdb.models[name].SubstructureLoad

SurfaceCharge(name: str, createStepName: str, region: Region, magnitude: float, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET') → SurfaceCharge[source]#

This method creates a SurfaceCharge object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created. This must be the first analysis step name.
region: A Region object specifying the region to which the load is applied.
magnitude: A Float specifying the load magnitude.
distributionType: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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: 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.

Notes

This function can be accessed by:

mdb.models[name].SurfaceCharge

SurfaceConcentrationFlux(name: str, createStepName: str, region: Region, magnitude: float, field: str = '', distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET') → SurfaceConcentrationFlux[source]#

This method creates a SurfaceConcentrationFlux object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created.
region: A Region object specifying the region to which the load is applied.
magnitude: A Float specifying the surface concentration flux magnitude. magnitude is optional if *distributionType*=USER_DEFINED.
field: 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: 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: 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.

Notes

This function can be accessed by:

mdb.models[name].SurfaceConcentrationFlux

SurfaceCurrent(name: str, createStepName: str, region: Region, magnitude: float, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET') → SurfaceCurrent[source]#

This method creates a SurfaceCurrent object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created. This must be the first analysis step name.
region: A Region object specifying the region to which the load is applied.
magnitude: A Float specifying the load magnitude.
distributionType: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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: 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.

Notes

This function can be accessed by:

mdb.models[name].SurfaceCurrent

SurfaceCurrentDensity(name: str, createStepName: str, region: Region, comp1: str, comp2: str, comp3: str, distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET') → SurfaceCurrentDensity[source]#

This method creates a SurfaceCurrentDensity object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created. This must be the first analysis step name.
region: A Region object specifying the region to which the load is applied.
comp1: A Complex specifying the first component of the load.
comp2: A Complex specifying the second component of the load.
comp3: A Complex specifying the third component of the load.
distributionType: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM.
amplitude: 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.

Notes

This function can be accessed by:

mdb.models[name].SurfaceCurrentDensity

SurfaceHeatFlux(name: str, createStepName: str, region: Region, magnitude: float, field: str = '', distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET') → SurfaceHeatFlux[source]#

This method creates a SurfaceHeatFlux object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created.
region: A Region object specifying the region to which the load is applied.
magnitude: A Float specifying the surface heat flux magnitude. magnitude is optional if *distributionType*=USER_DEFINED.
field: 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: 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: 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.

Notes

This function can be accessed by:

mdb.models[name].SurfaceHeatFlux

SurfacePoreFluid(name: str, createStepName: str, region: Region, magnitude: float, field: str = '', distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET') → SurfacePoreFluid[source]#

This method creates a SurfacePoreFluid object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created.
region: A Region object specifying the region to which the load is applied.
magnitude: A Float specifying the surface pore fluid flow magnitude. magnitude is optional if *distributionType*=USER_DEFINED.
field: 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: A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
amplitude: 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.

Notes

This function can be accessed by:

mdb.models[name].SurfacePoreFluid

SurfaceTraction(name: str, createStepName: str, region: Region, magnitude: float, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET', angle: float = 0, axis: SymbolicConstantType = 'AXIS_1', localCsys: int | None = None, userCsys: str = '', directionVector: tuple = (), follower: BooleanType = 1, resultant: BooleanType = 0, traction: SymbolicConstantType = 'SHEAR') → SurfaceTraction[source]#

This method creates a SurfaceTraction object.

Parameters:

name: A String specifying the load repository key.
createStepName: A String specifying the name of the step in which the load is created.
region: A Region object specifying the region to which the load is applied.
magnitude: A Float or Complex specifying the load magnitude. magnitude is optional if *distributionType*=USER_DEFINED.
distributionType: A SymbolicConstant specifying how the surface traction is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
field: 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: 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: A Float specifying an additional rotation of directionVector about an axis. The default value is 0.0.
axis: 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: 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: 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: 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: 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: 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: A SymbolicConstant specifying how to apply surface traction. Possible values are SHEAR and GENERAL. The default value is SHEAR.

Returns:

A SurfaceTraction object.

Notes

This function can be accessed by:

mdb.models[name].SurfaceTraction

Object features of loads#

Load#

class Load[source]#

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.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`deactivate`(stepName)	This method deactivates the load in the specified step and all its subsequent steps.
`delete`(indices)	This method allows you to delete existing loads.
`move`(fromStepName, toStepName)	This method moves the load state object from one step to a different step.
`reset`(stepName)	This method resets the load state of the specified step to the state of the previous general analysis step.
`resume`()	This method resumes the load that was previously suppressed.
`suppress`()	This method suppresses the load.

deactivate(stepName: str)[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the load is deactivated.

delete(indices: tuple)[source]#

This method allows you to delete existing loads.

Parameters:

indices: A sequence of Ints specifying the index of each load to delete.

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

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

Parameters:

fromStepName: A String specifying the name of the step from which the load state is moved.
toStepName: A String specifying the name of the step to which the load state is moved.

reset(stepName: str)[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the load state is reset.

resume()[source]#: This method resumes the load that was previously suppressed.

suppress()[source]#: This method suppresses the load.

LoadState#

class LoadState[source]#

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.

Notes

This object can be accessed by:

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

Attributes:

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:

amplitude: str

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

BodyCharge#

class BodyCharge(name: str, createStepName: str, region: Region, magnitude: float, amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM', field: str = '')[source]#

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

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
distributionType: SymbolicConstant: 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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([amplitude, distributionType, field])	This method modifies the data for an existing BodyCharge object in the step where it is created.
`setValuesInStep`(stepName[, magnitude, amplitude])	This method modifies the propagating data for an existing BodyCharge object in the specified step.

setValues(amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM', field: str = '')[source]#

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

Parameters:

amplitude: 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: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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: str, magnitude: float | None = None, amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the load is modified.
magnitude: A Float specifying the load magnitude.
amplitude: 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.

BodyChargeState#

class BodyChargeState[source]#

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.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

DECHARGE

Attributes:

magnitude: float

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.

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:

amplitude: str

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

BodyConcentrationFlux#

class BodyConcentrationFlux(name: str, createStepName: str, region: Region, magnitude: float, field: str = '', distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET')[source]#

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

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
distributionType: SymbolicConstant: 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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([field, distributionType, amplitude])	This method modifies the data for an existing BodyConcentrationFlux object in the step where it is created.
`setValuesInStep`(stepName[, magnitude, amplitude])	This method modifies the propagating data for an existing BodyConcentrationFlux object in the specified step.

setValues(field: str = '', distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET')[source]#

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

Parameters:

field: 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: 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: 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: str, magnitude: float | None = None, amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the Body heat flux is modified.
magnitude: A Float specifying the Body concentration flux magnitude.
amplitude: 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.

BodyConcentrationFluxState#

class BodyConcentrationFluxState[source]#

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.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

CFLUX

Attributes:

magnitude: float

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.

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:

amplitude: str

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

BodyCurrent#

class BodyCurrent(name: str, createStepName: str, region: Region, magnitude: float, amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM', field: str = '')[source]#

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

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
distributionType: SymbolicConstant: 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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([amplitude, distributionType, field])	This method modifies the data for an existing BodyCurrent object in the step where it is created.
`setValuesInStep`(stepName[, magnitude, amplitude])	This method modifies the propagating data for an existing BodyCurrent object in the specified step.

setValues(amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM', field: str = '')[source]#

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

Parameters:

amplitude: 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: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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: str, magnitude: float | None = None, amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the load is modified.
magnitude: A Float specifying the load magnitude.
amplitude: 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.

BodyCurrentDensity#

class BodyCurrentDensity(name: str, createStepName: str, region: Region, comp1: str, comp2: str, comp3: str, amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM')[source]#

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

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
distributionType: SymbolicConstant: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([amplitude, distributionType])	This method modifies the data for an existing BodyCurrentDensity object in the step where it is created.
`setValuesInStep`(stepName[, comp1, comp2, ...])	This method modifies the propagating data for an existing BodyCurrentDensity object in the specified step.

setValues(amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM')[source]#

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

Parameters:

amplitude: 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: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM.

setValuesInStep(stepName: str, comp1: str = '', comp2: str = '', comp3: str = '', amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the load is modified.
comp1: A Complex specifying the first component of the load.
comp2: A Complex specifying the second component of the load.
comp3: A Complex specifying the third component of the load.
amplitude: 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.

BodyCurrentState#

class BodyCurrentState[source]#

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.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

DECURRENT

Attributes:

magnitude: float

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.

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:

amplitude: str

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

BodyForce#

class BodyForce(name: str, createStepName: str, region: Region, field: str = '', distributionType: SymbolicConstantType = 'UNIFORM', comp1: float | None = None, comp2: float | None = None, comp3: float | None = None, amplitude: str = 'UNSET')[source]#

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

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

DLOAD

Attributes:

name: str: A String specifying the load repository key.
distributionType: SymbolicConstant: 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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([field, distributionType, comp1, ...])	This method modifies the data for an existing BodyForce object in the step where it is created.
`setValuesInStep`(stepName[, comp1, comp2, ...])	This method modifies the propagating data for an existing BodyForce object in the specified step.

setValues(field: str = '', distributionType: SymbolicConstantType = 'UNIFORM', comp1: float | None = None, comp2: float | None = None, comp3: float | None = None, amplitude: str = 'UNSET')[source]#

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

Parameters:

field: 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: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
comp1: 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: A Float or a Complex specifying the body force component in the 2-direction.
comp3: A Float or a Complex specifying the body force component in the 3-direction.
amplitude: 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.

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

Parameters:

stepName: A String specifying the name of the step in which the load is modified.
comp1: 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: 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: 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: 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.

BodyForceState#

class BodyForceState[source]#

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.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

DLOAD

Attributes:

comp1: float

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

comp2: float

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

comp3: float

A Float or a Complex specifying the body force component in the 3-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.

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.

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.

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:

amplitude: str

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

BodyHeatFlux#

class BodyHeatFlux(name: str, createStepName: str, region: Region, magnitude: float, field: str = '', distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET')[source]#

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

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
distributionType: SymbolicConstant: 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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([field, distributionType, amplitude])	This method modifies the data for an existing BodyHeatFlux object in the step where it is created.
`setValuesInStep`(stepName[, magnitude, amplitude])	This method modifies the propagating data for an existing BodyHeatFlux object in the specified step.

setValues(field: str = '', distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET')[source]#

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

Parameters:

field: 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: 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: 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: str, magnitude: float | None = None, amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the body heat flux is modified.
magnitude: A Float specifying the body heat flux magnitude.
amplitude: 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.

BodyHeatFluxState#

class BodyHeatFluxState[source]#

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.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

DFLUX

Attributes:

magnitude: float

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.

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:

amplitude: str

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

BoltLoad#

class BoltLoad(name: str, createStepName: str, region: ~abaqus.Region.Region.Region, magnitude: float, boltMethod: ~abaqusConstants.SymbolicConstantType = 'APPLY_FORCE', datumAxis: ~abaqus.Datum.DatumAxis.DatumAxis = <abaqus.Datum.DatumAxis.DatumAxis object>, amplitude: str = 'UNSET', preTenSecPartLevel: ~abaqusConstants.BooleanType = False)[source]#

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

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

PRE-TENSION SECTION
- NODE
- NSET

Attributes:

name: str: A String specifying the load repository key.
datumAxis: DatumAxis: 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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([boltMethod, datumAxis, ...])	This method modifies the data for an existing BoltLoad object in the step where it is created.
`setValuesInStep`(stepName[, boltMethod, ...])	This method modifies the propagating data for an existing BoltLoad object in the specified step.

setValues(boltMethod: ~abaqusConstants.SymbolicConstantType = 'APPLY_FORCE', datumAxis: ~abaqus.Datum.DatumAxis.DatumAxis = <abaqus.Datum.DatumAxis.DatumAxis object>, amplitude: str = 'UNSET', preTenSecPartLevel: ~abaqusConstants.BooleanType = False)[source]#

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

Parameters:

boltMethod: 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: 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: 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: 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: str, boltMethod: SymbolicConstantType = 'APPLY_FORCE', magnitude: float | None = None, amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the load is modified.
boltMethod: A SymbolicConstant specifying the type of bolt load. Possible values are APPLY_FORCE, ADJUST_LENGTH, and FIX_LENGTH. The default is APPLY_FORCE.
magnitude: A Float specifying the bolt load magnitude.
amplitude: 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.

BoltLoadState#

class BoltLoadState[source]#

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.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

CLOAD
- BOUNDARY

Attributes:

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: float

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.

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:

amplitude: str

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

ConcCharge#

class ConcCharge(name: str, createStepName: str, region: Region, magnitude: float, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET')[source]#

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

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
distributionType: SymbolicConstant: 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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([distributionType, field, amplitude])	This method modifies the data for an existing ConcCharge object in the step where it is created.
`setValuesInStep`(stepName[, magnitude, amplitude])	This method modifies the propagating data for an existing ConcCharge object in the specified step.

setValues(distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET')[source]#

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

Parameters:

distributionType: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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: 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: str, magnitude: float | None = None, amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the load is modified.
magnitude: A Float specifying the load magnitude.
amplitude: 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.

ConcConcFlux#

class ConcConcFlux(name: str, createStepName: str, region: Region, magnitude: float, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET')[source]#

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

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
distributionType: SymbolicConstant: 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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([distributionType, field, amplitude])	This method modifies the data for an existing ConcConcFlux object in the step where it is created.
`setValuesInStep`(stepName[, magnitude, amplitude])	This method modifies the propagating data for an existing ConcConcFlux object in the specified step.

setValues(distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET')[source]#

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

Parameters:

distributionType: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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: 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: str, magnitude: float | None = None, amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the load is modified.
magnitude: A Float specifying the load magnitude.
amplitude: 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.

ConcCurrent#

class ConcCurrent(name: str, createStepName: str, region: Region, magnitude: float, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET')[source]#

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

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
distributionType: SymbolicConstant: 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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([distributionType, field, amplitude])	This method modifies the data for an existing ConcCurrent object in the step where it is created.
`setValuesInStep`(stepName[, magnitude, amplitude])	This method modifies the propagating data for an existing ConcCurrent object in the specified step.

setValues(distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET')[source]#

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

Parameters:

distributionType: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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: 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: str, magnitude: float | None = None, amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the load is modified.
magnitude: A Float specifying the load magnitude.
amplitude: 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.

ConcCurrentState#

class ConcCurrentState[source]#

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.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

CECURRENT

Attributes:

magnitude: float

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.

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:

amplitude: str

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

ConcentratedChargeState#

class ConcentratedChargeState[source]#

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.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

CECHARGE

Attributes:

magnitude: float

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.

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:

amplitude: str

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

ConcentratedConcentrationFluxState#

class ConcentratedConcentrationFluxState[source]#

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.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

CFLUX

Attributes:

magnitude: float

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.

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:

amplitude: str

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

ConcentratedForce#

class ConcentratedForce(name: str, createStepName: str, region: Region, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', cf1: float | None = None, cf2: float | None = None, cf3: float | None = None, amplitude: str = 'UNSET', follower: BooleanType = 0, localCsys: int | None = None)[source]#

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

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
distributionType: SymbolicConstant: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
follower: Boolean: 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: int: 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.
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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([distributionType, field, cf1, ...])	This method modifies the data for an existing ConcentratedForce object in the step where it is created.
`setValuesInStep`(stepName[, cf1, cf2, cf3, ...])	This method modifies the propagating data for an existing ConcentratedForce object in the specified step.

setValues(distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', cf1: float | None = None, cf2: float | None = None, cf3: float | None = None, amplitude: str = 'UNSET', follower: BooleanType = 0, localCsys: int | None = None)[source]#

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

Parameters:

distributionType: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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: 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: A Float or a Complex specifying the concentrated force component in the 2-direction.
cf3: A Float or a Complex specifying the concentrated force component in the 3-direction.
amplitude: 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: 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: 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.

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

Parameters:

stepName: A String specifying the name of the step in which the load is modified.
cf1: 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: 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: 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: 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.

ConcentratedForceState#

class ConcentratedForceState[source]#

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.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

CLOAD

Attributes:

cf1: float

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: float

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

cf3: float

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

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.

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.

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.

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:

amplitude: str

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

ConcentratedHeatFlux#

class ConcentratedHeatFlux(name: str, createStepName: str, region: Region, magnitude: float, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET', dof: int = 11)[source]#

The ConcentratedHeatFlux object stores the data for a concentrated heat flux load. The ConcentratedHeatFlux object is derived from the Load object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
distributionType: SymbolicConstant: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
dof: int: 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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([distributionType, field, ...])	This method modifies the data for an existing ConcentratedHeatFlux object in the step where it is created.
`setValuesInStep`(stepName[, magnitude, amplitude])	This method modifies the propagating data for an existing ConcentratedHeatFlux object in the specified step.

setValues(distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET', dof: int = 11)[source]#

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

Parameters:

distributionType: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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: 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: 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: str, magnitude: float | None = None, amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the load is modified.
magnitude: A Float specifying the load magnitude.
amplitude: 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.

ConcentratedHeatFluxState#

class ConcentratedHeatFluxState[source]#

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.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

CFLUX

Attributes:

magnitude: float

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.

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:

amplitude: str

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

ConcentratedPoreFluidState#

class ConcentratedPoreFluidState[source]#

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.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

CLOAD

Attributes:

magnitude: float

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.

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:

amplitude: str

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

ConcPoreFluid#

class ConcPoreFluid(name: str, createStepName: str, region: Region, magnitude: float, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET')[source]#

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

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
distributionType: SymbolicConstant: 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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([distributionType, field, amplitude])	This method modifies the data for an existing ConcPoreFluid object in the step where it is created.
`setValuesInStep`(stepName[, magnitude, amplitude])	This method modifies the propagating data for an existing ConcPoreFluid object in the specified step.

setValues(distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET')[source]#

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

Parameters:

distributionType: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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: 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: str, magnitude: float | None = None, amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the load is modified.
magnitude: A Float specifying the load magnitude.
amplitude: 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.

ConnectorForce#

class ConnectorForce(name: str, createStepName: str, region: str = '', fastenerName: str = '', fastenerSetName: str = '', f1: float | None = None, f2: float | None = None, f3: float | None = None, amplitude: str = 'UNSET')[source]#

The ConnectorForce object defines a connector force. The ConnectorForce object is derived from the Load object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([region, fastenerName, ...])	This method modifies the data for an existing ConnectorForce object in the step where it is created.
`setValuesInStep`(stepName[, f1, f2, f3, ...])	This method modifies the propagating data for an existing ConnectorForce object in the specified step.

setValues(region: str = '', fastenerName: str = '', fastenerSetName: str = '', f1: float | None = None, f2: float | None = None, f3: float | None = None, amplitude: str = 'UNSET')[source]#

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

Parameters:

region: The wire region to which the load is applied. This argument is not valid when fastenerName and fastenerSetName are specified.
fastenerName: 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: 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: 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: A Float or a Complex specifying the connector force component in the connector’s local 2-direction.
f3: A Float or a Complex specifying the connector force component in the connector’s local 3-direction.
amplitude: 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.

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

Parameters:

stepName: A String specifying the name of the step in which the load is modified.
f1: 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: 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: 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: 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.

ConnectorForceState#

class ConnectorForceState[source]#

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.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

CONNECTOR LOAD

Attributes:

f1: float

A Float or a Complex specifying the connector force component in the connector’s local 1-direction.

f2: float

A Float or a Complex specifying the connector force component in the connector’s local 2-direction.

f3: float

A Float or a Complex specifying the connector force component in the connector’s local 3-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.

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.

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.

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:

amplitude: str

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

ConnectorMoment#

class ConnectorMoment(name: str, createStepName: str, region: str = '', fastenerName: str = '', fastenerSetName: str = '', m1: float | None = None, m2: float | None = None, m3: float | None = None, amplitude: str = 'UNSET')[source]#

The ConnectorMoment object stores the data for a connector moment. The ConnectorMoment object is derived from the Load object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([region, fastenerName, ...])	This method modifies the data for an existing ConnectorMoment object in the step where it is created.
`setValuesInStep`(stepName[, m1, m2, m3, ...])	This method modifies the propagating data for an existing ConnectorMoment object in the specified step.

setValues(region: str = '', fastenerName: str = '', fastenerSetName: str = '', m1: float | None = None, m2: float | None = None, m3: float | None = None, amplitude: str = 'UNSET')[source]#

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

Parameters:

region: The wire region to which the load is applied. This argument is not valid when fastenerName and fastenerSetName are specified.
fastenerName: 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: 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: A Float or a Complex specifying the moment component in the connector’s local 4-direction.
m2: A Float or a Complex specifying the moment component in the connector’s local 5-direction.
m3: A Float or a Complex specifying the moment component in the connector’s local 6-direction.
amplitude: 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.

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

Parameters:

stepName: A String specifying the name of the step in which the load is modified.
m1: 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: 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: 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: 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.

ConnectorMomentState#

class ConnectorMomentState[source]#

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.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

CONNECTOR LOAD

Attributes:

m1: float

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.

m2: float

A Float or a Complex specifying the connector moment component in the connector’s local 5direction.

m3: float

A Float or a Complex specifying the connector moment component in the connector’s local 6-direction.

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.

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.

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.

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:

amplitude: str

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

CoriolisForce#

class CoriolisForce(name: str, createStepName: str, region: Region, magnitude: float, point1: tuple, point2: tuple, amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM', field: str = '')[source]#

The CoriolisForce object stores the data for a coriolis force. The CoriolisForce object is derived from the Load object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
distributionType: SymbolicConstant: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
point1: float: A tuple of Floats specifying the first point on the axis of rotation for the load.
point2: float: A tuple of Floats specifying the second point on the axis of rotation for the load.
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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([amplitude, distributionType, field])	This method modifies the data for an existing CoriolisForce object in the step where it is created.
`setValuesInStep`(stepName[, magnitude, amplitude])	This method modifies the propagating data for an existing CoriolisForce object in the specified step.

setValues(amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM', field: str = '')[source]#

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

Parameters:

amplitude: 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: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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: str, magnitude: float | None = None, amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the load is modified.
magnitude: A Float specifying the load magnitude.
amplitude: 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.

CoriolisForceState#

class CoriolisForceState[source]#

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.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

DLOAD

Attributes:

magnitude: float

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.

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:

amplitude: str

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

Gravity#

class Gravity(name: str, createStepName: str, distributionType: ~abaqusConstants.SymbolicConstantType = 'UNIFORM', field: str = '', region: ~abaqus.Region.Region.Region = <abaqus.Region.Region.Region object>, comp1: float | None = None, comp2: float | None = None, comp3: float | None = None, amplitude: str = 'UNSET')[source]#

The Gravity object stores the data of a gravity load. The Gravity object is derived from the Load object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
distributionType: SymbolicConstant: 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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([distributionType, field, region, ...])	This method modifies the data for an existing Gravity object in the step where it is created.
`setValuesInStep`(stepName[, comp1, comp2, ...])	This method modifies the propagating data for an existing Gravity object in the specified step.

setValues(distributionType: ~abaqusConstants.SymbolicConstantType = 'UNIFORM', field: str = '', region: ~abaqus.Region.Region.Region = <abaqus.Region.Region.Region object>, comp1: float | None = None, comp2: float | None = None, comp3: float | None = None, amplitude: str = 'UNSET')[source]#

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

Parameters:

distributionType: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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: A Region object specifying the region to which the load is applied.
comp1: 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: A Float or a Complex specifying the component of the load in the 2-direction.
comp3: A Float or a Complex specifying the component of the load in the 3-direction.
amplitude: 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.

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

Parameters:

stepName: A String specifying the name of the step in which the load is modified.
comp1: 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: A Float, a Complex, or a SymbolicConstant specifying the load component in the 2-direction. For details see comp1.
comp3: A Float, a Complex, or a SymbolicConstant specifying the load component in the 3-direction. For details see comp1.
amplitude: 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.

GravityState#

class GravityState[source]#

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.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

DLOAD

Attributes:

comp1: float

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

comp2: float

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

comp3: float

A Float or a Complex specifying the load component in the 3-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.

comp2State: SymbolicConstant

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

comp3State: SymbolicConstant

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

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:

amplitude: str

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

HydrostaticFluidFlowState#

class HydrostaticFluidFlowState[source]#

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.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

FLUID FLUX

Attributes:

magnitude: float

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.

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:

amplitude: str

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

InertiaRelief#

class InertiaRelief(name: str, createStepName: str, u1: BooleanType = 0, u2: BooleanType = 0, u3: BooleanType = 0, ur1: BooleanType = 0, ur2: BooleanType = 0, ur3: BooleanType = 0, referencePoint: tuple = (), localCoordinates: int | None = None)[source]#

The InertiaRelief object defines an inertia relief load. The InertiaRelief object is derived from the Load object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
localCoordinates: int: 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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([u1, u2, u3, ur1, ur2, ur3, ...])	This method modifies the data for an existing InertiaRelief object in the step where it is created.
`setValuesInStep`(stepName[, u1, u2, u3, ur1, ...])	This method modifies the propagating data for an existing InertiaRelief object in the specified step.

setValues(u1: BooleanType = 0, u2: BooleanType = 0, u3: BooleanType = 0, ur1: BooleanType = 0, ur2: BooleanType = 0, ur3: BooleanType = 0, referencePoint: tuple = (), localCoordinates: int | None = None)[source]#

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

Parameters:

u1: 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: A Boolean specifying the 2-direction as a free direction.
u3: A Boolean specifying the 3-direction as a free direction.
ur1: A Boolean specifying the rotation about the 1–direction as a free direction.
ur2: A Boolean specifying the rotation about the 2–direction as a free direction.
ur3: A Boolean specifying the rotation about the 3–direction as a free direction.
referencePoint: 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: 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: str, u1: BooleanType = 0, u2: BooleanType = 0, u3: BooleanType = 0, ur1: BooleanType = 0, ur2: BooleanType = 0, ur3: BooleanType = 0, referencePoint: tuple = (), fixed: BooleanType = 0)[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the load is modified.
u1: A Boolean specifying the 1-direction as a free direction.
u2: A Boolean specifying the 2-direction as a free direction.
u3: A Boolean specifying the 3-direction as a free direction.
ur1: A Boolean specifying the rotation about the 1–direction as a free direction.
ur2: A Boolean specifying the rotation about the 2–direction as a free direction.
ur3: A Boolean specifying the rotation about the 3–direction as a free direction.
referencePoint: 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: 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.

InertiaReliefState#

class InertiaReliefState[source]#

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.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

INERTIA RELIEF

Attributes:

u1: Boolean

A Boolean specifying the 1-direction as a free direction.

u2: Boolean

A Boolean specifying the 2-direction as a free direction.

u3: Boolean

A Boolean specifying the 3-direction as a free direction.

ur1: Boolean

A Boolean specifying the rotation about the 1–direction as a free direction.

ur2: Boolean

A Boolean specifying the rotation about the 2–direction as a free direction.

ur3: Boolean

A Boolean specifying the rotation about the 3–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.

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.

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.

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.

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.

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.

fixed: Boolean

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.

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.

referencePoint: float

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:

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:

amplitude: str

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

InwardVolAccel#

class InwardVolAccel(name: str, createStepName: str, region: Region, magnitude: float, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET')[source]#

The InwardVolAccel object stores the data for an inward volume acceleration acoustic load. The InwardVolAccel object is derived from the Load object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
distributionType: SymbolicConstant: 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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([distributionType, field, amplitude])	This method modifies the data for an existing InwardVolAccel object in the step where it is created.
`setValuesInStep`(stepName[, magnitude, amplitude])	This method modifies the propagating data for an existing InwardVolAccel object in the specified step.

setValues(distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET')[source]#

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

Parameters:

distributionType: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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: 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: str, magnitude: float | None = None, amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the load is modified.
magnitude: A Float specifying the load magnitude.
amplitude: 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.

InwardVolAccelState#

class InwardVolAccelState[source]#

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.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

CLOAD

Attributes:

magnitude: float

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.

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:

amplitude: str

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

LineLoad#

class LineLoad(name: str, createStepName: str, region: Region, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', comp1: float | None = None, comp2: float | None = None, comp3: float | None = None, amplitude: str = 'UNSET', system: SymbolicConstantType = 'GLOBAL')[source]#

The LineLoad object stores the data of an applied line load. The LineLoad object is derived from the Load object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
distributionType: SymbolicConstant: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
system: SymbolicConstant: 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.
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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([distributionType, field, comp1, ...])	This method modifies the data for an existing LineLoad object in the step where it is created.
`setValuesInStep`(stepName[, comp1, comp2, ...])	This method modifies the propagating data for an existing LineLoad object in the specified step.

setValues(distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', comp1: float | None = None, comp2: float | None = None, comp3: float | None = None, amplitude: str = 'UNSET', system: SymbolicConstantType = 'GLOBAL')[source]#

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

Parameters:

distributionType: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
field: 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: 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: A Float or a Complex specifying the component of the load in the global or the beam local 2-direction.
comp3: A Float or a Complex specifying the component of the load in the global 3-direction.
amplitude: 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: 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.

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

Parameters:

stepName: A String specifying the name of the step in which the load is modified.
comp1: A Float, a Complex, or a SymbolicConstant specifying the load component in the global or the beam local 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: A Float, a Complex, or a SymbolicConstant specifying the load component in the global or the beam local 2-direction. For details see comp1.
comp3: A Float, a Complex, or a SymbolicConstant specifying the load component in the global 3-direction. For details see comp1.
amplitude: 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.

LineLoadState#

class LineLoadState[source]#

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

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

DLOAD

Attributes:

comp1: float

A Float or a Complex specifying the load component in the global or the beam local 1-direction.

comp2: float

A Float or a Complex specifying the load component in the global or the beam local 2-direction.

comp3: float

A Float or a Complex specifying the load component in the global 3-direction.

comp1State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the load component in the global or the beam local 1-direction. Possible values are UNSET, SET, UNCHANGED, and FREED.

comp2State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the load component in the global or the beam local 2-direction. Possible values are UNSET, SET, UNCHANGED, and FREED.

comp3State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the load component in the global 3-direction. Possible values are UNSET, SET, UNCHANGED, and FREED.

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:

amplitude: str

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

LoadStep#

class LoadStep[source]#

Methods

LoadCase(name[, boundaryConditions, loads, ...])

This method creates a load case in a step.

LoadCase(name: str, boundaryConditions: tuple = (), loads: tuple = (), includeActiveBaseStateBC: BooleanType = 1) → LoadCase[source]#

This method creates a load case in a step.

Parameters:

name: A String specifying the name of the object.
boundaryConditions: A sequence of (String, Float) sequences specifying the name of a BoundaryCondition followed by a nonzero Float scaling factor. The default value is an empty sequence.
loads: A sequence of (String, Float) sequences specifying the name of a Load followed by a nonzero Float specifying a scale factor. The default value is an empty sequence.
includeActiveBaseStateBC: A Boolean specifying whether to include all active boundary conditions propagated or modified from the base state. The default value is ON.

Returns:

A LoadCase object.

Raises:

RangeError.

Notes

This function can be accessed by:

mdb.models[name].steps[name].LoadCase

Moment#

class Moment(name: str, createStepName: str, region: Region, cm1: float | None = None, cm2: float | None = None, cm3: float | None = None, amplitude: str = 'UNSET', follower: BooleanType = 0, localCsys: int | None = None, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '')[source]#

The Moment object stores the data for a moment. The Moment object is derived from the Load object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
distributionType: SymbolicConstant: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
follower: Boolean: 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: int: 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.
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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([cm1, cm2, cm3, amplitude, ...])	This method modifies the data for an existing Moment object in the step where it is created.
`setValuesInStep`(stepName[, comp1, comp2, ...])	This method modifies the propagating data for an existing Moment object in the specified step.

setValues(cm1: float | None = None, cm2: float | None = None, cm3: float | None = None, amplitude: str = 'UNSET', follower: BooleanType = 0, localCsys: int | None = None, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '')[source]#

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

Parameters:

cm1: 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: A Float or a Complex specifying the load component in the 5- direction.
cm3: A Float or a Complex specifying the load component in the 6-direction.
amplitude: 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: 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: 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: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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.

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

Parameters:

stepName: A String specifying the name of the step in which the load is modified.
comp1: A Float, a Complex, or a SymbolicConstant specifying the load component in the 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.
comp2: A Float, a Complex, or a SymbolicConstant specifying the load component in the 5-direction. For details see comp1.
comp3: A Float, a Complex, or a SymbolicConstant specifying the load component in the 6-direction. For details see comp1.
amplitude: 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.

MomentState#

class MomentState[source]#

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

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

CLOAD

Attributes:

cm1: float

A Float or a Complex specifying the load component in the 4-direction.

cm2: float

A Float or a Complex specifying the load component in the 5-direction.

cm3: float

A Float or a Complex specifying the load component in the 6-direction.

cm1State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the load component in the 4-direction. Possible values are UNSET, SET, UNCHANGED, and FREED.

cm2State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the load component in the 5-direction. Possible values are UNSET, SET, UNCHANGED, and FREED.

cm3State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the load component in the 6-direction. Possible values are UNSET, SET, UNCHANGED, and FREED.

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:

amplitude: str

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

PEGLoad#

class PEGLoad(name: str, createStepName: str, region: Region, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', comp1: float | None = None, comp2: float | None = None, comp3: float | None = None, amplitude: str = 'UNSET')[source]#

The PEGLoad object stores the data for a PEG load. The PEGLoad object is derived from the Load object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
distributionType: SymbolicConstant: 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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([distributionType, field, comp1, ...])	This method modifies the data for an existing PEGLoad object in the step where it is created.
`setValuesInStep`(stepName[, comp1, comp2, ...])	This method modifies the propagating data for an existing PEGLoad object in the specified step.

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

Parameters:

distributionType: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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: 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: A Float or a Complex specifying the load component at dof 1 of reference node 2.
comp3: A Float or a Complex specifying the load component at dof 2 of reference node 2.
amplitude: 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.

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

Parameters:

stepName: A String specifying the name of the step in which the load is modified.
comp1: A Float, a Complex, or a SymbolicConstant specifying the load component at dof 1 of reference node 1. 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: A Float, a Complex, or a SymbolicConstant specifying the load component at dof 1 of reference node 2. For details see comp1.
comp3: A Float, a Complex, or a SymbolicConstant specifying the load component at dof 2 of reference node 2. For details see comp1.
amplitude: 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.

PEGLoadState#

class PEGLoadState[source]#

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

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

CLOAD

Attributes:

comp1: float

A Float or a Complex specifying the load component at dof 1 of reference node 1.

comp2: float

A Float or a Complex specifying the load component at dof 1 of reference node 2.

comp3: float

A Float or a Complex specifying the load component at dof 2 of reference node 2.

comp1State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the load component at dof 1 of reference node 1. Possible values are UNSET, SET, UNCHANGED, and FREED.

comp2State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the load component at dof 1 of reference node 2. Possible values are UNSET, SET, UNCHANGED, and FREED.

comp3State: SymbolicConstant

A SymbolicConstant specifying the propagation state of the load component at dof 2 of reference node 2. Possible values are UNSET, SET, UNCHANGED, and FREED.

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:

amplitude: str

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

PipePressure#

class PipePressure(name: str, createStepName: str, region: Region, magnitude: float, diameter: float, hZero: float, hReference: float, field: str = '', amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM', side: SymbolicConstantType = 'INTERNAL')[source]#

The PipePressure object stores the data for a pressure applied to pipe or elbow elements. The PipePressure object is derived from the Load object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
distributionType: SymbolicConstant: A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM, HYDROSTATIC, USER_DEFINED, and FIELD. The default value is UNIFORM.
side: SymbolicConstant: A SymbolicConstant specifying whether the pressure is applied internally or externally. Possible values are INTERNAL and EXTERNAL. The default value is INTERNAL.
diameter: float: A Float specifying the effective inner or outer diameter.
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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([field, amplitude, ...])	This method modifies the data for an existing PipePressure object in the step where it is created.
`setValuesInStep`(stepName[, magnitude, ...])	This method modifies the propagating data for an existing PipePressure object in the specified step.

setValues(field: str = '', amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM', side: SymbolicConstantType = 'INTERNAL')[source]#

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

Parameters:

field: 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: 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: A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM, HYDROSTATIC, USER_DEFINED, and FIELD. The default value is UNIFORM.
side: A SymbolicConstant specifying whether the pressure is applied internally or externally. Possible values are INTERNAL and EXTERNAL. The default value is INTERNAL.

setValuesInStep(stepName: str, magnitude: float | None = None, hZero: float | None = None, hReference: float | None = None, amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the load is modified.
magnitude: A Float specifying the pressure magnitude.
hZero: A Float specifying the height of the zero pressure level when *distributionType*=HYDROSTATIC.
hReference: A Float specifying the height of the reference pressure level when *distributionType*=HYDROSTATIC.
amplitude: 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 has no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

PipePressureState#

class PipePressureState[source]#

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

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

DSLOAD
- DLOAD

Attributes:

magnitude: float

A Float or a Complex specifying the load magnitude.

magnitudeState: SymbolicConstant

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

hZero: float

A Float specifying the height of the zero pressure level when the pipe pressure distributionType=HYDROSTATIC.

hZeroState: SymbolicConstant

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

hReference: float

A Float specifying the height of the reference pressure level when the pipe pressure distributionType=HYDROSTATIC.

hReferenceState: SymbolicConstant

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

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:

amplitude: str

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

Pressure#

class Pressure(name: str, createStepName: str, region: Region, magnitude: float = 0.0, hZero: float = 0.0, hReference: float = 0.0, field: str = '', refPoint: str = '', distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET')[source]#

The Pressure object defines a pressure load. The Pressure object is derived from the Load object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
distributionType: SymbolicConstant: 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.
field: str: 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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([field, refPoint, ...])	This method modifies the data for an existing Pressure object in the step where it is created.
`setValuesInStep`(stepName[, magnitude, ...])	This method modifies the propagating data for an existing Pressure object in the specified step.

setValues(field: str = '', refPoint: str = '', distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET')[source]#

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

Parameters:

field: 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: A Region specifying the reference point from which the relative velocity is determined when *distributionType*=STAGNATION or VISCOUS.
distributionType: 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: 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: str, magnitude: float | None = None, hZero: float | None = None, hReference: float | None = None, amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the load is modified.
magnitude: A Float or a Complex specifying the pressure magnitude.
hZero: A Float specifying the height of the zero pressure level when *distributionType*=HYDROSTATIC.
hReference: A Float specifying the height of the reference pressure level when *distributionType*=HYDROSTATIC.
amplitude: 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.

PressureState#

class PressureState[source]#

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

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

DSLOAD
- DLOAD

Attributes:

magnitude: float

A Float or a Complex specifying the pressure magnitude.

magnitudeState: SymbolicConstant

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

hZero: float

A Float specifying the height of the zero pressure level when the pressure distributionType=HYDROSTATIC.

hZeroState: SymbolicConstant

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

hReference: float

A Float specifying the height of the reference pressure level when the pressure distributionType=HYDROSTATIC.

hReferenceState: SymbolicConstant

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

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:

amplitude: str

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

RotationalBodyForce#

class RotationalBodyForce(name: str, createStepName: str, region: Region, magnitude: float, point1: tuple, point2: tuple, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', centrifugal: BooleanType = 0, rotaryAcceleration: BooleanType = 0, amplitude: str = 'UNSET')[source]#

The RotationalBodyForce object stores the data for a rotational body force. The RotationalBodyForce object is derived from the Load object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
distributionType: SymbolicConstant: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
centrifugal: Boolean: 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: Boolean: 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.
point1: float: A tuple of Floats specifying the first point on the axis of rotation for the load.
point2: float: A tuple of Floats specifying the second point on the axis of rotation for the load.
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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([distributionType, field, ...])	This method modifies the data for an existing RotationalBodyForce object in the step where it is created.
`setValuesInStep`(stepName[, magnitude, amplitude])	This method modifies the propagating data for an existing RotationalBodyForce object in the specified step.

setValues(distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', centrifugal: BooleanType = 0, rotaryAcceleration: BooleanType = 0, amplitude: str = 'UNSET')[source]#

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

Parameters:

distributionType: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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: 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: 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: 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: str, magnitude: float | None = None, amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the load is modified.
magnitude: A Float specifying the load magnitude.
amplitude: 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.

RotationalBodyForceState#

class RotationalBodyForceState[source]#

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

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

DLOAD

Attributes:

magnitude: float

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.

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:

amplitude: str

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

ShellEdgeLoad#

class ShellEdgeLoad(name: str, createStepName: str, region: Region, magnitude: float, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET', angle: float = 0, axis: SymbolicConstantType = 'AXIS_1', localCsys: int = 'GENERAL', userCsys: str = 'GENERAL', directionVector: tuple = (), follower: BooleanType = 1, resultant: BooleanType = 0, traction: SymbolicConstantType = 'NORMAL')[source]#

The ShellEdgeLoad object defines shell edge loads on a region. The ShellEdgeLoad object is derived from the Load object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
distributionType: SymbolicConstant: 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: 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: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([distributionType, field, ...])	This method modifies the data for an existing ShellEdgeLoad object in the step where it is created.
`setValuesInStep`(stepName[, magnitude, amplitude])	This method modifies the propagating data for an existing ShellEdgeLoad object in the specified step.

setValues(distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET', angle: float = 0, axis: SymbolicConstantType = 'AXIS_1', localCsys: int = 'GENERAL', userCsys: str = 'GENERAL', directionVector: tuple = (), follower: BooleanType = 1, resultant: BooleanType = 0, traction: SymbolicConstantType = 'NORMAL')[source]#

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

Parameters:

distributionType: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: A SymbolicConstant specifying how to apply surface traction. Possible values are NORMAL, TRANSVERSE, SHEAR, MOMENT and GENERAL. The default value is NORMAL.

setValuesInStep(stepName: str, magnitude: SymbolicConstantType | float | None = None, amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the surface pore fluid flow is modified.
magnitude: A Float, a Complex, or the SymbolicConstant UNCHANGED specifying the load magnitude. UNCHANGED should be used if the magnitude is propagated from the previous analysis step.
amplitude: 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.

ShellEdgeLoadState#

class ShellEdgeLoadState[source]#

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

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

DSLOAD
- DLOAD

Attributes:

magnitude: float

A Float or a Complex specifying the load magnitude.

magnitudeState: SymbolicConstant

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

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:

amplitude: str

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

SubmodelSB#

class SubmodelSB(name: str, createStepName: str, region: Region, globalStep: str, globalDrivingRegion: str = '', absoluteExteriorTolerance: float | None = None, exteriorTolerance: float = 0, globalIncrement: int = 0)[source]#

The SubmodelSB object stores the data for a submodel surface based load. The SubmodelSB object is derived from the Load object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
absoluteExteriorTolerance: float: 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: 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.
globalDrivingRegion: str: 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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([globalDrivingRegion, ...])	This method modifies the data for an existing SubmodelSB object in the step where it is created.
`setValuesInStep`(stepName[, fixed, ...])	This method modifies the propagating data for an existing SubmodelSB object in the specified step.

setValues(globalDrivingRegion: str = '', absoluteExteriorTolerance: float | None = None, exteriorTolerance: float = 0, globalIncrement: int = 0)[source]#

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

Parameters:

globalDrivingRegion: 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: 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: 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: 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.

setValuesInStep(stepName: str, fixed: BooleanType = 1, globalStep: str = '', globalIncrement: int = 0)[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the load is modified.
fixed: A Boolean specifying whether the load should remain fixed at the current values at the start of the step. The default value is ON.
globalStep: 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. The *globalStep argument is applicable only if *fixed*=OFF.
globalIncrement: An Int specifying the increment number in the global model step at 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 and if *fixed*=OFF. The default value is 0.

SubmodelSBState#

class SubmodelSBState[source]#

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

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

SUBMODEL
- DSLOAD

Attributes:

globalStepState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the globalStep member. Possible values are SET and UNCHANGED.

globalIncrement: int

An Int specifying the increment number in the global model step at which the solution will be used to specify the values of the driven variables. This argument is applicable only for linear perturbation steps.

globalIncrementState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the globalIncrement member. Possible values are SET and UNCHANGED.

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.

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:

amplitude: str

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

SubstructureLoad#

class SubstructureLoad(name: str, createStepName: str, region: Region, loadCaseNames: str, magnitude: float, amplitude: str = 'UNSET')[source]#

The SubstructureLoad object defines a substructure load. The SubstructureLoad object is derived from the Load object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([amplitude])	This method modifies the data for an existing SubstructureLoad object in the step where it is created.
`setValuesInStep`(stepName[, loadCaseNames, ...])	This method modifies the propagating data for an existing SubstructureLoad object in the specified step.

setValues(amplitude: str = 'UNSET')[source]#

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

Parameters:

amplitude: 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: str, loadCaseNames: str = '', magnitude: float | None = None, amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the load is modified.
loadCaseNames: A list of names of the load cases that should be activated by this substructure load.
magnitude: A Float specifying the multiplier for the load case magnitude.
amplitude: 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.

SubstructureLoadState#

class SubstructureLoadState[source]#

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

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

SLOAD

Attributes:

loadCaseNames: tuple

A tuple of strings specifying the names of the load cases to be activated.

magnitude: float

A Float or a Complex specifying the load magnitude.

magnitudeState: SymbolicConstant

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

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:

amplitude: str

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

SurfaceCharge#

class SurfaceCharge(name: str, createStepName: str, region: Region, magnitude: float, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET')[source]#

The SurfaceCharge object stores the data for a surface charge. The SurfaceCharge object is derived from the Load object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
distributionType: SymbolicConstant: 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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([distributionType, field, amplitude])	This method modifies the data for an existing SurfaceCharge object in the step where it is created.
`setValuesInStep`(stepName[, magnitude, amplitude])	This method modifies the propagating data for an existing SurfaceCharge object in the specified step.

setValues(distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET')[source]#

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

Parameters:

distributionType: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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: 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: str, magnitude: float | None = None, amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the load is modified.
magnitude: A Float specifying the load magnitude.
amplitude: 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.

SurfaceChargeState#

class SurfaceChargeState[source]#

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

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

DSECHARGE

Attributes:

magnitude: float

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.

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:

amplitude: str

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

SurfaceConcentrationFlux#

class SurfaceConcentrationFlux(name: str, createStepName: str, region: Region, magnitude: float, field: str = '', distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET')[source]#

The SurfaceConcentrationFlux object defines surface concentration flux from a region or into a region. The SurfaceConcentrationFlux object is derived from the Load object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
distributionType: SymbolicConstant: A SymbolicConstant specifying how the surface 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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([field, distributionType, amplitude])	This method modifies the data for an existing SurfaceConcentrationFlux object in the step where it is created.
`setValuesInStep`(stepName[, magnitude, amplitude])	This method modifies the propagating data for an existing SurfaceConcentrationFlux object in the specified step.

setValues(field: str = '', distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET')[source]#

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

Parameters:

field: 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: 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: 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: str, magnitude: float | None = None, amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the surface concentration flux is modified.
magnitude: A Float specifying the surface concentration flux magnitude.
amplitude: 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.

SurfaceConcentrationFluxState#

class SurfaceConcentrationFluxState[source]#

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

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

DSFLUX

Attributes:

magnitude: float

A Float specifying the surface concentration flux magnitude.

magnitudeState: SymbolicConstant

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

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:

amplitude: str

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

SurfaceCurrent#

class SurfaceCurrent(name: str, createStepName: str, region: Region, magnitude: float, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET')[source]#

The SurfaceCurrent object stores the data for a surface current. The SurfaceCurrent object is derived from the Load object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
distributionType: SymbolicConstant: 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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([distributionType, field, amplitude])	This method modifies the data for an existing SurfaceCurrent object in the step where it is created.
`setValuesInStep`(stepName[, magnitude, amplitude])	This method modifies the propagating data for an existing SurfaceCurrent object in the specified step.

setValues(distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET')[source]#

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

Parameters:

distributionType: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and FIELD. The default value is UNIFORM.
field: 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: 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: str, magnitude: float | None = None, amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the load is modified.
magnitude: A Float specifying the load magnitude.
amplitude: 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.

SurfaceCurrentDensity#

class SurfaceCurrentDensity(name: str, createStepName: str, region: Region, comp1: str, comp2: str, comp3: str, distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET')[source]#

The SurfaceCurrentDensity object stores the data for a surface current. The SurfaceCurrentDensity object is derived from the Load object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
distributionType: SymbolicConstant: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([distributionType, amplitude])	This method modifies the data for an existing SurfaceCurrentDensity object in the step where it is created.
`setValuesInStep`(stepName[, comp1, comp2, ...])	This method modifies the propagating data for an existing SurfaceCurrentDensity object in the specified step.

setValues(distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET')[source]#

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

Parameters:

distributionType: A SymbolicConstant specifying how the load is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM.
amplitude: 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: str, comp1: str = '', comp2: str = '', comp3: str = '', amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the load is modified.
comp1: A Complex specifying the first component of the load.
comp2: A Complex specifying the second component of the load.
comp3: A Complex specifying the third component of the load.
amplitude: 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.

SurfaceCurrentState#

class SurfaceCurrentState[source]#

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

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

DSECURRENT

Attributes:

magnitude: float

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.

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:

amplitude: str

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

SurfaceHeatFlux#

class SurfaceHeatFlux(name: str, createStepName: str, region: Region, magnitude: float, field: str = '', distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET')[source]#

The SurfaceHeatFlux object defines surface heat flux from a region or into a region. The SurfaceHeatFlux object is derived from the Load object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
distributionType: SymbolicConstant: A SymbolicConstant specifying how the surface 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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([field, distributionType, amplitude])	This method modifies the data for an existing SurfaceHeatFlux object in the step where it is created.
`setValuesInStep`(stepName[, magnitude, amplitude])	This method modifies the propagating data for an existing SurfaceHeatFlux object in the specified step.

setValues(field: str = '', distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET')[source]#

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

Parameters:

field: 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: 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: 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: str, magnitude: float | None = None, amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the surface heat flux is modified.
magnitude: A Float specifying the surface heat flux magnitude.
amplitude: 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.

SurfaceHeatFluxState#

class SurfaceHeatFluxState[source]#

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

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

DSFLUX

Attributes:

magnitude: float

A Float specifying the surface heat flux magnitude.

magnitudeState: SymbolicConstant

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

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:

amplitude: str

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

SurfacePoreFluid#

class SurfacePoreFluid(name: str, createStepName: str, region: Region, magnitude: float, field: str = '', distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET')[source]#

The SurfacePoreFluid object defines surface pore fluid flow from a region or into a region. The SurfacePoreFluid object is derived from the Load object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
distributionType: SymbolicConstant: A SymbolicConstant specifying whether the load is uniform. 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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([field, distributionType, amplitude])	This method modifies the data for an existing SurfacePoreFluid object in the step where it is created.
`setValuesInStep`(stepName[, magnitude, amplitude])	This method modifies the propagating data for an existing SurfacePoreFluid object in the specified step.

setValues(field: str = '', distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET')[source]#

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

Parameters:

field: 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: A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
amplitude: 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: str, magnitude: float | None = None, amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the surface pore fluid flow is modified.
magnitude: A Float specifying the surface pore fluid flow magnitude.
amplitude: 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.

SurfacePoreFluidState#

class SurfacePoreFluidState[source]#

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

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

DSFLOW

Attributes:

magnitude: float

A Float specifying the surface pore fluid flow magnitude.

magnitudeState: SymbolicConstant

A SymbolicConstant specifying the propagation state of the surface pore fluid flow magnitude. Possible values are UNSET, SET, UNCHANGED, and MODIFIED.

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:

amplitude: str

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

SurfaceTraction#

class SurfaceTraction(name: str, createStepName: str, region: Region, magnitude: float, distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET', angle: float = 0, axis: SymbolicConstantType = 'AXIS_1', localCsys: int | None = None, userCsys: str = '', directionVector: tuple = (), follower: BooleanType = 1, resultant: BooleanType = 0, traction: SymbolicConstantType = 'SHEAR')[source]#

The SurfaceTraction object defines surface traction on a region. The SurfaceTraction object is derived from the Load object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the load repository key.
angle: float: A Float specifying an additional rotation of directionVector about an axis. The default value is 0.0.
axis: SymbolicConstant: 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.
follower: Boolean: 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: Boolean: 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: SymbolicConstant: A SymbolicConstant specifying how to apply surface traction. Possible values are SHEAR and GENERAL. The default value is SHEAR.
distributionType: SymbolicConstant: 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: 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.
userCsys: str: 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”.
localCsys: int: 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.
directionVector: tuple: 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.
region: Region: A Region object specifying the region to which the load is applied.

Methods

`setValues`([distributionType, field, ...])	This method modifies the data for an existing SurfaceTraction object in the step where it is created.
`setValuesInStep`(stepName[, magnitude, amplitude])	This method modifies the propagating data for an existing SurfaceTraction object in the specified step.

setValues(distributionType: SymbolicConstantType = 'UNIFORM', field: str = '', amplitude: str = 'UNSET', angle: float = 0, axis: SymbolicConstantType = 'AXIS_1', localCsys: int | None = None, userCsys: str = '', directionVector: tuple = (), follower: BooleanType = 1, resultant: BooleanType = 0, traction: SymbolicConstantType = 'SHEAR')[source]#

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

Parameters:

distributionType: A SymbolicConstant specifying how the surface traction is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
field: 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: 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: A Float specifying an additional rotation of directionVector about an axis. The default value is 0.0.
axis: 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: 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: 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: 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: 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: 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: A SymbolicConstant specifying how to apply surface traction. Possible values are SHEAR and GENERAL. The default value is SHEAR.

setValuesInStep(stepName: str, magnitude: SymbolicConstantType | float | None = None, amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the load is modified.
magnitude: A Float, a Complex, or the SymbolicConstant UNCHANGED specifying the load magnitude. UNCHANGED should be used if the magnitude is propagated from the previous analysis step.
amplitude: 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.

SurfaceTractionState#

class SurfaceTractionState[source]#

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

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

DSLOAD
- DLOAD

Attributes:

magnitude: float

A Float or a Complex specifying the load magnitude.

magnitudeState: SymbolicConstant

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

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:

amplitude: str

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

Load case#

The LoadCase object is used to define the loads and constraints comprising a particular loading condition and the linear response of a structure subjected to that loading condition.

Create load cases#

class LoadStep[source]#

Methods

LoadCase(name[, boundaryConditions, loads, ...])

This method creates a load case in a step.

LoadCase(name: str, boundaryConditions: tuple = (), loads: tuple = (), includeActiveBaseStateBC: BooleanType = 1) → LoadCase[source]#

This method creates a load case in a step.

Parameters:

name: A String specifying the name of the object.
boundaryConditions: A sequence of (String, Float) sequences specifying the name of a BoundaryCondition followed by a nonzero Float scaling factor. The default value is an empty sequence.
loads: A sequence of (String, Float) sequences specifying the name of a Load followed by a nonzero Float specifying a scale factor. The default value is an empty sequence.
includeActiveBaseStateBC: A Boolean specifying whether to include all active boundary conditions propagated or modified from the base state. The default value is ON.

Returns:

A LoadCase object.

Raises:

RangeError.

Notes

This function can be accessed by:

mdb.models[name].steps[name].LoadCase

Object features of load cases#

class LoadCase(name: str, boundaryConditions: tuple = (), loads: tuple = (), includeActiveBaseStateBC: BooleanType = 1)[source]#

The LoadCase object is used to define the loads and constraints comprising a particular loading condition and the linear response of a structure subjected to that loading condition.

Notes

This object can be accessed by:

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

Attributes:

suppressed: Boolean: A Boolean specifying whether the load case is suppressed or not. The default value is OFF.

Methods

`resume`()	This method resumes the load case that was previously suppressed.
`setValues`([boundaryConditions, loads, ...])	This method modifies the LoadCase object.
`suppress`()	This method suppresses the load case.

resume()[source]#: This method resumes the load case that was previously suppressed.

setValues(boundaryConditions: tuple = (), loads: tuple = (), includeActiveBaseStateBC: BooleanType = 1)[source]#

This method modifies the LoadCase object.

Parameters:

boundaryConditions: A sequence of (String, Float) sequences specifying the name of a BoundaryCondition followed by a nonzero Float scaling factor. The default value is an empty sequence.
loads: A sequence of (String, Float) sequences specifying the name of a Load followed by a nonzero Float specifying a scale factor. The default value is an empty sequence.
includeActiveBaseStateBC: A Boolean specifying whether to include all active boundary conditions propagated or modified from the base state. The default value is ON.

suppress()[source]#: This method suppresses the load case.