Constraint

The Constraint commands define constraints between regions of the model.

Create constraints

class ConstraintModel(
name,
description='',
stefanBoltzmann=None,
absoluteZero=None,
waveFormulation=NOT_SET,
modelType=STANDARD_EXPLICIT,
universalGas=None,
copyConstraints=1,
copyConnectors=1,
copyInteractions=1,
)[source]

Bases: ModelBase

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

Note

This object can be accessed by:

mdb.models[name]

Public Data Attributes:

Inherited from ModelBase

name

A String specifying the repository key.

stefanBoltzmann

None or a Float specifying the Stefan-Boltzmann constant.

absoluteZero

None or a Float specifying the absolute zero constant.

waveFormulation

A SymbolicConstant specifying the type of incident wave formulation to be used in acoustic problems.

universalGas

None or a Float specifying the universal gas constant.

noPartsInputFile

A Boolean specifying whether an input file should be written without parts and assemblies.

endRestartStep

A Boolean specifying that the step specified by restartStep should be terminated at the increment specified by restartIncrement.

shellToSolid

A Boolean specifying that a shell global model drives a solid submodel.

lastChangedCount

A Float specifying the time stamp that indicates when the model was last changed.

description

A String specifying the purpose and contents of the Model object.

restartJob

A String specifying the name of the job that generated the restart data.

restartStep

A String specifying the name of the step where the restart analysis will start.

globalJob

A String specifying the name of the job that generated the results for the global model.

copyConstraints

A boolean specifying the status of constraints created in a model, in the model which instances this model.

copyConnectors

A boolean specifying the status of connectors created in a model, in the model which instances this model.

copyInteractions

A boolean specifying the status of interactions created in a model, in the model which instances this model.

keywordBlock

A KeywordBlock object.

amplitudes

A repository of Amplitude objects.

profiles

A repository of Profile objects.

boundaryConditions

A repository of BoundaryCondition objects.

constraints

A repository of ConstrainedSketchConstraint objects.

analyticalFields

A repository of AnalyticalField objects.

discreteFields

A repository of DiscreteField objects.

predefinedFields

A repository of PredefinedField objects.

interactions

A repository of Interaction objects.

interactionProperties

A repository of InteractionProperty objects.

contactControls

A repository of ContactControl objects.

contactInitializations

A repository of ContactInitialization objects.

contactStabilizations

A repository of ContactStabilization objects.

linkedInstances

A tuple of tuples of Strings specifying the linked child PartInstance name in the current model to the corresponding parent PartInstance name in a different model.

linkedParts

A tuple of tuples of Strings specifying the linked child Part name in the current model to the corresponding parent Part name in a different model.

loads

A repository of Load objects.

materials

A repository of Material objects.

calibrations

A repository of Calibration objects.

sections

A repository of Section objects.

remeshingRules

A repository of RemeshingRule objects.

sketches

A repository of ConstrainedSketch objects.

parts

A repository of Part objects.

steps

A repository of Step objects.

featureOptions

A FeatureOptions object.

adaptiveMeshConstraints

A repository of AdaptiveMeshConstraint objects.

adaptiveMeshControls

A repository of AdaptiveMeshControl objects.

timePoints

A repository of TimePoint objects.

filters

A repository of Filter objects.

integratedOutputSections

A repository of IntegratedOutputSection objects.

fieldOutputRequests

A repository of FieldOutputRequest objects.

historyOutputRequests

A repository of HistoryOutputRequest objects.

optimizationTasks

A repository of OptimizationTask objects.

tableCollections

A repository of TableCollection objects.

eventSeriesTypes

A repository of EventSeriesType objects.

eventSeriesDatas

A repository of EventSeriesData objects.

restartIncrement

An Int specifying the increment, interval, iteration or cycle where the restart analysis will start.

rootAssembly

An Assembly object.

Public Methods:

AdjustPoints(name, surface, controlPoints)

This method creates an AdjustPoints object.

Coupling(name, surface, controlPoint, ...[, ...])

This method creates a Coupling object.

DisplayBody(name, instance, controlPoints)

This method creates a DisplayBody object.

EmbeddedRegion(name, embeddedRegion, hostRegion)

This method creates a EmbeddedRegion object.

Equation(name, terms)

This method creates an Equation object.

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

This method creates a MultipointConstraint object.

RigidBody(name, refPointRegion[, ...])

This method creates a RigidBody object.

ShellSolidCoupling(name, shellEdge, solidFace)

This method creates a ShellSolidCoupling object.

Tie(name, main, secondary[, adjust, ...])

This method creates a Tie object.

Inherited from ModelBase

__init__(name[, description, ...])

This method creates a Model object.

ModelFromInputFile(name, inputFileName)

This method creates a Model object by reading the keywords in an input file and creating the corresponding Abaqus/CAE objects.

ModelFromOdbFile(name, odbFileName)

This method creates a Model object by reading an output database and creating any corresponding Abaqus/CAE objects.

ModelFromNastranFile(modelName, inputFileName)

This method creates a Model object by reading the keywords in a Nastran bulk data file or Nastran input file and creating any corresponding Abaqus/CAE objects.

setValues([description, noPartsInputFile, ...])

This method modifies the Model object.


Member Details:

AdjustPoints(name, surface, controlPoints)[source]

This method creates an AdjustPoints object.

