Boundary Condition#

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

Create boundary conditions#

class BoundaryConditionModel(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

`AccelerationBC`(name, createStepName, region)	This method creates an AccelerationBC object.
`AccelerationBaseMotionBC`(name, ...[, ...])	This method creates a AccelerationBaseMotionBC object.
`AcousticPressureBC`(name, createStepName, region)	This method creates a AcousticPressureBC object.
`Calibration`(name)	This method creates a Calibration object.
`ConcentrationBC`(name, createStepName, region)	This method creates a ConcentrationBC object.
`ConnAccelerationBC`(name, createStepName[, ...])	This method creates an ConnAccelerationBC object on a wire region.
`ConnDisplacementBC`(name, createStepName[, ...])	This method creates a ConnDisplacementBC object on a wire region.
`ConnVelocityBC`(name, createStepName[, ...])	This method creates a ConnVelocityBC object on a wire region.
`DisplacementBC`(name, createStepName, region)	This method creates a DisplacementBC object.
`DisplacementBaseMotionBC`(name, ...[, ...])	This method creates a DisplacementBaseMotionBC object.
`ElectricPotentialBC`(name, createStepName, region)	This method creates an ElectricPotentialBC object.
`EncastreBC`(name, createStepName, region[, ...])	This method creates an encastre TypeBC object.
`EulerianBC`(name, createStepName, region[, ...])	This method creates a EulerianBC object.
`EulerianMotionBC`(name, createStepName, ...)	This method creates an EulerianMotionBC object.
`FluidCavityPressureBC`(name, createStepName, ...)	This method creates a FluidCavityPressureBC object.
`MagneticVectorPotentialBC`(name, ...[, ...])	This method creates a MagneticVectorPotentialBC object.
`MaterialFlowBC`(name, createStepName, region)	This method creates a MaterialFlowBC object.
`PinnedBC`(name, createStepName, region[, ...])	This method creates a pinned TypeBC object.
`PorePressureBC`(name, createStepName, region)	This method creates a PorePressureBC object.
`RetainedNodalDofsBC`(name, createStepName, region)	This method creates a RetainedNodalDofsBC object.
`SecondaryBaseBC`(name, createStepName, ...)	This method creates a SecondaryBaseBC object.
`SubmodelBC`(name, createStepName, region, ...)	This method creates a SubmodelBC object.
`TemperatureBC`(name, createStepName, region)	This method creates a TemperatureBC object.
`VelocityBC`(name, createStepName, region[, ...])	This method creates a VelocityBC object.
`VelocityBaseMotionBC`(name, createStepName, dof)	This method creates a VelocityBaseMotionBC object.
`XasymmBC`(name, createStepName, region[, ...])	This method creates a TypeBC object that specifies antisymmetry about the X-axis.
`XsymmBC`(name, createStepName, region[, ...])	This method creates a TypeBC object that specifies symmetry about the X-axis.
`YasymmBC`(name, createStepName, region[, ...])	This method creates a TypeBC object that specifies antisymmetry about the Y-axis.
`YsymmBC`(name, createStepName, region[, ...])	This method creates a TypeBC object that specifies symmetry about the Y-axis.
`ZasymmBC`(name, createStepName, region[, ...])	This method creates a TypeBC object that specifies antisymmetry about the Z-axis.
`ZsymmBC`(name, createStepName, region[, ...])	This method creates a TypeBC object that specifies symmetry about the Z-axis.

AccelerationBC(name: str, createStepName: str, region: Region, fieldName: str = '', a1: SymbolicConstantType | float = 'UNSET', a2: SymbolicConstantType | float = 'UNSET', a3: SymbolicConstantType | float = 'UNSET', ar1: SymbolicConstantType | float = 'UNSET', ar2: SymbolicConstantType | float = 'UNSET', ar3: SymbolicConstantType | float = 'UNSET', amplitude: str = 'UNSET', localCsys: str | None = None, distributionType: SymbolicConstantType = 'UNIFORM') → AccelerationBC[source]#

This method creates an AccelerationBC object.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: A Region object specifying the region to which the boundary condition is applied.
fieldName: A String specifying the name of the AnalyticalField object associated with this boundary condition. The fieldName argument applies only when *distributionType*=FIELD. The default value is an empty string.
a1: A Float or a SymbolicConstant specifying the acceleration component in the 1-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.Note:Although a1, a2, a3, ar1, ar2, and ar3 are optional arguments, at least one of them must be specified.
a2: A Float or a SymbolicConstant specifying the acceleration component in the 2-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
a3: A Float or a SymbolicConstant specifying the acceleration component in the 3-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
ar1: A Float or a SymbolicConstant specifying the rotational acceleration component about the 1-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
ar2: A Float or a SymbolicConstant specifying the rotational acceleration component about the 2-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
ar3: A Float or a SymbolicConstant specifying the rotational acceleration component about the 3-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
amplitude: A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the boundary condition has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.
localCsys: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.
distributionType: A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

Returns:

bc: AccelerationBC: An AccelerationBC object.

Notes

This function can be accessed by:

mdb.models[name].AccelerationBC

AccelerationBaseMotionBC(name: str, createStepName: str, dof: SymbolicConstantType, amplitudeScaleFactor: float = 1, centerOfRotation: tuple = (), correlation: CorrelationArray | None = None, secondaryBase: str = '', useComplex: BooleanType = 0, amplitude: str = 'UNSET') → AccelerationBaseMotionBC[source]#

This method creates a AccelerationBaseMotionBC object.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
dof: A SymbolicConstant specifying the constrained degree-of-freedom. Possible values for the SymbolicConstant are U1, U2, U3, UR1, UR2, UR3. The default value is U1.
amplitudeScaleFactor: A Float specifying the scale factor for the amplitude curve. The default value is 1.0.
centerOfRotation: A ModelDot object specifying a tuple containing one center of rotation. The default value is the global origin. This argument applies only when *dof*=UR1, UR2, or UR3.
correlation: A CorrelationArray object.
secondaryBase: A String specifying the name of the SecondaryBaseBC object associated with this boundary condition. The default value is an empty string.
useComplex: A Boolean specifying whether to define the imaginary (out-of-plane) portion of the base motion record given by amplitude definition. The default value is OFF.
amplitude: A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the boundary condition 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:

bc: AccelerationBC: An AccelerationBaseMotionBC object.

Notes

This function can be accessed by:

mdb.models[name].AccelerationBaseMotionBC

AcousticPressureBC(name: str, createStepName: str, region: Region, fieldName: str = '', magnitude: float = 0, distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET', fixed: BooleanType = 0) → AcousticPressureBC[source]#

This method creates a AcousticPressureBC object.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: A Region object specifying the region to which the boundary condition is applied.
fieldName: A String specifying the name of the AnalyticalField object associated with this boundary condition. The fieldName argument applies only when *distributionType*=FIELD. The default value is an empty string.
magnitude: A Float specifying the acoustic pressure magnitude. The default value is 0. The magnitude argument is optional if *distributionType*=USER_DEFINED.
distributionType: A SymbolicConstant specifying how the boundary condition 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 boundary condition has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.
fixed: A Boolean specifying whether the boundary condition should remain fixed at the current values at the start of the step. The default value is OFF.

Returns:

bc: AcousticPressureBC: An AcousticPressureBC object.

Notes

This function can be accessed by:

mdb.models[name].AcousticPressureBC

Calibration(name: str) → Calibration[source]#

This method creates a Calibration object.

Parameters:

name: A String specifying the name of the new calibration.

Returns:

calibration: Calibration: A Calibration object.

Notes

This function can be accessed by:

mdb.models[name].Calibration

ConcentrationBC(name: str, createStepName: str, region: Region, fieldName: str = '', magnitude: float = 0, distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET', fixed: BooleanType = 0) → ConcentrationBC[source]#

This method creates a ConcentrationBC object.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: A Region object specifying the region to which the boundary condition is applied.
fieldName: A String specifying the name of the AnalyticalField object associated with this boundary condition. The fieldName argument applies only when *distributionType*=FIELD. The default value is an empty string.
magnitude: A Float specifying the concentration magnitude. The default value is 0. The magnitude argument is optional if *distributionType*=USER_DEFINED.
distributionType: A SymbolicConstant specifying how the boundary condition 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 boundary condition has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.
fixed: A Boolean specifying whether the boundary condition should remain fixed at the current values at the start of the step. The default value is OFF.

Returns:

bc: ConcentrationBC: A ConcentrationBC object.

Notes

This function can be accessed by:

mdb.models[name].ConcentrationBC

ConnAccelerationBC(name: str, createStepName: str, region: str = '', fastenerName: str = '', fastenerSetName: str = '', a1: SymbolicConstantType | float = 'UNSET', a2: SymbolicConstantType | float = 'UNSET', a3: SymbolicConstantType | float = 'UNSET', ar1: SymbolicConstantType | float = 'UNSET', ar2: SymbolicConstantType | float = 'UNSET', ar3: SymbolicConstantType | float = 'UNSET', amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM') → ConnAccelerationBC[source]#

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

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: The wire region to which the boundary condition 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 boundary condition 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 boundary condition 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.
a1: A Float or a SymbolicConstant specifying the acceleration component in the connector’s local 1-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.Note:Although a1, a2, a3, ar1, ar2, and ar3 are optional arguments, at least one of them must be specified.
a2: A Float or a SymbolicConstant specifying the acceleration component in the connector’s local 2-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
a3: A Float or a SymbolicConstant specifying the acceleration component in the connector’s local 3-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
ar1: A Float or a SymbolicConstant specifying the rotational acceleration component in the connector’s local 4-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
ar2: A Float or a SymbolicConstant specifying the rotational acceleration component in the connector’s local 5-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
ar3: A Float or a SymbolicConstant specifying the rotational acceleration component in the connector’s local 6-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
amplitude: A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the boundary condition 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 boundary condition is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM.

Returns:

bc: ConnAccelerationBC: A ConnAccelerationBC object.

Notes

This function can be accessed by:

mdb.models[name].ConnAccelerationBC

ConnDisplacementBC(name: str, createStepName: str, region: str = '', fastenerName: str = '', fastenerSetName: str = '', u1: SymbolicConstantType | float = 'UNSET', u2: SymbolicConstantType | float = 'UNSET', u3: SymbolicConstantType | float = 'UNSET', ur1: SymbolicConstantType | float = 'UNSET', ur2: SymbolicConstantType | float = 'UNSET', ur3: SymbolicConstantType | float = 'UNSET', fixed: BooleanType = 0, amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM', buckleCase: SymbolicConstantType = 'NOT_APPLICABLE') → ConnDisplacementBC[source]#

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

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: The wire region to which the boundary condition 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 boundary condition 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 boundary condition 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.
u1: A Float, a Complex, or a SymbolicConstant specifying the displacement component in the connector’s local 1-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.Note:Although u1, u2, u3, ur1, ur2, and ur3 are optional arguments, at least one of them must be specified.
u2: A Float, a Complex, or a SymbolicConstant specifying the displacement component in the connector’s local 2-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
u3: A Float, a Complex, or a SymbolicConstant specifying the displacement component in the connector’s local 3-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
ur1: A Float, a Complex, or a SymbolicConstant specifying the rotational component in the connector’s local 4-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
ur2: A Float, a Complex, or a SymbolicConstant specifying the rotational component in the connector’s local 5-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
ur3: A Float, a Complex, or a SymbolicConstant specifying the rotational component in the connector’s local 6-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
fixed: A Boolean specifying whether the boundary condition should remain fixed at the current values at the start of the step. The default value is OFF.
amplitude: A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the boundary condition 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 boundary condition is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM.
buckleCase: A SymbolicConstant specifying how the boundary condition is defined in a BUCKLE analysis. Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES, and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.

Returns:

bc: ConnDisplacementBC: A ConnDisplacementBC object.

Notes

This function can be accessed by:

mdb.models[name].ConnDisplacementBC

ConnVelocityBC(name: str, createStepName: str, region: str = '', fastenerName: str = '', fastenerSetName: str = '', v1: SymbolicConstantType | float = 'UNSET', v2: SymbolicConstantType | float = 'UNSET', v3: SymbolicConstantType | float = 'UNSET', vr1: SymbolicConstantType | float = 'UNSET', vr2: SymbolicConstantType | float = 'UNSET', vr3: SymbolicConstantType | float = 'UNSET', amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM') → ConnVelocityBC[source]#

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

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: The wire region to which the boundary condition 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 boundary condition 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 boundary condition 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.
v1: A Float or a SymbolicConstant specifying the velocity component in the connector’s local 1-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.Note:Although v1, v2, v3, vr1, vr2, and vr3 are optional arguments, at least one of them must be specified.
v2: A Float or a SymbolicConstant specifying the velocity component in the connector’s local 2-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
v3: A Float or a SymbolicConstant specifying the velocity component in the connector’s local 3-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
vr1: A Float or a SymbolicConstant specifying the rotational velocity component in the connector’s local 4-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
vr2: A Float or a SymbolicConstant specifying the rotational velocity component in the connector’s local 5-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
vr3: A Float or a SymbolicConstant specifying the rotational velocity component in the connector’s local 6-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
amplitude: A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the boundary condition 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 boundary condition is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM.

Returns:

bc: ConnVelocityBC: A ConnVelocityBC object.

Notes

This function can be accessed by:

mdb.models[name].ConnVelocityBC

DisplacementBC(name: str, createStepName: str, region: Region, fieldName: str = '', u1: SymbolicConstantType | float = 'UNSET', u2: SymbolicConstantType | float = 'UNSET', u3: SymbolicConstantType | float = 'UNSET', ur1: SymbolicConstantType | float = 'UNSET', ur2: SymbolicConstantType | float = 'UNSET', ur3: SymbolicConstantType | float = 'UNSET', fixed: BooleanType = 0, amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM', localCsys: str | None = None, buckleCase: SymbolicConstantType = 'NOT_APPLICABLE') → DisplacementBC[source]#

This method creates a DisplacementBC object.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: A Region object specifying the region to which the boundary condition is applied.
fieldName: A String specifying the name of the AnalyticalField or DiscreteField object associated with this boundary condition. The fieldName argument applies only when *distributionType*=FIELD or *distributionType*=DISCRETE_FIELD. The default value is an empty string.
u1: A Float, a Complex, or a SymbolicConstant specifying the displacement component in the 1-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.Note:Although u1, u2, u3, ur1, ur2, and ur3 are optional arguments, at least one of them must be specified.
u2: A Float, a Complex, or a SymbolicConstant specifying the displacement component in the 2-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
u3: A Float, a Complex, or a SymbolicConstant specifying the displacement component in the 3-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
ur1: A Float, a Complex, or a SymbolicConstant specifying the rotational displacement component about the 1-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
ur2: A Float, a Complex, or a SymbolicConstant specifying the rotational displacement component about the 2-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
ur3: A Float, a Complex, or a SymbolicConstant specifying the rotational displacement component about the 3-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
fixed: A Boolean specifying whether the boundary condition should remain fixed at the current values at the start of the step. The default value is OFF.
amplitude: A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the boundary condition 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 boundary condition is distributed spatially. Possible values are UNIFORM, USER_DEFINED, FIELD, and DISCRETE_FIELD. The default value is UNIFORM.
localCsys: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.
buckleCase: A SymbolicConstant specifying how the boundary condition is defined in a BUCKLE analysis. Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES, and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.

Returns:

bc: DisplacementBC: A DisplacementBC object

Notes

This function can be accessed by:

mdb.models[name].DisplacementBC

DisplacementBaseMotionBC(name: str, createStepName: str, dof: SymbolicConstantType, amplitudeScaleFactor: float = 1, centerOfRotation: tuple = (), correlation: CorrelationArray | None = None, secondaryBase: str = '', useComplex: BooleanType = 0, amplitude: str = 'UNSET') → DisplacementBaseMotionBC[source]#

This method creates a DisplacementBaseMotionBC object.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
dof: A SymbolicConstant specifying the constrained degree-of-freedom. Possible values for the SymbolicConstant are U1, U2, U3, UR1, UR2, UR3. The default value is U1.
amplitudeScaleFactor: A Float specifying the scale factor for the amplitude curve. The default value is 1.0.
centerOfRotation: A ModelDot object specifying a tuple containing one center of rotation. The default value is the global origin. This argument applies only when *dof*=UR1, UR2, or UR3.
correlation: A CorrelationArray object.
secondaryBase: A String specifying the name of the SecondaryBaseBC object associated with this boundary condition. The default value is an empty string.
useComplex: A Boolean specifying whether to define the imaginary (out-of-plane) portion of the base motion record given by amplitude definition. The default value is OFF.
amplitude: A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the boundary condition 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:

bc: DisplacementBaseMotionBC: A DisplacementBaseMotionBC object.

Notes

This function can be accessed by:

mdb.models[name].DisplacementBaseMotionBC

ElectricPotentialBC(name: str, createStepName: str, region: Region, fieldName: str = '', magnitude: float = 0, distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET', fixed: BooleanType = 0) → ElectricPotentialBC[source]#

This method creates an ElectricPotentialBC object.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: A Region object specifying the region to which the boundary condition is applied.
fieldName: A String specifying the name of the AnalyticalField object associated with this boundary condition. The fieldName argument applies only when *distributionType*=FIELD. The default value is an empty string.
magnitude: A Float specifying the electrical potential magnitude. The default value is 0. The magnitude argument is optional if *distributionType*=USER_DEFINED.
distributionType: A SymbolicConstant specifying how the boundary condition 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 boundary condition has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.
fixed: A Boolean specifying whether the boundary condition should remain fixed at the current values at the start of the step. The default value is OFF.

Returns:

bc: ElectricPotentialBC: An ElectricPotentialBC object.

Notes

This function can be accessed by:

mdb.models[name].ElectricPotentialBC

EncastreBC(name: str, createStepName: str, region: Region, buckleCase: SymbolicConstantType = 'NOT_APPLICABLE', localCsys: str | None = None) → TypeBC[source]#

This method creates an encastre TypeBC object.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: A Region object specifying the region to which the boundary condition is applied.
buckleCase: A SymbolicConstant specifying how the boundary condition is defined in a BUCKLE analysis. Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES, and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.
localCsys: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Returns:

A TypeBC object.

Notes

This function can be accessed by:

mdb.models[name].EncastreBC

EulerianBC(name: str, createStepName: str, region: Region, definition: SymbolicConstantType = 'INFLOW', inflowType: SymbolicConstantType = 'FREE', outflowType: SymbolicConstantType = 'ZERO_PRESSURE') → EulerianBC[source]#

This method creates a EulerianBC object.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: A Region object specifying the region to which the boundary condition is applied.
definition: A SymbolicConstant specifying the flow conditions to be defined. Possible values are INFLOW, OUTFLOW, and BOTH. The default value is INFLOW.
inflowType: A SymbolicConstant specifying the control of material flow into the Eulerian domain. Possible values are FREE, NONE, and VOID. The default value is FREE.
outflowType: A SymbolicConstant specifying the control of flow of material out of the Eulerian domain. Possible values are ZERO_PRESSURE, FREE, NON_REFLECTING, and EQUILIBRIUM. The default value is ZERO_PRESSURE.

Returns:

bc: EulerianBC: An EulerianBC object.

Notes

This function can be accessed by:

mdb.models[name].EulerianBC

EulerianMotionBC(name: str, createStepName: str, instanceName: str, followRegion: ~abaqusConstants.BooleanType = 1, region: ~abaqus.Region.Region.Region = <abaqus.Region.Region.Region object>, materialName: str = '', ctrPosition1: ~abaqusConstants.SymbolicConstantType = 'FREE', posPosition1: ~abaqusConstants.SymbolicConstantType = 'FREE', negPosition1: ~abaqusConstants.SymbolicConstantType = 'FREE', expansionRatio1: float | None = None, contractRatio1: float = 0, ctrPosition2: ~abaqusConstants.SymbolicConstantType = 'FREE', posPosition2: ~abaqusConstants.SymbolicConstantType = 'FREE', negPosition2: ~abaqusConstants.SymbolicConstantType = 'FREE', expansionRatio2: float | None = None, contractRatio2: float = 0, ctrPosition3: ~abaqusConstants.SymbolicConstantType = 'FREE', posPosition3: ~abaqusConstants.SymbolicConstantType = 'FREE', negPosition3: ~abaqusConstants.SymbolicConstantType = 'FREE', expansionRatio3: float | None = None, contractRatio3: float = 0, allowContraction: ~abaqusConstants.BooleanType = 1, aspectLimit: float = 10, vmaxFactor: float = 1, volThreshold: float = 0, bufferSize: float = 2) → EulerianMotionBC[source]#

This method creates an EulerianMotionBC object.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
instanceName: A String specifying the name of the Eulerian part instance.
followRegion: A Boolean specifying whether the mesh will follow a regular surface region or an Eulerian surface. The default value is ON.
region: A Region object specifying the region to which the boundary condition is applied.
materialName: A String specifying the name of the Eulerian surface to follow. This argument applies only when *followRegion*=False.
ctrPosition1: A SymbolicConstant specifying the 1-direction translational constraint on the center of the Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
posPosition1: A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of the mesh in the 1 direction. Possible values are FREE and FIXED. The default value is FREE.
negPosition1: A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of the mesh in the 1 direction. Possible values are FREE and FIXED. The default value is FREE.
expansionRatio1: None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 1 direction. If *expansionRatio1*=None, then there is no upper limit. The default value is None.
contractRatio1: A Float specifying the lower bounds on the allowable scaling of the mesh in the 1 direction. The default value is 0.0.
ctrPosition2: A SymbolicConstant specifying the 2-direction translational constraint on the center of the Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
posPosition2: A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of the mesh in the 2 direction. Possible values are FREE and FIXED. The default value is FREE.
negPosition2: A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of the mesh in the 2 direction. Possible values are FREE and FIXED. The default value is FREE.
expansionRatio2: None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 2 direction. If *expansionRatio2*=None, then there is no upper limit. The default value is None.
contractRatio2: A Float specifying the lower bounds on the allowable scaling of the mesh in the 2 direction. The default value is 0.0.
ctrPosition3: A SymbolicConstant specifying the 3-direction translational constraint on the center of the Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
posPosition3: A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of the mesh in the 3 direction. Possible values are FREE and FIXED. The default value is FREE.
negPosition3: A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of the mesh in the 3 direction. Possible values are FREE and FIXED. The default value is FREE.
expansionRatio3: None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 3 direction. If *expansionRatio3*=None, then there is no upper limit. The default value is None.
contractRatio3: A Float specifying the lower bounds on the allowable scaling of the mesh in the 3 direction. The default value is 0.0.
allowContraction: A Boolean specifying whether the mesh is allowed to contract . The default value is ON.
aspectLimit: A Float specifying the maximum change in allowed aspect ratio (for any of the three mesh aspects, 1-2, 2-3, 3-1). The default value is 10.0.
vmaxFactor: A Float specifying the multiplier for the mesh nodal velocity limit. The default value is 1.01.
volThreshold: A Float specifying the lower bounds on the volume fraction when determining which nodes to include in the surface bounding box calculation for an Eulerian material surface. This argument applies only when *followRegion*=False. The default value is 0.5.
bufferSize: None or a Float specifying the buffer between the surface box and the Eulerian section mesh bounding box. The default value is 2.0.

Returns:

bc: EulerianMotionBC: An EulerianMotionBC object.

Notes

This function can be accessed by:

mdb.models[name].EulerianMotionBC

FluidCavityPressureBC(name: str, createStepName: str, fluidCavity: str, magnitude: float = 0, amplitude: str = 'UNSET', fixed: BooleanType = 0) → FluidCavityPressureBC[source]#

This method creates a FluidCavityPressureBC object.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
fluidCavity: A String specifying the name of a Fluid Cavity Interaction.
magnitude: A Float specifying the fluid cavity pressure magnitude. The default value is 0.
amplitude: A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the boundary condition has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.
fixed: A Boolean specifying whether the boundary condition should remain fixed at the current values at the start of the step. The default value is OFF.

Returns:

bc: FluidCavityPressureBC: A FluidCavityPressureBC object.

Notes

This function can be accessed by:

mdb.models[name].FluidCavityPressureBC

MagneticVectorPotentialBC(name: str, createStepName: str, region: Region, component1: SymbolicConstantType | None = None, component2: SymbolicConstantType = 'UNSET', component3: SymbolicConstantType = 'UNSET', amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM', localCsys: str | None = None) → MagneticVectorPotentialBC[source]#

This method creates a MagneticVectorPotentialBC object.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: A Region object specifying the region to which the boundary condition is applied.
component1: A Complex, or a SymbolicConstant specifying the magnetic vector potential component in the 1-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET
component2: A Complex, or a SymbolicConstant specifying the magnetic vector potential component in the 2-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
component3: A Complex, or a SymbolicConstant specifying the magnetic vector potential component in the 3-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
amplitude: A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the boundary condition 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 boundary condition is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM.
localCsys: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Returns:

bc: MagneticVectorPotentialBC: A MagneticVectorPotentialBC object.

Notes

This function can be accessed by:

mdb.models[name].MagneticVectorPotentialBC

MaterialFlowBC(name: str, createStepName: str, region: Region, fieldName: str = '', magnitude: float = 0, distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET', fixed: BooleanType = 0) → MaterialFlowBC[source]#

This method creates a MaterialFlowBC object.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: A Region object specifying the region to which the boundary condition is applied.
fieldName: A String specifying the name of the AnalyticalField object associated with this boundary condition. The fieldName argument applies only when *distributionType*=FIELD. The default value is an empty string.
magnitude: A Float specifying the material flow magnitude. The default value is 0. The magnitude argument is optional if *distributionType*=USER_DEFINED.
distributionType: A SymbolicConstant specifying how the boundary condition 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 boundary condition has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.
fixed: A Boolean specifying whether the boundary condition should remain fixed at the current values at the start of the step. The default value is OFF.

Returns:

bc: MaterialFlowBC: A MaterialFlowBC object.

Notes

This function can be accessed by:

mdb.models[name].MaterialFlowBC

PinnedBC(name: str, createStepName: str, region: Region, buckleCase: SymbolicConstantType = 'NOT_APPLICABLE', localCsys: str | None = None) → TypeBC[source]#

This method creates a pinned TypeBC object.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: A Region object specifying the region to which the boundary condition is applied.
buckleCase: A SymbolicConstant specifying how the boundary condition is defined in a BUCKLE analysis. Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES, and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.
localCsys: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Returns:

A TypeBC object.

Notes

This function can be accessed by:

mdb.models[name].PinnedBC

PorePressureBC(name: str, createStepName: str, region: Region, fieldName: str = '', magnitude: float = 0, distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET', fixed: BooleanType = 0) → PorePressureBC[source]#

This method creates a PorePressureBC object.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: A Region object specifying the region to which the boundary condition is applied.
fieldName: A String specifying the name of the AnalyticalField object associated with this boundary condition. The fieldName argument applies only when *distributionType*=FIELD. The default value is an empty string.
magnitude: A Float specifying the pore pressure magnitude. The default value is 0. The magnitude argument is optional if *distributionType*=USER_DEFINED.
distributionType: A SymbolicConstant specifying how the boundary condition 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 boundary condition has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.
fixed: A Boolean specifying whether the boundary condition should remain fixed at the current values at the start of the step. The default value is OFF.

Returns:

bc: PorePressureBC: A PorePressureBC object.

Notes

This function can be accessed by:

mdb.models[name].PorePressureBC

RetainedNodalDofsBC(name: str, createStepName: str, region: Region, u1: BooleanType = 0, u2: BooleanType = 0, u3: BooleanType = 0, ur1: BooleanType = 0, ur2: BooleanType = 0, ur3: BooleanType = 0) → RetainedNodalDofsBC[source]#

This method creates a RetainedNodalDofsBC object.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: A Region object specifying the region to which the boundary condition is applied.
u1: A Boolean specifying whether to retain the degree of freedom in the 1-direction. The default value is OFF indicating that the degree of freedom is not retained.
u2: A Boolean specifying whether to retain the degree of freedom in the 2-direction. The default value is OFF indicating that the degree of freedom is not retained.
u3: A Boolean specifying whether to retain the degree of freedom in the 3-direction. The default value is OFF indicating that the degree of freedom is not retained.
ur1: A Boolean specifying whether to retain the rotational degree of freedom about the 1-direction. The default value is OFF indicating that the degree of freedom is not retained.
ur2: A Boolean specifying whether to retain the rotational degree of freedom about the 2-direction. The default value is OFF indicating that the degree of freedom is not retained.
ur3: A Boolean specifying whether to retain the rotational degree of freedom about the 3-direction. The default value is OFF indicating that the degree of freedom is not retained.

Returns:

bc: RetainedNodalDofsBC: A RetainedNodalDofsBC object.

Notes

This function can be accessed by:

mdb.models[name].RetainedNodalDofsBC

SecondaryBaseBC(name: str, createStepName: str, regions: RegionArray, dofs: tuple) → SecondaryBaseBC[source]#

This method creates a SecondaryBaseBC object.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
regions: A RegionArray object specifying the region to which the boundary condition is applied. Note that the usual region is ignored. The default value is MODEL.
dofs: A sequence of sequences of Ints specifying the constrained degrees-of-freedom.

Returns:

bc: SecondaryBaseBC: A SecondaryBaseBC object.

Notes

This function can be accessed by:

mdb.models[name].SecondaryBaseBC

SubmodelBC(name: str, createStepName: str, region: Region, dof: tuple, globalStep: str, timeScale: BooleanType, shellThickness: float, globalDrivingRegion: str = '', absoluteExteriorTolerance: float | None = None, exteriorTolerance: float = 0, localCsys: str | None = None, globalIncrement: int = 0, centerZoneSize: float | None = None, intersectionOnly: BooleanType = 0) → SubmodelBC[source]#

This method creates a SubmodelBC object.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: A Region object specifying the region to which the boundary condition is applied.
dof: A sequence of Ints specifying the degrees of freedom to which the boundary condition 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.
timeScale: A Boolean specifying whether to scale the time variable for the driven nodes’ amplitude functions to match the submodel analysis step time. The default value is OFF.
shellThickness: A Float specifying the thickness of the shell in the global model. This argument is required for shell-to-solid submodeling and is not applicable to other submodels. The default value is 0.0.
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.
localCsys: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.
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.
centerZoneSize: A Float specifying the thickness of the center zone size around the shell midsurface. The default value is None.
intersectionOnly: A Boolean specifying whether to ignore driven nodes that lie outside the region of elements of the global model after accounting for the exterior search tolerance. The default value is OFF.

Returns:

bc: SubmodelBC: A SubmodelBC object.

Notes

This function can be accessed by:

mdb.models[name].SubmodelBC

TemperatureBC(name: str, createStepName: str, region: Region, fieldName: str = '', magnitude: float = 0, dof: tuple = (), amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM', fixed: BooleanType = 0) → TemperatureBC[source]#

This method creates a TemperatureBC object.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: A Region object specifying the region to which the boundary condition is applied.
fieldName: A String specifying the name of the AnalyticalField object associated with this boundary condition. The fieldName argument applies only when *distributionType*=FIELD. The default value is an empty string.
magnitude: A Float specifying the temperature magnitude. The default value is 0.
dof: A sequence of Ints specifying the degrees of freedom to which the boundary condition is applied. The default value is (11,).
amplitude: A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the boundary condition 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 boundary condition is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
fixed: A Boolean specifying whether the boundary condition should remain fixed at the current values at the start of the step. The default value is OFF.

Returns:

bc: TemperatureBC: A TemperatureBC object.

Notes

This function can be accessed by:

mdb.models[name].TemperatureBC

VelocityBC(name: str, createStepName: str, region: Region, fieldName: str = '', v1: SymbolicConstantType | float = 'UNSET', v2: SymbolicConstantType | float = 'UNSET', v3: SymbolicConstantType | float = 'UNSET', vr1: SymbolicConstantType | float = 'UNSET', vr2: SymbolicConstantType | float = 'UNSET', vr3: SymbolicConstantType | float = 'UNSET', amplitude: str = 'UNSET', localCsys: str | None = None, distributionType: SymbolicConstantType = 'UNIFORM') → VelocityBC[source]#

This method creates a VelocityBC object.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: A Region object specifying the region to which the boundary condition is applied.
fieldName: A String specifying the name of the AnalyticalField object associated with this boundary condition. The fieldName argument applies only when *distributionType*=FIELD. The default value is an empty string.
v1: A Float or a SymbolicConstant specifying the velocity component in the 1-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.Note:Although v1, v2, v3, vr1, vr2, and vr3 are optional arguments, at least one of them must be specified.
v2: A Float or a SymbolicConstant specifying the velocity component in the 2-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
v3: A Float or a SymbolicConstant specifying the velocity component in the 3-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
vr1: A Float or a SymbolicConstant specifying the rotational velocity component about the 1-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
vr2: A Float or a SymbolicConstant specifying the rotational velocity component about the 2-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
vr3: A Float or a SymbolicConstant specifying the rotational velocity component about the 3-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
amplitude: A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the boundary condition has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.
localCsys: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.
distributionType: A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

Returns:

bc: VelocityBC: A VelocityBC object.

Notes

This function can be accessed by:

mdb.models[name].VelocityBC

VelocityBaseMotionBC(name: str, createStepName: str, dof: SymbolicConstantType, amplitudeScaleFactor: float = 1, centerOfRotation: tuple = (), correlation: CorrelationArray | None = None, secondaryBase: str = '', useComplex: BooleanType = 0, amplitude: str = 'UNSET') → VelocityBaseMotionBC[source]#

This method creates a VelocityBaseMotionBC object.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
dof: A SymbolicConstant specifying the constrained degree-of-freedom. Possible values for the SymbolicConstant are U1, U2, U3, UR1, UR2, UR3. The default value is U1.
amplitudeScaleFactor: A Float specifying the scale factor for the amplitude curve. The default value is 1.0.
centerOfRotation: A ModelDot object specifying a tuple containing one center of rotation. The default value is the global origin. This argument applies only when *dof*=UR1, UR2, or UR3.
correlation: A CorrelationArray object.
secondaryBase: A String specifying the name of the SecondaryBaseBC object associated with this boundary condition. The default value is an empty string.
useComplex: A Boolean specifying whether to define the imaginary (out-of-plane) portion of the base motion record given by amplitude definition. The default value is OFF.
amplitude: A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the boundary condition 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:

bc: VelocityBaseMotionBC: A VelocityBaseMotionBC object.

Notes

This function can be accessed by:

mdb.models[name].VelocityBaseMotionBC

XasymmBC(name: str, createStepName: str, region: Region, buckleCase: SymbolicConstantType = 'NOT_APPLICABLE', localCsys: str | None = None) → TypeBC[source]#

This method creates a TypeBC object that specifies antisymmetry about the X-axis.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: A Region object specifying the region to which the boundary condition is applied.
buckleCase: A SymbolicConstant specifying how the boundary condition is defined in a BUCKLE analysis. Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES, and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.
localCsys: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Returns:

A TypeBC object.

Notes

This function can be accessed by:

mdb.models[name].EncastreBC

XsymmBC(name: str, createStepName: str, region: Region, buckleCase: SymbolicConstantType = 'NOT_APPLICABLE', localCsys: str | None = None) → TypeBC[source]#

This method creates a TypeBC object that specifies symmetry about the X-axis.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: A Region object specifying the region to which the boundary condition is applied.
buckleCase: A SymbolicConstant specifying how the boundary condition is defined in a BUCKLE analysis. Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES, and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.
localCsys: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Returns:

A TypeBC object.

Notes

This function can be accessed by:

mdb.models[name].EncastreBC

YasymmBC(name: str, createStepName: str, region: Region, buckleCase: SymbolicConstantType = 'NOT_APPLICABLE', localCsys: str | None = None) → TypeBC[source]#

This method creates a TypeBC object that specifies antisymmetry about the Y-axis.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: A Region object specifying the region to which the boundary condition is applied.
buckleCase: A SymbolicConstant specifying how the boundary condition is defined in a BUCKLE analysis. Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES, and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.
localCsys: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Returns:

A TypeBC object.

Notes

This function can be accessed by:

mdb.models[name].YasymmBC

YsymmBC(name: str, createStepName: str, region: Region, buckleCase: SymbolicConstantType = 'NOT_APPLICABLE', localCsys: str | None = None) → TypeBC[source]#

This method creates a TypeBC object that specifies symmetry about the Y-axis.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: A Region object specifying the region to which the boundary condition is applied.
buckleCase: A SymbolicConstant specifying how the boundary condition is defined in a BUCKLE analysis. Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES, and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.
localCsys: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Returns:

A TypeBC object.

Notes

This function can be accessed by:

mdb.models[name].YsymmBC

ZasymmBC(name: str, createStepName: str, region: Region, buckleCase: SymbolicConstantType = 'NOT_APPLICABLE', localCsys: str | None = None) → TypeBC[source]#

This method creates a TypeBC object that specifies antisymmetry about the Z-axis.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: A Region object specifying the region to which the boundary condition is applied.
buckleCase: A SymbolicConstant specifying how the boundary condition is defined in a BUCKLE analysis. Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES, and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.
localCsys: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Returns:

A TypeBC object.

Notes

This function can be accessed by:

mdb.models[name].ZasymmBC

ZsymmBC(name: str, createStepName: str, region: Region, buckleCase: SymbolicConstantType = 'NOT_APPLICABLE', localCsys: str | None = None) → TypeBC[source]#

This method creates a TypeBC object that specifies symmetry about the Z-axis.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: A Region object specifying the region to which the boundary condition is applied.
buckleCase: A SymbolicConstant specifying how the boundary condition is defined in a BUCKLE analysis. Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES, and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.
localCsys: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Returns:

A TypeBC object.

Notes

This function can be accessed by:

mdb.models[name].EncastreBC

Object features#

BoundaryCondition#

class BoundaryCondition[source]#

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

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the boundary condition repository key.
category: SymbolicConstant: A SymbolicConstant specifying the category of the boundary condition. Possible values are MECHANICAL and THERMAL.
region: Region: A Region object specifying the region to which the boundary condition is applied.
localCsys: str: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Methods

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

setValues
setValuesInStep

deactivate(stepName: str)[source]#

This method deactivates the boundary condition in the specified step and all subsequent steps.

Parameters:

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

delete(indices: tuple)[source]#

This method allows you to delete existing boundary conditions.

Parameters:

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

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

This method moves the boundary condition state from one step to a different step.

Parameters:

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

reset(stepName: str)[source]#

This method resets the boundary condition state of the specified step to the state of the previous analysis step.

Parameters:

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

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

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

BoundaryConditionState#

class BoundaryConditionState[source]#

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

Notes

This object can be accessed by:

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

Attributes:

amplitudeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the amplitude reference. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
status: SymbolicConstant: A SymbolicConstant specifying the propagation state of the BoundaryConditionState object. Possible values are: NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE PROPAGATED_FROM_BASE_STATE MODIFIED_FROM_BASE_STATE DEACTIVATED_FROM_BASE_STATE BUILT_INTO_MODES
amplitude: str: A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference.

AccelerationBaseMotionBC#

class AccelerationBaseMotionBC(name: str, createStepName: str, dof: SymbolicConstantType, amplitudeScaleFactor: float = 1, centerOfRotation: tuple = (), correlation: CorrelationArray | None = None, secondaryBase: str = '', useComplex: BooleanType = 0, amplitude: str = 'UNSET')[source]#

The AccelerationBaseMotionBC object stores the data for an acceleration base motion boundary condition. The AccelerationBaseMotionBC object is derived from the BoundaryCondition object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the boundary condition repository key.
amplitudeScaleFactor: float: A Float specifying the scale factor for the amplitude curve. The default value is 1.0.
useComplex: Boolean: A Boolean specifying whether to define the imaginary (out-of-plane) portion of the base motion record given by amplitude definition. The default value is OFF.
centerOfRotation: tuple: A ModelDot object specifying a tuple containing one center of rotation. The default value is the global origin. This argument applies only when dof=UR1, UR2, or UR3.
correlation: CorrelationArray: A CorrelationArray object.
secondaryBase: str: A String specifying the name of the SecondaryBaseBC object associated with this boundary condition. The default value is an empty string.
category: SymbolicConstant: A SymbolicConstant specifying the category of the boundary condition. Possible values are MECHANICAL and THERMAL.
region: Region: A Region object specifying the region to which the boundary condition is applied.
localCsys: str: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Methods

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

setValues(amplitudeScaleFactor: float = 1, centerOfRotation: tuple = (), correlation: CorrelationArray | None = None, secondaryBase: str = '', useComplex: BooleanType = 0, amplitude: str = 'UNSET')[source]#

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

Parameters:

amplitudeScaleFactor: A Float specifying the scale factor for the amplitude curve. The default value is 1.0.
centerOfRotation: A ModelDot object specifying a tuple containing one center of rotation. The default value is the global origin. This argument applies only when *dof*=UR1, UR2, or UR3.
correlation: A CorrelationArray object.
secondaryBase: A String specifying the name of the SecondaryBaseBC object associated with this boundary condition. The default value is an empty string.
useComplex: A Boolean specifying whether to define the imaginary (out-of-plane) portion of the base motion record given by amplitude definition. The default value is OFF.
amplitude: A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the boundary condition 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, amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the boundary condition is modified.
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 boundary condition is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

AccelerationBaseMotionBCState#

class AccelerationBaseMotionBCState[source]#

The AccelerationBaseMotionBCState object stores the propagating data for a velocity base motion boundary condition in a step. One instance of this object is created internally by the AccelerationBaseMotionBC object for each step. The instance is also deleted internally by the AccelerationBaseMotionBC object. The AccelerationBaseMotionBCState object has no constructor or methods. The AccelerationBaseMotionBCState object is derived from the BoundaryConditionState object.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

BASE MOTION

Attributes:

amplitudeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the amplitude reference. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
status: SymbolicConstant: A SymbolicConstant specifying the propagation state of the BoundaryConditionState object. Possible values are: NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE PROPAGATED_FROM_BASE_STATE MODIFIED_FROM_BASE_STATE DEACTIVATED_FROM_BASE_STATE BUILT_INTO_MODES
amplitude: str: A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference.

AccelerationBC#

class AccelerationBC(name: str, createStepName: str, region: Region, fieldName: str = '', a1: SymbolicConstantType | float = 'UNSET', a2: SymbolicConstantType | float = 'UNSET', a3: SymbolicConstantType | float = 'UNSET', ar1: SymbolicConstantType | float = 'UNSET', ar2: SymbolicConstantType | float = 'UNSET', ar3: SymbolicConstantType | float = 'UNSET', amplitude: str = 'UNSET', localCsys: str | None = None, distributionType: SymbolicConstantType = 'UNIFORM')[source]#

The AccelerationBC object stores the data for an acceleration boundary condition. The AccelerationBC object is derived from the BoundaryCondition object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the boundary condition repository key.
distributionType: SymbolicConstant: A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
fieldName: str: A String specifying the name of the AnalyticalField object associated with this boundary condition. The fieldName argument applies only when distributionType=FIELD. The default value is an empty string.
category: SymbolicConstant: A SymbolicConstant specifying the category of the boundary condition. Possible values are MECHANICAL and THERMAL.
region: Region: A Region object specifying the region to which the boundary condition is applied.
localCsys: str: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Methods

`setValues`([fieldName, a1, a2, a3, ar1, ar2, ...])	This method modifies the data for an existing AccelerationBC object in the step where it is created.
`setValuesInStep`(stepName[, a1, a2, a3, ar1, ...])	This method modifies the propagating data for an existing AccelerationBC object in the specified step.

setValues(fieldName: str = '', a1: SymbolicConstantType | float = 'UNSET', a2: SymbolicConstantType | float = 'UNSET', a3: SymbolicConstantType | float = 'UNSET', ar1: SymbolicConstantType | float = 'UNSET', ar2: SymbolicConstantType | float = 'UNSET', ar3: SymbolicConstantType | float = 'UNSET', amplitude: str = 'UNSET', localCsys: str | None = None, distributionType: SymbolicConstantType = 'UNIFORM')[source]#

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

Parameters:

fieldName: A String specifying the name of the AnalyticalField object associated with this boundary condition. The fieldName argument applies only when *distributionType*=FIELD. The default value is an empty string.
a1: A Float or a SymbolicConstant specifying the acceleration component in the 1-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.Note:Although a1, a2, a3, ar1, ar2, and ar3 are optional arguments, at least one of them must be specified.
a2: A Float or a SymbolicConstant specifying the acceleration component in the 2-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
a3: A Float or a SymbolicConstant specifying the acceleration component in the 3-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
ar1: A Float or a SymbolicConstant specifying the rotational acceleration component about the 1-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
ar2: A Float or a SymbolicConstant specifying the rotational acceleration component about the 2-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
ar3: A Float or a SymbolicConstant specifying the rotational acceleration component about the 3-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
amplitude: A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the boundary condition has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.
localCsys: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.
distributionType: A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

setValuesInStep(stepName: str, a1: SymbolicConstantType | float = 'SET', a2: SymbolicConstantType | float = 'SET', a3: SymbolicConstantType | float = 'SET', ar1: SymbolicConstantType | float = 'SET', ar2: SymbolicConstantType | float = 'SET', ar3: SymbolicConstantType | float = 'SET', amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the boundary condition is modified.
a1: A Float or a SymbolicConstant specifying the acceleration component in the 1-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
a2: A Float or a SymbolicConstant specifying the acceleration component in the 2-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
a3: A Float or a SymbolicConstant specifying the acceleration component in the 3-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
ar1: A Float or a SymbolicConstant specifying the rotational acceleration component about the 1-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
ar2: A Float or a SymbolicConstant specifying the rotational acceleration component about the 2-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
ar3: A Float or a SymbolicConstant specifying the rotational acceleration component about the 3-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
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 boundary condition is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

AccelerationBCState#

class AccelerationBCState[source]#

The AccelerationBCState object stores the propagating data of an acceleration boundary condition in a step. One instance of this object is created internally by the AccelerationBC object for each step. The instance is also deleted internally by the AccelerationBC object. The AccelerationBCState object has no constructor or methods. The AccelerationBCState object is derived from the BoundaryConditionState object.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

BOUNDARY

Attributes:

a1: float: A Float specifying the acceleration component in the 1-direction.
a2: float: A Float specifying the acceleration component in the 2-direction.
a3: float: A Float specifying the acceleration component in the 3-direction.
ar1: float: A Float specifying the rotational acceleration component about the 1-direction.
ar2: float: A Float specifying the rotational acceleration component about the 2-direction.
ar3: float: A Float specifying the rotational acceleration component about the 3-direction.
a1State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the acceleration component in the 1-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
a2State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the acceleration component in the 2-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
a3State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the acceleration component in the 3-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
ar1State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the rotational acceleration component about the 1-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
ar2State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the rotational acceleration component about the 2-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
ar3State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the rotational acceleration component about the 3-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
amplitudeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the amplitude reference. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
status: SymbolicConstant: A SymbolicConstant specifying the propagation state of the BoundaryConditionState object. Possible values are: NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE PROPAGATED_FROM_BASE_STATE MODIFIED_FROM_BASE_STATE DEACTIVATED_FROM_BASE_STATE BUILT_INTO_MODES
amplitude: str: A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference.

AcousticPressureBC#

class AcousticPressureBC(name: str, createStepName: str, region: Region, fieldName: str = '', magnitude: float = 0, distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET', fixed: BooleanType = 0)[source]#

The AcousticPressureBC object stores the data for an acoustic pressure boundary condition. The AcousticPressureBC object is derived from the BoundaryCondition object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the boundary condition repository key.
distributionType: SymbolicConstant: A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
fieldName: str: A String specifying the name of the AnalyticalField object associated with this boundary condition. The fieldName argument applies only when distributionType=FIELD. The default value is an empty string.
category: SymbolicConstant: A SymbolicConstant specifying the category of the boundary condition. Possible values are MECHANICAL and THERMAL.
region: Region: A Region object specifying the region to which the boundary condition is applied.
localCsys: str: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Methods

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

setValues(fieldName: str = '', magnitude: float = 0, distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET', fixed: BooleanType = 0)[source]#

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

Parameters:

fieldName: A String specifying the name of the AnalyticalField object associated with this boundary condition. The fieldName argument applies only when *distributionType*=FIELD. The default value is an empty string.
magnitude: A Float specifying the acoustic pressure magnitude. The default value is 0. The magnitude argument is optional if *distributionType*=USER_DEFINED.
distributionType: A SymbolicConstant specifying how the boundary condition 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 boundary condition has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.
fixed: A Boolean specifying whether the boundary condition should remain fixed at the current values at the start of the step. The default value is OFF.

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

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

Parameters:

stepName: A String specifying the name of the step in which the boundary condition is modified.
magnitude: A Float or the SymbolicConstant FREED specifying the acoustic pressure 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 boundary condition is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

AcousticPressureBCState#

class AcousticPressureBCState[source]#

The AcousticPressureBCState object stores the propagating data for an acoustic pressure boundary condition in a step. One instance of this object is created internally by the AcousticPressureBC object for each step. The instance is also deleted internally by the AcousticPressureBC object. The AcousticPressureBCState object has no constructor or methods. The AcousticPressureBCState object is derived from the BoundaryConditionState object.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

BOUNDARY

Attributes:

magnitude: float: A Float specifying the acoustic pressure magnitude.
magnitudeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the acoustic pressure magnitude. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
amplitudeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the amplitude reference. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
status: SymbolicConstant: A SymbolicConstant specifying the propagation state of the BoundaryConditionState object. Possible values are: NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE PROPAGATED_FROM_BASE_STATE MODIFIED_FROM_BASE_STATE DEACTIVATED_FROM_BASE_STATE BUILT_INTO_MODES
amplitude: str: A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference.

Create Calibration#

class Calibration(name: str)[source]#

A Calibration object is the object used to specify a material calibration. The Calibration object stores the data that is used for specifying materials from test data.

Notes

This object can be accessed by:

import calibration
mdb.models[name].calibrations[name]

Attributes:

dataSets: DataSet: A DataSet object.
behaviors: Behavior: A Behavior object.

ConcentrationBC#

class ConcentrationBC(name: str, createStepName: str, region: Region, fieldName: str = '', magnitude: float = 0, distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET', fixed: BooleanType = 0)[source]#

The ConcentrationBC object stores the data for a concentration boundary condition. The ConcentrationBC object is derived from the BoundaryCondition object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the boundary condition repository key.
distributionType: SymbolicConstant: A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
fieldName: str: A String specifying the name of the AnalyticalField object associated with this boundary condition. The fieldName argument applies only when distributionType=FIELD. The default value is an empty string.
category: SymbolicConstant: A SymbolicConstant specifying the category of the boundary condition. Possible values are MECHANICAL and THERMAL.
region: Region: A Region object specifying the region to which the boundary condition is applied.
localCsys: str: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Methods

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

setValues(fieldName: str = '', magnitude: float = 0, distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET', fixed: BooleanType = 0)[source]#

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

Parameters:

fieldName: A String specifying the name of the AnalyticalField object associated with this boundary condition. The fieldName argument applies only when *distributionType*=FIELD. The default value is an empty string.
magnitude: A Float specifying the concentration magnitude. The default value is 0. The magnitude argument is optional if *distributionType*=USER_DEFINED.
distributionType: A SymbolicConstant specifying how the boundary condition 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 boundary condition has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.
fixed: A Boolean specifying whether the boundary condition should remain fixed at the current values at the start of the step. The default value is OFF.

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

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

Parameters:

stepName: A String specifying the name of the step in which the boundary condition is modified.
magnitude: A Float or the SymbolicConstant FREED specifying the concentration 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 boundary condition is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

ConcentrationBCState#

class ConcentrationBCState[source]#

The ConcentrationBCState object stores the propagating data for a concentration boundary condition in a step. One instance of this object is created internally by the ConcentrationBC object for each step. The instance is also deleted internally by the ConcentrationBC object. The ConcentrationBCState object has no constructor or methods. The ConcentrationBCState object is derived from the BoundaryConditionState object.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

BOUNDARY

Attributes:

magnitude: float: A Float specifying the concentration magnitude.
magnitudeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the concentration magnitude. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
amplitudeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the amplitude reference. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
status: SymbolicConstant: A SymbolicConstant specifying the propagation state of the BoundaryConditionState object. Possible values are: NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE PROPAGATED_FROM_BASE_STATE MODIFIED_FROM_BASE_STATE DEACTIVATED_FROM_BASE_STATE BUILT_INTO_MODES
amplitude: str: A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference.

ConnAccelerationBC#

class ConnAccelerationBC(name: str, createStepName: str, region: str = '', fastenerName: str = '', fastenerSetName: str = '', a1: SymbolicConstantType | float = 'UNSET', a2: SymbolicConstantType | float = 'UNSET', a3: SymbolicConstantType | float = 'UNSET', ar1: SymbolicConstantType | float = 'UNSET', ar2: SymbolicConstantType | float = 'UNSET', ar3: SymbolicConstantType | float = 'UNSET', amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM')[source]#

The ConnAccelerationBC object stores the data for a connector acceleration boundary condition. The ConnAccelerationBC object is derived from the BoundaryCondition object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the boundary condition repository key.
distributionType: SymbolicConstant: A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM.
fastenerName: str: A String specifying the name of the assembled fastener to which the boundary condition 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 boundary condition 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.
category: SymbolicConstant: A SymbolicConstant specifying the category of the boundary condition. Possible values are MECHANICAL and THERMAL.
region: Region: A Region object specifying the region to which the boundary condition is applied.
localCsys: str: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Methods

`setValues`([region, fastenerName, ...])	This method modifies the data for an existing ConnAccelerationBC object in the step where it is created.
`setValuesInStep`(stepName[, a1, a2, a3, ar1, ...])	This method modifies the propagating data for an existing ConnAccelerationBC object in the specified step.

setValues(region: str = '', fastenerName: str = '', fastenerSetName: str = '', a1: SymbolicConstantType | float = 'UNSET', a2: SymbolicConstantType | float = 'UNSET', a3: SymbolicConstantType | float = 'UNSET', ar1: SymbolicConstantType | float = 'UNSET', ar2: SymbolicConstantType | float = 'UNSET', ar3: SymbolicConstantType | float = 'UNSET', amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM')[source]#

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

Parameters:

region: The wire region to which the boundary condition 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 boundary condition 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 boundary condition 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.
a1: A Float or a SymbolicConstant specifying the acceleration component in the connector’s local 1-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.Note:Although a1, a2, a3, ar1, ar2, and ar3 are optional arguments, at least one of them must be specified.
a2: A Float or a SymbolicConstant specifying the acceleration component in the connector’s local 2-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
a3: A Float or a SymbolicConstant specifying the acceleration component in the connector’s local 3-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
ar1: A Float or a SymbolicConstant specifying the rotational acceleration component in the connector’s local 4-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
ar2: A Float or a SymbolicConstant specifying the rotational acceleration component in the connector’s local 5-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
ar3: A Float or a SymbolicConstant specifying the rotational acceleration component in the connector’s local 6-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
amplitude: A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the boundary condition 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 boundary condition is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM.

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

Parameters:

stepName: A String specifying the name of the step in which the boundary condition is modified.
a1: A Float or a SymbolicConstant specifying the connector acceleration component in the connector’s local 1-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
a2: A Float or a SymbolicConstant specifying the connector acceleration component in the connector’s local 2-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
a3: A Float or a SymbolicConstant specifying the connector acceleration component in the connector’s local 3-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
ar1: A Float or a SymbolicConstant specifying the connector acceleration component in the connector’s local 4-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
ar2: A Float or a SymbolicConstant specifying the connector acceleration component in the connector’s local 5-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
ar3: A Float or a SymbolicConstant specifying the connector acceleration component in the connector’s local 6-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
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 boundary condition is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

ConnAccelerationBCState#

class ConnAccelerationBCState[source]#

The ConnAccelerationBCState object stores the propagating data of a connector acceleration boundary condition in a step. One instance of this object is created internally by the ConnAccelerationBC object for each step. The instance is also deleted internally by the ConnAccelerationBC object. The ConnAccelerationBCState object has no constructor or methods. The ConnAccelerationBCState object is derived from the BoundaryConditionState object.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

CONNECTOR MOTION

Attributes:

a1: float: A Float specifying the connector acceleration component in the connector’s local 1-direction.
a2: float: A Float specifying the connector acceleration component in the connector’s local 2-direction.
a3: float: A Float specifying the connector acceleration component in the connector’s local 3-direction.
ar1: float: A Float specifying the connector acceleration component in the connector’s local 4-direction.
ar2: float: A Float specifying the connector acceleration component in the connector’s local 5-direction.
ar3: float: A Float specifying the connector acceleration component in the connector’s local 6-direction.
a1State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the connector acceleration component in the connector’s local 1-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
a2State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the connector acceleration component in the connector’s local 2-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
a3State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the connector acceleration component in the connector’s local 3-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
ar1State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the connector acceleration component in the connector’s local 4-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
ar2State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the connector acceleration component in the connector’s local 5-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
ar3State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the connector acceleration component in the connector’s local 6-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
amplitudeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the amplitude reference. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
status: SymbolicConstant: A SymbolicConstant specifying the propagation state of the BoundaryConditionState object. Possible values are: NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE PROPAGATED_FROM_BASE_STATE MODIFIED_FROM_BASE_STATE DEACTIVATED_FROM_BASE_STATE BUILT_INTO_MODES
amplitude: str: A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference.

ConnDisplacementBC#

class ConnDisplacementBC(name: str, createStepName: str, region: str = '', fastenerName: str = '', fastenerSetName: str = '', u1: SymbolicConstantType | float = 'UNSET', u2: SymbolicConstantType | float = 'UNSET', u3: SymbolicConstantType | float = 'UNSET', ur1: SymbolicConstantType | float = 'UNSET', ur2: SymbolicConstantType | float = 'UNSET', ur3: SymbolicConstantType | float = 'UNSET', fixed: BooleanType = 0, amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM', buckleCase: SymbolicConstantType = 'NOT_APPLICABLE')[source]#

The ConnDisplacementBC object stores the data for a connector displacement/rotation boundary condition. The ConnDisplacementBC object is derived from the BoundaryCondition object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the boundary condition repository key.
fixed: Boolean: A Boolean specifying whether the boundary condition should remain fixed at the current values at the start of the step. The default value is OFF.
buckleCase: SymbolicConstant: A SymbolicConstant specifying how the boundary condition is defined in a BUCKLE analysis. Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES, and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.
distributionType: SymbolicConstant: A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM.
fastenerName: str: A String specifying the name of the assembled fastener to which the boundary condition 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 boundary condition 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.
category: SymbolicConstant: A SymbolicConstant specifying the category of the boundary condition. Possible values are MECHANICAL and THERMAL.
region: Region: A Region object specifying the region to which the boundary condition is applied.
localCsys: str: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Methods

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

setValues(region: str = '', fastenerName: str = '', fastenerSetName: str = '', u1: SymbolicConstantType | float = 'UNSET', u2: SymbolicConstantType | float = 'UNSET', u3: SymbolicConstantType | float = 'UNSET', ur1: SymbolicConstantType | float = 'UNSET', ur2: SymbolicConstantType | float = 'UNSET', ur3: SymbolicConstantType | float = 'UNSET', fixed: BooleanType = 0, amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM', buckleCase: SymbolicConstantType = 'NOT_APPLICABLE')[source]#

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

Parameters:

region: The wire region to which the boundary condition 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 boundary condition 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 boundary condition 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.
u1: A Float, a Complex, or a SymbolicConstant specifying the displacement component in the connector’s local 1-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.Note:Although u1, u2, u3, ur1, ur2, and ur3 are optional arguments, at least one of them must be specified.
u2: A Float, a Complex, or a SymbolicConstant specifying the displacement component in the connector’s local 2-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
u3: A Float, a Complex, or a SymbolicConstant specifying the displacement component in the connector’s local 3-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
ur1: A Float, a Complex, or a SymbolicConstant specifying the rotational component in the connector’s local 4-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
ur2: A Float, a Complex, or a SymbolicConstant specifying the rotational component in the connector’s local 5-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
ur3: A Float, a Complex, or a SymbolicConstant specifying the rotational component in the connector’s local 6-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
fixed: A Boolean specifying whether the boundary condition should remain fixed at the current values at the start of the step. The default value is OFF.
amplitude: A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the boundary condition 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 boundary condition is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM.
buckleCase: A SymbolicConstant specifying how the boundary condition is defined in a BUCKLE analysis. Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES, and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.

setValuesInStep(stepName: str, u1: SymbolicConstantType | float = 'SET', u2: SymbolicConstantType | float = 'SET', u3: SymbolicConstantType | float = 'SET', ur1: SymbolicConstantType | float = 'SET', ur2: SymbolicConstantType | float = 'SET', ur3: SymbolicConstantType | float = 'SET', amplitude: str = '', buckleCase: SymbolicConstantType = 'NOT_APPLICABLE')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the boundary condition is modified.
u1: A Float, a Complex, or a SymbolicConstant specifying the displacement component in the connector’s local 1-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
u2: A Float, a Complex, or a SymbolicConstant specifying the displacement component in the connector’s local 2-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
u3: A Float, a Complex, or a SymbolicConstant specifying the displacement component in the connector’s local 3-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
ur1: A Float, a Complex, or a SymbolicConstant specifying the rotational component in the connector’s local 4-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
ur2: A Float, a Complex, or a SymbolicConstant specifying the rotational component in the connector’s local 5-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
ur3: A Float, a Complex, or a SymbolicConstant specifying the rotational component in the connector’s local 6-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
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 boundary condition is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.
buckleCase: A SymbolicConstant specifying how the boundary condition is defined in a BUCKLE analysis. Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES, and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.

ConnDisplacementBCState#

class ConnDisplacementBCState[source]#

The ConnDisplacementBCState object stores the propagating data for a connector displacement/rotation boundary condition in a step. One instance of this object is created internally by the ConnDisplacementBC object for each step. The instance is also deleted internally by the ConnDisplacementBC object. The ConnDisplacementBCState object has no constructor or methods. The ConnDisplacementBCState object is derived from the BoundaryConditionState object.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

CONNECTOR MOTION

Attributes:

u1: float: A Float or a Complex specifying the displacement component in the connector’s local 1-direction.
u2: float: A Float or a Complex specifying the displacement component in the connector’s local 2-direction.
u3: float: A Float or a Complex specifying the displacement component in the connector’s local 3-direction.
ur1: float: A Float or a Complex specifying the rotational component in the connector’s local 4-direction.
ur2: float: A Float or a Complex specifying the rotational component in the connector’s local 5-direction.
ur3: float: A Float or a Complex specifying the rotational component in the connector’s local 6-direction.
u1State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the displacement component in the connector’s local 1-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
u2State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the displacement component in the connector’s local 2-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
u3State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the displacement component in the connector’s local 3-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
ur1State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the rotational component in the connector’s local 4-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
ur2State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the rotational component in the connector’s local 5-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
ur3State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the rotational component in the connector’s local 6-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
amplitudeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the amplitude reference. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
status: SymbolicConstant: A SymbolicConstant specifying the propagation state of the BoundaryConditionState object. Possible values are: NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE PROPAGATED_FROM_BASE_STATE MODIFIED_FROM_BASE_STATE DEACTIVATED_FROM_BASE_STATE BUILT_INTO_MODES
amplitude: str: A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference.

ConnVelocityBC#

class ConnVelocityBC(name: str, createStepName: str, region: str = '', fastenerName: str = '', fastenerSetName: str = '', v1: SymbolicConstantType | float = 'UNSET', v2: SymbolicConstantType | float = 'UNSET', v3: SymbolicConstantType | float = 'UNSET', vr1: SymbolicConstantType | float = 'UNSET', vr2: SymbolicConstantType | float = 'UNSET', vr3: SymbolicConstantType | float = 'UNSET', amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM')[source]#

The ConnVelocityBC object stores the data for a connector velocity boundary condition. The ConnVelocityBC object is derived from the BoundaryCondition object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the boundary condition repository key.
distributionType: SymbolicConstant: A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM.
fastenerName: str: A String specifying the name of the assembled fastener to which the boundary condition 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 boundary condition 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.
category: SymbolicConstant: A SymbolicConstant specifying the category of the boundary condition. Possible values are MECHANICAL and THERMAL.
region: Region: A Region object specifying the region to which the boundary condition is applied.
localCsys: str: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Methods

`setValues`([region, fastenerName, ...])	This method modifies the data for an existing ConnVelocityBC object in the step where it is created.
`setValuesInStep`(stepName[, v1, v2, v3, vr1, ...])	This method modifies the propagating data for an existing ConnVelocityBC object in the specified step.

setValues(region: str = '', fastenerName: str = '', fastenerSetName: str = '', v1: SymbolicConstantType | float = 'UNSET', v2: SymbolicConstantType | float = 'UNSET', v3: SymbolicConstantType | float = 'UNSET', vr1: SymbolicConstantType | float = 'UNSET', vr2: SymbolicConstantType | float = 'UNSET', vr3: SymbolicConstantType | float = 'UNSET', amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM')[source]#

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

Parameters:

region: The wire region to which the boundary condition 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 boundary condition 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 boundary condition 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.
v1: A Float or a SymbolicConstant specifying the velocity component in the connector’s local 1-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.Note:Although v1, v2, v3, vr1, vr2, and vr3 are optional arguments, at least one of them must be specified.
v2: A Float or a SymbolicConstant specifying the velocity component in the connector’s local 2-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
v3: A Float or a SymbolicConstant specifying the velocity component in the connector’s local 3-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
vr1: A Float or a SymbolicConstant specifying the rotational velocity component in the connector’s local 4-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
vr2: A Float or a SymbolicConstant specifying the rotational velocity component in the connector’s local 5-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
vr3: A Float or a SymbolicConstant specifying the rotational velocity component in the connector’s local 6-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
amplitude: A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the boundary condition 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 boundary condition is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM.

setValuesInStep(stepName: str, v1: SymbolicConstantType | float = 'SET', v2: SymbolicConstantType | float = 'SET', v3: SymbolicConstantType | float = 'SET', vr1: SymbolicConstantType | float = 'SET', vr2: SymbolicConstantType | float = 'SET', vr3: SymbolicConstantType | float = 'SET', amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the boundary condition is modified.
v1: A Float or a SymbolicConstant specifying the velocity component in the connector’s local 1-direction. Possible values for the SymbolicConstant are SET and FREED.
v2: A Float or a SymbolicConstant specifying the velocity component in the connector’s local 2-direction. Possible values for the SymbolicConstant are SET and FREED.
v3: A Float or a SymbolicConstant specifying the velocity component in the connector’s local 3-direction. Possible values for the SymbolicConstant are SET and FREED.
vr1: A Float or a SymbolicConstant specifying the rotational velocity component in the connector’s local 4-direction. Possible values for the SymbolicConstant are SET and FREED.
vr2: A Float or a SymbolicConstant specifying the rotational velocity component in the connector’s local 5-direction. Possible values for the SymbolicConstant are SET and FREED.
vr3: A Float or a SymbolicConstant specifying the rotational velocity component in the connector’s local 6-direction. Possible values for the SymbolicConstant are SET and FREED.
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 boundary condition is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

ConnVelocityBCState#

class ConnVelocityBCState[source]#

The ConnVelocityBCState object stores the propagating data for a velocity boundary condition in a step. One instance of this object is created internally by the ConnVelocityBC object for each step. The instance is also deleted internally by the ConnVelocityBC object. The ConnVelocityBCState object has no constructor or methods. The ConnVelocityBCState object is derived from the BoundaryConditionState object.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

CONNECTOR MOTION

Attributes:

v1: float: A Float specifying the velocity component in the connector’s local 1-direction.
v2: float: A Float specifying the velocity component in the connector’s local 2-direction.
v3: float: A Float specifying the velocity component in the connector’s local 3-direction.
vr1: float: A Float specifying the rotational velocity component in the connector’s local 4-direction.
vr2: float: A Float specifying the rotational velocity component in the connector’s local 5-direction.
vr3: float: A Float specifying the rotational velocity component in the connector’s local 6-direction.
v1State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the velocity component in the connector’s local 1-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
v2State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the velocity component in the connector’s local 2-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
v3State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the velocity component in the connector’s local 3-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
vr1State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the rotational velocity component in the connector’s local 4–direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
vr2State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the rotational velocity component in the connector’s local 5–direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
vr3State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the rotational velocity component in the connector’s local 6–direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
amplitudeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the amplitude reference. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
status: SymbolicConstant: A SymbolicConstant specifying the propagation state of the BoundaryConditionState object. Possible values are: NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE PROPAGATED_FROM_BASE_STATE MODIFIED_FROM_BASE_STATE DEACTIVATED_FROM_BASE_STATE BUILT_INTO_MODES
amplitude: str: A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference.

DisplacementBaseMotionBC#

class DisplacementBaseMotionBC(name: str, createStepName: str, dof: SymbolicConstantType, amplitudeScaleFactor: float = 1, centerOfRotation: tuple = (), correlation: CorrelationArray | None = None, secondaryBase: str = '', useComplex: BooleanType = 0, amplitude: str = 'UNSET')[source]#

The DisplacementBaseMotionBC object stores the data for a displacement base motion boundary condition. The DisplacementBaseMotionBC object is derived from the BoundaryCondition object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the boundary condition repository key.
amplitudeScaleFactor: float: A Float specifying the scale factor for the amplitude curve. The default value is 1.0.
useComplex: Boolean: A Boolean specifying whether to define the imaginary (out-of-plane) portion of the base motion record given by amplitude definition. The default value is OFF.
centerOfRotation: tuple: A ModelDot object specifying a tuple containing one center of rotation. The default value is the global origin. This argument applies only when dof=UR1, UR2, or UR3.
correlation: CorrelationArray: A CorrelationArray object.
secondaryBase: str: A String specifying the name of the SecondaryBaseBC object associated with this boundary condition. The default value is an empty string.
category: SymbolicConstant: A SymbolicConstant specifying the category of the boundary condition. Possible values are MECHANICAL and THERMAL.
region: Region: A Region object specifying the region to which the boundary condition is applied.
localCsys: str: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Methods

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

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

Parameters:

amplitudeScaleFactor: A Float specifying the scale factor for the amplitude curve. The default value is 1.0.
centerOfRotation: A ModelDot object specifying a tuple containing one center of rotation. The default value is the global origin. This argument applies only when *dof*=UR1, UR2, or UR3.
correlation: A CorrelationArray object.
secondaryBase: A String specifying the name of the SecondaryBaseBC object associated with this boundary condition. The default value is an empty string.
useComplex: A Boolean specifying whether to define the imaginary (out-of-plane) portion of the base motion record given by amplitude definition. The default value is OFF.
amplitude: A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the boundary condition 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, amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the boundary condition is modified.
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 boundary condition is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

DisplacementBaseMotionBCState#

class DisplacementBaseMotionBCState[source]#

The DisplacementBaseMotionBCState object stores the propagating data for a velocity base motion boundary condition in a step. One instance of this object is created internally by the DisplacementBaseMotionBC object for each step. The instance is also deleted internally by the DisplacementBaseMotionBC object. The DisplacementBaseMotionBCState object has no constructor or methods. The DisplacementBaseMotionBCState object is derived from the BoundaryConditionState object.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

BASE MOTION

Attributes:

amplitudeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the amplitude reference. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
status: SymbolicConstant: A SymbolicConstant specifying the propagation state of the BoundaryConditionState object. Possible values are: NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE PROPAGATED_FROM_BASE_STATE MODIFIED_FROM_BASE_STATE DEACTIVATED_FROM_BASE_STATE BUILT_INTO_MODES
amplitude: str: A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference.

DisplacementBC#

class DisplacementBC(name: str, createStepName: str, region: Region, fieldName: str = '', u1: SymbolicConstantType | float = 'UNSET', u2: SymbolicConstantType | float = 'UNSET', u3: SymbolicConstantType | float = 'UNSET', ur1: SymbolicConstantType | float = 'UNSET', ur2: SymbolicConstantType | float = 'UNSET', ur3: SymbolicConstantType | float = 'UNSET', fixed: BooleanType = 0, amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM', localCsys: str | None = None, buckleCase: SymbolicConstantType = 'NOT_APPLICABLE')[source]#

The DisplacementBC object stores the data for a displacement/rotation boundary condition. The DisplacementBC object is derived from the BoundaryCondition object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the boundary condition repository key.
distributionType: SymbolicConstant: A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible values are UNIFORM, USER_DEFINED, FIELD, and DISCRETE_FIELD. The default value is UNIFORM.
fixed: Boolean: A Boolean specifying whether the boundary condition should remain fixed at the current values at the start of the step. The default value is OFF.
buckleCase: SymbolicConstant: A SymbolicConstant specifying how the boundary condition is defined in a BUCKLE analysis. Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES, and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.
fieldName: str: A String specifying the name of the AnalyticalField or DiscreteField object associated with this boundary condition. The fieldName argument applies only when distributionType=FIELD or distributionType=DISCRETE_FIELD. The default value is an empty string.
category: SymbolicConstant: A SymbolicConstant specifying the category of the boundary condition. Possible values are MECHANICAL and THERMAL.
region: Region: A Region object specifying the region to which the boundary condition is applied.
localCsys: str: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Methods

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

setValues(fieldName: str = '', u1: SymbolicConstantType | float = 'UNSET', u2: SymbolicConstantType | float = 'UNSET', u3: SymbolicConstantType | float = 'UNSET', ur1: SymbolicConstantType | float = 'UNSET', ur2: SymbolicConstantType | float = 'UNSET', ur3: SymbolicConstantType | float = 'UNSET', fixed: BooleanType = 0, amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM', localCsys: str | None = None, buckleCase: SymbolicConstantType = 'NOT_APPLICABLE')[source]#

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

Parameters:

fieldName: A String specifying the name of the AnalyticalField or DiscreteField object associated with this boundary condition. The fieldName argument applies only when *distributionType*=FIELD or *distributionType*=DISCRETE_FIELD. The default value is an empty string.
u1: A Float, a Complex, or a SymbolicConstant specifying the displacement component in the 1-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.Note:Although u1, u2, u3, ur1, ur2, and ur3 are optional arguments, at least one of them must be specified.
u2: A Float, a Complex, or a SymbolicConstant specifying the displacement component in the 2-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
u3: A Float, a Complex, or a SymbolicConstant specifying the displacement component in the 3-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
ur1: A Float, a Complex, or a SymbolicConstant specifying the rotational displacement component about the 1-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
ur2: A Float, a Complex, or a SymbolicConstant specifying the rotational displacement component about the 2-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
ur3: A Float, a Complex, or a SymbolicConstant specifying the rotational displacement component about the 3-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
fixed: A Boolean specifying whether the boundary condition should remain fixed at the current values at the start of the step. The default value is OFF.
amplitude: A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the boundary condition 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 boundary condition is distributed spatially. Possible values are UNIFORM, USER_DEFINED, FIELD, and DISCRETE_FIELD. The default value is UNIFORM.
localCsys: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.
buckleCase: A SymbolicConstant specifying how the boundary condition is defined in a BUCKLE analysis. Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES, and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.

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

Parameters:

stepName: A String specifying the name of the step in which the boundary condition is modified.
u1: A Float, a Complex, or a SymbolicConstant specifying the displacement component in the 1-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
u2: A Float, a Complex, or a SymbolicConstant specifying the displacement component in the 2-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
u3: A Float, a Complex, or a SymbolicConstant specifying the displacement component in the 3-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
ur1: A Float, a Complex, or a SymbolicConstant specifying the rotational displacement component about the 1-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
ur2: A Float, a Complex, or a SymbolicConstant specifying the rotational displacement component about the 2-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
ur3: A Float, a Complex, or a SymbolicConstant specifying the rotational displacement component about the 3-direction. Possible values for the SymbolicConstant are SET, UNCHANGED, and FREED.
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 boundary condition is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.
buckleCase: A SymbolicConstant specifying how the boundary condition is defined in a BUCKLE analysis. Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES, and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.

DisplacementBCState#

class DisplacementBCState[source]#

The DisplacementBCState object stores the propagating data for a displacement/rotation boundary condition in a step. One instance of this object is created internally by the DisplacementBC object for each step. The instance is also deleted internally by the DisplacementBC object. The DisplacementBCState object has no constructor or methods. The DisplacementBCState object is derived from the BoundaryConditionState object.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

BOUNDARY

Attributes:

u1: float: A Float or a Complex specifying the displacement component in the 1-direction.
u2: float: A Float or a Complex specifying the displacement component in the 2-direction.
u3: float: A Float or a Complex specifying the displacement component in the 3-direction.
ur1: float: A Float or a Complex specifying the rotational displacement component about the 1-direction.
ur2: float: A Float or a Complex specifying the rotational displacement component about the 2-direction.
ur3: float: A Float or a Complex specifying the rotational displacement component about the 3-direction.
u1State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the displacement component in the 1-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
u2State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the displacement component in the 2-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
u3State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the displacement component in the 3-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
ur1State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the rotational displacement component about the 1-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
ur2State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the rotational displacement component about the 2-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
ur3State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the rotational displacement component about the 3-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
amplitudeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the amplitude reference. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
status: SymbolicConstant: A SymbolicConstant specifying the propagation state of the BoundaryConditionState object. Possible values are: NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE PROPAGATED_FROM_BASE_STATE MODIFIED_FROM_BASE_STATE DEACTIVATED_FROM_BASE_STATE BUILT_INTO_MODES
amplitude: str: A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference.

ElectricPotentialBC#

class ElectricPotentialBC(name: str, createStepName: str, region: Region, fieldName: str = '', magnitude: float = 0, distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET', fixed: BooleanType = 0)[source]#

The ElectricPotentialBC object stores the data for an electrical potential boundary condition. The ElectricPotentialBC object is derived from the BoundaryCondition object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the boundary condition repository key.
distributionType: SymbolicConstant: A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
fieldName: str: A String specifying the name of the AnalyticalField object associated with this boundary condition. The fieldName argument applies only when distributionType=FIELD. The default value is an empty string.
category: SymbolicConstant: A SymbolicConstant specifying the category of the boundary condition. Possible values are MECHANICAL and THERMAL.
region: Region: A Region object specifying the region to which the boundary condition is applied.
localCsys: str: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Methods

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

setValues(fieldName: str = '', magnitude: float = 0, distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET', fixed: BooleanType = 0)[source]#

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

Parameters:

fieldName: A String specifying the name of the AnalyticalField object associated with this boundary condition. The fieldName argument applies only when *distributionType*=FIELD. The default value is an empty string.
magnitude: A Float specifying the electrical potential magnitude. The default value is 0. The magnitude argument is optional if *distributionType*=USER_DEFINED.
distributionType: A SymbolicConstant specifying how the boundary condition 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 boundary condition has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.
fixed: A Boolean specifying whether the boundary condition should remain fixed at the current values at the start of the step. The default value is OFF.

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

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

Parameters:

stepName: A String specifying the name of the step in which the boundary condition is modified.
magnitude: A Float or the SymbolicConstant FREED specifying the electrical potential 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 boundary condition is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

ElectricPotentialBCState#

class ElectricPotentialBCState[source]#

The ElectricPotentialBCState object stores the propagating data for a electrical potential boundary condition in a step. One instance of this object is created internally by the ElectricPotentialBC object for each step. The instance is also deleted internally by the ElectricPotentialBC object. The ElectricPotentialBCState object has no constructor or methods. The ElectricPotentialBCState object is derived from the BoundaryConditionState object.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

BOUNDARY

Attributes:

magnitude: float: A Float specifying the electrical potential magnitude.
magnitudeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the electrical potential magnitude. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
amplitudeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the amplitude reference. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
status: SymbolicConstant: A SymbolicConstant specifying the propagation state of the BoundaryConditionState object. Possible values are: NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE PROPAGATED_FROM_BASE_STATE MODIFIED_FROM_BASE_STATE DEACTIVATED_FROM_BASE_STATE BUILT_INTO_MODES
amplitude: str: A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference.

EulerianBC#

class EulerianBC(name: str, createStepName: str, region: Region, definition: SymbolicConstantType = 'INFLOW', inflowType: SymbolicConstantType = 'FREE', outflowType: SymbolicConstantType = 'ZERO_PRESSURE')[source]#

The EulerianBC object stores the data for an Eulerian boundary condition. The EulerianBC object is derived from the BoundaryCondition object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the boundary condition repository key.
definition: SymbolicConstant: A SymbolicConstant specifying the flow conditions to be defined. Possible values are INFLOW, OUTFLOW, and BOTH. The default value is INFLOW.
inflowType: SymbolicConstant: A SymbolicConstant specifying the control of material flow into the Eulerian domain. Possible values are FREE, NONE, and VOID. The default value is FREE.
outflowType: SymbolicConstant: A SymbolicConstant specifying the control of flow of material out of the Eulerian domain. Possible values are ZERO_PRESSURE, FREE, NON_REFLECTING, and EQUILIBRIUM. The default value is ZERO_PRESSURE.
category: SymbolicConstant: A SymbolicConstant specifying the category of the boundary condition. Possible values are MECHANICAL and THERMAL.
region: Region: A Region object specifying the region to which the boundary condition is applied.
localCsys: str: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Methods

`setValues`([region, definition, inflowType, ...])	This method modifies the data for an existing EulerianBC object in the step where it is created.
`setValuesInStep`(stepName[, definition, ...])	This method modifies the propagating data for an existing EulerianBC object in the specified step.

setValues(region: ~abaqus.Region.Region.Region = <abaqus.Region.Region.Region object>, definition: ~abaqusConstants.SymbolicConstantType = 'INFLOW', inflowType: ~abaqusConstants.SymbolicConstantType = 'FREE', outflowType: ~abaqusConstants.SymbolicConstantType = 'ZERO_PRESSURE')[source]#

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

Parameters:

region: A Region object specifying the region to which the boundary condition is applied.
definition: A SymbolicConstant specifying the material flow conditions to be defined. Possible values are INFLOW, OUTFLOW, and BOTH. The default value is INFLOW.
inflowType: A SymbolicConstant specifying the control of material flow into the Eulerian domain. Possible values are FREE, NONE, and VOID. The default value is FREE.
outflowType: A SymbolicConstant specifying the control of material flow out of the Eulerian domain. Possible values are ZERO_PRESSURE, FREE, NON_REFLECTING, and EQUILIBRIUM. The default value is ZERO_PRESSURE.

setValuesInStep(stepName: str, definition: SymbolicConstantType = 'INFLOW', inflowType: SymbolicConstantType = 'FREE', outflowType: SymbolicConstantType = 'ZERO_PRESSURE')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the boundary condition is modified.
definition: A SymbolicConstant specifying the material flow conditions to be defined. Possible values are INFLOW, OUTFLOW, and BOTH. The default value is INFLOW.
inflowType: A SymbolicConstant specifying the control of material flow into the Eulerian domain. Possible values are FREE, NONE, and VOID. The default value is FREE.
outflowType: A SymbolicConstant specifying the control of material flow out of the Eulerian domain. Possible values are ZERO_PRESSURE, FREE, NON_REFLECTING, and EQUILIBRIUM. The default value is ZERO_PRESSURE.

EulerianBCState#

class EulerianBCState[source]#

The EulerianBCState object stores the propagating data for an Eulerian boundary condition in a step. One instance of this object is created internally by the EulerianBC object for each step. The instance is also deleted internally by the EulerianBC object. The EulerianBCState object has no constructor or methods. The EulerianBCState object is derived from the BoundaryConditionState object.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

EULERIAN BOUNDARY

Attributes:

definition: SymbolicConstant: A SymbolicConstant specifying the material flow conditions to be defined. Possible values are INFLOW, OUTFLOW, and BOTH. The default value is INFLOW.
definitionState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the definition member. Possible values are UNSET, SET, and UNCHANGED.
inflowType: SymbolicConstant: A SymbolicConstant specifying the material flow conditions to be defined. Possible values are FREE, NONE, and VOID. The default value is FREE.
inflowTypeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the definition member. Possible values are UNSET, SET, and UNCHANGED.
outflowType: SymbolicConstant: A SymbolicConstant specifying the material flow conditions to be defined. Possible values are ZERO_PRESSURE, FREE, NON_REFLECTING, and EQUILIBRIUM. The default value is ZERO_PRESSURE.
outflowTypeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the definition member. Possible values are UNSET, SET, and UNCHANGED.
amplitudeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the amplitude reference. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
status: SymbolicConstant: A SymbolicConstant specifying the propagation state of the BoundaryConditionState object. Possible values are: NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE PROPAGATED_FROM_BASE_STATE MODIFIED_FROM_BASE_STATE DEACTIVATED_FROM_BASE_STATE BUILT_INTO_MODES
amplitude: str: A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference.

EulerianMotionBC#

class EulerianMotionBC(name: str, createStepName: str, instanceName: str, followRegion: ~abaqusConstants.BooleanType = 1, region: ~abaqus.Region.Region.Region = <abaqus.Region.Region.Region object>, materialName: str = '', ctrPosition1: ~abaqusConstants.SymbolicConstantType = 'FREE', posPosition1: ~abaqusConstants.SymbolicConstantType = 'FREE', negPosition1: ~abaqusConstants.SymbolicConstantType = 'FREE', expansionRatio1: float | None = None, contractRatio1: float = 0, ctrPosition2: ~abaqusConstants.SymbolicConstantType = 'FREE', posPosition2: ~abaqusConstants.SymbolicConstantType = 'FREE', negPosition2: ~abaqusConstants.SymbolicConstantType = 'FREE', expansionRatio2: float | None = None, contractRatio2: float = 0, ctrPosition3: ~abaqusConstants.SymbolicConstantType = 'FREE', posPosition3: ~abaqusConstants.SymbolicConstantType = 'FREE', negPosition3: ~abaqusConstants.SymbolicConstantType = 'FREE', expansionRatio3: float | None = None, contractRatio3: float = 0, allowContraction: ~abaqusConstants.BooleanType = 1, aspectLimit: float = 10, vmaxFactor: float = 1, volThreshold: float = 0, bufferSize: float = 2)[source]#

The EulerianMotionBC object stores the data for an Eulerian mesh motion boundary condition. The EulerianMotionBC object is derived from the BoundaryCondition object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the boundary condition repository key.
followRegion: Boolean: A Boolean specifying whether the mesh will follow a regular surface region or an Eulerian surface. The default value is ON.
ctrPosition1: SymbolicConstant: A SymbolicConstant specifying the 1-direction translational constraint on the center of the Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
ctrPosition2: SymbolicConstant: A SymbolicConstant specifying the 2-direction translational constraint on the center of the Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
ctrPosition3: SymbolicConstant: A SymbolicConstant specifying the 3-direction translational constraint on the center of the Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
posPosition1: SymbolicConstant: A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of the mesh in the 1 direction. Possible values are FREE and FIXED. The default value is FREE.
posPosition2: SymbolicConstant: A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of the mesh in the 2 direction. Possible values are FREE and FIXED. The default value is FREE.
posPosition3: SymbolicConstant: A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of the mesh in the 3 direction. Possible values are FREE and FIXED. The default value is FREE.
negPosition1: SymbolicConstant: A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of the mesh in the 1 direction. Possible values are FREE and FIXED. The default value is FREE.
negPosition2: SymbolicConstant: A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of the mesh in the 2 direction. Possible values are FREE and FIXED. The default value is FREE.
negPosition3: SymbolicConstant: A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of the mesh in the 3 direction. Possible values are FREE and FIXED. The default value is FREE.
expansionRatio1: float: None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 1 direction. If expansionRatio1=None, then there is no upper limit. The default value is None.
expansionRatio2: float: None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 2 direction. If expansionRatio2=None, then there is no upper limit. The default value is None.
expansionRatio3: float: None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 3 direction. If expansionRatio3=None, then there is no upper limit. The default value is None.
contractRatio1: float: A Float specifying the lower bounds on the allowable scaling of the mesh in the 1 direction. The default value is 0.0.
contractRatio2: float: A Float specifying the lower bounds on the allowable scaling of the mesh in the 2 direction. The default value is 0.0.
contractRatio3: float: A Float specifying the lower bounds on the allowable scaling of the mesh in the 3 direction. The default value is 0.0.
allowContraction: Boolean: A Boolean specifying whether the mesh is allowed to contract . The default value is ON.
aspectLimit: float: A Float specifying the maximum change in allowed aspect ratio (for any of the three mesh aspects, 1-2, 2-3, 3-1). The default value is 10.0.
vmaxFactor: float: A Float specifying the multiplier for the mesh nodal velocity limit. The default value is 1.01.
volThreshold: float: A Float specifying the lower bounds on the volume fraction when determining which nodes to include in the surface bounding box calculation for an Eulerian material surface. This argument applies only when followRegion=False. The default value is 0.5.
bufferSize: float: None or a Float specifying the buffer between the surface box and the Eulerian section mesh bounding box. The default value is 2.0.
instanceName: str: A String specifying the name of the Eulerian part instance.
materialName: str: A String specifying the name of the Eulerian surface to follow. This argument applies only when followRegion=False.
category: SymbolicConstant: A SymbolicConstant specifying the category of the boundary condition. Possible values are MECHANICAL and THERMAL.
region: Region: A Region object specifying the region to which the boundary condition is applied.
localCsys: str: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Methods

`setValues`([instanceName, followRegion, ...])	This method modifies the data for an existing EulerianMotionBC object in the step where it is created.
`setValuesInStep`(stepName[, ctrPosition1, ...])	This method modifies the propagating data for an existing EulerianMotionBC object in the specified step.

setValues(instanceName: str = '', followRegion: ~abaqusConstants.BooleanType = 1, region: ~abaqus.Region.Region.Region = <abaqus.Region.Region.Region object>, materialName: str = '', ctrPosition1: ~abaqusConstants.SymbolicConstantType = 'FREE', posPosition1: ~abaqusConstants.SymbolicConstantType = 'FREE', negPosition1: ~abaqusConstants.SymbolicConstantType = 'FREE', expansionRatio1: float | None = None, contractRatio1: float = 0, ctrPosition2: ~abaqusConstants.SymbolicConstantType = 'FREE', posPosition2: ~abaqusConstants.SymbolicConstantType = 'FREE', negPosition2: ~abaqusConstants.SymbolicConstantType = 'FREE', expansionRatio2: float | None = None, contractRatio2: float = 0, ctrPosition3: ~abaqusConstants.SymbolicConstantType = 'FREE', posPosition3: ~abaqusConstants.SymbolicConstantType = 'FREE', negPosition3: ~abaqusConstants.SymbolicConstantType = 'FREE', expansionRatio3: float | None = None, contractRatio3: float = 0, allowContraction: ~abaqusConstants.BooleanType = 1, aspectLimit: float = 10, vmaxFactor: float = 1, volThreshold: float = 0, bufferSize: float = 2)[source]#

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

Parameters:

instanceName: A String specifying the name of the Eulerian part instance.
followRegion: A Boolean specifying whether the mesh will follow a regular surface region or an Eulerian surface. The default value is ON.
region: A Region object specifying the region to which the boundary condition is applied.
materialName: A String specifying the name of the Eulerian surface to follow. This argument applies only when *followRegion*=False.
ctrPosition1: A SymbolicConstant specifying the 1-direction translational constraint on the center of the Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
posPosition1: A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of the mesh in the 1 direction. Possible values are FREE and FIXED. The default value is FREE.
negPosition1: A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of the mesh in the 1 direction. Possible values are FREE and FIXED. The default value is FREE.
expansionRatio1: None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 1 direction. If *expansionRatio1*=None, then there is no upper limit. The default value is None.
contractRatio1: A Float specifying the lower bounds on the allowable scaling of the mesh in the 1 direction. The default value is 0.0.
ctrPosition2: A SymbolicConstant specifying the 2-direction translational constraint on the center of the Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
posPosition2: A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of the mesh in the 2 direction. Possible values are FREE and FIXED. The default value is FREE.
negPosition2: A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of the mesh in the 2 direction. Possible values are FREE and FIXED. The default value is FREE.
expansionRatio2: None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 2 direction. If *expansionRatio2*=None, then there is no upper limit. The default value is None.
contractRatio2: A Float specifying the lower bounds on the allowable scaling of the mesh in the 2 direction. The default value is 0.0.
ctrPosition3: A SymbolicConstant specifying the 3-direction translational constraint on the center of the Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
posPosition3: A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of the mesh in the 3 direction. Possible values are FREE and FIXED. The default value is FREE.
negPosition3: A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of the mesh in the 3 direction. Possible values are FREE and FIXED. The default value is FREE.
expansionRatio3: None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 3 direction. If *expansionRatio3*=None, then there is no upper limit. The default value is None.
contractRatio3: A Float specifying the lower bounds on the allowable scaling of the mesh in the 3 direction. The default value is 0.0.
allowContraction: A Boolean specifying whether the mesh is allowed to contract . The default value is ON.
aspectLimit: A Float specifying the maximum change in allowed aspect ratio (for any of the three mesh aspects, 1-2, 2-3, 3-1). The default value is 10.0.
vmaxFactor: A Float specifying the multiplier for the mesh nodal velocity limit. The default value is 1.01.
volThreshold: A Float specifying the lower bounds on the volume fraction when determining which nodes to include in the surface bounding box calculation for an Eulerian material surface. This argument applies only when *followRegion*=False. The default value is 0.5.
bufferSize: None or a Float specifying the buffer between the surface box and the Eulerian section mesh bounding box. The default value is 2.0.

setValuesInStep(stepName: str, ctrPosition1: SymbolicConstantType = 'FREE', posPosition1: SymbolicConstantType = 'FREE', negPosition1: SymbolicConstantType = 'FREE', expansionRatio1: float | None = None, contractRatio1: float = 0, ctrPosition2: SymbolicConstantType = 'FREE', posPosition2: SymbolicConstantType = 'FREE', negPosition2: SymbolicConstantType = 'FREE', expansionRatio2: float | None = None, contractRatio2: float = 0, ctrPosition3: SymbolicConstantType = 'FREE', posPosition3: SymbolicConstantType = 'FREE', negPosition3: SymbolicConstantType = 'FREE', expansionRatio3: float | None = None, contractRatio3: float = 0, allowContraction: BooleanType = 1, aspectLimit: float = 10, vmaxFactor: float = 1, volThreshold: float = 0, bufferSize: float = 2)[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the boundary condition is modified.
ctrPosition1: A SymbolicConstant specifying the 1-direction translational constraint on the center of the Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
posPosition1: A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of the mesh in the 1 direction. Possible values are FREE and FIXED. The default value is FREE.
negPosition1: A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of the mesh in the 1 direction. Possible values are FREE and FIXED. The default value is FREE.
expansionRatio1: None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 1 direction. If *expansionRatio1*=None, then there is no upper limit. The default value is None.
contractRatio1: A Float specifying the lower bounds on the allowable scaling of the mesh in the 1 direction. The default value is 0.0.
ctrPosition2: A SymbolicConstant specifying the 2-direction translational constraint on the center of the Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
posPosition2: A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of the mesh in the 2 direction. Possible values are FREE and FIXED. The default value is FREE.
negPosition2: A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of the mesh in the 2 direction. Possible values are FREE and FIXED. The default value is FREE.
expansionRatio2: None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 2 direction. If *expansionRatio2*=None, then there is no upper limit. The default value is None.
contractRatio2: A Float specifying the lower bounds on the allowable scaling of the mesh in the 2 direction. The default value is 0.0.
ctrPosition3: A SymbolicConstant specifying the 3-direction translational constraint on the center of the Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
posPosition3: A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of the mesh in the 3 direction. Possible values are FREE and FIXED. The default value is FREE.
negPosition3: A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of the mesh in the 3 direction. Possible values are FREE and FIXED. The default value is FREE.
expansionRatio3: None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 3 direction. If *expansionRatio3*=None, then there is no upper limit. The default value is None.
contractRatio3: A Float specifying the lower bounds on the allowable scaling of the mesh in the 3 direction. The default value is 0.0.
allowContraction: A Boolean specifying whether the mesh is allowed to contract . The default value is ON.
aspectLimit: A Float specifying the maximum change in allowed aspect ratio (for any of the three mesh aspects, 1-2, 2-3, 3-1). The default value is 10.0.
vmaxFactor: A Float specifying the multiplier for the mesh nodal velocity limit. The default value is 1.01.
volThreshold: A Float specifying the lower bounds on the volume fraction when determining which nodes to include in the surface bounding box calculation for an Eulerian material surface. This argument applies only when *followRegion*=False. The default value is 0.5.
bufferSize: None or a Float specifying the buffer between the surface box and the Eulerian section mesh bounding box. The default value is 2.0.

EulerianMotionBCState#

class EulerianMotionBCState[source]#

The EulerianMotionBCState object stores the propagating data for an Eulerian mesh motion boundary condition in a step. One instance of this object is created internally by the EulerianMotionBC object for each step. The instance is also deleted internally by the EulerianMotionBC object. The EulerianMotionBCState object has no constructor or methods. The EulerianMotionBCState object is derived from the BoundaryConditionState object.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

EULERIAN MESH MOTION

Attributes:

ctrPosition1: SymbolicConstant: A SymbolicConstant specifying the 1-direction translational constraint on the center of the Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
ctrPosition2: SymbolicConstant: A SymbolicConstant specifying the 2-direction translational constraint on the center of the Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
ctrPosition3: SymbolicConstant: A SymbolicConstant specifying the 3-direction translational constraint on the center of the Eulerian mesh. Possible values are FREE and FIXED. The default value is FREE.
posPosition1: SymbolicConstant: A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of the mesh in the 1 direction. Possible values are FREE and FIXED. The default value is FREE.
posPosition2: SymbolicConstant: A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of the mesh in the 2 direction. Possible values are FREE and FIXED. The default value is FREE.
posPosition3: SymbolicConstant: A SymbolicConstant specifying the translational constraint on the positive (maximum) bounds of the mesh in the 3 direction. Possible values are FREE and FIXED. The default value is FREE.
negPosition1: SymbolicConstant: A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of the mesh in the 1 direction. Possible values are FREE and FIXED. The default value is FREE.
negPosition2: SymbolicConstant: A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of the mesh in the 2 direction. Possible values are FREE and FIXED. The default value is FREE.
negPosition3: SymbolicConstant: A SymbolicConstant specifying the translational constraint on the negative (minimum) bounds of the mesh in the 3 direction. Possible values are FREE and FIXED. The default value is FREE.
expansionRatio1: float: None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 1 direction. If expansionRatio1=None, then there is no upper limit. The default value is None.
expansionRatio2: float: None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 2 direction. If expansionRatio2=None, then there is no upper limit. The default value is None.
expansionRatio3: float: None or a Float specifying the upper bounds on the allowable scaling of the mesh in the 3 direction. If expansionRatio3=None, then there is no upper limit. The default value is None.
contractRatio1: float: A Float specifying the lower bounds on the allowable scaling of the mesh in the 1 direction. The default value is 0.0.
contractRatio2: float: A Float specifying the lower bounds on the allowable scaling of the mesh in the 2 direction. The default value is 0.0.
contractRatio3: float: A Float specifying the lower bounds on the allowable scaling of the mesh in the 3 direction. The default value is 0.0.
allowContraction: Boolean: A Boolean specifying whether the mesh is allowed to contract . The default value is ON.
aspectLimit: float: A Float specifying the maximum change in allowed aspect ratio (for any of the three mesh aspects, 1-2, 2-3, 3-1). The default value is 10.0.
vmaxFactor: float: A Float specifying the multiplier for the mesh nodal velocity limit. The default value is 1.01.
volThreshold: float: A Float specifying the lower bounds on the volume fraction when determining which nodes to include in the surface bounding box calculation for an Eulerian material surface. This argument applies only when followRegion=False. The default value is 0.5.
bufferSize: float: None or a Float specifying the buffer between the surface box and the Eulerian section mesh bounding box. The default value is 2.0.
amplitudeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the amplitude reference. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
status: SymbolicConstant: A SymbolicConstant specifying the propagation state of the BoundaryConditionState object. Possible values are: NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE PROPAGATED_FROM_BASE_STATE MODIFIED_FROM_BASE_STATE DEACTIVATED_FROM_BASE_STATE BUILT_INTO_MODES
amplitude: str: A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference.

FluidCavityPressureBC#

class FluidCavityPressureBC(name: str, createStepName: str, fluidCavity: str, magnitude: float = 0, amplitude: str = 'UNSET', fixed: BooleanType = 0)[source]#

The FluidCavityPressureBC object stores the data for a fluid cavity pressure boundary condition. The FluidCavityPressureBC object is derived from the BoundaryCondition object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the boundary condition repository key.
fluidCavity: str: A String specifying the name of a Fluid Cavity Interaction.
category: SymbolicConstant: A SymbolicConstant specifying the category of the boundary condition. Possible values are MECHANICAL and THERMAL.
region: Region: A Region object specifying the region to which the boundary condition is applied.
localCsys: str: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Methods

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

setValues(magnitude: float = 0, amplitude: str = 'UNSET', fixed: BooleanType = 0)[source]#

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

Parameters:

magnitude: A Float specifying the fluid cavity pressure magnitude. The default value is 0.
amplitude: A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the boundary condition has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.
fixed: A Boolean specifying whether the boundary condition should remain fixed at the current values at the start of the step. The default value is OFF.

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

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

Parameters:

stepName: A String specifying the name of the step in which the boundary condition is modified.
magnitude: A Float or the SymbolicConstant FREED specifying the fluid cavity pressure 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 boundary condition is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

FluidCavityPressureBCState#

class FluidCavityPressureBCState[source]#

The FluidCavityPressureBCState object stores the propagating data for a fluid cavity pressure boundary condition in a step. One instance of this object is created internally by the FluidCavityPressureBC object for each step. The instance is also deleted internally by the FluidCavityPressureBC object. The FluidCavityPressureBCState object has no constructor or methods. The FluidCavityPressureBCState object is derived from the BoundaryConditionState object.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

BOUNDARY

Attributes:

magnitude: float: A Float specifying the fluid cavity pressure magnitude.
magnitudeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the fluid cavity pressure magnitude. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
amplitudeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the amplitude reference. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
status: SymbolicConstant: A SymbolicConstant specifying the propagation state of the BoundaryConditionState object. Possible values are: NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE PROPAGATED_FROM_BASE_STATE MODIFIED_FROM_BASE_STATE DEACTIVATED_FROM_BASE_STATE BUILT_INTO_MODES
amplitude: str: A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference.

MagneticVectorPotentialBC#

class MagneticVectorPotentialBC(name: str, createStepName: str, region: Region, component1: SymbolicConstantType | None = None, component2: SymbolicConstantType = 'UNSET', component3: SymbolicConstantType = 'UNSET', amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM', localCsys: str | None = None)[source]#

The MagneticVectorPotentialBC object stores the data for a magnetic vector potential boundary condition. The MagneticVectorPotentialBC object is derived from the BoundaryCondition object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the boundary condition repository key.
distributionType: SymbolicConstant: A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM.
category: SymbolicConstant: A SymbolicConstant specifying the category of the boundary condition. Possible values are MECHANICAL and THERMAL.
region: Region: A Region object specifying the region to which the boundary condition is applied.
localCsys: str: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Methods

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

setValues(component1: SymbolicConstantType | None = None, component2: SymbolicConstantType = 'UNSET', component3: SymbolicConstantType = 'UNSET', amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM', localCsys: str | None = None)[source]#

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

Parameters:

component1: A Complex, or a SymbolicConstant specifying the magnetic vector potential component in the 1-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET
component2: A Complex, or a SymbolicConstant specifying the magnetic vector potential component in the 2-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
component3: A Complex, or a SymbolicConstant specifying the magnetic vector potential component in the 3-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
amplitude: A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the boundary condition 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 boundary condition is distributed spatially. Possible values are UNIFORM and USER_DEFINED. The default value is UNIFORM.
localCsys: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

setValuesInStep(stepName: str, component1: SymbolicConstantType | None = None, component2: SymbolicConstantType | None = None, component3: SymbolicConstantType | None = None, amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the boundary condition is modified.
component1: A Complex, or a SymbolicConstant specifying the magnetic vector potential component in the 1-direction. Possible values for the SymbolicConstant are SET and UNCHANGED.
component2: A Complex, or a SymbolicConstant specifying the magnetic vector potential component in the 2-direction. Possible values for the SymbolicConstant are SET and UNCHANGED.
component3: A Complex, or a SymbolicConstant specifying the magnetic vector potential component in the 3-direction. Possible values for the SymbolicConstant areSET and UNCHANGED.
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 boundary condition is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

MaterialFlowBC#

class MaterialFlowBC(name: str, createStepName: str, region: Region, fieldName: str = '', magnitude: float = 0, distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET', fixed: BooleanType = 0)[source]#

The MaterialFlowBC object stores the data for a connector material flow boundary condition. The MaterialFlowBC object is derived from the BoundaryCondition object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the boundary condition repository key.
distributionType: SymbolicConstant: A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
fieldName: str: A String specifying the name of the AnalyticalField object associated with this boundary condition. The fieldName argument applies only when distributionType=FIELD. The default value is an empty string.
category: SymbolicConstant: A SymbolicConstant specifying the category of the boundary condition. Possible values are MECHANICAL and THERMAL.
region: Region: A Region object specifying the region to which the boundary condition is applied.
localCsys: str: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Methods

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

setValues(fieldName: str = '', magnitude: float = 0, distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET', fixed: BooleanType = 0)[source]#

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

Parameters:

fieldName: A String specifying the name of the AnalyticalField object associated with this boundary condition. The fieldName argument applies only when *distributionType*=FIELD. The default value is an empty string.
magnitude: A Float specifying the material flow magnitude. The default value is 0. The magnitude argument is optional if *distributionType*=USER_DEFINED.
distributionType: A SymbolicConstant specifying how the boundary condition 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 boundary condition has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.
fixed: A Boolean specifying whether the boundary condition should remain fixed at the current values at the start of the step. The default value is OFF.

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

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

Parameters:

stepName: A String specifying the name of the step in which the boundary condition is modified.
magnitude: A Float or the SymbolicConstant FREED specifying the material 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 boundary condition is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

MaterialFlowBCState#

class MaterialFlowBCState[source]#

The MaterialFlowBCState object stores the propagating data for a connector material flow boundary condition in a step. One instance of this object is created internally by the MaterialFlowBC object for each step. The instance is also deleted internally by the MaterialFlowBC object. The MaterialFlowBCState object has no constructor or methods. The MaterialFlowBCState object is derived from the BoundaryConditionState object.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

BOUNDARY

Attributes:

magnitude: float: A Float specifying the material flow magnitude.
magnitudeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the material flow magnitude. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
amplitudeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the amplitude reference. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
status: SymbolicConstant: A SymbolicConstant specifying the propagation state of the BoundaryConditionState object. Possible values are: NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE PROPAGATED_FROM_BASE_STATE MODIFIED_FROM_BASE_STATE DEACTIVATED_FROM_BASE_STATE BUILT_INTO_MODES
amplitude: str: A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference.

PorePressureBC#

class PorePressureBC(name: str, createStepName: str, region: Region, fieldName: str = '', magnitude: float = 0, distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET', fixed: BooleanType = 0)[source]#

The PorePressureBC object stores the data for a pore pressure boundary condition. The PorePressureBC object is derived from the BoundaryCondition object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the boundary condition repository key.
distributionType: SymbolicConstant: A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
fieldName: str: A String specifying the name of the AnalyticalField object associated with this boundary condition. The fieldName argument applies only when distributionType=FIELD. The default value is an empty string.
category: SymbolicConstant: A SymbolicConstant specifying the category of the boundary condition. Possible values are MECHANICAL and THERMAL.
region: Region: A Region object specifying the region to which the boundary condition is applied.
localCsys: str: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Methods

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

setValues(fieldName: str = '', magnitude: float = 0, distributionType: SymbolicConstantType = 'UNIFORM', amplitude: str = 'UNSET', fixed: BooleanType = 0)[source]#

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

Parameters:

fieldName: A String specifying the name of the AnalyticalField object associated with this boundary condition. The fieldName argument applies only when *distributionType*=FIELD. The default value is an empty string.
magnitude: A Float specifying the pore pressure magnitude. The default value is 0. The magnitude argument is optional if *distributionType*=USER_DEFINED.
distributionType: A SymbolicConstant specifying how the boundary condition 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 boundary condition has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.
fixed: A Boolean specifying whether the boundary condition should remain fixed at the current values at the start of the step. The default value is OFF.

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

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

Parameters:

stepName: A String specifying the name of the step in which the boundary condition is modified.
magnitude: A Float or the SymbolicConstant FREED specifying the pore pressure 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 boundary condition is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

PorePressureBCState#

class PorePressureBCState[source]#

The PorePressureBCState object stores the propagating data for a pore pressure boundary condition in a step. One instance of this object is created internally by the PorePressureBC object for each step. The instance is also deleted internally by the PorePressureBC object. The PorePressureBCState object has no constructor or methods. The PorePressureBCState object is derived from the BoundaryConditionState object.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

BOUNDARY

Attributes:

magnitude: float: A Float specifying the pore pressure magnitude.
magnitudeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the pore pressure magnitude. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
amplitudeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the amplitude reference. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
status: SymbolicConstant: A SymbolicConstant specifying the propagation state of the BoundaryConditionState object. Possible values are: NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE PROPAGATED_FROM_BASE_STATE MODIFIED_FROM_BASE_STATE DEACTIVATED_FROM_BASE_STATE BUILT_INTO_MODES
amplitude: str: A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference.

RetainedNodalDofsBC#

class RetainedNodalDofsBC(name: str, createStepName: str, region: Region, u1: BooleanType = 0, u2: BooleanType = 0, u3: BooleanType = 0, ur1: BooleanType = 0, ur2: BooleanType = 0, ur3: BooleanType = 0)[source]#

The RetainedNodalDofsBC object stores the data for a retained nodal dofs boundary condition. The RetainedNodalDofsBC object is derived from the BoundaryCondition object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the boundary condition repository key.
category: SymbolicConstant: A SymbolicConstant specifying the category of the boundary condition. Possible values are MECHANICAL and THERMAL.
region: Region: A Region object specifying the region to which the boundary condition is applied.
localCsys: str: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Methods

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

setValues(u1: BooleanType = 0, u2: BooleanType = 0, u3: BooleanType = 0, ur1: BooleanType = 0, ur2: BooleanType = 0, ur3: BooleanType = 0)[source]#

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

Parameters:

u1: A Boolean specifying whether to retain the degree of freedom in the 1-direction. The default value is OFF indicating that the degree of freedom is not retained.
u2: A Boolean specifying whether to retain the degree of freedom in the 2-direction. The default value is OFF indicating that the degree of freedom is not retained.
u3: A Boolean specifying whether to retain the degree of freedom in the 3-direction. The default value is OFF indicating that the degree of freedom is not retained.
ur1: A Boolean specifying whether to retain the rotational degree of freedom about the 1-direction. The default value is OFF indicating that the degree of freedom is not retained.
ur2: A Boolean specifying whether to retain the rotational degree of freedom about the 2-direction. The default value is OFF indicating that the degree of freedom is not retained.
ur3: A Boolean specifying whether to retain the rotational degree of freedom about the 3-direction. The default value is OFF indicating that the degree of freedom is not retained.

setValuesInStep(stepName: str, u1: BooleanType = 0, u2: BooleanType = 0, u3: BooleanType = 0, ur1: BooleanType = 0, ur2: BooleanType = 0, ur3: BooleanType = 0)[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the boundary condition is modified.
u1: A Boolean specifying whether to retain the degree of freedom in the 1-direction.
u2: A Boolean specifying whether to retain the degree of freedom in the 2-direction.
u3: A Boolean specifying whether to retain the degree of freedom in the 3-direction.
ur1: A Boolean specifying whether to retain the rotational degree of freedom about the 1-direction.
ur2: A Boolean specifying whether to retain the rotational degree of freedom about the 2-direction.
ur3: A Boolean specifying whether to retain the rotational degree of freedom about the 3-direction.

SecondaryBaseBC#

class SecondaryBaseBC(name: str, createStepName: str, regions: RegionArray, dofs: tuple)[source]#

The SecondaryBaseBC object stores the data for a secondary base boundary condition. The SecondaryBaseBC object is derived from the BoundaryCondition object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the boundary condition repository key.
dofs: int: A tuple of tuples of Ints specifying the constrained degrees-of-freedom.
regions: RegionArray: A RegionArray object specifying the region to which the boundary condition is applied. Note that the usual region is ignored. The default value is MODEL.
category: SymbolicConstant: A SymbolicConstant specifying the category of the boundary condition. Possible values are MECHANICAL and THERMAL.
region: Region: A Region object specifying the region to which the boundary condition is applied.
localCsys: str: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Methods

`setValues`()	This method modifies the data for an existing SecondaryBaseBC object in the step where it is created.
`setValuesInStep`(stepName)	This method modifies the propagating data for an existing SecondaryBaseBC object in the specified step.

setValues()[source]#: This method modifies the data for an existing SecondaryBaseBC object in the step where it is created.

setValuesInStep(stepName: str)[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the boundary condition is modified.

SecondaryBaseBCState#

class SecondaryBaseBCState[source]#

The SecondaryBaseBCState object stores the propagating data for a secondary base boundary condition in a step. One instance of this object is created internally by the SecondaryBaseBC object for each step. The instance is also deleted internally by the SecondaryBaseBC object. The SecondaryBaseBCState object has no constructor or methods. The SecondaryBaseBCState object is derived from the BoundaryConditionState object.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

BOUNDARY

Attributes:

amplitudeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the amplitude reference. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
status: SymbolicConstant: A SymbolicConstant specifying the propagation state of the BoundaryConditionState object. Possible values are: NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE PROPAGATED_FROM_BASE_STATE MODIFIED_FROM_BASE_STATE DEACTIVATED_FROM_BASE_STATE BUILT_INTO_MODES
amplitude: str: A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference.

SubmodelBC#

class SubmodelBC(name: str, createStepName: str, region: Region, dof: tuple, globalStep: str, timeScale: BooleanType, shellThickness: float, globalDrivingRegion: str = '', absoluteExteriorTolerance: float | None = None, exteriorTolerance: float = 0, localCsys: str | None = None, globalIncrement: int = 0, centerZoneSize: float | None = None, intersectionOnly: BooleanType = 0)[source]#

The SubmodelBC object stores the data for a submodel boundary condition. The SubmodelBC object is derived from the BoundaryCondition object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the boundary condition repository key.
shellThickness: float: A Float specifying the thickness of the shell in the global model. This argument is required for shell-to-solid submodeling and is not applicable to other submodels. The default value is 0.0.
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.
category: SymbolicConstant: A SymbolicConstant specifying the category of the boundary condition. Possible values are MECHANICAL and THERMAL.
region: Region: A Region object specifying the region to which the boundary condition is applied.
localCsys: str: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Methods

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

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

This method modifies the data for an existing SubmodelBC 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.
localCsys: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.
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.
centerZoneSize: A Float specifying the thickness of the center zone size around the shell midsurface. The default value is None.
intersectionOnly: A Boolean specifying whether to ignore driven nodes that lie outside the region of elements of the global model after accounting for the exterior search tolerance. The default value is OFF.

setValuesInStep(stepName: str, fixed: BooleanType = 1, dof: tuple = (), globalStep: str = '', globalIncrement: int = 0, centerZoneSize: float | None = None)[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the boundary condition is modified.
fixed: A Boolean specifying whether the boundary condition should remain fixed at the current values at the start of the step. The default value is ON.
dof: A sequence of Ints specifying the degrees of freedom to which the boundary condition is applied. The dof argument is applicable only if *fixed*=OFF.
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.
centerZoneSize: A Float specifying the thickness of the center zone size around the shell midsurface. The default value is None.The centerZoneSize argument is applicable only if *fixed*=OFF.

SubmodelBCState#

class SubmodelBCState[source]#

The SubmodelBCState object stores the propagating data for a Submodel boundary condition in a step. One instance of this object is created internally by the SubmodelBC object for each step. The instance is also deleted internally by the SubmodelBC object. The SubmodelBCState object has no constructor or methods. The SubmodelBCState object is derived from the BoundaryConditionState object.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

SUBMODEL
- BOUNDARY

Attributes:

dofState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the dof member. Possible values are SET and UNCHANGED.
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.
centerZoneSize: float: None or a Float specifying the thickness of the center zone size around the shell midsurface. The default value is None.
centerZoneSizefState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the centerZoneSize member. Possible values are SET and UNCHANGED.
scale: float: None or a Float specifying a scaling value applied to the applied displacements at the interface. The default value is 1.0.
scaleState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the scale 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.
dof: int: A tuple of Ints specifying the degrees of freedom to which the boundary condition is applied.
amplitudeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the amplitude reference. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
status: SymbolicConstant: A SymbolicConstant specifying the propagation state of the BoundaryConditionState object. Possible values are: NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE PROPAGATED_FROM_BASE_STATE MODIFIED_FROM_BASE_STATE DEACTIVATED_FROM_BASE_STATE BUILT_INTO_MODES
amplitude: str: A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference.

TemperatureBC#

class TemperatureBC(name: str, createStepName: str, region: Region, fieldName: str = '', magnitude: float = 0, dof: tuple = (), amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM', fixed: BooleanType = 0)[source]#

The TemperatureBC object stores the data for a temperature boundary condition. The TemperatureBC object is derived from the BoundaryCondition object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the boundary condition repository key.
distributionType: SymbolicConstant: A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
fieldName: str: A String specifying the name of the AnalyticalField object associated with this boundary condition. The fieldName argument applies only when distributionType=FIELD. The default value is an empty string.
category: SymbolicConstant: A SymbolicConstant specifying the category of the boundary condition. Possible values are MECHANICAL and THERMAL.
region: Region: A Region object specifying the region to which the boundary condition is applied.
localCsys: str: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Methods

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

setValues(fieldName: str = '', magnitude: float = 0, dof: tuple = (), amplitude: str = 'UNSET', distributionType: SymbolicConstantType = 'UNIFORM', fixed: BooleanType = 0)[source]#

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

Parameters:

fieldName: A String specifying the name of the AnalyticalField object associated with this boundary condition. The fieldName argument applies only when *distributionType*=FIELD. The default value is an empty string.
magnitude: A Float specifying the temperature magnitude. The default value is 0.
dof: A sequence of Ints specifying the degrees of freedom to which the boundary condition is applied. The default value is (11,).
amplitude: A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the boundary condition 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 boundary condition is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
fixed: A Boolean specifying whether the boundary condition should remain fixed at the current values at the start of the step. The default value is OFF.

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

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

Parameters:

stepName: A String specifying the name of the step in which the boundary condition is modified.
magnitude: A Float or the SymbolicConstant FREED specifying the temperature magnitude.
dof: A sequence of Ints specifying the degrees of freedom to which the boundary condition is applied.
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 boundary condition is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

TemperatureBCState#

class TemperatureBCState[source]#

The TemperatureBCState object stores the propagating data for a temperature boundary condition in a step. One instance of this object is created internally by the TemperatureBC object for each step. The instance is also deleted internally by the TemperatureBC object. The TemperatureBCState object has no constructor or methods. The TemperatureBCState object is derived from the BoundaryConditionState object.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

BOUNDARY

Attributes:

magnitude: float: A Float specifying the temperature magnitude.
magnitudeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the temperature magnitude. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
dofState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the dof member. Possible values are SET and UNCHANGED.
dof: int: A tuple of Ints specifying the degrees of freedom to which the boundary condition is applied.
amplitudeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the amplitude reference. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
status: SymbolicConstant: A SymbolicConstant specifying the propagation state of the BoundaryConditionState object. Possible values are: NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE PROPAGATED_FROM_BASE_STATE MODIFIED_FROM_BASE_STATE DEACTIVATED_FROM_BASE_STATE BUILT_INTO_MODES
amplitude: str: A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference.

TypeBC#

class TypeBC(name: str, createStepName: str, region: Region, buckleCase: SymbolicConstantType = 'NOT_APPLICABLE', localCsys: str | None = None)[source]#

The TypeBC object stores the data for several types of predefined boundary conditions that are commonly used in stress/displacement analyses. The TypeBC object is derived from the BoundaryCondition object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the boundary condition repository key.
buckleCase: SymbolicConstant: A SymbolicConstant specifying how the boundary condition is defined in a BUCKLE analysis. Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES, and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.
category: SymbolicConstant: A SymbolicConstant specifying the category of the boundary condition. Possible values are MECHANICAL and THERMAL.
region: Region: A Region object specifying the region to which the boundary condition is applied.
localCsys: str: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Methods

`EncastreBC`(name, createStepName, region[, ...])	This method creates an encastre TypeBC object.
`PinnedBC`(name, createStepName, region[, ...])	This method creates a pinned TypeBC object.
`XasymmBC`(name, createStepName, region[, ...])	This method creates a TypeBC object that specifies antisymmetry about the X-axis.
`XsymmBC`(name, createStepName, region[, ...])	This method creates a TypeBC object that specifies symmetry about the X-axis.
`YasymmBC`(name, createStepName, region[, ...])	This method creates a TypeBC object that specifies antisymmetry about the Y-axis.
`YsymmBC`(name, createStepName, region[, ...])	This method creates a TypeBC object that specifies symmetry about the Y-axis.
`ZasymmBC`(name, createStepName, region[, ...])	This method creates a TypeBC object that specifies antisymmetry about the Z-axis.
`ZsymmBC`(name, createStepName, region[, ...])	This method creates a TypeBC object that specifies symmetry about the Z-axis.
`setValues`([region, typeName, buckleCase, ...])	This method modifies the data for an existing TypeBC object in the step where it is created.
`setValuesInStep`(stepName[, typeName])	This method always returns a value error for a TypeBC; it is inherited from the BoundaryCondition object.

EncastreBC(name: str, createStepName: str, region: Region, buckleCase: SymbolicConstantType = 'NOT_APPLICABLE', localCsys: str | None = None) → TypeBC[source]#

This method creates an encastre TypeBC object.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: A Region object specifying the region to which the boundary condition is applied.
buckleCase: A SymbolicConstant specifying how the boundary condition is defined in a BUCKLE analysis. Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES, and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.
localCsys: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Returns:

A TypeBC object.

Notes

This function can be accessed by:

mdb.models[name].EncastreBC

PinnedBC(name: str, createStepName: str, region: Region, buckleCase: SymbolicConstantType = 'NOT_APPLICABLE', localCsys: str | None = None) → TypeBC[source]#

This method creates a pinned TypeBC object.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: A Region object specifying the region to which the boundary condition is applied.
buckleCase: A SymbolicConstant specifying how the boundary condition is defined in a BUCKLE analysis. Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES, and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.
localCsys: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Returns:

A TypeBC object.

Notes

This function can be accessed by:

mdb.models[name].PinnedBC

XasymmBC(name: str, createStepName: str, region: Region, buckleCase: SymbolicConstantType = 'NOT_APPLICABLE', localCsys: str | None = None) → TypeBC[source]#

This method creates a TypeBC object that specifies antisymmetry about the X-axis.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: A Region object specifying the region to which the boundary condition is applied.
buckleCase: A SymbolicConstant specifying how the boundary condition is defined in a BUCKLE analysis. Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES, and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.
localCsys: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Returns:

A TypeBC object.

Notes

This function can be accessed by:

mdb.models[name].XasymmBC

XsymmBC(name: str, createStepName: str, region: Region, buckleCase: SymbolicConstantType = 'NOT_APPLICABLE', localCsys: str | None = None) → TypeBC[source]#

This method creates a TypeBC object that specifies symmetry about the X-axis.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: A Region object specifying the region to which the boundary condition is applied.
buckleCase: A SymbolicConstant specifying how the boundary condition is defined in a BUCKLE analysis. Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES, and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.
localCsys: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Returns:

A TypeBC object.

Notes

This function can be accessed by:

mdb.models[name].XsymmBC

YasymmBC(name: str, createStepName: str, region: Region, buckleCase: SymbolicConstantType = 'NOT_APPLICABLE', localCsys: str | None = None) → TypeBC[source]#

This method creates a TypeBC object that specifies antisymmetry about the Y-axis.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: A Region object specifying the region to which the boundary condition is applied.
buckleCase: A SymbolicConstant specifying how the boundary condition is defined in a BUCKLE analysis. Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES, and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.
localCsys: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Returns:

A TypeBC object.

Notes

This function can be accessed by:

mdb.models[name].YasymmBC

YsymmBC(name: str, createStepName: str, region: Region, buckleCase: SymbolicConstantType = 'NOT_APPLICABLE', localCsys: str | None = None) → TypeBC[source]#

This method creates a TypeBC object that specifies symmetry about the Y-axis.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: A Region object specifying the region to which the boundary condition is applied.
buckleCase: A SymbolicConstant specifying how the boundary condition is defined in a BUCKLE analysis. Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES, and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.
localCsys: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Returns:

A TypeBC object.

Notes

This function can be accessed by:

mdb.models[name].YsymmBC

ZasymmBC(name: str, createStepName: str, region: Region, buckleCase: SymbolicConstantType = 'NOT_APPLICABLE', localCsys: str | None = None) → TypeBC[source]#

This method creates a TypeBC object that specifies antisymmetry about the Z-axis.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: A Region object specifying the region to which the boundary condition is applied.
buckleCase: A SymbolicConstant specifying how the boundary condition is defined in a BUCKLE analysis. Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES, and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.
localCsys: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Returns:

A TypeBC object.

Notes

This function can be accessed by:

mdb.models[name].ZasymmBC

ZsymmBC(name: str, createStepName: str, region: Region, buckleCase: SymbolicConstantType = 'NOT_APPLICABLE', localCsys: str | None = None) → TypeBC[source]#

This method creates a TypeBC object that specifies symmetry about the Z-axis.

Parameters:

name: A String specifying the boundary condition repository key.
createStepName: A String specifying the name of the step in which the boundary condition is created.
region: A Region object specifying the region to which the boundary condition is applied.
buckleCase: A SymbolicConstant specifying how the boundary condition is defined in a BUCKLE analysis. Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES, and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.
localCsys: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Returns:

A TypeBC object.

Notes

This function can be accessed by:

mdb.models[name].ZsymmBC

setValues(region: ~abaqus.Region.Region.Region = <abaqus.Region.Region.Region object>, typeName: ~abaqusConstants.SymbolicConstantType | None = None, buckleCase: ~abaqusConstants.SymbolicConstantType = 'NOT_APPLICABLE', localCsys: str | None = None)[source]#

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

Parameters:

region: A Region object specifying the region to which the boundary condition is applied.
typeName: A SymbolicConstant specifying the predefined boundary condition type. Possible values are XSYMM, YSYMM, ZSYMM, XASYMM, YASYMM, ZASYMM, PINNED, and ENCASTRE.
buckleCase: A SymbolicConstant specifying how the boundary condition is defined in a BUCKLE analysis. Possible values are NOT_APPLICABLE, STRESS_PERTURBATION, BUCKLING_MODES, and PERTURBATION_AND_BUCKLING. The default value is NOT_APPLICABLE.
localCsys: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

setValuesInStep(stepName: str, typeName: SymbolicConstantType | None = None)[source]#

This method always returns a value error for a TypeBC; it is inherited from the BoundaryCondition object.

Parameters:

stepName: A String specifying the name of the step in which the boundary condition is modified.
typeName: A SymbolicConstant specifying the predefined boundary condition type. Possible values are XSYMM, YSYMM, ZSYMM, XASYMM, YASYMM, ZASYMM, PINNED, and ENCASTRE.

Raises:

Value Error:
A Symmetry/Antisymmetry/Encastre BC cannot be edited in a propagated step.

TypeBCState#

class TypeBCState[source]#

The TypeBCState object stores the propagating data for a predefined boundary condition in a step. One instance of this object is created internally by the TypeBC object for each step. The instance is also deleted internally by the TypeBC object. The TypeBCState object has no constructor or methods. The TypeBCState object is derived from the BoundaryConditionState object.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

BOUNDARY

Attributes:

typeName: SymbolicConstant: A SymbolicConstant specifying the predefined boundary condition type. Possible values are XSYMM, YSYMM, ZSYMM, XASYMM, YASYMM, ZASYMM, PINNED, and ENCASTRE.
typeNameState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the predefined boundary condition type. The only possible value is UNCHANGED.
amplitudeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the amplitude reference. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
status: SymbolicConstant: A SymbolicConstant specifying the propagation state of the BoundaryConditionState object. Possible values are: NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE PROPAGATED_FROM_BASE_STATE MODIFIED_FROM_BASE_STATE DEACTIVATED_FROM_BASE_STATE BUILT_INTO_MODES
amplitude: str: A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference.

VelocityBaseMotionBC#

class VelocityBaseMotionBC(name: str, createStepName: str, dof: SymbolicConstantType, amplitudeScaleFactor: float = 1, centerOfRotation: tuple = (), correlation: CorrelationArray | None = None, secondaryBase: str = '', useComplex: BooleanType = 0, amplitude: str = 'UNSET')[source]#

The VelocityBaseMotionBC object stores the data for a velocity base motion boundary condition. The VelocityBaseMotionBC object is derived from the BoundaryCondition object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the boundary condition repository key.
amplitudeScaleFactor: float: A Float specifying the scale factor for the amplitude curve. The default value is 1.0.
useComplex: Boolean: A Boolean specifying whether to define the imaginary (out-of-plane) portion of the base motion record given by amplitude definition. The default value is OFF.
centerOfRotation: tuple: A ModelDot object specifying a tuple containing one center of rotation. The default value is the global origin. This argument applies only when dof=UR1, UR2, or UR3.
correlation: CorrelationArray: A CorrelationArray object.
secondaryBase: str: A String specifying the name of the SecondaryBaseBC object associated with this boundary condition. The default value is an empty string.
category: SymbolicConstant: A SymbolicConstant specifying the category of the boundary condition. Possible values are MECHANICAL and THERMAL.
region: Region: A Region object specifying the region to which the boundary condition is applied.
localCsys: str: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Methods

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

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

Parameters:

amplitudeScaleFactor: A Float specifying the scale factor for the amplitude curve. The default value is 1.0.
centerOfRotation: A ModelDot object specifying a tuple containing one center of rotation. The default value is the global origin. This argument applies only when *dof*=UR1, UR2, or UR3.
correlation: A CorrelationArray object.
secondaryBase: A String specifying the name of the SecondaryBaseBC object associated with this boundary condition. The default value is an empty string.
useComplex: A Boolean specifying whether to define the imaginary (out-of-plane) portion of the base motion record given by amplitude definition. The default value is OFF.
amplitude: A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the boundary condition 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, amplitude: str = '')[source]#

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

Parameters:

stepName: A String specifying the name of the step in which the boundary condition is modified.
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 boundary condition is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

VelocityBaseMotionBCState#

class VelocityBaseMotionBCState[source]#

The VelocityBaseMotionBCState object stores the propagating data for a velocity base motion boundary condition in a step. One instance of this object is created internally by the VelocityBaseMotionBC object for each step. The instance is also deleted internally by the VelocityBaseMotionBC object. The VelocityBaseMotionBCState object has no constructor or methods. The VelocityBaseMotionBCState object is derived from the BoundaryConditionState object.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

BASE MOTION

Attributes:

amplitudeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the amplitude reference. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
status: SymbolicConstant: A SymbolicConstant specifying the propagation state of the BoundaryConditionState object. Possible values are: NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE PROPAGATED_FROM_BASE_STATE MODIFIED_FROM_BASE_STATE DEACTIVATED_FROM_BASE_STATE BUILT_INTO_MODES
amplitude: str: A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference.

VelocityBC#

class VelocityBC(name: str, createStepName: str, region: Region, fieldName: str = '', v1: SymbolicConstantType | float = 'UNSET', v2: SymbolicConstantType | float = 'UNSET', v3: SymbolicConstantType | float = 'UNSET', vr1: SymbolicConstantType | float = 'UNSET', vr2: SymbolicConstantType | float = 'UNSET', vr3: SymbolicConstantType | float = 'UNSET', amplitude: str = 'UNSET', localCsys: str | None = None, distributionType: SymbolicConstantType = 'UNIFORM')[source]#

The VelocityBC object stores the data for a velocity boundary condition. The VelocityBC object is derived from the BoundaryCondition object.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the boundary condition repository key.
distributionType: SymbolicConstant: A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.
fieldName: str: A String specifying the name of the AnalyticalField object associated with this boundary condition. The fieldName argument applies only when distributionType=FIELD. The default value is an empty string.
category: SymbolicConstant: A SymbolicConstant specifying the category of the boundary condition. Possible values are MECHANICAL and THERMAL.
region: Region: A Region object specifying the region to which the boundary condition is applied.
localCsys: str: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If localCsys=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Methods

`setValues`([fieldName, v1, v2, v3, vr1, vr2, ...])	This method modifies the data for an existing VelocityBC object in the step where it is created.
`setValuesInStep`(stepName[, v1, v2, v3, vr1, ...])	This method modifies the propagating data for an existing VelocityBC object in the specified step.

setValues(fieldName: str = '', v1: SymbolicConstantType | float = 'UNSET', v2: SymbolicConstantType | float = 'UNSET', v3: SymbolicConstantType | float = 'UNSET', vr1: SymbolicConstantType | float = 'UNSET', vr2: SymbolicConstantType | float = 'UNSET', vr3: SymbolicConstantType | float = 'UNSET', amplitude: str = 'UNSET', localCsys: str | None = None, distributionType: SymbolicConstantType = 'UNIFORM')[source]#

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

Parameters:

fieldName: A String specifying the name of the AnalyticalField object associated with this boundary condition. The fieldName argument applies only when *distributionType*=FIELD. The default value is an empty string.
v1: A Float or a SymbolicConstant specifying the velocity component in the 1-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.Note:Although v1, v2, v3, vr1, vr2, and vr3 are optional arguments, at least one of them must be specified.
v2: A Float or a SymbolicConstant specifying the velocity component in the 2-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
v3: A Float or a SymbolicConstant specifying the velocity component in the 3-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
vr1: A Float or a SymbolicConstant specifying the rotational velocity component about the 1-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
vr2: A Float or a SymbolicConstant specifying the rotational velocity component about the 2-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
vr3: A Float or a SymbolicConstant specifying the rotational velocity component about the 3-direction. Possible values for the SymbolicConstant are UNSET and SET. The default value is UNSET.
amplitude: A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the boundary condition has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.
localCsys: None or a DatumCsys object specifying the local coordinate system of the boundary condition’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.
distributionType: A SymbolicConstant specifying how the boundary condition is distributed spatially. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

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

Parameters:

stepName: A String specifying the name of the step in which the boundary condition is modified.
v1: A Float or a SymbolicConstant specifying the velocity component in the 1-direction. Possible values for the SymbolicConstant are SET and FREED.
v2: A Float or a SymbolicConstant specifying the velocity component in the 2-direction. Possible values for the SymbolicConstant are SET and FREED.
v3: A Float or a SymbolicConstant specifying the velocity component in the 3-direction. Possible values for the SymbolicConstant are SET and FREED.
vr1: A Float or a SymbolicConstant specifying the rotational velocity component about the 1-direction. Possible values for the SymbolicConstant are SET and FREED.
vr2: A Float or a SymbolicConstant specifying the rotational velocity component about the 2-direction. Possible values for the SymbolicConstant are SET and FREED.
vr3: A Float or a SymbolicConstant specifying the rotational velocity component about the 3-direction. Possible values for the SymbolicConstant are SET and FREED.
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 boundary condition is changed to have no amplitude reference. You should provide the amplitude argument only if it is valid for the specified step.

VelocityBCState#

class VelocityBCState[source]#

The VelocityBCState object stores the propagating data for a velocity boundary condition in a step. One instance of this object is created internally by the VelocityBC object for each step. The instance is also deleted internally by the VelocityBC object. The VelocityBCState object has no constructor or methods. The VelocityBCState object is derived from the BoundaryConditionState object.

Notes

This object can be accessed by:

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

The corresponding analysis keywords are:

BOUNDARY

Attributes:

v1: float: A Float specifying the velocity component in the 1-direction.
v2: float: A Float specifying the velocity component in the 2-direction.
v3: float: A Float specifying the velocity component in the 3-direction.
vr1: float: A Float specifying the rotational velocity component about the 1-direction.
vr2: float: A Float specifying the rotational velocity component about the 2-direction.
vr3: float: A Float specifying the rotational velocity component about the 3-direction.
v1State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the velocity component in the 1-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
v2State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the velocity component in the 2-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
v3State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the velocity component in the 3-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
vr1State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the rotational velocity component about the 1-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
vr2State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the rotational velocity component about the 2-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
vr3State: SymbolicConstant: A SymbolicConstant specifying the propagation state of the rotational velocity component about the 3-direction. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
amplitudeState: SymbolicConstant: A SymbolicConstant specifying the propagation state of the amplitude reference. Possible values are UNSET, SET, UNCHANGED, FREED, and MODIFIED.
status: SymbolicConstant: A SymbolicConstant specifying the propagation state of the BoundaryConditionState object. Possible values are: NOT_YET_ACTIVE CREATED PROPAGATED MODIFIED DEACTIVATED NO_LONGER_ACTIVE TYPE_NOT_APPLICABLE INSTANCE_NOT_APPLICABLE PROPAGATED_FROM_BASE_STATE MODIFIED_FROM_BASE_STATE DEACTIVATED_FROM_BASE_STATE BUILT_INTO_MODES
amplitude: str: A String specifying the name of the amplitude reference. The String is empty if the boundary condition has no amplitude reference.