Note

This function can be accessed by:

mdb.models[name].AdjustPoints
Parameters:
name

A String specifying the constraint repository key.

surface

A Region object specifying the surface to which the controlPoints are adjusted.

controlPoints

A Region object specifying the constraint control points.

Returns:

An AdjustPoints object.

Return type:

AdjustPoints

Coupling(
name,
surface,
controlPoint,
influenceRadius,
couplingType,
rotationalCouplingType,
adjust=0,
localCsys=None,
u1=1,
u2=1,
u3=1,
ur1=1,
ur2=1,
ur3=1,
weightingMethod=UNIFORM,
alpha=0.0,
)[source]

This method creates a Coupling object.

Note

This function can be accessed by:

mdb.models[name].Coupling
Parameters:
name

A String specifying the constraint repository key.

surface

A Region object specifying the surface on which the coupling nodes are located.

controlPoint

A Region object specifying the constraint control point.

influenceRadius

The SymbolicConstant WHOLE_SURFACE or a Float specifying the influence radius.

couplingType

A SymbolicConstant specifying the coupling constraint type. Possible values are KINEMATIC, DISTRIBUTING, and STRUCTURAL.

rotationalCouplingType

A SymbolicConstant specifying the rotational coupling constraint type. Possible values are ROTATIONAL_CONTINUUM and ROTATIONAL_STRUCTURAL.

Added in version 2024: The rotationalCouplingType argument was added.

adjust=0

A Boolean specifying if the control point will be adjusted (moved) to the surface. The point will be adjusted in the direction normal to the specified surface. The default value is OFF.

localCsys=None

None or a DatumCsys object specifying the initial orientation of the local coordinate system for the coupling’s degrees of freedom. If localCsys = None, the coupling is defined in the global coordinate system. The default value is None.

u1=1

A Boolean specifying if the displacement component in the 1-direction is constrained to the reference node for a kinematic coupling constraint. The default value is ON.The u1 argument applies only when couplingType = KINEMATIC.

u2=1

A Boolean specifying if the displacement component in the 2-direction is constrained to the reference node for a kinematic coupling constraint. The default value is ON.The u2 argument applies only when couplingType = KINEMATIC.

u3=1

A Boolean specifying if the displacement component in the 3-direction is constrained to the reference node for a kinematic coupling constraint. The default value is ON.The u3 argument applies only when couplingType = KINEMATIC.

ur1=1

A Boolean specifying if the rotational displacement component about the 1-direction is constrained to the reference node for a kinematic coupling constraint. The default value is ON.The ur1 argument applies only when couplingType = KINEMATIC.

ur2=1

A Boolean specifying if the rotational displacement component about the 2-direction is constrained to the reference node for a kinematic coupling constraint. The default value is ON.The ur2 argument applies only when couplingType = KINEMATIC.

ur3=1

A Boolean specifying if the rotational displacement component about the 3-direction is constrained to the reference node for a kinematic coupling constraint. The default value is ON.The ur3 argument applies only when couplingType = KINEMATIC.

weightingMethod=UNIFORM

A SymbolicConstant specifying an optional weighting method used for calculating the distributing weight factors. Possible values are UNIFORM, LINEAR, QUADRATIC, and CUBIC. The default value is UNIFORM.The weightingMethod argument applies only when couplingType = DISTRIBUTING.

alpha=0.0

A Float specifying the value of the thermal expansion coefficient. The default value is 0.0. The alpha argument applies only when couplingType=KINEMATIC.

Added in version 2022: The alpha argument was added.

Returns:

A Coupling object.

Return type:

Coupling

DisplayBody(name, instance, controlPoints)[source]

This method creates a DisplayBody object.

Note

This function can be accessed by:

mdb.models[name].DisplayBody
Parameters:
name

A String specifying the constraint repository key.

instance

A PartInstance object specifying the part instance that is to be used for display only.

controlPoints

A ModelDotArray object specifying the motion of the PartInstance. The control points may be ConstrainedSketchVertex, ReferencePoint, or MeshNode objects. Their motion will control the motion of the PartInstance. If this argument is set to an empty sequence, the PartInstance will remain fixed in space during the analysis. The sequence can have either one object or three objects.

Returns:

A DisplayBody object.

Return type:

DisplayBody

EmbeddedRegion(
name,
embeddedRegion,
hostRegion,
weightFactorTolerance=None,
toleranceMethod=BOTH,
absoluteTolerance=0,
fractionalTolerance=0,
)[source]

This method creates a EmbeddedRegion object.

Note

This function can be accessed by:

mdb.models[name].EmbeddedRegion
Parameters:
name

A String specifying the constraint repository key.

embeddedRegion

A Region object specifying the body region to be embedded.

hostRegion

A Region object specifying the host region. A value of None indicates that the host region is the whole model.

weightFactorTolerance=None

A Float specifying a small value below which the weighting factors will be zeroed out. The default value is 10⁻⁶.

toleranceMethod=BOTH

A SymbolicConstant specifying the method used to determine the embedded element tolerance. Possible values are ABSOLUTE, FRACTIONAL, and BOTH. The default value is BOTH.

absoluteTolerance=0

A Float specifying the absolute value by which a node on the embedded region may lie outside the host region. If absoluteTolerance = 0.0, the fractionalTolerance value will be used. The default value is 0.0.This argument applies only when toleranceMethod = ABSOLUTE or BOTH.

fractionalTolerance=0

A Float specifying the fractional value by which a node on the embedded region may lie outside the host region. The fractional value is based on the average element size within the host region. The default value is 0.05.If both tolerance arguments are specified, the smaller value will be used.This argument applies only when toleranceMethod = FRACTIONAL or BOTH.

Returns:

An EmbeddedRegion object.

Return type:

EmbeddedRegion

Equation(name, terms)[source]

This method creates an Equation object.

Note

This function can be accessed by:

mdb.models[name].Equation
Parameters:
name

A String specifying the constraint repository key.

terms

A sequence of (Float, String, Int, Int) sequences specifying a coefficient, Set name, degree of freedom, and coordinate system ID. The coordinate system ID is optional.

Returns:

An Equation object.

Return type:

Equation

Raises:

Exception – If terms does not contain more than one entry, Equation must have two or more terms.

MultipointConstraint(
name,
surface,
controlPoint,
mpcType,
csys=None,
userType=0,
userMode=DOF_MODE_MPC,
)[source]

This method creates a MultipointConstraint object.

Note

This function can be accessed by:

mdb.models[name].MultipointConstraint
Parameters:
name

A String specifying the constraint repository key.

surface

A Region object specifying the surface on which the MultipointConstraint nodes are located.

controlPoint

A Region object specifying the constraint control point.

mpcType

A SymbolicConstant specifying the MPC type of the constraint. Possible values are BEAM_MPC, ELBOW_MPC, PIN_MPC, LINK_MPC, TIE_MPC, and USER_MPC.

csys=None

None or a DatumCsys object specifying the initial orientation of the local coordinate system for the MultipointConstraint’s degrees of freedom. If localCsys = None, the MultipointConstraint is defined in the global coordinate system. The default value is None.

userType=0

An Int specifying to differentiate between different constraint types in a user-defined MultipointConstraint. The default value is 0.The userType argument applies only when mpcType = USER_MPC.

userMode=DOF_MODE_MPC

A SymbolicConstant specifying the mode of the constraint when it is user-defined. Possible values are DOF_MODE_MPC and NODE_MODE_MPC. The default value is DOF_MODE_MPC.The userMode argument applies only when mpcType = USER_MPC.

Returns:

A MultipointConstraint object.

Return type:

MultipointConstraint

RigidBody(
name,
refPointRegion,
bodyRegion=None,
tieRegion=None,
pinRegion=None,
surfaceRegion=None,
refPointAtCOM=0,
isothermal=0,
)[source]

This method creates a RigidBody object.

Note

This function can be accessed by:

mdb.models[name].RigidBody
Parameters:
name

A String specifying the constraint repository key.

refPointRegion

A Region object specifying the reference point.

bodyRegion=None

None or a Region object specifying the elements constrained to the movement of the reference point. The default value is None.

tieRegion=None

None or a Region object specifying the nodes tied to the movement of the reference point. The default value is None.

pinRegion=None

None or a Region object specifying the nodes pinned to the movement of the reference point. The default value is None.

surfaceRegion=None

None or a Region object specifying the analytic surface constrained to the movement of the reference point. The default value is None.

refPointAtCOM=0

A Boolean specifying whether the analysis product should recompute the reference point position to be at the center of mass. The default value is OFF.

isothermal=0

A Boolean specifying whether the temperature degree of freedom should be constrained. The default value is OFF.

Returns:

A RigidBody object.

Return type:

RigidBody

ShellSolidCoupling(
name,
shellEdge,
solidFace,
positionToleranceMethod=COMPUTED,
positionTolerance=0,
influenceDistanceMethod=DEFAULT,
influenceDistance=0,
)[source]

This method creates a ShellSolidCoupling object.

Note

This function can be accessed by:

mdb.models[name].ShellSolidCoupling
Parameters:
name

A String specifying the constraint repository key.

shellEdge

A Region object specifying the name of the shell edge surface.

solidFace

A Region object specifying the name of the solid surface.

positionToleranceMethod=COMPUTED

A SymbolicConstant specifying the method used to determine the position tolerance. Possible values are COMPUTED and SPECIFIED. The default value is COMPUTED.

positionTolerance=0

A Float specifying the position tolerance. The default value is 0.0.The positionTolerance argument applies only when positionToleranceMethod = SPECIFIED. Note: Abaqus will not constrain nodes on the solid face region outside the position tolerance.

influenceDistanceMethod=DEFAULT

A SymbolicConstant specifying the method used to determine the influence distance. Possible values are DEFAULT and SPECIFIED. The default value is DEFAULT.

influenceDistance=0

A Float specifying the influence distance. The influenceDistance argument applies only when influenceDistanceMethod = SPECIFIED. The default value is 0.0.

Returns:

A ShellSolidCoupling object.

Return type:

ShellSolidCoupling

Tie(
name,
main,
secondary,
adjust=1,
positionToleranceMethod=COMPUTED,
positionTolerance=0,
tieRotations=1,
constraintRatioMethod=DEFAULT,
constraintRatio=0,
constraintEnforcement=SOLVER_DEFAULT,
thickness=1,
)[source]

This method creates a Tie object.

Note

This function can be accessed by:

mdb.models[name].Tie
Parameters:
name

A String specifying the constraint repository key.

Changed in version 2022: The master argument was renamed to main.

main

A Region object specifying the name of the main surface.

Changed in version 2022: The slave argument was renamed to secondary.

secondary

A Region object specifying the name of the secondary surface.

adjust=1

A Boolean specifying whether initial positions of tied secondary nodes are adjusted to lie on the main surface. The default value is ON.

positionToleranceMethod=COMPUTED

A SymbolicConstant specifying the method used to determine the position tolerance. Possible values are COMPUTED and SPECIFIED. The default value is COMPUTED.

positionTolerance=0

A Float specifying the position tolerance. The positionTolerance argument applies only when positionToleranceMethod = SPECIFIED. The default value is 0.0.

tieRotations=1

A Boolean specifying whether rotation degrees of freedom should be tied. The default value is ON.

constraintRatioMethod=DEFAULT

A SymbolicConstant specifying the method used to determine the constraint ratio. Possible values are DEFAULT and SPECIFIED. The default value is DEFAULT.

constraintRatio=0

A Float specifying the fractional distance between the main reference surface and the secondary node at which the translational constraint should act. The constraintRatio argument applies only when constraintRatioMethod = SPECIFIED. The default value is 0.0.

constraintEnforcement=SOLVER_DEFAULT

A SymbolicConstant specifying the discretization method. Possible values are SOLVER_DEFAULT, NODE_TO_SURFACE, and SURFACE_TO_SURFACE. The default value is SOLVER_DEFAULT.

thickness=1

A Boolean specifying whether shell element thickness is considered. The default value is ON.

Returns:

A Tie object.

Return type:

Tie

Other Classes

class AdjustPoints(name, surface, controlPoints)[source]

Bases: Constraint

The AdjustPoints constraint object is used to adjust points (nodes) to a surface. The AdjustPoints object is derived from the ConstrainedSketchConstraint object.

Note

This object can be accessed by:

import interaction
mdb.models[name].constraints[name]

The corresponding analysis keywords are:

  • ADJUST

Member Details:

controlPoints : --is-rst--:py:class:`~abaqus.Region.Region.Region`[source]

A Region object specifying the constraint control points.

setValues(*args, **kwargs)[source]

This method modifies the AdjustPoints object.

suppressed : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether the constraint is suppressed or not. The default value is OFF.

surface : --is-rst--:py:class:`~abaqus.Region.Region.Region`[source]

A Region object specifying the surface to which the controlPoints are adjusted.

class Constraint[source]

Bases: object

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

Note

This object can be accessed by:

import interaction
mdb.models[name].constraints[name]

Member Details:

delete(indices)[source]

This method allows you to delete existing constraints.

Parameters:
indices

A sequence of Ints specifying the index of each constraint to delete.

name : --is-rst--:py:class:`str` = ''[source]

A String specifying the constraint repository key.

resume()[source]

This method resumes the constraint that was previously suppressed.

suppress()[source]

This method suppresses the constraint.

suppressed : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether the constraint is suppressed or not. The default value is OFF.

class Coupling(
name,
surface,
controlPoint,
influenceRadius,
couplingType,
rotationalCouplingType,
adjust=0,
localCsys=None,
u1=1,
u2=1,
u3=1,
ur1=1,
ur2=1,
ur3=1,
weightingMethod=UNIFORM,
alpha=0.0,
)[source]

Bases: Constraint

The Coupling object defines a constraint between a group of coupling nodes located on a region and a reference point. The Coupling object is derived from the ConstrainedSketchConstraint object.

Note

This object can be accessed by:

import interaction
mdb.models[name].constraints[name]

The corresponding analysis keywords are:

  • COUPLING

Member Details:

adjust : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying if the control point will be adjusted (moved) to the surface. The point will be adjusted in the direction normal to the specified surface. The default value is OFF.

alpha : --is-rst--:py:class:`float` = 0.0[source]

A Float specifying the value of the thermal expansion coefficient. The default value is 0.0. The alpha argument applies only when couplingType=KINEMATIC.

Added in version 2022: The alpha attribute was added.

controlPoint : --is-rst--:py:class:`~abaqus.Region.Region.Region`[source]

A Region object specifying the constraint control point.

couplingType : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`[source]

A SymbolicConstant specifying the coupling constraint type. Possible values are KINEMATIC, DISTRIBUTING, and STRUCTURAL.

influenceRadius : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`, :py:class:`float`][source]

The SymbolicConstant WHOLE_SURFACE or a Float specifying the influence radius.

localCsys : --is-rst--:py:class:`str` | :py:obj:`None` = None[source]

None or a DatumCsys object specifying the initial orientation of the local coordinate system for the coupling’s degrees of freedom. If localCsys = None, the coupling is defined in the global coordinate system. The default value is None.

rotationalCouplingType : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`[source]

A SymbolicConstant specifying the rotational coupling constraint type. Possible values are ROTATIONAL_CONTINUUM and ROTATIONAL_STRUCTURAL.

Added in version 2024: The rotationalCouplingType attribute was added.

setValues(
adjust=0,
localCsys=None,
u1=1,
u2=1,
u3=1,
ur1=1,
ur2=1,
ur3=1,
weightingMethod=UNIFORM,
)[source]

This method modifies the Coupling object.

Parameters:
adjust=0

A Boolean specifying if the control point will be adjusted (moved) to the surface. The point will be adjusted in the direction normal to the specified surface. The default value is OFF.

localCsys=None

None or a DatumCsys object specifying the initial orientation of the local coordinate system for the coupling’s degrees of freedom. If localCsys = None, the coupling is defined in the global coordinate system. The default value is None.

u1=1

A Boolean specifying if the displacement component in the 1-direction is constrained to the reference node for a kinematic coupling constraint. The default value is ON.The u1 argument applies only when couplingType = KINEMATIC.

u2=1

A Boolean specifying if the displacement component in the 2-direction is constrained to the reference node for a kinematic coupling constraint. The default value is ON.The u2 argument applies only when couplingType = KINEMATIC.

u3=1

A Boolean specifying if the displacement component in the 3-direction is constrained to the reference node for a kinematic coupling constraint. The default value is ON.The u3 argument applies only when couplingType = KINEMATIC.

ur1=1

A Boolean specifying if the rotational displacement component about the 1-direction is constrained to the reference node for a kinematic coupling constraint. The default value is ON.The ur1 argument applies only when couplingType = KINEMATIC.

ur2=1

A Boolean specifying if the rotational displacement component about the 2-direction is constrained to the reference node for a kinematic coupling constraint. The default value is ON.The ur2 argument applies only when couplingType = KINEMATIC.

ur3=1

A Boolean specifying if the rotational displacement component about the 3-direction is constrained to the reference node for a kinematic coupling constraint. The default value is ON.The ur3 argument applies only when couplingType = KINEMATIC.

weightingMethod=UNIFORM

A SymbolicConstant specifying an optional weighting method used for calculating the distributing weight factors. Possible values are UNIFORM, LINEAR, QUADRATIC, and CUBIC. The default value is UNIFORM.The weightingMethod argument applies only when couplingType = DISTRIBUTING.

suppressed : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether the constraint is suppressed or not. The default value is OFF.

surface : --is-rst--:py:class:`~abaqus.Region.Region.Region`[source]

A Region object specifying the surface on which the coupling nodes are located.

u1 : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying if the displacement component in the 1-direction is constrained to the reference node for a kinematic coupling constraint. The default value is ON.The u1 argument applies only when couplingType = KINEMATIC.

u2 : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying if the displacement component in the 2-direction is constrained to the reference node for a kinematic coupling constraint. The default value is ON.The u2 argument applies only when couplingType = KINEMATIC.

u3 : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying if the displacement component in the 3-direction is constrained to the reference node for a kinematic coupling constraint. The default value is ON.The u3 argument applies only when couplingType = KINEMATIC.

ur1 : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying if the rotational displacement component about the 1-direction is constrained to the reference node for a kinematic coupling constraint. The default value is ON.The ur1 argument applies only when couplingType = KINEMATIC.

ur2 : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying if the rotational displacement component about the 2-direction is constrained to the reference node for a kinematic coupling constraint. The default value is ON.The ur2 argument applies only when couplingType = KINEMATIC.

ur3 : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying if the rotational displacement component about the 3-direction is constrained to the reference node for a kinematic coupling constraint. The default value is ON.The ur3 argument applies only when couplingType = KINEMATIC.

weightingMethod : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'UNIFORM'[source]

A SymbolicConstant specifying an optional weighting method used for calculating the distributing weight factors. Possible values are UNIFORM, LINEAR, QUADRATIC, and CUBIC. The default value is UNIFORM.The weightingMethod argument applies only when couplingType = DISTRIBUTING.

class DisplayBody(name, instance, controlPoints)[source]

Bases: Constraint

The DisplayBody object defines a constraint such that the specified instance is used for display only and does not take part in the analysis. However it will still be visible during postprocessing and its position at any frame will be defined by the translation and rotation of the specified control points. The DisplayBody object is derived from the ConstrainedSketchConstraint object.

Note

This object can be accessed by:

import interaction
mdb.models[name].constraints[name]

The corresponding analysis keywords are:

  • DISPLAY BODY

Member Details:

controlPoints : --is-rst--:py:class:`~typing.List`\ \[:py:class:`~abaqus.BasicGeometry.ModelDot.ModelDot`][source]

A ModelDotArray object specifying the motion of the PartInstance. The control points may be ConstrainedSketchVertex, ReferencePoint, or MeshNode objects. Their motion will control the motion of the PartInstance. If this argument is set to an empty sequence, the PartInstance will remain fixed in space during the analysis. The sequence can have either one object or three objects.

instance : --is-rst--:py:class:`~abaqus.Assembly.PartInstance.PartInstance`[source]

A PartInstance object specifying the part instance that is to be used for display only.

setValues(*args, **kwargs)[source]

This method modifies the DisplayBody object.

suppressed : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether the constraint is suppressed or not. The default value is OFF.

class EmbeddedRegion(
name,
embeddedRegion,
hostRegion,
weightFactorTolerance=None,
toleranceMethod=BOTH,
absoluteTolerance=0,
fractionalTolerance=0,
)[source]

Bases: Constraint

The EmbeddedRegion object allows you to embed a region of the model within a “host” region of the model or within the whole model. The EmbeddedRegion object is derived from the ConstrainedSketchConstraint object.

Note

This object can be accessed by:

import interaction
mdb.models[name].constraints[name]

The corresponding analysis keywords are:

  • EMBEDDED ELEMENT

Member Details:

absoluteTolerance : --is-rst--:py:class:`float` = 0[source]

A Float specifying the absolute value by which a node on the embedded region may lie outside the host region. If absoluteTolerance = 0.0, the fractionalTolerance value will be used. The default value is 0.0.This argument applies only when toleranceMethod = ABSOLUTE or BOTH.

embeddedRegion : --is-rst--:py:class:`~abaqus.Region.Region.Region`[source]

A Region object specifying the body region to be embedded.

fractionalTolerance : --is-rst--:py:class:`float` = 0[source]

A Float specifying the fractional value by which a node on the embedded region may lie outside the host region. The fractional value is based on the average element size within the host region. The default value is 0.05.If both tolerance arguments are specified, the smaller value will be used.This argument applies only when toleranceMethod = FRACTIONAL or BOTH.

hostRegion : --is-rst--:py:class:`~abaqus.Region.Region.Region`[source]

A Region object specifying the host region. A value of None indicates that the host region is the whole model.

setValues(
weightFactorTolerance=None,
toleranceMethod=BOTH,
absoluteTolerance=0,
fractionalTolerance=0,
)[source]

This method modifies the EmbeddedRegion object.

Parameters:
weightFactorTolerance=None

A Float specifying a small value below which the weighting factors will be zeroed out. The default value is 10⁻⁶.

toleranceMethod=BOTH

A SymbolicConstant specifying the method used to determine the embedded element tolerance. Possible values are ABSOLUTE, FRACTIONAL, and BOTH. The default value is BOTH.

absoluteTolerance=0

A Float specifying the absolute value by which a node on the embedded region may lie outside the host region. If absoluteTolerance = 0.0, the fractionalTolerance value will be used. The default value is 0.0.This argument applies only when toleranceMethod = ABSOLUTE or BOTH.

fractionalTolerance=0

A Float specifying the fractional value by which a node on the embedded region may lie outside the host region. The fractional value is based on the average element size within the host region. The default value is 0.05.If both tolerance arguments are specified, the smaller value will be used.This argument applies only when toleranceMethod = FRACTIONAL or BOTH.

suppressed : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether the constraint is suppressed or not. The default value is OFF.

toleranceMethod : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'BOTH'[source]

A SymbolicConstant specifying the method used to determine the embedded element tolerance. Possible values are ABSOLUTE, FRACTIONAL, and BOTH. The default value is BOTH.

weightFactorTolerance : --is-rst--:py:class:`float` | :py:obj:`None` = None[source]

A Float specifying a small value below which the weighting factors will be zeroed out. The default value is 10⁻⁶.

class Equation(name, terms)[source]

Bases: Constraint

The Equation object defines a linear multi-point constraint between a set of degrees of freedom. The Equation object is derived from the ConstrainedSketchConstraint object.

Note

This object can be accessed by:

import interaction
mdb.models[name].constraints[name]

The corresponding analysis keywords are:

  • EQUATION

Member Details:

setValues(*args, **kwargs)[source]

This method modifies the Equation object.

Raises:

Exception – If terms does not contain more than one entry, Equation must have two or more terms.

suppressed : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether the constraint is suppressed or not. The default value is OFF.

terms : --is-rst--:py:class:`tuple`[source]

A sequence of (Float, String, Int, Int) sequences specifying a coefficient, Set name, degree of freedom, and coordinate system ID. The coordinate system ID is optional.

class MultipointConstraint(
name,
surface,
controlPoint,
mpcType,
csys=None,
userType=0,
userMode=DOF_MODE_MPC,
)[source]

Bases: Constraint

The MultipointConstraint object defines a constraint between a group of MultipointConstraint nodes located on a region and a reference point. The MultipointConstraint object is derived from the ConstrainedSketchConstraint object.

Note

This object can be accessed by:

import interaction
mdb.models[name].constraints[name]

The corresponding analysis keywords are:

  • MPC

Member Details:

controlPoint : --is-rst--:py:class:`~abaqus.Region.Region.Region`[source]

A Region object specifying the constraint control point.

csys : --is-rst--:py:class:`str` | :py:obj:`None` = None[source]

None or a DatumCsys object specifying the initial orientation of the local coordinate system for the MultipointConstraint’s degrees of freedom. If localCsys = None, the MultipointConstraint is defined in the global coordinate system. The default value is None.

mpcType : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`[source]

A SymbolicConstant specifying the MPC type of the constraint. Possible values are BEAM_MPC, ELBOW_MPC, PIN_MPC, LINK_MPC, TIE_MPC, and USER_MPC.

setValues(csys=None, userType=0, userMode=DOF_MODE_MPC)[source]

This method modifies the MultipointConstraint object.

Parameters:
csys=None

None or a DatumCsys object specifying the initial orientation of the local coordinate system for the MultipointConstraint’s degrees of freedom. If localCsys = None, the MultipointConstraint is defined in the global coordinate system. The default value is None.

userType=0

An Int specifying to differentiate between different constraint types in a user-defined MultipointConstraint. The default value is 0.The userType argument applies only when mpcType = USER_MPC.

userMode=DOF_MODE_MPC

A SymbolicConstant specifying the mode of the constraint when it is user-defined. Possible values are DOF_MODE_MPC and NODE_MODE_MPC. The default value is DOF_MODE_MPC.The userMode argument applies only when mpcType = USER_MPC.

suppressed : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether the constraint is suppressed or not. The default value is OFF.

surface : --is-rst--:py:class:`~abaqus.Region.Region.Region`[source]

A Region object specifying the surface on which the MultipointConstraint nodes are located.

userMode : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'DOF_MODE_MPC'[source]

A SymbolicConstant specifying the mode of the constraint when it is user-defined. Possible values are DOF_MODE_MPC and NODE_MODE_MPC. The default value is DOF_MODE_MPC.The userMode argument applies only when mpcType = USER_MPC.

userType : --is-rst--:py:class:`int` = 0[source]

An Int specifying to differentiate between different constraint types in a user-defined MultipointConstraint. The default value is 0.The userType argument applies only when mpcType = USER_MPC.

class RigidBody(
name,
refPointRegion,
bodyRegion=None,
tieRegion=None,
pinRegion=None,
surfaceRegion=None,
refPointAtCOM=0,
isothermal=0,
)[source]

Bases: Constraint

The RigidBody object constrains all the degrees of freedom on the specified regions to the degree of freedom of its associated reference point. The RigidBody object is derived from the ConstrainedSketchConstraint object.

Note

This object can be accessed by:

import interaction
mdb.models[name].constraints[name]

The corresponding analysis keywords are:

  • RIGID BODY

Member Details:

bodyRegion : --is-rst--:py:class:`str` | :py:obj:`None` = None[source]

None or a Region object specifying the elements constrained to the movement of the reference point. The default value is None.

isothermal : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether the temperature degree of freedom should be constrained. The default value is OFF.

pinRegion : --is-rst--:py:class:`str` | :py:obj:`None` = None[source]

None or a Region object specifying the nodes pinned to the movement of the reference point. The default value is None.

refPointAtCOM : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether the analysis product should recompute the reference point position to be at the center of mass. The default value is OFF.

refPointRegion : --is-rst--:py:class:`~abaqus.Region.Region.Region`[source]

A Region object specifying the reference point.

setValues(
bodyRegion=None,
tieRegion=None,
pinRegion=None,
surfaceRegion=None,
refPointAtCOM=0,
isothermal=0,
)[source]

This method modifies the RigidBody object.

Parameters:
bodyRegion=None

None or a Region object specifying the elements constrained to the movement of the reference point. The default value is None.

tieRegion=None

None or a Region object specifying the nodes tied to the movement of the reference point. The default value is None.

pinRegion=None

None or a Region object specifying the nodes pinned to the movement of the reference point. The default value is None.

surfaceRegion=None

None or a Region object specifying the analytic surface constrained to the movement of the reference point. The default value is None.

refPointAtCOM=0

A Boolean specifying whether the analysis product should recompute the reference point position to be at the center of mass. The default value is OFF.

isothermal=0

A Boolean specifying whether the temperature degree of freedom should be constrained. The default value is OFF.

suppressed : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether the constraint is suppressed or not. The default value is OFF.

surfaceRegion : --is-rst--:py:class:`str` | :py:obj:`None` = None[source]

None or a Region object specifying the analytic surface constrained to the movement of the reference point. The default value is None.

tieRegion : --is-rst--:py:class:`str` | :py:obj:`None` = None[source]

None or a Region object specifying the nodes tied to the movement of the reference point. The default value is None.

class ShellSolidCoupling(
name,
shellEdge,
solidFace,
positionToleranceMethod=COMPUTED,
positionTolerance=0,
influenceDistanceMethod=DEFAULT,
influenceDistance=0,
)[source]

Bases: Constraint

The ShellSolidCoupling object defines two surfaces to be tied together for the duration of a simulation. The ShellSolidCoupling object is derived from the ConstrainedSketchConstraint object.

Note

This object can be accessed by:

import interaction
mdb.models[name].constraints[name]

The corresponding analysis keywords are:

  • SHELL TO SOLID COUPLING

Member Details:

influenceDistance : --is-rst--:py:class:`float` = 0[source]

A Float specifying the influence distance. The influenceDistance argument applies only when influenceDistanceMethod = SPECIFIED. The default value is 0.0.

influenceDistanceMethod : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'DEFAULT'[source]

A SymbolicConstant specifying the method used to determine the influence distance. Possible values are DEFAULT and SPECIFIED. The default value is DEFAULT.

positionTolerance : --is-rst--:py:class:`float` = 0[source]

A Float specifying the position tolerance. The default value is 0.0.The positionTolerance argument applies only when positionToleranceMethod = SPECIFIED. Note: Abaqus will not constrain nodes on the solid face region outside the position tolerance.

positionToleranceMethod : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'COMPUTED'[source]

A SymbolicConstant specifying the method used to determine the position tolerance. Possible values are COMPUTED and SPECIFIED. The default value is COMPUTED.

setValues(
positionToleranceMethod=COMPUTED,
positionTolerance=0,
influenceDistanceMethod=DEFAULT,
influenceDistance=0,
)[source]

This method modifies the ShellSolidCoupling object.

Parameters:
positionToleranceMethod=COMPUTED

A SymbolicConstant specifying the method used to determine the position tolerance. Possible values are COMPUTED and SPECIFIED. The default value is COMPUTED.

positionTolerance=0

A Float specifying the position tolerance. The default value is 0.0.The positionTolerance argument applies only when positionToleranceMethod = SPECIFIED. Note: Abaqus will not constrain nodes on the solid face region outside the position tolerance.

influenceDistanceMethod=DEFAULT

A SymbolicConstant specifying the method used to determine the influence distance. Possible values are DEFAULT and SPECIFIED. The default value is DEFAULT.

influenceDistance=0

A Float specifying the influence distance. The influenceDistance argument applies only when influenceDistanceMethod = SPECIFIED. The default value is 0.0.

shellEdge : --is-rst--:py:class:`~abaqus.Region.Region.Region`[source]

A Region object specifying the name of the shell edge surface.

solidFace : --is-rst--:py:class:`~abaqus.Region.Region.Region`[source]

A Region object specifying the name of the solid surface.

suppressed : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether the constraint is suppressed or not. The default value is OFF.

class Tie(
name,
main,
secondary,
adjust=1,
positionToleranceMethod=COMPUTED,
positionTolerance=0,
tieRotations=1,
constraintRatioMethod=DEFAULT,
constraintRatio=0,
constraintEnforcement=SOLVER_DEFAULT,
thickness=1,
)[source]

Bases: Constraint

The Tie object defines two surfaces to be tied together for the duration of a simulation. The Tie object is derived from the ConstrainedSketchConstraint object.

Note

This object can be accessed by:

import interaction
mdb.models[name].constraints[name]

The corresponding analysis keywords are:

  • TIE

Member Details:

adjust : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying whether initial positions of tied secondary nodes are adjusted to lie on the main surface. The default value is ON.

constraintEnforcement : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'SOLVER_DEFAULT'[source]

A SymbolicConstant specifying the discretization method. Possible values are SOLVER_DEFAULT, NODE_TO_SURFACE, and SURFACE_TO_SURFACE. The default value is SOLVER_DEFAULT.

constraintRatio : --is-rst--:py:class:`float` = 0[source]

A Float specifying the fractional distance between the main reference surface and the secondary node at which the translational constraint should act. The constraintRatio argument applies only when constraintRatioMethod = SPECIFIED. The default value is 0.0.

constraintRatioMethod : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'DEFAULT'[source]

A SymbolicConstant specifying the method used to determine the constraint ratio. Possible values are DEFAULT and SPECIFIED. The default value is DEFAULT.

main : --is-rst--:py:class:`~abaqus.Region.Region.Region`[source]

A Region object specifying the name of the main surface.

Changed in version 2022: The master attribute was renamed to main.

positionTolerance : --is-rst--:py:class:`float` = 0[source]

A Float specifying the position tolerance. The positionTolerance argument applies only when positionToleranceMethod = SPECIFIED. The default value is 0.0.

positionToleranceMethod : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'COMPUTED'[source]

A SymbolicConstant specifying the method used to determine the position tolerance. Possible values are COMPUTED and SPECIFIED. The default value is COMPUTED.

secondary : --is-rst--:py:class:`~abaqus.Region.Region.Region`[source]

A Region object specifying the name of the secondary surface.

Changed in version 2022: The slave attribute was renamed to secondary.

setValues(
adjust=1,
positionToleranceMethod=COMPUTED,
positionTolerance=0,
tieRotations=1,
constraintRatioMethod=DEFAULT,
constraintRatio=0,
constraintEnforcement=SOLVER_DEFAULT,
thickness=1,
)[source]

This method modifies the Tie object.

Parameters:
adjust=1

A Boolean specifying whether initial positions of tied secondary nodes are adjusted to lie on the main surface. The default value is ON.

positionToleranceMethod=COMPUTED

A SymbolicConstant specifying the method used to determine the position tolerance. Possible values are COMPUTED and SPECIFIED. The default value is COMPUTED.

positionTolerance=0

A Float specifying the position tolerance. The positionTolerance argument applies only when positionToleranceMethod = SPECIFIED. The default value is 0.0.

tieRotations=1

A Boolean specifying whether rotation degrees of freedom should be tied. The default value is ON.

constraintRatioMethod=DEFAULT

A SymbolicConstant specifying the method used to determine the constraint ratio. Possible values are DEFAULT and SPECIFIED. The default value is DEFAULT.

constraintRatio=0

A Float specifying the fractional distance between the main reference surface and the secondary node at which the translational constraint should act. The constraintRatio argument applies only when constraintRatioMethod = SPECIFIED. The default value is 0.0.

constraintEnforcement=SOLVER_DEFAULT

A SymbolicConstant specifying the discretization method. Possible values are SOLVER_DEFAULT, NODE_TO_SURFACE, and SURFACE_TO_SURFACE. The default value is SOLVER_DEFAULT.

thickness=1

A Boolean specifying whether shell element thickness is considered. The default value is ON.

suppressed : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]

A Boolean specifying whether the constraint is suppressed or not. The default value is OFF.

swapSurfaces()[source]

This method switches the main and secondary surfaces of a tied constraint.

This command is valid only during the step in which the interaction is created.

thickness : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying whether shell element thickness is considered. The default value is ON.

tieRotations : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]

A Boolean specifying whether rotation degrees of freedom should be tied. The default value is ON.