Model

Model commands are used to create Abaqus/CAE models. A finished model contains all the data that Abaqus/CAE needs to create and submit an analysis to Abaqus/Standard or Abaqus/Explicit. Models are stored in a model database.

Objects in Model

• Adaptivity
• Amplitude
• Boundary Condition
• Calibration of Material
• Constraint
• Field
• Filter
• Interaction
• Load
• Material
• Mesh
• Optimization
• Output Request
• Part and Assembly
• Predefined Field
• Beam Section Profile
• Property
• Section
• Sketcher
• Step

Create models

Mdb.Model(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) → Model

This method creates a Model object.

Parameters:

name

A String specifying the repository key.

description

A String specifying the purpose and contents of the Model object. The default value is an empty string.

stefanBoltzmann

None or a Float specifying the Stefan-Boltzmann constant. The default value is None.

absoluteZero

None or a Float specifying the absolute zero constant. The default value is None.

waveFormulation

A SymbolicConstant specifying the type of incident wave formulation to be used in acoustic problems. Possible values are NOT_SET, SCATTERED, and TOTAL. The default value is NOT_SET.

modelType

A SymbolicConstant specifying the analysis model type. Possible values are STANDARD_EXPLICIT and ELECTROMAGNETIC. The default is STANDARD_EXPLICIT.

universalGas

None or a Float specifying the universal gas constant. The default value is None.

copyConstraints

A boolean specifying whether to copy the constraints created in the model to the model that instances this model. The default value is ON.

copyConnectors

A boolean specifying whether to copy the connectors created in the model to the model that instances this model. The default value is ON.

copyInteractions

A boolean specifying whether to copy the interactions created in the model to the model that instances this model. The default value is ON.

Returns:

model: Model

A Model object

Notes

This function can be accessed by:

mdb.Model

Object features

Model

class Model(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)

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

Notes

This object can be accessed by:

mdb.models[name]

The corresponding analysis keywords are:

• PHYSICAL CONSTANTS

Attributes:

name: str

A String specifying the repository key.

stefanBoltzmann: float

None or a Float specifying the Stefan-Boltzmann constant. The default value is None.

absoluteZero: float

None or a Float specifying the absolute zero constant. The default value is None.

waveFormulation: SymbolicConstant

A SymbolicConstant specifying the type of incident wave formulation to be used in acoustic problems. Possible values are NOT_SET, SCATTERED, and TOTAL. The default value is NOT_SET.

universalGas: float

None or a Float specifying the universal gas constant. The default value is None.

noPartsInputFile: Boolean

A Boolean specifying whether an input file should be written without parts and assemblies. The default value is OFF.

restartIncrement: SymbolicConstant

An Int specifying the increment, interval, iteration or cycle where the restart analysis will start. To select the end of the step use the SymbolicConstant STEP_END.

endRestartStep: Boolean

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

shellToSolid: Boolean

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

lastChangedCount: float

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

description: str

A String specifying the purpose and contents of the Model object. The default value is an empty string.

restartJob: str

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

restartStep: str

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

globalJob: str

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

copyConstraints: Boolean

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

copyConnectors: Boolean

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

copyInteractions: Boolean

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

keywordBlock: KeywordBlock

A KeywordBlock object.

rootAssembly: Assembly

An Assembly object.

amplitudes: dict[str, Amplitude]

A repository of Amplitude objects.

profiles: dict[str, Profile]

A repository of Profile objects.

boundaryConditions: dict[str, BoundaryCondition]

A repository of BoundaryCondition objects.

constraints: dict[str, Constraint]

A repository of ConstrainedSketchConstraint objects.

analyticalFields: dict[str, AnalyticalField]

A repository of AnalyticalField objects.

discreteFields: dict[str, DiscreteField]

A repository of DiscreteField objects.

predefinedFields: dict[str, PredefinedField]

A repository of PredefinedField objects.

interactions: dict[str, Interaction]

A repository of Interaction objects.

interactionProperties: dict[str, ContactProperty]

A repository of InteractionProperty objects.

contactControls: dict[str, ContactControl]

A repository of ContactControl objects.

contactInitializations: dict[str, ContactInitialization]

A repository of ContactInitialization objects.

contactStabilizations: dict[str, ContactStabilization]

A repository of ContactStabilization objects.

linkedInstances: tuple

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

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: dict[str, Load]

A repository of Load objects.

materials: dict[str, Material]

A repository of Material objects.

calibrations: dict[str, Calibration]

A repository of Calibration objects.

sections: dict[str, Section]

A repository of Section objects.

remeshingRules: dict[str, RemeshingRule]

A repository of RemeshingRule objects.

sketches: dict[str, ConstrainedSketch]

A repository of ConstrainedSketch objects.

parts: dict[str, Part]

A repository of Part objects.

steps: dict[str, Step]

A repository of Step objects.

featureOptions: FeatureOptions

A FeatureOptions object.

adaptiveMeshConstraints: dict[str, AdaptiveMeshConstraint]

A repository of AdaptiveMeshConstraint objects.

adaptiveMeshControls: dict[str, AdaptiveMeshControl]

A repository of AdaptiveMeshControl objects.

timePoints: dict[str, TimePoint]

A repository of TimePoint objects.

filters: dict[str, Filter]

A repository of Filter objects.

integratedOutputSections: dict[str, IntegratedOutputSection]

A repository of IntegratedOutputSection objects.

fieldOutputRequests: dict[str, FieldOutputRequest]

A repository of FieldOutputRequest objects.

historyOutputRequests: dict[str, HistoryOutputRequest]

A repository of HistoryOutputRequest objects.

optimizationTasks: dict[str, OptimizationTask]

A repository of OptimizationTask objects.

tableCollections: dict[str, TableCollection]

A repository of TableCollection objects.

eventSeriesTypes: dict[str, EventSeriesType]

A repository of EventSeriesType objects.

eventSeriesDatas: dict[str, EventSeriesData]

A repository of EventSeriesData objects.

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

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

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

AcousticImpedance(name: str, createStepName: str, surface: Region, definition: SymbolicConstantType = 'TABULAR', interactionProperty: str = '', nonreflectingType: SymbolicConstantType = 'PLANE', radius: float = 1, semimajorAxis: float = 1, eccentricity: float = 0, centerCoordinates: tuple = (), directionCosine: tuple = ()) → AcousticImpedance

This method creates an AcousticImpedance object.

Parameters:

name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which the AcousticImpedance object is created.

surface

A Region object specifying the acoustic boundary surface.

definition

A SymbolicConstant specifying the type of acoustic impedance to be defined. Possible values are TABULAR and NONREFLECTING. The default value is TABULAR.

interactionProperty

A String specifying the AcousticImpedanceProp object associated with this interaction.

nonreflectingType

A SymbolicConstant specifying the type of nonreflecting geometry to be defined. Possible values are PLANE, IMPROVED, CIRCULAR, SPHERICAL, ELLIPTICAL, and PROLATE. The default value is PLANE.This argument is valid only when *definition*=NONREFLECTING.

radius

A Float specifying the radius of the circle or sphere defining the boundary surface. The default value is 1.0.This argument is valid only when *definition*=NONREFLECTING, and *nonreflectingType*=CIRCULAR or SPHERICAL.

semimajorAxis

A Float specifying the semimajor axis length of the ellipse or prolate spheroid defining the boundary surface. The default value is 1.0.This argument is valid only when *definition*=NONREFLECTING, and *nonreflectingType*=ELLIPTICAL or PROLATE.

eccentricity

A Float specifying the eccentricity of the ellipse or prolate spheroid defining the boundary surface. The default value is 0.0.This argument is valid only when *definition*=NONREFLECTING, and *nonreflectingType*=ELLIPTICAL or PROLATE.

centerCoordinates

A sequence of three Floats specifying the X, Y, and Z coordinates of the center of the ellipse or prolate spheroid defining the boundary surface. The default value is (0, 0, 0).This argument is valid only when *definition*=NONREFLECTING, and *nonreflectingType*=ELLIPTICAL or PROLATE.

directionCosine

A sequence of three Floats specifying the X, Y, and Z components of the direction cosine of the major axis of the ellipse or prolate spheroid defining the boundary surface. The default value is (0, 0, 1).This argument is valid only when *definition*=NONREFLECTING, and *nonreflectingType*=ELLIPTICAL or PROLATE.

Returns:

An AcousticImpedance object.

Notes

This function can be accessed by:

mdb.models[name].AcousticImpedance

AcousticImpedanceProp(name: str, tableType: SymbolicConstantType, table: tuple, frequencyDependency: BooleanType = 0) → AcousticImpedanceProp

This method creates an AcousticImpedanceProp object.

Parameters:

name

A String specifying the interaction property repository key.

tableType

A SymbolicConstant specifying the type of tabular data to be defined. Possible values are IMPEDANCE and ADMITTANCE.

table

A sequence of sequences of Floats specifying acoustic impedance properties.If *tableType*=IMPEDANCE, each sequence of the table data specifies:The real part of the complex impedance.The imaginary part of the complex impedance.Frequency, if the data depend on frequency.If *tableType*=ADMITTANCE, each sequence of the table data specifies:The real part of the complex admittance.The imaginary part of the complex admittance.Frequency, if the data depend on frequency.

frequencyDependency

A Boolean specifying whether the table data depend on frequency. The default value is OFF.

Returns:

An AcousticImpedanceProp object.

Notes

This function can be accessed by:

mdb.models[name].AcousticImpedanceProp

AcousticInfiniteSection(name: str, material: str, thickness: float = 1, order: int = 10) → AcousticInfiniteSection

This method creates an AcousticInfiniteSection object.

Parameters:

name

A String specifying the repository key.

material

A String specifying the name of the material.

thickness

A Float specifying the thickness of the section. Possible values are thickness >> 0.0. The default value is 1.0.

order

An Int specifying the number of ninth-order polynomials that will be used to resolve the variation of the acoustic field in the infinite direction. Possible values are 0 << order ≤≤ 10. The default value is 10.

Returns:

An AcousticInfiniteSection object.

Raises:

InvalidNameError

RangeError

Notes

This function can be accessed by:

mdb.models[name].AcousticInfiniteSection
session.odbs[name].AcousticInfiniteSection

AcousticInterfaceSection(name: str, thickness: float = 1) → AcousticInterfaceSection

This method creates an AcousticInterfaceSection object.

Parameters:

name

A String specifying the repository key.

thickness

A Float specifying the thickness of the section. Possible values are thickness >> 0.0. The default value is 1.0.

Returns:

An AcousticInterfaceSection object.

Raises:

InvalidNameError

RangeError

Notes

This function can be accessed by:

mdb.models[name].AcousticInterfaceSection
session.odbs[name].AcousticInterfaceSection

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

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

ActuatorAmplitude(name: str, timeSpan: SymbolicConstantType = 'STEP') → ActuatorAmplitude

This method creates a ActuatorAmplitude object.

Parameters:

name

A String specifying the repository key.

timeSpan

A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:

An ActuatorAmplitude object.

Raises:

InvalidNameError

RangeError

Notes

This function can be accessed by:

mdb.models[name].ActuatorAmplitude
session.odbs[name].ActuatorAmplitude

ActuatorSensor(name: str, createStepName: str, point: Region, interactionProperty: str, noCoordComponents: int, unsymm: BooleanType, noSolutionDepVar: int, userSubUel: str, dof: str, solutionDepVars: tuple) → ActuatorSensor

This method creates an ActuatorSensor object.

Parameters:

name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which the actuator/sensor interaction is created. createStepName must be set to ‘Initial’.

point

A Region object specifying the point at which the constraint is applied.

interactionProperty

A String specifying the ActuatorSensorProp object associated with this interaction.

noCoordComponents

An Int specifying the number of coordinate components supplied to the user subroutine (UEL).

unsymm

A Boolean specifying whether the element matrices are symmetric (ON) or unsymmetric (OFF). The default value is OFF.

noSolutionDepVar

An Int specifying the number of solution-dependent variables. The default value is 0.

userSubUel

A String specifying the name of the user subroutine (UEL) that defines the user element.

dof

A String specifying the degrees of freedom, separated by commas.

solutionDepVars

A sequence of Floats specifying the initial values of the solution-dependent variables.

Returns:

An ActuatorSensor object.

Notes

This function can be accessed by:

mdb.models[name].ActuatorSensor

ActuatorSensorProp(name: str, realProperties: tuple = (), integerProperties: tuple = ()) → ActuatorSensorProp

This method creates an ActuatorSensorProp object.

Parameters:

name

A String specifying the interaction property repository key.

realProperties

A sequence of Floats specifying the PROPS array used by user subroutine UEL. The default value is an empty sequence.

integerProperties

A sequence of Ints specifying the JPROPS array used by user subroutine UEL. The default value is an empty sequence.

Returns:

An ActuatorSensorProp object.

Notes

This function can be accessed by:

mdb.models[name].ActuatorSensorProp

AdaptiveMeshConstraint(name: str = '', category: ~abaqusConstants.SymbolicConstantType | None = None, region: ~abaqus.Region.Region.Region = <abaqus.Region.Region.Region object>, localCsys: ~abaqus.Datum.DatumCsys.DatumCsys | None = None) → AdaptiveMeshConstraint

The AdaptiveMeshConstraint object is the abstract base type for other Arbitrary Lagrangian Eularian (ALE) style AdaptiveMeshConstraint objects. The AdaptiveMeshConstraint object has no explicit constructor. The methods and members of the AdaptiveMeshConstraint object are common to all objects derived from the AdaptiveMeshConstraint object.

Parameters:

name

A String specifying the adaptive mesh constraint repository key.

category

A SymbolicConstant specifying the category of the adaptive mesh constraint. Possible values are MECHANICAL and THERMAL.

region

A Region object specifying the region to which the adaptive mesh constraint is applied.

localCsys

None or a DatumCsys object specifying the local coordinate system of the adaptive mesh constraint’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

Notes

This function can be accessed by:

mdb.models[name].AdaptiveMeshConstraint

AdaptiveMeshControl(name: str, remapping: SymbolicConstantType = 'SECOND_ORDER_ADVECTION', smoothingAlgorithm: SymbolicConstantType = 'GEOMETRY_ENHANCED', smoothingPriority: SymbolicConstantType = 'UNIFORM', initialFeatureAngle: float = 30, transitionFeatureAngle: float = 30, momentumAdvection: SymbolicConstantType = 'ELEMENT_CENTER_PROJECTION', meshingPredictor: SymbolicConstantType = 'CURRENT', curvatureRefinement: float = 1, volumetricSmoothingWeight: float = 1, laplacianSmoothingWeight: float = 0, equipotentialSmoothingWeight: float = 0, meshConstraintAngle: float = 60, originalConfigurationProjectionWeight: float = 1, standardVolumetricSmoothingWeight: float = 0) → AdaptiveMeshControl

This method creates an AdaptiveMeshControl object.

Parameters:

name

A String specifying the name of the object.

remapping

A SymbolicConstant specifying the remapping algorithm. Possible values are FIRST_ORDER_ADVECTION and SECOND_ORDER_ADVECTION. The default value is SECOND_ORDER_ADVECTION.

smoothingAlgorithm

A SymbolicConstant specifying the type of smoothing algorithm to use. Possible values are STANDARD and GEOMETRY_ENHANCED. The default value is GEOMETRY_ENHANCED.

smoothingPriority

A SymbolicConstant specifying the type of smoothing to perform. Possible values are UNIFORM and GRADED. The default value is UNIFORM.

initialFeatureAngle

A Float specifying the initial geometric feature angle, θI, in degrees. Possible values are 0° ≤θI≤ 180°. The default value is 30.0.

transitionFeatureAngle

A Float specifying the transitional feature angle, θT, in degrees. Possible values are 0° ≤θT≤ 180°. The default value is 30.0.

momentumAdvection

A SymbolicConstant specifying the type of momentum advection algorithm. Possible values are ELEMENT_CENTER_PROJECTION and HALF_INDEX_SHIFT. The default value is ELEMENT_CENTER_PROJECTION.

meshingPredictor

A SymbolicConstant specifying the nodal starting location to use for remeshing. Possible values are CURRENT and PREVIOUS. The default value is CURRENT.

curvatureRefinement

A Float specifying the solution dependence weight, αC. Possible values are 0.0 ≤αC≤ 1.0. The default value is 1.0.

volumetricSmoothingWeight

A Float specifying the weight used by Abaqus/Explicit for the volumetric smoothing method. The default value is 1.0.

laplacianSmoothingWeight

A Float specifying the weight for the Laplacian smoothing method. The default value is 0.0.

equipotentialSmoothingWeight

A Float specifying the weight for the equipotential smoothing method. The default value is 0.0.

meshConstraintAngle

A Float specifying the initial geometric feature angle, θC. Possible values are 0° ≤θC≤ 180°. The default value is 60.0.

originalConfigurationProjectionWeight

A Float specifying the weight for the original configuration projection method. The default value is 1.0.

standardVolumetricSmoothingWeight

A Float specifying the weight used by Abaqus/Standard for the volumetric smoothing method. The default value is 0.0.

Returns:

An AdaptiveMeshControl object

Notes

This function can be accessed by:

mdb.models[name].AdaptiveMeshConstraint

AdjustPoints(name: str, surface: Region, controlPoints: Region) → AdjustPoints

This method creates an AdjustPoints object.

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.

Notes

This function can be accessed by:

mdb.models[name].AdjustPoints

AnnealStep(name: str, previous: str, description: str = '', refTemp: float | None = None, maintainAttributes: BooleanType = False) → AnnealStep

This method creates an AnnealStep object.

Parameters:

name

A String specifying the repository key.

previous

A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

description

A String specifying a description of the new step. The default value is an empty string.

refTemp

A Float specifying the post-anneal reference temperature. The default value is the current temperature at all nodes in the model after the annealing has completed.

maintainAttributes

A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is False.

Returns:

step: AnnealStep

An AnnealStep object.

Notes

This function can be accessed by:

mdb.models[name].AnnealStep

ArbitraryProfile(name: str, table: tuple) → ArbitraryProfile

This method creates a ArbitraryProfile object.

Parameters:

name

A String specifying the repository key.

table

A sequence of sequences of Floats specifying the items described below.

Returns:

An ArbitraryProfile object.

Raises:

RangeError.

!img

Notes

This function can be accessed by:

mdb.models[name].ArbitraryProfile
session.odbs[name].ArbitraryProfile

BeadTask(name: str, abaqusSensitivities: BooleanType = True, algorithm: SymbolicConstantType = 'GENERAL_OPTIMIZATION', areBCRegionsFrozen: BooleanType = 0, beadIter: str = 1, beadMaxMembraneStress: str = 0, beadMinStress: str = 0, beadPerturbation: str = 0, beadWidth: SymbolicConstantType = 'DEFAULT', curveSmooth: str = 5, filterRadius: str = 4, filterRadiusBy: SymbolicConstantType = 'VALUE', flipNormalDir: BooleanType = 0, frozenBoundaryConditionRegion: SymbolicConstantType = 'MODEL', isSensCalcOnlyOnDesignNodes: BooleanType = 0, modeTrackingRegion: SymbolicConstantType = 'MODEL', nodalMoveLimit: float = 0, nodeSmooth: SymbolicConstantType = 'DEFAULT', nodeUpdateStrategy: SymbolicConstantType = 'CONSERVATIVE', numTrackedModes: int = 5, updateShapeBasisVectors: SymbolicConstantType = 'EVERY_CYCLE', groupOperator: BooleanType = 0) → BeadTask

This method creates a BeadTask object.

Parameters:

name

A String specifying the optimization task repository key.

abaqusSensitivities

A Boolean specifying whether to use Abaqus to compute the design responses and their sensitivities. The default value is True.

algorithm

A SymbolicConstant specifying the optimization task algorithm. Possible values are GENERAL_OPTIMIZATION and CONDITION_BASED_OPTIMIZATION. The default value is GENERAL_OPTIMIZATION.

areBCRegionsFrozen

A Boolean specifying whether to exclude elements with boundary conditions from the optimization. The default value is OFF.

beadIter

An int specifying the step size of the optimization. The default value is 1.

beadMaxMembraneStress

A float specifying maximum membrane/bending stress. The default value is 0.1.

beadMinStress

A float specifying minimum stress. The default value is 0.001.

beadPerturbation

A Sets perturbation size for finite differences. The default value is 0.0001.

beadWidth

A SymbolicConstant specifying the Optimization product default or a float specifying the bead width. The default value is DEFAULT.

curveSmooth

A float specifying relative value to the middle element edge length such that normals in this area do not cross each other. The default value is 5.

filterRadius

A float specifying the filter radius. The default value is 4.

filterRadiusBy

A SymbolicConstant specifying the method used to define filter radius. Possible values are VALUE and REFERENCE. The default is VALUE.

flipNormalDir

A Boolean specifying whether the growth direction is along the normal direction of elements or opposite to the normal direction. The default value is OFF

frozenBoundaryConditionRegion

When nodes with boundary conditions are excluded from the optimization (frozenBoundaryConditionRegions = ON). you can specify that this exclusion apply to nodes throughout the model or only to those nodes from a specific region. Set this parameter to the SymbolicConstant MODEL to apply the freeze to the entire model, or set this parameter to a Region object to specify an individual region over which nodes with boundary conditions should be frozen. The default value is MODEL.

isSensCalcOnlyOnDesignNodes

A Boolean specifying whether to calculate the sensitivities only on design nodes or the whole model. The default value is ON

modeTrackingRegion

The SymbolicConstant MODEL or a Region object specifying the region to use for mode tracking. The default value is MODEL.

nodalMoveLimit

A Float specifying the maximum change in nodal displacement per design cycle. The default value is 0.1.

nodeSmooth

A SymbolicConstant specifying the Optimization product default or a float specifying the node smooth. The default value is DEFAULT.

nodeUpdateStrategy

A SymbolicConstant specifying the strategy for how the nodal displacements are updated in the method of moving asymptotes. Possible values are NORMAL, CONSERVATIVE, and AGGRESSIVE. The default value is CONSERVATIVE.

numTrackedModes

An Int specifying the number of modes included in mode tracking. The default value is 5.

updateShapeBasisVectors

A SymbolicConstant specifying whether to update shape basis vectors in the first design cycle or every design cycle. Possible values are EVERY_CYCLE and FIRST_CYCLE. The default value is EVERY_CYCLE.

Returns:

A BeadTask object.

Notes

This function can be accessed by:

mdb.models[name].BeadTask

BeamSection(name: str, integration: SymbolicConstantType, profile: str, poissonRatio: float = 0, thermalExpansion: BooleanType = 0, temperatureDependency: BooleanType = 0, dependencies: int = 0, density: float | None = None, referenceTemperature: float | None = None, temperatureVar: SymbolicConstantType = 'LINEAR', alphaDamping: float = 0, betaDamping: float = 0, compositeDamping: float = 0, useFluidInertia: BooleanType = 0, submerged: SymbolicConstantType = 'FULLY', fluidMassDensity: float | None = None, crossSectionRadius: float | None = None, lateralMassCoef: float = 1, axialMassCoef: float = 0, massOffsetX: float = 0, massOffsetY: float = 0, beamShape: SymbolicConstantType = 'CONSTANT', material: str = '', table: tuple = (), outputPts: tuple = (), centroid: tuple[float] = (), shearCenter: tuple[float] = (), profileEnd: str = '') → BeamSection

This method creates a BeamSection object.

Parameters:

name

A String specifying the repository key.

integration

A SymbolicConstant specifying the integration method for the section. Possible values are BEFORE_ANALYSIS and DURING_ANALYSIS.

profile

A String specifying the name of the profile. This argument represents the start profile in case of *beamShape*=TAPERED.

poissonRatio

A Float specifying the Poisson’s ratio of the section. The default value is 0.0.

thermalExpansion

A Boolean specifying whether to use thermal expansion data. The default value is OFF.

temperatureDependency

A Boolean specifying whether the data depend on temperature. The default value is OFF.

dependencies

An Int specifying the number of field variable dependencies. The default value is 0.

density

None or a Float specifying the density of the section. The default value is None.

referenceTemperature

None or a Float specifying the reference temperature of the section. The default value is None.

temperatureVar

A SymbolicConstant specifying the temperature variation for the section. Possible values are LINEAR and INTERPOLATED. The default value is LINEAR.

alphaDamping

A Float specifying the αRαR factor to create mass proportional damping in direct-integration dynamics. The default value is 0.0.

betaDamping

A Float specifying the βRβR factor to create stiffness proportional damping in direct-integration dynamics. The default value is 0.0.

compositeDamping

A Float specifying the fraction of critical damping to be used in calculating composite damping factors for the modes (for use in modal dynamics). The default value is 0.0.

useFluidInertia

A Boolean specifying whether added mass effects will be simulated. The default value is OFF.

submerged

A SymbolicConstant specifying whether the section is either full submerged or half submerged. This argument applies only when useFluidInertia = True. Possible values are FULLY and HALF. The default value is FULLY.

fluidMassDensity

None or a Float specifying the mass density of the fluid. This argument applies only when useFluidInertia = True and must be specified in that case. The default value is None.

crossSectionRadius

None or a Float specifying the radius of the cylindrical cross-section. This argument applies only when useFluidInertia = True and must be specified in that case. The default value is None.

lateralMassCoef

A Float specifying the added mass coefficient, CACA, for lateral motions of the beam. This argument applies only when*useFluidInertia* = True. The default value is 1.0.

axialMassCoef

A Float specifying the added mass coefficient, C(A−E)C(A-E), for motions along the axis of the beam. This argument affects only the term added to the free end(s) of the beam, and applies only when useFluidInertia = True. The default value is 0.0.

massOffsetX

A Float specifying the local 1-coordinate of the center of the cylindrical cross-section with respect to the beam cross-section. This argument applies only when useFluidInertia = True. The default value is 0.0.

massOffsetY

A Float specifying the local 2-coordinate of the center of the cylindrical cross-section with respect to the beam cross-section. This argument applies only when useFluidInertia = True. The default value is 0.0.

beamShape

A SymbolicConstant specifying the change in cross-section of the beam along length. Possible values are CONSTANT and TAPERED. The default value is CONSTANT. This parameter is available for manipulating the model database but not for the ODB API.

material

A String specifying the name of the material. The default value is an empty string. The material is required when integration is “DURING_ANALYSIS”.

table

A sequence of sequences of Floats specifying the items described below. The default value is an empty sequence.

outputPts

A sequence of pairs of Floats specifying the positions at which output is requested. The default value is an empty sequence.

centroid

A pair of Floats specifying the X–Y coordinates of the centroid. The default value is (0.0, 0.0).

shearCenter

A pair of Floats specifying the X–Y coordinates of the shear center. The default value is (0.0, 0.0).

profileEnd

A String specifying the name of the end profile. The type of the end profile must be same as that of the start profile. This argument is valid only when *beamShape*=TAPERED. The default value is an empty string. This parameter is available for manipulating the model database but not for the ODB API.

Returns:

A BeamSection object.

Notes

This function can be accessed by:

mdb.models[name].BeamSection
session.odbs[name].BeamSection

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

This method creates a BodyCharge object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created. This must be the first analysis step name.

region

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

magnitude

A Float specifying the load magnitude.

amplitude

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

distributionType

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

field

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

Returns:

A BodyCharge object.

Notes

This function can be accessed by:

mdb.models[name].BodyCharge

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

This method creates a BodyConcentrationFlux object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created.

region

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

magnitude

A Float specifying the body concentration flux magnitude. magnitude is optional if *distributionType*=USER_DEFINED.

field

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

distributionType

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

amplitude

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

Returns:

A BodyConcentrationFlux object.

Notes

This function can be accessed by:

mdb.models[name].BodyConcentrationFlux

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

This method creates a BodyCurrent object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created. This must be the first analysis step name.

region

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

magnitude

A Float specifying the load magnitude.

amplitude

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

distributionType

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

field

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

Returns:

A BodyCurrent object.

Notes

This function can be accessed by:

mdb.models[name].BodyCurrent

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

This method creates a BodyCurrentDensity object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created. This must be the first analysis step name.

region

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

comp1

A Complex specifying the first component of the load.

comp2

A Complex specifying the second component of the load.

comp3

A Complex specifying the third component of the load.

amplitude

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

distributionType

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

Returns:

A BodyCurrentDensity object.

Notes

This function can be accessed by:

mdb.models[name].BodyCurrentDensity

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

This method creates a BodyForce object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created.

region

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

field

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

distributionType

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

comp1

A Float or a Complex specifying the body force component in the 1-direction.Note:Although comp1, comp2, and comp3 are optional arguments, at least one of them must be nonzero unless *distributionType*=USER_DEFINED.

comp2

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

comp3

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

amplitude

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

Returns:

A BodyForce object.

Notes

This function can be accessed by:

mdb.models[name].BodyForce

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

This method creates a BodyHeatFlux object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created.

region

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

magnitude

A Float specifying the body heat flux magnitude. magnitude is optional if *distributionType*=USER_DEFINED.

field

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

distributionType

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

amplitude

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

Returns:

A BodyHeatFlux object.

Notes

This function can be accessed by:

mdb.models[name].BodyHeatFlux

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

This method creates a BoltLoad object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created. This must be the first analysis step name.

region

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

magnitude

A Float specifying the bolt load magnitude.

boltMethod

A SymbolicConstant specifying the method of applying the bolt load. Possible values are APPLY_FORCE and ADJUST_LENGTH. The default value is APPLY_FORCE.

datumAxis

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

amplitude

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

preTenSecPartLevel

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

Returns:

A BoltLoad object.

Raises:

TextError.

Notes

This function can be accessed by:

mdb.models[name].BoltLoad

BoxProfile(name: str, a: float, b: float, uniformThickness: BooleanType, t1: float, t2: float = 0, t3: float = 0, t4: float = 0) → BoxProfile

This method creates a BoxProfile object.

Parameters:

name

A String specifying the repository key.

a

A Float specifying the a dimension of the box profile. For more information, see [Beam cross-section library](https://help.3ds.com/2021/English/DSSIMULIA_Established/SIMACAEELMRefMap/simaelm-c-beamcrosssectlib.htm?ContextScope=all).

b

A Float specifying the b dimension of the box profile.

uniformThickness

A Boolean specifying whether the thickness is uniform.

t1

A Float specifying the uniform wall thickness if *uniformThickness*=ON, and the wall thickness of the first segment if *uniformThickness*=OFF.

t2

A Float specifying the wall thickness of the second segment. t2 is required only when *uniformThickness*=OFF. The default value is 0.0.

t3

A Float specifying the wall thickness of the third segment. t3 is required only when *uniformThickness*=OFF. The default value is 0.0.

t4

A Float specifying the wall thickness of the fourth segment. t4 is required only when *uniformThickness*=OFF. The default value is 0.0.

Returns:

A BoxProfile object.

Raises:

RangeError.

!img

Notes

This function can be accessed by:

mdb.models[name].BoxProfile
session.odbs[name].BoxProfile

BuckleStep(name: str, previous: str, numEigen: int, description: str = '', eigensolver: SymbolicConstantType = 'SUBSPACE', minEigen: float | None = None, maxEigen: float | None = None, vectors: int | None = None, maxIterations: int = 30, blockSize: SymbolicConstantType = 'DEFAULT', maxBlocks: SymbolicConstantType = 'DEFAULT', matrixStorage: SymbolicConstantType = 'SOLVER_DEFAULT', maintainAttributes: BooleanType = False) → BuckleStep

This method creates a BuckleStep object.

Parameters:

name

A String specifying the repository key.

previous

A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

numEigen

An Int specifying the number of eigenvalues to be estimated.

description

A String specifying a description of the new step. The default value is an empty string.

eigensolver

A SymbolicConstant specifying the eigensolver. Possible values are SUBSPACE and LANCZOS. The default value is SUBSPACE.

minEigen

None or a Float specifying the minimum eigenvalue of interest. The default value is None.

maxEigen

None or a Float specifying the maximum eigenvalue of interest. The default value is None.

vectors

An Int specifying the number of vectors used in the iteration. The default value is the minimum of (2*n*, n + 8), where n is the number of eigenvalues requested.

maxIterations

An Int specifying the maximum number of iterations. The default value is 30.

blockSize

The SymbolicConstant DEFAULT or an Int specifying the size of the Lanczos block steps. The default value is DEFAULT.

maxBlocks

The SymbolicConstant DEFAULT or an Int specifying the maximum number of Lanczos block steps within each Lanczos run. The default value is DEFAULT.Note:minEigen, blockSize, and maxBlocks are ignored unless *eigensolver*=LANCZOS.

matrixStorage

A SymbolicConstant specifying the type of matrix storage. Possible values are SYMMETRIC, UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT.

maintainAttributes

A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is False.

Returns:

step: BuckleStep

A BuckleStep object.

Notes

This function can be accessed by:

mdb.models[name].BuckleStep

ButterworthFilter(name: str, cutoffFrequency: float, order: int = 2, operation: SymbolicConstantType = 'NONE', halt: BooleanType = 0, limit: float | None = None, invariant: SymbolicConstantType = 'NONE') → ButterworthFilter

This method creates a ButterworthFilter object.

Parameters:

name

A String specifying the repository key. This name ANTIALIASING is reserved for filters generated internally by the program.

cutoffFrequency

A Float specifying the attenuation point of the filter. Possible values are non-negative numbers. Order is not available for OperatorFilter.

order

An Int specifying the highest power of the filter transfer function. Possible values are non-negative numbers less than or equal to 20. Order is not available for OperatorFilter. The default value is 2.

operation

A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.

halt

A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.

limit

None or a Float specifying the threshold limit, an upper or lower bound for output values depending on the operation, or a bound for stopping the analysis when Halt is used. The default value is None.

invariant

A SymbolicConstant specifying the invariant to which filtering is applied. Possible values are NONE, FIRST, and SECOND. The default value is NONE.

Returns:

A ButterworthFilter object.

Raises:

InvalidNameError

RangeError

Notes

This function can be accessed by:

mdb.models[name].ButterworthFilter
session.odbs[name].ButterworthFilter

Calibration(name: str) → Calibration

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

CavityRadiation(name: str, createStepName: str, surfaces: ~abaqus.Region.RegionArray.RegionArray, surfaceEmissivities: tuple = (), ambientTemp: float | None = None, blocking: ~abaqusConstants.SymbolicConstantType = 'BLOCKING_ALL', blockingSurfaces: ~abaqus.Region.RegionArray.RegionArray | None = None, rangeOfView: float | None = None, surfaceReflection: ~abaqusConstants.BooleanType = 1, viewfactorAccurTol: float = 0, minInfinitesimalRatio: float = 64, numPointsPerEdge: int = 3, minLumpedAreaDS: float = 5, cyclicSymmetry: ~abaqusConstants.BooleanType = 0, cyclicImages: int = 2, cyclicRotPt: ~abaqus.BasicGeometry.ModelDot.ModelDot = <abaqus.BasicGeometry.ModelDot.ModelDot object>, cyclicRotEndPt: ~abaqus.BasicGeometry.ModelDot.ModelDot = <abaqus.BasicGeometry.ModelDot.ModelDot object>, cyclicSymPt: ~abaqus.BasicGeometry.ModelDot.ModelDot = <abaqus.BasicGeometry.ModelDot.ModelDot object>, periodicSymmetries: int = 0, periodicImages_1: int = 2, periodicImages_2: int = 2, periodicImages_3: int = 2, periodicSymAxis_1: str = '', periodicSymAxis_2: str = '', periodicSymPlane_1: str = '', periodicSymPlane_2: str = '', periodicSymPlane_3: str = '', periodicDistance_1: tuple = (), periodicDistance_2: tuple = (), periodicDistance_3: tuple = (), periodicSymZ: float | None = None, periodicDistZ: float | None = None, reflectionSymmetries: int = 0, reflectionSymAxis_1: str = '', reflectionSymAxis_2: str = '', reflectionSymPlane_1: str = '', reflectionSymPlane_2: str = '', reflectionSymPlane_3: str = '', reflectionSymZ: float | None = None) → CavityRadiation

This method creates a CavityRadiation object.

Parameters:

name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which the cavity radiation interaction should be created.

surfaces

A RegionArray object specifying the surfaces for which radiation viewfactor control is being specified.

surfaceEmissivities

A sequence of Strings specifying the names of the Cavity Radiation properties containing the surface emissivity data. One name per specified surface. The emissivity data is ignored when *surfaceReflection*=OFF.

ambientTemp

None or a Float specifying the reference ambient temperature value, θ0θ0. Specifying a value indicates an open cavity. The default value is None.

blocking

A SymbolicConstant specifying the blocking checks to be performed in the viewfactor calculations. Possible values are BLOCKING_ALL, NO_BLOCKING, and PARTIAL_BLOCKING. The default value is BLOCKING_ALL.

blockingSurfaces

A RegionArray object specifying the surfaces that provide blocking inside the cavity. This argument applies only when *blocking*=PARTIAL_BLOCKING.

rangeOfView

None or a Float specifying the maximum distance between surface facets at which viewfactors are calculated. More distant facets are deemed too far apart to exchange significant amounts of heat through radiation effects, and the viewfactors between these facets are assumed to be zero. If *rangeOfView*=None, there is no upper limit. The default value is None.

surfaceReflection

A Boolean specifying whether heat reflections are to be included in the cavity radiation calculations. The default value is ON.

viewfactorAccurTol

A Float specifying the acceptable tolerance for the viewfactor calculations. The default value is 0.05.

minInfinitesimalRatio

A Float specifying the facet area ratio above which the infinitesimal-to-finite area approximation is used for viewfactor calculations. The default value is 64.0.

numPointsPerEdge

An Int specifying the number of Gauss integration points to be used along each edge when the numerical integration of contour integrals is used for viewfactor calculations. One to five integration points are allowed. The default value is 3.

minLumpedAreaDS

A Float specifying the nondimensional distance-square value above which the lumped area approximation is used for viewfactor calculations. The default value is 5.0.

cyclicSymmetry

A Boolean specifying whether cyclic symmetry will be applied. This argument cannot be specified for axisymmetric models. The default value is OFF.

cyclicImages

An Int specifying the number of cyclically similar images that compose the cavity formed as a result of this symmetry. This argument applies only when *cyclicSymmetry*=ON. The default value is 2.

cyclicRotPt

A ModelDot object specifying the rotation axis point. This argument applies only when *cyclicSymmetry*=ON.

cyclicRotEndPt

A ModelDot object specifying the rotation axis end point. This argument applies only for three-dimensional models, and only when *cyclicSymmetry*=ON.

cyclicSymPt

A ModelDot object specifying the symmetry axis end point. This argument applies only when *cyclicSymmetry*=ON.

periodicSymmetries

An Int specifying the number of periodic symmetries that will be applied. The default value is 0.

periodicImages_1

An Int specifying the number of repetitions used in the numerical calculation of the cavity viewfactors resulting from the first periodic symmetry. The result of this symmetry is a cavity composed of the cavity surface defined in the model plus twice the value of periodicImages_1. This argument applies only when periodicSymmetries is greater than zero. The default value is 2.

periodicImages_2

An Int specifying the number of repetitions used in the numerical calculation of the cavity viewfactors resulting from the second periodic symmetry. The result of this symmetry is a cavity composed of the cavity surface defined in the model plus twice the value of periodicImages_2. This argument applies only when periodicSymmetries is greater than one. The default value is 2.

periodicImages_3

An Int specifying the number of repetitions used in the numerical calculation of the cavity viewfactors resulting from the third periodic symmetry. The result of this symmetry is a cavity composed of the cavity surface defined in the model plus twice the value of periodicImages_3. This argument applies only when periodicSymmetries = 3. The default value is 2.

periodicSymAxis_1

A straight Edge, a Datum object representing a datum axis, or an ElementEdge object indicating the first line of symmetry in two-dimensional models. This argument applies only for 2D models, and when periodicSymmetries is greater than zero.

periodicSymAxis_2

A straight Edge, a Datum object representing a datum axis, or an ElementEdge object indicating the second line of symmetry in two-dimensional models. This argument applies only for two-dimensional models, and when periodicSymmetries = 2.

periodicSymPlane_1

A planar Face, an ElementFace, or a Datum object representing a datum plane; indicating the first plane of symmetry in three-dimensional models. This argument applies only for three-dimensional models, and when periodicSymmetries is greater than zero.

periodicSymPlane_2

A planar Face, an ElementFace, or a Datum object representing a datum plane; indicating the second plane of symmetry in three-dimensional models. This argument applies only for three-dimensional models, and when periodicSymmetries is greater than one.

periodicSymPlane_3

A planar Face, an ElementFace, or a Datum object representing a datum plane; indicating the third plane of symmetry in three-dimensional models. This argument applies only for three-dimensional models, and when periodicSymmetries = 3.

periodicDistance_1

A sequence of sequences of Floats specifying the two points of the vector that describes the periodic distance for the first periodic symmetry. Each point is defined by a tuple of three coordinates indicating its position. This argument applies only when periodicSymmetries is greater than zero. The default value is an empty sequence.

periodicDistance_2

A sequence of sequences of Floats specifying the two points of the vector that describes the periodic distance for the second periodic symmetry. Each point is defined by a tuple of three coordinates indicating its position. This argument applies only when periodicSymmetries is greater than one. The default value is an empty sequence.

periodicDistance_3

A sequence of sequences of Floats specifying the two points of the vector that describes the periodic distance for the third periodic symmetry. Each point is defined by a tuple of three coordinates indicating its position. This argument applies only when periodicSymmetries = 3. The default value is an empty sequence.

periodicSymZ

None or a Float specifying the Z value indicating the symmetry reference line in axisymmetric models. This argument applies only for axisymmetric models, and when periodicSymmetries = 1. The default value is None.

periodicDistZ

None or a Float specifying the Z value indicating the periodic distance in axisymmetric models. This argument applies only for axisymmetric models, and when periodicSymmetries = 1. The default value is None.

reflectionSymmetries

An Int specifying the number of reflection symmetries will be applied. The default value is 0.

reflectionSymAxis_1

A straight Edge, a Datum object representing a datum axis, or an ElementEdge object indicating the first line of symmetry in two-dimensional models. This argument applies only for two-dimensional models, and when reflectionSymmetries is greater than zero.

reflectionSymAxis_2

A straight Edge, a Datum object representing a datum axis, or an ElementEdge object indicating the second line of symmetry in two-dimensional models. This argument applies only for two-dimensional models, and when reflectionSymmetries = 2.

reflectionSymPlane_1

A planar Face, an ElementFace, or a Datum object representing a datum plane; indicating the first plane of symmetry in three-dimensional models. This argument applies only for three-dimensional models, and when reflectionSymmetries is greater than zero.

reflectionSymPlane_2

A planar Face, an ElementFace, or a Datum object representing a datum plane; indicating the second plane of symmetry in three-dimensional models. This argument applies only for three-dimensional models, and when reflectionSymmetries is greater than one.

reflectionSymPlane_3

A planar Face, an ElementFace, or a Datum object representing a datum plane; indicating the third plane of symmetry in three-dimensional models. This argument applies only for three-dimensional models, and when reflectionSymmetries = 3.

reflectionSymZ

None or a Float specifying the Z value indicating the symmetry reference line in axisymmetric models. This argument applies only for axisymmetric models, and when reflectionSymmetries = 1. The default value is None.

Returns:

A CavityRadiation object.

Notes

This function can be accessed by:

mdb.models[name].CavityRadiation

CavityRadiationProp(name: str, temperatureDependency: BooleanType = 0, dependencies: int = 0, property: tuple = ()) → CavityRadiationProp

This method creates a CavityRadiationProp object.

Parameters:

name

A String specifying the interaction property repository key.

temperatureDependency

A Boolean specifying whether the data depend on temperature. The default value is OFF.

dependencies

An Int specifying the number of field variable dependencies. The default value is 0.

property

A sequence of sequences of Floats specifying the following:The emissivity, ϵϵ.Temperature, if the data depend on temperature.Value of the first field variable, if the data depend on field variables.Value of the second field variable.Etc.

Returns:

A CavityRadiationProp object.

Notes

This function can be accessed by:

mdb.models[name].CavityRadiationProp

Chebyshev1Filter(name: str, cutoffFrequency: float, rippleFactor: float = 0, order: int = 2, operation: SymbolicConstantType = 'NONE', halt: BooleanType = 0, limit: float | None = None, invariant: SymbolicConstantType = 'NONE') → Chebyshev1Filter

This method creates a Chebyshev1Filter object.

Parameters:

name

A String specifying the repository key. This name ANTIALIASING is reserved for filters generated internally by the program.

cutoffFrequency

A Float specifying the attenuation point of the filter. Possible values are non-negative numbers. Order is not available for OperatorFilter.

rippleFactor

A Float specifying the amount of allowable ripple in the filter. Possible values are non-negative numbers. The default value is 0.225.

order

An Int specifying the highest power of the filter transfer function. Possible values are non-negative numbers less than or equal to 20. Order is not available for OperatorFilter. The default value is 2.

operation

A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.

halt

A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.

limit

None or a Float specifying the threshold limit, an upper or lower bound for output values depending on the operation, or a bound for stopping the analysis when Halt is used. The default value is None.

invariant

A SymbolicConstant specifying the invariant to which filtering is applied. Possible values are NONE, FIRST, and SECOND. The default value is NONE.

Returns:

A Chebyshev1Filter object.

Raises:

InvalidNameError

RangeError

Notes

This function can be accessed by:

mdb.models[name].Chebyshev1Filter
session.odbs[name].Chebyshev1Filter

Chebyshev2Filter(name: str, cutoffFrequency: float, rippleFactor: float = 0, order: int = 2, operation: SymbolicConstantType = 'NONE', halt: BooleanType = 0, limit: float | None = None, invariant: SymbolicConstantType = 'NONE') → Chebyshev2Filter

This method creates a Chebyshev2Filter object.

Parameters:

name

A String specifying the repository key. This name ANTIALIASING is reserved for filters generated internally by the program.

cutoffFrequency

A Float specifying the attenuation point of the filter. Possible values are non-negative numbers. Order is not available for OperatorFilter.

rippleFactor

A Float specifying the amount of allowable ripple in the filter. Possible values are non-negative numbers less than 1. The default value is 0.025.

order

An Int specifying the highest power of the filter transfer function. Possible values are non-negative numbers less than or equal to 20. Order is not available for OperatorFilter. The default value is 2.

operation

A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.

halt

A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.

limit

None or a Float specifying the threshold limit, an upper or lower bound for output values depending on the operation, or a bound for stopping the analysis when Halt is used. The default value is None.

invariant

A SymbolicConstant specifying the invariant to which filtering is applied. Possible values are NONE, FIRST, and SECOND. The default value is NONE.

Returns:

A Chebyshev2Filter object.

Raises:

InvalidNameError

RangeError

Notes

This function can be accessed by:

mdb.models[name].Chebyshev2Filter
session.odbs[name].Chebyshev2Filter

CircularProfile(name: str, r: float) → CircularProfile

This method creates a CircularProfile object.

Parameters:

name

A String specifying the repository key.

r

A positive Float specifying the r dimension (outer radius) of the circular profile. For more information, see [Beam cross-section library](https://help.3ds.com/2021/English/DSSIMULIA_Established/SIMACAEELMRefMap/simaelm-c-beamcrosssectlib.htm?ContextScope=all).

Returns:

A CircularProfile object.

Raises:

RangeError.

!img

Notes

This function can be accessed by:

mdb.models[name].CircularProfile
session.odbs[name].CircularProfile

CohesiveSection(name: str, response: SymbolicConstantType, material: str, initialThicknessType: SymbolicConstantType = 'SOLVER_DEFAULT', initialThickness: float = 1, outOfPlaneThickness: float | None = None) → CohesiveSection

This method creates a CohesiveSection object.

Parameters:

name

A String specifying the repository key.

response

A SymbolicConstant specifying the geometric assumption that defines the constitutive behavior of the cohesive elements. Possible values are TRACTION_SEPARATION, CONTINUUM, and GASKET.

material

A String specifying the name of the material.

initialThicknessType

A SymbolicConstant specifying the method used to compute the initial thickness. Possible values are:SOLVER_DEFAULT, specifying that Abaqus will use the analysis product defaultGEOMETRY, specifying that Abaqus will compute the thickness from the nodal coordinates of the elements.SPECIFY, specifying that Abaqus will use the value given for *initialThickness*The default value is SOLVER_DEFAULT.

initialThickness

A Float specifying the initial thickness for the section. The initialThickness argument applies only when *initialThicknessType*=SPECIFY. The default value is 1.0.

outOfPlaneThickness

None or a Float specifying the out-of-plane thickness for the section. The default value is None.

Returns:

A CohesiveSection object.

Raises:

RangeError and InvalidNameError.

Notes

This function can be accessed by:

mdb.models[name].CohesiveSection
session.odbs[name].CohesiveSection

ComplexFrequencyStep(name: str, previous: str, numEigen: SymbolicConstantType = 'ALL', description: str = '', shift: float | None = None, frictionDamping: BooleanType = 0, matrixStorage: SymbolicConstantType = 'SOLVER_DEFAULT', maintainAttributes: BooleanType = False, minEigen: float | None = None, maxEigen: float | None = None, propertyEvaluationFrequency: float | None = None) → ComplexFrequencyStep

This method creates a ComplexFrequencyStep object.

Parameters:

name

A String specifying the repository key.

previous

A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

numEigen

The SymbolicConstant ALL or an Int specifying the number of complex eigenmodes to be calculated or a SymbolicConstant ALL. The default value is ALL.

description

A String specifying a description of the new step. The default value is an empty string.

shift

None or a Float specifying the shift point in cycles per time. The default value is None.

frictionDamping

A Boolean specifying whether to add to the damping matrix contributions due to friction effects. The default value is OFF.

matrixStorage

A SymbolicConstant specifying the type of matrix storage. Possible values are SYMMETRIC, UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT.

maintainAttributes

A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is False.

minEigen

None or a Float specifying the minimum frequency of interest in cycles per time. The default value is None.

maxEigen

None or a Float specifying the maximum frequency of interest in cycles per time. The default value is None.

propertyEvaluationFrequency

None or a Float specifying the frequency at which to evaluate frequency-dependent properties for viscoelasticity, springs, and dashpots during the eigenvalue extraction. If the value is None, the analysis product will evaluate the stiffness associated with frequency-dependent springs and dashpots at zero frequency and will not consider the stiffness contributions from frequency-domain viscoelasticity in the step. The default value is None.

Returns:

step: ComplexFrequencyStep

A ComplexFrequencyStep object.

Notes

This function can be accessed by:

mdb.models[name].ComplexFrequencyStep

CompositeShellSection(name: str, layup: SectionLayerArray, symmetric: BooleanType = 0, thicknessType: SymbolicConstantType = 'UNIFORM', preIntegrate: BooleanType = 0, poissonDefinition: SymbolicConstantType = 'DEFAULT', poisson: float = 0, integrationRule: SymbolicConstantType = 'SIMPSON', temperature: SymbolicConstantType = 'GRADIENT', idealization: SymbolicConstantType = 'NO_IDEALIZATION', nTemp: int | None = None, thicknessModulus: float | None = None, useDensity: BooleanType = 0, density: float = 0, layupName: str = '', thicknessField: str = '', nodalThicknessField: str = '') → CompositeShellSection

This method creates a CompositeShellSection object.

Parameters:

name

A String specifying the repository key.

layup

A SectionLayerArray object specifying the shell cross-section.

symmetric

A Boolean specifying whether or not the layup should be made symmetric by the analysis. The default value is OFF.

thicknessType

A SymbolicConstant specifying the distribution used for defining the thickness of the elements. Possible values are UNIFORM, ANALYTICAL_FIELD, DISCRETE_FIELD, NODAL_ANALYTICAL_FIELD, and NODAL_DISCRETE_FIELD. The default value is UNIFORM.

preIntegrate

A Boolean specifying whether the shell section properties are specified by the user prior to the analysis (ON) or integrated during the analysis (OFF). The default value is OFF.

poissonDefinition

A SymbolicConstant specifying whether to use the default value for the Poisson’s ratio. Possible values are:DEFAULT, specifying that the default value for the Poisson’s ratio is 0.5 in an Abaqus/Standard analysis and is obtained from the material definition in an Abaqus/Explicit analysis.VALUE, specifying that the Poisson’s ratio used in the analysis is the value provided in poisson.The default value is DEFAULT.

poisson

A Float specifying the Poisson’s ratio. Possible values are −1.0 ≤≤ poisson ≤≤ 0.5. This argument is valid only when *poissonDefinition*=VALUE. The default value is 0.5.

integrationRule

A SymbolicConstant specifying the shell section integration rule. Possible values are SIMPSON and GAUSS. The default value is SIMPSON.

temperature

A SymbolicConstant specifying the mode used for temperature and field variable input across the section thickness. Possible values are GRADIENT and POINTWISE. The default value is GRADIENT.

idealization

A SymbolicConstant specifying the mechanical idealization used for the section calculations. This member is only applicable when preIntegrate is set to ON. Possible values are NO_IDEALIZATION, SMEAR_ALL_LAYERS, MEMBRANE, and BENDING. The default value is NO_IDEALIZATION.

nTemp

None or an Int specifying the number of temperature points to be input. This argument is valid only when *temperature*=POINTWISE. The default value is None.

thicknessModulus

None or a Float specifying the effective thickness modulus. This argument is relevant only for continuum shells and must be used in conjunction with the argument poisson. The default value is None.

useDensity

A Boolean specifying whether or not to use the value of density. The default value is OFF.

density

A Float specifying the value of density to apply to this section. The default value is 0.0.

layupName

A String specifying the layup name for this section. The default value is an empty string.

thicknessField

A String specifying the name of the AnalyticalField or DiscreteField object used to define the thickness of the shell elements. The thicknessField argument applies only when *thicknessType*=ANALYTICAL_FIELD or *thicknessType*=DISCRETE_FIELD. The default value is an empty string.

nodalThicknessField

A String specifying the name of the AnalyticalField or DiscreteField object used to define the thickness of the shell elements at each node. The nodalThicknessField argument applies only when *thicknessType*=NODAL_ANALYTICAL_FIELD or *thicknessType*=NODAL_DISCRETE_FIELD. The default value is an empty string.

Returns:

A CompositeShellSection object.

Notes

This function can be accessed by:

mdb.models[name].parts[name].compositeLayups[i].CompositeShellSection
mdb.models[name].CompositeShellSection
session.odbs[name].CompositeShellSection

CompositeSolidSection(name: str, layup: SectionLayerArray, symmetric: BooleanType = 0, layupName: str = '') → CompositeSolidSection

This method creates a CompositeSolidSection object.

Parameters:

name

A String specifying the repository key.

layup

A SectionLayerArray object specifying the solid cross-section.

symmetric

A Boolean specifying whether or not the layup should be made symmetric by the analysis. The default value is OFF.

layupName

A String specifying the layup name for this section. The default value is an empty string.

Returns:

A CompositeSolidSection object.

Notes

This function can be accessed by:

mdb.models[name].CompositeSolidSection
session.odbs[name].CompositeSolidSection

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

This method creates a ConcCharge object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created. This must be the first analysis step name.

region

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

magnitude

A Float specifying the load magnitude.

distributionType

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

field

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

amplitude

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

Returns:

A ConcCharge object.

Notes

This function can be accessed by:

mdb.models[name].ConcCharge

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

This method creates a ConcConcFlux object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created. This must be the first analysis step name.

region

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

magnitude

A Float specifying the load magnitude.

distributionType

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

field

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

amplitude

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

Returns:

A ConcConcFlux object.

Notes

This function can be accessed by:

mdb.models[name].ConcConcFlux

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

This method creates a ConcCurrent object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created. This must be the first analysis step name.

region

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

magnitude

A Float specifying the load magnitude.

distributionType

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

field

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

amplitude

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

Returns:

A ConcCurrent object.

Notes

This function can be accessed by:

mdb.models[name].ConcCurrent

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

This method creates a ConcPoreFluid object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created. This must be the first analysis step name.

region

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

magnitude

A Float specifying the load magnitude.

distributionType

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

field

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

amplitude

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

Returns:

A ConcPoreFluid object.

Notes

This function can be accessed by:

mdb.models[name].ConcPoreFluid

ConcentratedFilmCondition(name: str, createStepName: str, region: Region, definition: SymbolicConstantType, nodalArea: float = 1, explicitRegionType: SymbolicConstantType = 'LAGRANGIAN', interactionProperty: str = '', field: str = '', sinkTemperature: float = 0, sinkAmplitude: str = '', filmCoeff: float = 0, filmCoeffAmplitude: str = '', sinkFieldName: str = '', sinkDistributionType: SymbolicConstantType = 'UNIFORM') → ConcentratedFilmCondition

This method creates a ConcentratedFilmCondition object.

Parameters:

name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which the ConcentratedFilmCondition object is created.

region

A Region object specifying the region to which the concentrated film condition interaction is applied. The interaction is applied to each node in the region.

definition

A SymbolicConstant specifying how the concentrated film condition is defined. Possible values are EMBEDDED_COEFF, PROPERTY_REF, USER_SUB, and FIELD.

nodalArea

A Float specifying the area associated with the node where the concentrated film condition is applied. The default value is 1.0.

explicitRegionType

A SymbolicConstant specifying how the concentrated film condition is applied to the boundary of an adaptive mesh domain. Possible values are LAGRANGIAN, SLIDING, and EULERIAN. The default value is LAGRANGIAN. This argument applies only during an Abaqus/Explicit analysis.

interactionProperty

A String specifying the name of the FilmConditionProp object associated with this interaction. The interactionProperty argument applies only when *definition*=PROPERTY_REF. The default value is an empty string.

field

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

sinkTemperature

A Float specifying the reference sink temperature, θ0θ0. The default value is 0.0.

sinkAmplitude

A String specifying the name of the Amplitude object that gives the variation of the sink temperature, θ0θ0, with time. The default value is an empty string.Note:Use None in an Abaqus/Standard analysis to specify that the reference sink temperature is applied immediately at the beginning of the step or linearly over the step. Use None in an Abaqus/Explicit analysis to specify that the reference sink temperature is applied throughout the step.

filmCoeff

A Float specifying the reference film coefficient value, hh. The filmCoeff argument applies when *definition*=EMBEDDED_COEFF, *definition*=USER_SUB, or *definition*=FIELD. The default value is 0.0.

filmCoeffAmplitude

A String specifying the name of the Amplitude object that gives the variation of the film coefficient, hh, with time. The default value is an empty string.Note:Use None in an Abaqus/Standard analysis to specify that the reference film coefficient is applied immediately at the beginning of the step or linearly over the step. Use None in an Abaqus/Explicit analysis to specify that the reference film coefficient is applied throughout the step.

sinkFieldName

A String specifying the name of the AnalyticalField or DiscreteField object associated with the sink temperature. The sinkFieldName argument applies only when *sinkDistributionType*=ANALYTICAL_FIELD or *sinkDistributionType*=DISCRETE_FIELD. The default value is an empty string.

sinkDistributionType

A SymbolicConstant specifying how the sink temperature is distributed. Possible values are UNIFORM, ANALYTICAL_FIELD, and DISCRETE_FIELD. The default value is UNIFORM.

Returns:

A ConcentratedFilmCondition object.

Notes

This function can be accessed by:

mdb.models[name].ConcentratedFilmCondition

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

This method creates a ConcentratedForce object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created.

region

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

distributionType

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

field

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

cf1

A Float or a Complex specifying the concentrated force component in the 1-direction. Although cf1, cf2, and cf3 are optional arguments, at least one of them must be nonzero.

cf2

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

cf3

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

amplitude

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

follower

A Boolean specifying whether the direction of the force rotates with the rotation at each node of the region. You should provide the follower argument only if it is valid for the specified step. The default value is OFF.

localCsys

None or a DatumCsys object specifying the local coordinate system of the load’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. When this member is queried, it returns an Int. The default value is None.

Returns:

A ConcentratedForce object.

Notes

This function can be accessed by:

mdb.models[name].ConcentratedForce

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

This method creates a ConcentratedHeatFlux object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created. This must be the first analysis step name.

region

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

magnitude

A Float specifying the load magnitude.

distributionType

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

field

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

amplitude

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

dof

An Int specifying the degree of freedom of the node, to which the concentrated heat flux should be applied. The default value is 11.

Returns:

A ConcentratedHeatFlux object.

Notes

This function can be accessed by:

mdb.models[name].ConcentratedHeatFlux

ConcentratedRadiationToAmbient(name: str, createStepName: str, region: Region, ambientTemperature: float, ambientTemperatureAmp: str, emissivity: float, nodalArea: float = 1, explicitRegionType: SymbolicConstantType = 'LAGRANGIAN', field: str = '', distributionType: SymbolicConstantType = 'UNIFORM') → ConcentratedRadiationToAmbient

This method creates a ConcentratedRadiationToAmbient object.

Parameters:

name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which the ConcentratedRadiationToAmbient object is created.

region

A Region object specifying the region to which the concentrated radiation interaction is applied. The interaction is applied to each node in the region.

ambientTemperature

A Float specifying the reference ambient temperature, θ0θ0.

ambientTemperatureAmp

A String specifying the name of the Amplitude object that gives the variation of the ambient temperature with time.Note:Use None in an Abaqus/Standard analysis to specify that the reference ambient temperature is applied immediately at the beginning of the step or linearly over the step. Use None in an Abaqus/Explicit analysis to specify that the reference ambient temperature is applied throughout the step.

emissivity

A Float specifying the emissivity, ϵϵ.

nodalArea

A Float specifying the area associated with the node where the concentrated radiation interaction is applied. The default value is 1.0.

explicitRegionType

A SymbolicConstant specifying how the concentrated radiation is applied to the boundary of an adaptive mesh domain. Possible values are LAGRANGIAN, SLIDING, and EULERIAN. The default value is LAGRANGIAN.Note:explicitRegionType applies only during an Abaqus/Explicit analysis.

field

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

distributionType

A SymbolicConstant specifying how the radiation is defined. Possible values are UNIFORM and ANALYTICAL_FIELD. The default value is UNIFORM.

Returns:

A ConcentratedRadiationToAmbient object.

Notes

This function can be accessed by:

mdb.models[name].ConcentratedRadiationToAmbient

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

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

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

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

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

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

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

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created.

region

The wire region to which the load is applied. This argument is not valid when fastenerName and fastenerSetName are specified.

fastenerName

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

fastenerSetName

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

f1

A Float or a Complex specifying the connector force component in the connector’s local 1-direction.Note:Although f1, f2, and f3 are optional arguments, at least one of them must be nonzero.

f2

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

f3

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

amplitude

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

Returns:

A ConnectorForce object.

Notes

This function can be accessed by:

mdb.models[name].ConnectorForce

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

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

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created.

region

The wire region to which the load is applied. This argument is not valid when fastenerName and fastenerSetName are specified.

fastenerName

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

fastenerSetName

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

m1

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

m2

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

m3

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

amplitude

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

Returns:

A ConnectorMoment object.

Notes

This function can be accessed by:

mdb.models[name].ConnectorMoment

ConnectorSection(name: str, assembledType: SymbolicConstantType = 'NONE', rotationalType: SymbolicConstantType = 'NONE', translationalType: SymbolicConstantType = 'NONE', integration: SymbolicConstantType = 'UNSPECIFIED', u1ReferenceLength: float | None = None, u2ReferenceLength: float | None = None, u3ReferenceLength: float | None = None, ur1ReferenceAngle: float | None = None, ur2ReferenceAngle: float | None = None, ur3ReferenceAngle: float | None = None, massPerLength: float | None = None, contactAngle: float | None = None, materialFlowFactor: float = 1, regularize: BooleanType = 1, defaultTolerance: BooleanType = 1, regularization: float = 0, extrapolation: SymbolicConstantType = 'CONSTANT', behaviorOptions: ConnectorBehaviorOptionArray | None = None) → ConnectorSection

This method creates a ConnectorSection object.

Parameters:

name

A String specifying the repository key.

assembledType

A SymbolicConstant specifying the assembled connection type. Possible values are:NONEBEAMBUSHINGCVJOINTCYLINDRICALHINGEPLANARRETRACTORSLIPRINGTRANSLATORUJOINTWELDThe default value is NONE.You cannot include the assembledType argument if translationalType or rotationalType are given a value other than NONE. At least one of the arguments assembledType, translationalType, or rotationalType must be given a value other than NONE.

rotationalType

A SymbolicConstant specifying the basic rotational connection type. Possible values are:NONEALIGNCARDANCONSTANT_VELOCITYEULERFLEXION_TORSIONFLOW_CONVERTERPROJECTION_FLEXION_TORSIONREVOLUTEROTATIONROTATION_ACCELEROMETERUNIVERSALThe default value is NONE.You cannot include the rotationalType argument if assembledType is given a value other than NONE. At least one of the arguments assembledType, translationalType, or rotationalType must be given an value other than NONE.

translationalType

A SymbolicConstant specifying the basic translational connection type. Possible values are:NONEACCELEROMETERAXIALCARTESIANJOINLINKPROJECTION_CARTESIANRADIAL_THRUSTSLIDE_PLANESLOTThe default value is NONE.You cannot include the translationalType argument if assembledType is given a value other than NONE. At least one of the arguments assembledType, translationalType, or rotationalType must be given an value other than NONE.

integration

A SymbolicConstant specifying the time integration scheme to use for analysis. This argument is applicable only to an Abaqus/Explicit analysis. Possible values are UNSPECIFIED, IMPLICIT, and EXPLICIT. The default value is UNSPECIFIED.

u1ReferenceLength

None or a Float specifying the reference length associated with constitutive response for the first component of relative motion. The default value is None.

u2ReferenceLength

None or a Float specifying the reference length associated with constitutive response for the second component of relative motion. The default value is None.

u3ReferenceLength

None or a Float specifying the reference length associated with constitutive response for the third component of relative motion. The default value is None.

ur1ReferenceAngle

None or a Float specifying the reference angle in degrees associated with constitutive response for the fourth component of relative motion. The default value is None.

ur2ReferenceAngle

None or a Float specifying the reference angle in degrees associated with constitutive response for the fifth component of relative motion. The default value is None.

ur3ReferenceAngle

None or a Float specifying the reference angle in degrees associated with constitutive response for the sixth component of relative motion. The default value is None.

massPerLength

None or a Float specifying the mass per unit reference length of belt material. This argument is applicable only when *assembledType*=SLIPRING, and must be specified in that case. The default value is None.

contactAngle

None or a Float specifying the contact angle made by the belt wrapping around node b. This argument is applicable only to an Abaqus/Explicit analysis, and only when *assembledType*=SLIPRING. The default value is None.

materialFlowFactor

A Float specifying the scaling factor for material flow at node b. This argument is applicable only when *assembledType*=RETRACTOR or *rotationalType*=FLOW_CONVERTER. The default value is 1.0.

regularize

A Boolean specifying whether or not all tabular data associated with the behaviorOptions will be regularized. This argument is applicable only for an Abaqus/Explicit analysis. The default value is ON.

defaultTolerance

A Boolean specifying whether or not the default regularization tolerance will be used for all tabular data associated with the behaviorOptions. This argument is applicable only for an Abaqus/Explicit analysis and only if *regularize*=ON. The default value is ON.

regularization

A Float specifying the regularization increment to be used for all tabular data associated with the behaviorOptions. This argument is applicable only for an Abaqus/Explicit analysis and only if *regularize*=ON and *defaultTolerance*=OFF. The default value is 0.03.

extrapolation

A SymbolicConstant specifying the extrapolation technique to be used for all tabular data associated with the behaviorOptions. Possible values are CONSTANT and LINEAR. The default value is CONSTANT.

behaviorOptions

A ConnectorBehaviorOptionArray object.

Returns:

A ConnectorSection object.

Raises:

InvalidNameError

RangeError

Notes

This function can be accessed by:

mdb.models[name].ConnectorSection
session.odbs[name].ConnectorSection

ConstrainedSketch(name: str, sheetSize: float, gridSpacing: float | None = None, transform: tuple = ()) → ConstrainedSketch

This method creates a ConstrainedSketch object. If the sketch cannot be created, the method returns None.

Parameters:

name

A String specifying the repository key.

sheetSize

A Float specifying the sheet size.

gridSpacing

A Float specifying the spacing between gridlines. Possible values are Floats >> 0. The default value is approximately 2 percent of sheetSize.

transform

A sequence of sequences of Floats specifying the three-dimensional orientation of the sketch. The sequence is a 3 × 4 transformation matrix specifying the axis of rotation and the translation vector. Possible values are any Floats.The default value for the axis of rotation is the identity matrix`(1.0, 0.0, 0.0), (0.0, 1.0, 0.0), (0.0, 0.0, 1.0)`The default value for the translation vector is`(0.0, 0.0, 0.0)`The default values position the sketch on the X–Y plane centered at the origin.

Returns:

sketch: ConstrainedSketch

A ConstrainedSketch object.

Notes

This function can be accessed by:

mdb.models[name].ConstrainedSketch

ContactExp(name: str, createStepName: str, useAllstar: ~abaqusConstants.BooleanType = 0, globalSmoothing: ~abaqusConstants.BooleanType = 1, includedPairs: ~abaqus.Interaction.RegionPairs.RegionPairs = <abaqus.Interaction.RegionPairs.RegionPairs object>, excludedPairs: ~abaqus.Interaction.RegionPairs.RegionPairs = <abaqus.Interaction.RegionPairs.RegionPairs object>, contactPropertyAssignments: ~abaqus.Interaction.ContactPropertyAssignment.ContactPropertyAssignment = <abaqus.Interaction.ContactPropertyAssignment.ContactPropertyAssignment object>, surfaceThicknessAssignments: ~abaqus.Interaction.SurfaceThicknessAssignment.SurfaceThicknessAssignment = <abaqus.Interaction.SurfaceThicknessAssignment.SurfaceThicknessAssignment object>, surfaceOffsetAssignments: ~abaqus.Interaction.SurfaceOffsetAssignment.SurfaceOffsetAssignment = <abaqus.Interaction.SurfaceOffsetAssignment.SurfaceOffsetAssignment object>, surfaceFeatureAssignments: ~abaqus.Interaction.SurfaceFeatureAssignment.SurfaceFeatureAssignment = <abaqus.Interaction.SurfaceFeatureAssignment.SurfaceFeatureAssignment object>, smoothingAssignments: ~abaqus.Interaction.SmoothingAssignment.SmoothingAssignment = <abaqus.Interaction.SmoothingAssignment.SmoothingAssignment object>, surfaceCrushTriggerAssignments: ~abaqus.Interaction.SurfaceCrushTriggerAssignment.SurfaceCrushTriggerAssignment = <abaqus.Interaction.SurfaceCrushTriggerAssignment.SurfaceCrushTriggerAssignment object>, surfaceFrictionAssignments: ~abaqus.Interaction.SurfaceFrictionAssignment.SurfaceFrictionAssignment = <abaqus.Interaction.SurfaceFrictionAssignment.SurfaceFrictionAssignment object>, mainSecondaryAssignments: ~abaqus.Interaction.MainSecondaryAssignment.MainSecondaryAssignment = <abaqus.Interaction.MainSecondaryAssignment.MainSecondaryAssignment object>, polarityAssignments: ~abaqus.Interaction.PolarityAssignments.PolarityAssignments = <abaqus.Interaction.PolarityAssignments.PolarityAssignments object>) → ContactExp

This method creates a ContactExp object.

Parameters:

name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which this contact interaction is created.

useAllstar

A Boolean specifying whether the contacting surface pair consists of all exterior faces, shell edges, beam segments, analytical rigid surfaces, and, when applicable, Eulerian material surfaces.

globalSmoothing

A Boolean specifying whether surface smoothing (geometric correction) is automatically applied to all eligible surfaces. The default value is ON.

includedPairs

A RegionPairs object specifying the domain pairs included in contact.

excludedPairs

A RegionPairs object specifying the domain pairs excluded from contact.

contactPropertyAssignments

A ContactPropertyAssignment object specifying the contact property assignments in the contact domain.

surfaceThicknessAssignments

A SurfaceThicknessAssignment object specifying the surface thickness assignments in the contact domain.

surfaceOffsetAssignments

A SurfaceOffsetAssignment object specifying the surface offset fraction assignments in the contact domain.

surfaceFeatureAssignments

A SurfaceFeatureAssignment object specifying the surface feature angle assignments in the contact domain.

smoothingAssignments

A SmoothingAssignment object specifying the surface smoothing assignments in the contact domain.

surfaceCrushTriggerAssignments

A SurfaceCrushTriggerAssignment object specifying the surface crush trigger assignments in the contact domain.

surfaceFrictionAssignments

A SurfaceFrictionAssignment object specifying the surface friction assignments in the contact domain.

masterSlaveAssignments

A MasterSlaveAssignment object specifying the master-slave assignments in the contact domain.

polarityAssignments

A PolarityAssignments object specifying the polarity assignments in the contact domain.

Returns:

A ContactExp object.

Notes

This function can be accessed by:

mdb.models[name].ContactExp

ContactProperty(name: str) → ContactProperty

This method creates a ContactProperty object.

Parameters:

name

A String specifying the interaction property repository key.

Returns:

A ContactProperty object.

Notes

This function can be accessed by:

mdb.models[name].ContactProperty

ContactStd(name: str, createStepName: str, useAllstar: ~abaqusConstants.BooleanType = 0, globalSmoothing: ~abaqusConstants.BooleanType = 1, includedPairs: ~abaqus.Interaction.RegionPairs.RegionPairs = <abaqus.Interaction.RegionPairs.RegionPairs object>, excludedPairs: ~abaqus.Interaction.RegionPairs.RegionPairs = <abaqus.Interaction.RegionPairs.RegionPairs object>, contactPropertyAssignments: ~abaqus.Interaction.ContactPropertyAssignment.ContactPropertyAssignment = <abaqus.Interaction.ContactPropertyAssignment.ContactPropertyAssignment object>, surfaceThicknessAssignments: ~abaqus.Interaction.SurfaceThicknessAssignment.SurfaceThicknessAssignment = <abaqus.Interaction.SurfaceThicknessAssignment.SurfaceThicknessAssignment object>, surfaceOffsetAssignments: ~abaqus.Interaction.SurfaceOffsetAssignment.SurfaceOffsetAssignment = <abaqus.Interaction.SurfaceOffsetAssignment.SurfaceOffsetAssignment object>, surfaceFeatureAssignments: ~abaqus.Interaction.SurfaceFeatureAssignment.SurfaceFeatureAssignment = <abaqus.Interaction.SurfaceFeatureAssignment.SurfaceFeatureAssignment object>, surfaceBeamSmoothingAssignments: ~abaqus.Interaction.SurfaceBeamSmoothingAssignment.SurfaceBeamSmoothingAssignment = <abaqus.Interaction.SurfaceBeamSmoothingAssignment.SurfaceBeamSmoothingAssignment object>, surfaceVertexCriteriaAssignments: ~abaqus.Interaction.SurfaceVertexCriteriaAssignment.SurfaceVertexCriteriaAssignment = <abaqus.Interaction.SurfaceVertexCriteriaAssignment.SurfaceVertexCriteriaAssignment object>, mainSecondaryAssignments: ~abaqus.Interaction.MainSecondaryAssignment.MainSecondaryAssignment = <abaqus.Interaction.MainSecondaryAssignment.MainSecondaryAssignment object>, initializationAssignments: ~abaqus.Interaction.InitializationAssignment.InitializationAssignment = <abaqus.Interaction.InitializationAssignment.InitializationAssignment object>, stabilizationAssignments: ~abaqus.Interaction.StabilizationAssignment.StabilizationAssignment = <abaqus.Interaction.StabilizationAssignment.StabilizationAssignment object>, smoothingAssignments: ~abaqus.Interaction.SmoothingAssignment.SmoothingAssignment = <abaqus.Interaction.SmoothingAssignment.SmoothingAssignment object>, slidingTransitionAssignments: ~abaqus.Interaction.SlidingTransitionAssignment.SlidingTransitionAssignment = <abaqus.Interaction.SlidingTransitionAssignment.SlidingTransitionAssignment object>, slidingFormulationAssignments: ~abaqus.Interaction.SlidingFormulationAssignment.SlidingFormulationAssignment = <abaqus.Interaction.SlidingFormulationAssignment.SlidingFormulationAssignment object>) → ContactStd

This method creates a ContactStd object.

Parameters:

name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which this contact interaction is created.

useAllstar

A Boolean specifying whether the contacting surface pairs consist of all exterior faces in the model.

globalSmoothing

A Boolean specifying whether surface smoothing (geometric correction) is automatically applied to all eligible surfaces. The default value is ON.

includedPairs

A RegionPairs object specifying the domain pairs included in contact.

excludedPairs

A RegionPairs object specifying the domain pairs excluded from contact.

contactPropertyAssignments

A ContactPropertyAssignment object specifying the contact property assignments in the contact domain.

surfaceThicknessAssignments

A SurfaceThicknessAssignment object specifying the surface thickness assignments in the contact domain.

surfaceOffsetAssignments

A SurfaceOffsetAssignment object specifying the surface offset fraction assignments in the contact domain.

surfaceFeatureAssignments

A SurfaceFeatureAssignment object specifying the surface feature angle assignments in the contact domain.

surfaceBeamSmoothingAssignments

A SurfaceBeamSmoothingAssignment object specifying the surface beam smoothing assignments in the contact domain.

surfaceVertexCriteriaAssignments

A SurfaceVertexCriteriaAssignment object specifying the surface vertex criteria assignments in the contact domain.

masterSlaveAssignments

A MasterSlaveAssignment object specifying the master-slave assignments in the contact domain.

initializationAssignments

An InitializationAssignment object specifying the contact initialization assignments in the contact domain.

stabilizationAssignments

A StabilizationAssignment object specifying the contact stabilization assignments in the contact domain.

smoothingAssignments

A SmoothingAssignment object specifying the surface smoothing assignments in the contact domain.

slidingTransitionAssignments

A SlidingTransitionAssignments object specifying the sliding transition assignments in the contact domain.

slidingFormulationAssignments

A SlidingFormulationAssignment object specifying the sliding formulation assignments in the contact domain.

Returns:

A ContactStd object.

Notes

This function can be accessed by:

mdb.models[name].ContactStd

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

This method creates a CoriolisForce object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created. This must be the first analysis step name.

region

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

magnitude

A Float specifying the load magnitude.

point1

A sequence of Floats specifying the first point on the axis of rotation for the load.

point2

A sequence of Floats specifying the second point on the axis of rotation for the load.

amplitude

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

distributionType

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

field

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

Returns:

A CoriolisForce object.

Notes

This function can be accessed by:

mdb.models[name].CoriolisForce

CoupledTempDisplacementStep(name: str, previous: str, description: str = '', response: SymbolicConstantType = 'TRANSIENT', timePeriod: float = 1, nlgeom: BooleanType = 0, stabilizationMethod: SymbolicConstantType = 'NONE', stabilizationMagnitude: float | None = None, timeIncrementationMethod: SymbolicConstantType = 'AUTOMATIC', maxNumInc: int = 100, initialInc: float | None = None, minInc: float | None = None, maxInc: float | None = None, deltmx: float = 0, cetol: float = 0, creepIntegration: SymbolicConstantType = 'IMPLICIT', solutionTechnique: SymbolicConstantType = 'FULL_NEWTON', matrixStorage: SymbolicConstantType = 'SOLVER_DEFAULT', amplitude: SymbolicConstantType = 'STEP', extrapolation: SymbolicConstantType = 'LINEAR', maintainAttributes: BooleanType = False, convertSDI: SymbolicConstantType = 'PROPAGATED', adaptiveDampingRatio: float = 0, continueDampingFactors: BooleanType = 0) → CoupledTempDisplacementStep

This method creates a CoupledTempDisplacementStep object.

Parameters:

name

A String specifying the repository key.

previous

A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

description

A String specifying a description of the new step. The default value is an empty string.

response

A SymbolicConstant specifying the analysis type. Possible values are STEADY_STATE and TRANSIENT. The default value is TRANSIENT.

timePeriod

A Float specifying the total time period for the step. The default value is 1.0.

nlgeom

A Boolean specifying whether geometric nonlinearities should be accounted for during the step. The default value is OFF.

stabilizationMethod

A SymbolicConstant specifying the stabilization type. Possible values are NONE, DISSIPATED_ENERGY_FRACTION, and DAMPING_FACTOR. The default value is NONE.

stabilizationMagnitude

A Float specifying the damping intensity of the automatic damping algorithm if the problem is expected to be unstable and *stabilizationMethod*≠NONE. The default value is 2×10–4.

timeIncrementationMethod

A SymbolicConstant specifying the time incrementation method to be used. Possible values are FIXED and AUTOMATIC. The default value is AUTOMATIC.

maxNumInc

An Int specifying the maximum number of increments in a step. The default value is 100.

initialInc

A Float specifying the initial time increment. The default value is the total time period for the step.

minInc

A Float specifying the minimum time increment allowed. The default value is the smaller of the suggested initial time increment or 10−5 times the total time period.

maxInc

A Float specifying the maximum time increment allowed. The default value is the total time period for the step.

deltmx

A Float specifying the maximum temperature change to be allowed in an increment in a transient analysis. The default value is 0.0.

cetol

A Float specifying the maximum difference in the creep strain increment calculated from the creep strain rates at the beginning and end of the increment. The default value is 0.0.

creepIntegration

A SymbolicConstant specifying the type of integration to be used for creep and swelling effects throughout the step. Possible values are IMPLICIT, EXPLICIT, and NONE. The default value is IMPLICIT.

solutionTechnique

A SymbolicConstant specifying the type of solution technique. Possible values are FULL_NEWTON and SEPARATED. The default value is FULL_NEWTON.

matrixStorage

A SymbolicConstant specifying the type of matrix storage. Possible values are SYMMETRIC, UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT.

amplitude

A SymbolicConstant specifying the amplitude variation for loading magnitudes during the step. The default value is STEP. Possible values are STEP and RAMP.

extrapolation

A SymbolicConstant specifying the type of extrapolation to use in determining the incremental solution for a nonlinear analysis. Possible values are NONE, LINEAR, and PARABOLIC. The default value is LINEAR.

maintainAttributes

A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is False.

convertSDI

A SymbolicConstant specifying whether to force a new iteration if severe discontinuities occur during an iteration. Possible values are PROPAGATED, CONVERT_SDI_OFF, and CONVERT_SDI_ON. The default value is PROPAGATED.

adaptiveDampingRatio

A Float specifying the maximum allowable ratio of the stabilization energy to the total strain energy and can be used only if stabilizationMethod is not NONE. The default value is 0.05.

continueDampingFactors

A Boolean specifying whether this step will carry over the damping factors from the results of the preceding general step. This parameter must be used in conjunction with the adaptiveDampingRatio parameter. The default value is OFF.

Returns:

step: CoupledTempDisplacementStep

A CoupledTempDisplacementStep object.

Notes

This function can be accessed by:

mdb.models[name].CoupledTempDisplacementStep

CoupledThermalElectricStep(name: str, previous: str, description: str = '', response: SymbolicConstantType = 'TRANSIENT', timePeriod: float = 1, timeIncrementationMethod: SymbolicConstantType = 'AUTOMATIC', maxNumInc: int = 100, initialInc: float | None = None, minInc: float | None = None, maxInc: float | None = None, end: SymbolicConstantType = 'PERIOD', deltmx: float = 0, mxdem: float = 0, solutionTechnique: SymbolicConstantType = 'FULL_NEWTON', matrixStorage: SymbolicConstantType = 'SOLVER_DEFAULT', amplitude: SymbolicConstantType = 'STEP', extrapolation: SymbolicConstantType = 'LINEAR', maintainAttributes: BooleanType = False, convertSDI: SymbolicConstantType = 'PROPAGATED') → CoupledThermalElectricStep

This method creates a CoupledThermalElectricStep object.

Parameters:

name

A String specifying the repository key.

previous

A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

description

A String specifying a description of the new step. The default value is an empty string.

response

A SymbolicConstant specifying the analysis type. Possible values are STEADY_STATE and TRANSIENT. The default value is TRANSIENT.

timePeriod

A Float specifying the total time period for the step. The default value is 1.0.

timeIncrementationMethod

A SymbolicConstant specifying the time incrementation method to be used. Possible values are FIXED and AUTOMATIC. The default value is AUTOMATIC.

maxNumInc

An Int specifying the maximum number of increments in a step. The default value is 100.

initialInc

A Float specifying the initial time increment. The default value is the total time period for the step.

minInc

A Float specifying the minimum time increment allowed. The default value is the smaller of the suggested initial time increment or 10−5 times the total time period.

maxInc

A Float specifying the maximum time increment allowed. The default value is the total time period for the step.

end

A SymbolicConstant specifying the time period to be analyzed in a transient analysis. Possible values are PERIOD and SS. The default value is PERIOD.

deltmx

A Float specifying the maximum temperature change to be allowed in an increment in a transient analysis. The default value is 0.0.

mxdem

A Float specifying the maximum allowable emissivity change with temperature and field variables during an increment. The default value is 0.1.

solutionTechnique

A SymbolicConstant specifying the type of solution technique. Possible values are FULL_NEWTON and SEPARATED. The default value is FULL_NEWTON.

matrixStorage

A SymbolicConstant specifying the type of matrix storage. Possible values are SYMMETRIC, UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT.

amplitude

A SymbolicConstant specifying the amplitude variation for loading magnitudes during the step. The default value is STEP. Possible values are STEP and RAMP.

extrapolation

A SymbolicConstant specifying the type of extrapolation to use in determining the incremental solution for a nonlinear analysis. Possible values are NONE, LINEAR, and PARABOLIC. The default value is LINEAR.

maintainAttributes

A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is False.

convertSDI

A SymbolicConstant specifying whether to force a new iteration if severe discontinuities occur during an iteration. Possible values are PROPAGATED, CONVERT_SDI_OFF, and CONVERT_SDI_ON. The default value is PROPAGATED.

Returns:

step: CoupledThermalElectricStep

A CoupledThermalElectricStep object.

Notes

This function can be accessed by:

mdb.models[name].CoupledThermalElectricStep

CoupledThermalElectricalStructuralStep(name: str, previous: str, description: str = '', response: SymbolicConstantType = 'TRANSIENT', timePeriod: float = 1, nlgeom: BooleanType = 0, stabilizationMethod: SymbolicConstantType = 'NONE', stabilizationMagnitude: float | None = None, timeIncrementationMethod: SymbolicConstantType = 'AUTOMATIC', maxNumInc: int = 100, initialInc: float | None = None, minInc: float | None = None, maxInc: float | None = None, deltmx: float = 0, cetol: float = 0, creepIntegration: SymbolicConstantType = 'IMPLICIT', matrixStorage: SymbolicConstantType = 'SOLVER_DEFAULT', amplitude: SymbolicConstantType = 'STEP', extrapolation: SymbolicConstantType = 'LINEAR', maintainAttributes: BooleanType = False, convertSDI: SymbolicConstantType = 'PROPAGATED', adaptiveDampingRatio: float = 0, continueDampingFactors: BooleanType = 0) → CoupledThermalElectricalStructuralStep

This method creates a CoupledThermalElectricalStructuralStep object.

Parameters:

name

A String specifying the repository key.

previous

A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

description

A String specifying a description of the new step. The default value is an empty string.

response

A SymbolicConstant specifying the analysis type. Possible values are STEADY_STATE and TRANSIENT. The default value is TRANSIENT.

timePeriod

A Float specifying the total time period for the step. The default value is 1.0.

nlgeom

A Boolean specifying whether geometric nonlinearities should be accounted for during the step. The default value is OFF.

stabilizationMethod

A SymbolicConstant specifying the stabilization type. Possible values are NONE, DISSIPATED_ENERGY_FRACTION, and DAMPING_FACTOR. The default value is NONE.

stabilizationMagnitude

A Float specifying the damping intensity of the automatic damping algorithm if the problem is expected to be unstable and *stabilizationMethod*≠NONE. The default value is 2×10–4.

timeIncrementationMethod

A SymbolicConstant specifying the time incrementation method to be used. Possible values are FIXED and AUTOMATIC. The default value is AUTOMATIC.

maxNumInc

An Int specifying the maximum number of increments in a step. The default value is 100.

initialInc

A Float specifying the initial time increment. The default value is the total time period for the step.

minInc

A Float specifying the minimum time increment allowed. The default value is the smaller of the suggested initial time increment or 10−5 times the total time period.

maxInc

A Float specifying the maximum time increment allowed. The default value is the total time period for the step.

deltmx

A Float specifying the maximum temperature change to be allowed in an increment in a transient analysis. The default value is 0.0.

cetol

A Float specifying the maximum difference in the creep strain increment calculated from the creep strain rates at the beginning and end of the increment. The default value is 0.0.

creepIntegration

A SymbolicConstant specifying the type of integration to be used for creep and swelling effects throughout the step. Possible values are IMPLICIT, EXPLICIT, and NONE. The default value is IMPLICIT.

matrixStorage

A SymbolicConstant specifying the type of matrix storage. Possible values are SYMMETRIC, UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT.

amplitude

A SymbolicConstant specifying the amplitude variation for loading magnitudes during the step. The default value is STEP. Possible values are STEP and RAMP.

extrapolation

A SymbolicConstant specifying the type of extrapolation to use in determining the incremental solution for a nonlinear analysis. Possible values are NONE, LINEAR, and PARABOLIC. The default value is LINEAR.

maintainAttributes

A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is False.

convertSDI

A SymbolicConstant specifying whether to force a new iteration if severe discontinuities occur during an iteration. Possible values are PROPAGATED, CONVERT_SDI_OFF, and CONVERT_SDI_ON. The default value is PROPAGATED.

adaptiveDampingRatio

A Float specifying the maximum allowable ratio of the stabilization energy to the total strain energy and can be used only if stabilizationMethod is not NONE. The default value is 0.05.

continueDampingFactors

A Boolean specifying whether this step will carry over the damping factors from the results of the preceding general step. This parameter must be used in conjunction with the adaptiveDampingRatio parameter. The default value is OFF.

Returns:

step: CoupledThermalElectricalStructuralStep

A CoupledThermalElectricalStructuralStep object.

Notes

This function can be accessed by:

mdb.models[name].CoupledThermalElectricalStructuralStep

Coupling(name: str, surface: Region, controlPoint: Region, influenceRadius: SymbolicConstantType | float, couplingType: SymbolicConstantType, adjust: BooleanType = 0, localCsys: str | None = None, u1: BooleanType = 1, u2: BooleanType = 1, u3: BooleanType = 1, ur1: BooleanType = 1, ur2: BooleanType = 1, ur3: BooleanType = 1, weightingMethod: SymbolicConstantType = 'UNIFORM') → Coupling

This method creates a Coupling object.

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.

adjust

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

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

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

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

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

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

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

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.

Returns:

A Coupling object.

Notes

This function can be accessed by:

mdb.models[name].Coupling

CyclicSymmetry(name: str, createStepName: str, main: Region, secondary: Region, repetitiveSectors: int, axisPoint1: Region, axisPoint2: Region, extractedNodalDiameter: SymbolicConstantType = 'ALL_NODAL_DIAMETER', lowestNodalDiameter: int = 0, highestNodalDiameter: int = 0, excitationNodalDiameter: int = 0, adjustTie: BooleanType = 1, positionTolerance: float = 0, positionToleranceMethod: SymbolicConstantType = 'COMPUTED_TOLERANCE') → CyclicSymmetry

This method creates a CyclicSymmetry object.

Parameters:

name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which the cyclic symmetry interaction should be created.

master

A Region object specifying the master surface.

slave

A Region object specifying the slave surface.

repetitiveSectors

An Int specifying the total number of sectors in the cyclic symmetric model.

axisPoint1

A Region object specifying the first point of the axis of symmetry. The region should contain exactly one mesh node, vertex, interesting point, reference point, or datum point. In a two-dimensional model axisPoint1 is the only point used to define the axis of symmetry.

axisPoint2

A Region object specifying the second point of the axis of symmetry. The region should contain exactly one mesh node, vertex, interesting point, reference point, or datum point. This point is ignored in a two-dimensional model.

extractedNodalDiameter

A SymbolicConstant specifying whether Abaqus should extract all possible nodal diameters or the nodal diameters between the user-specified values for lowestNodalDiameter and highestNodalDiameter. Possible values are ALL_NODAL_DIAMETER and SPECIFIED_NODAL_DIAMETER. The default value is ALL_NODAL_DIAMETER.

lowestNodalDiameter

An Int specifying the lowest nodal diameter to be used in the eigenfrequency analysis. The default value is 0.

highestNodalDiameter

An Int specifying the highest nodal diameter to be used in the eigenfrequency analysis. This argument value should be less than or equal to the half of the total number of sectors (as specified in the repetitiveSectors parameter). The default value is 0.

excitationNodalDiameter

An Int specifying the nodal diameter for which the modal-based steady-state dynamic analysis will be performed. This value should be greater than or equal to the lowest nodal diameter (specified in the lowestNodalDiameter parameter), and less than or equal to the highest nodal diameter (specified in the highestNodalDiameter parameter). The default value is 0.

adjustTie

A Boolean specifying whether or not to adjust the slave surface of the cyclic symmetry to tie it to the master surface. The default value is ON.

positionTolerance

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

positionToleranceMethod

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

Returns:

A CyclicSymmetry object.

Notes

This function can be accessed by:

mdb.models[name].CyclicSymmetry

DecayAmplitude(name: str, initial: float, maximum: float, start: float, decayTime: float, timeSpan: SymbolicConstantType = 'STEP') → DecayAmplitude

This method creates a DecayAmplitude object.

Parameters:

name

A String specifying the repository key.

initial

A Float specifying the constant A0A0.

maximum

A Float specifying the coefficient AA.

start

A Float specifying the starting time t0t0. Possible values are non-negative numbers.

decayTime

A Float specifying the decay time tdtd. Possible values are non-negative numbers.

timeSpan

A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:

A DecayAmplitude object.

Raises:

InvalidNameError

RangeError

Notes

This function can be accessed by:

mdb.models[name].DecayAmplitude
session.odbs[name].DecayAmplitude

DirectCyclicStep(name: str, previous: str, description: str = '', timePeriod: float = 1, timeIncrementationMethod: SymbolicConstantType = 'AUTOMATIC', maxNumInc: int = 100, initialInc: float | None = None, minInc: float | None = None, maxInc: float | None = None, maxNumIterations: int = 200, initialTerms: int = 11, maxTerms: int = 25, termsIncrement: int = 5, deltmx: float = 0, cetol: float = 0, timePoints: str = 'NONE', fatigue: BooleanType = 0, continueAnalysis: BooleanType = 0, minCycleInc: int = 100, maxCycleInc: int = 1000, maxNumCycles: SymbolicConstantType = 'DEFAULT', damageExtrapolationTolerance: float = 1, matrixStorage: SymbolicConstantType = 'SOLVER_DEFAULT', extrapolation: SymbolicConstantType = 'LINEAR', maintainAttributes: BooleanType = False, convertSDI: SymbolicConstantType = 'PROPAGATED') → DirectCyclicStep

This method creates a DirectCyclicStep object.

Parameters:

name

A String specifying the repository key.

previous

A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

description

A String specifying a description of the new step. The default value is an empty string.

timePeriod

A Float specifying the time of single loading cycle. The default value is 1.0.

timeIncrementationMethod

A SymbolicConstant specifying the time incrementation method to be used. Possible values are FIXED and AUTOMATIC. The default value is AUTOMATIC.

maxNumInc

An Int specifying the maximum number of increments in a step. The default value is 100.

initialInc

A Float specifying the initial time increment. The default value is the total time period for the step.

minInc

A Float specifying the minimum time increment allowed. The default value is the smaller of the suggested initial time increment or 10−5 times the total time period.

maxInc

A Float specifying the maximum time increment allowed. The default value is the total time period for the step.

maxNumIterations

An Int specifying the maximum number of iterations in a step. The default value is 200.

initialTerms

An Int specifying the initial number of terms in the Fourier series. The default value is 11.

maxTerms

An Int specifying the maximum number of terms in the Fourier series. The default value is 25.

termsIncrement

An Int specifying the increment in number of terms in the Fourier series. The default value is 5.

deltmx

A Float specifying the maximum temperature change to be allowed in an increment. The default value is 0.0.

cetol

A Float specifying the maximum difference in the creep strain increment calculated from the creep strain rates at the beginning and end of the increment. The default value is 0.0.

timePoints

None or a String specifying a String specifying the name of a time point object used to determine at which times the response of the structure will be evaluated. The default value is NONE.

fatigue

A Boolean specifying whether to include low-cycle fatigue analysis. The default value is OFF.

continueAnalysis

A Boolean specifying whether the displacement solution in the Fourier series obtained in the previous direct cyclic step is used as the starting values for the current step. The default value is OFF.

minCycleInc

An Int specifying the minimum number of cycles over which the damage is extrapolated forward. The default value is 100.

maxCycleInc

An Int specifying the maximum number of cycles over which the damage is extrapolated forward. The default value is 1000.

maxNumCycles

The SymbolicConstant DEFAULT or an Int specifying the maximum number of cycles allowed in a step or DEFAULT. A value of 1 plus half of the maximum number of cycles will be used if DEFAULT is specified. The default value is DEFAULT.

damageExtrapolationTolerance

A Float specifying the maximum extrapolated damage increment. The default value is 1.0.

matrixStorage

A SymbolicConstant specifying the type of matrix storage. Possible values are SYMMETRIC, UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT.

extrapolation

A SymbolicConstant specifying the type of extrapolation to use in determining the incremental solution for a nonlinear analysis. Possible values are NONE, LINEAR, and PARABOLIC. The default value is LINEAR.

maintainAttributes

A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is False.

convertSDI

A SymbolicConstant specifying whether to force a new iteration if severe discontinuities occur during an iteration. Possible values are PROPAGATED, CONVERT_SDI_OFF, and CONVERT_SDI_ON. The default value is PROPAGATED.

Returns:

step: DirectCyclicStep

A DirectCyclicStep object.

Notes

This function can be accessed by:

mdb.models[name].DirectCyclicStep

DisplacementAdaptiveMeshConstraint(name: str, createStepName: str, region: Region, u1: SymbolicConstantType | float = 'UNSET', u2: SymbolicConstantType | float = 'UNSET', u3: SymbolicConstantType | float = 'UNSET', ur1: SymbolicConstantType | float = 'UNSET', ur2: SymbolicConstantType | float = 'UNSET', ur3: SymbolicConstantType | float = 'UNSET', amplitude: str = 'UNSET', motionType: SymbolicConstantType = 'INDEPENDENT', localCsys: str | None = None) → DisplacementAdaptiveMeshConstraint

This method creates a DisplacementAdaptiveMeshConstraint object.

Parameters:

name

A String specifying the adaptive mesh constraint repository key.

createStepName

A String specifying the name of the step in which the adaptive mesh constraint is created.

region

A Region object specifying the region to which the adaptive mesh constraint is applied.

u1

A Float 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 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 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 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 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 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.

amplitude

A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the adaptive mesh constraint has no amplitude reference. The default value is UNSET. You should provide the amplitude argument only if it is valid for the specified step.

motionType

A SymbolicConstant specifying the mesh motion in relation to the underlying material. Possible values are INDEPENDENT, FOLLOW and USER_DEFINED. The default value is INDEPENDENT.

localCsys

None or a DatumCsys object specifying the local coordinate system of the adaptive mesh constraint’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 DisplacementAdaptiveMeshConstraint object

Notes

This function can be accessed by:

mdb.models[name].AdaptiveMeshConstraint

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

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

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

DisplayBody(name: str, instance: PartInstance, controlPoints: ModelDotArray) → DisplayBody

This method creates a DisplayBody object.

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.

Notes

This function can be accessed by:

mdb.models[name].DisplayBody

ElasticFoundation(name: str, createStepName: str, surface: Region, stiffness: float) → ElasticFoundation

This method creates an ElasticFoundation object.

Parameters:

name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which the ElasticFoundation object is created. createStepName must be set to ‘Initial’.

surface

A Region object specifying the surface to which the foundation applies.

stiffness

A Float specifying the foundation stiffness per area (or per length for beams).

Returns:

An ElasticFoundation object.

Notes

This function can be accessed by:

mdb.models[name].ElasticFoundation

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

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

EmagTimeHarmonicStep(name: str, previous: str, frequencyRange: EmagTimeHarmonicFrequencyArray, description: str = '', factorization: SymbolicConstantType = 'COMPLEX') → EmagTimeHarmonicStep

This method creates a EmagTimeHarmonicStep object.

Parameters:

name

A String specifying the repository key.

previous

A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

frequencyRange

An EmagTimeHarmonicFrequencyArray object.

description

A String specifying a description of the new step. The default value is an empty string.

factorization

A SymbolicConstant specifying whether damping terms are to be ignored so that a real, rather than a complex, system matrix is factored. Possible values are REAL_ONLY and COMPLEX. The default value is COMPLEX.

Returns:

step: EmagTimeHarmonicStep

An EmagTimeHarmonicStep object.

Notes

This function can be accessed by:

mdb.models[name].EmagTimeHarmonicStep

EmbeddedRegion(name: str, embeddedRegion: Region, hostRegion: Region, weightFactorTolerance: float | None = None, toleranceMethod: SymbolicConstantType | None = None, absoluteTolerance: float = 0, fractionalTolerance: float = 0) → EmbeddedRegion

This method creates a EmbeddedRegion object.

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

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

toleranceMethod

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

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

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.

Notes

This function can be accessed by:

mdb.models[name].EmbeddedRegion

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

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

EquallySpacedAmplitude(name: str, fixedInterval: float, data: tuple, begin: float = 0, smooth: SymbolicConstantType | float = 'SOLVER_DEFAULT', timeSpan: SymbolicConstantType = 'STEP') → EquallySpacedAmplitude

This method creates an EquallySpacedAmplitude object.

Parameters:

name

A String specifying the repository key.

fixedInterval

A Float specifying the fixed time interval at which the amplitude data are given. Possible values are positive numbers.

data

A sequence of Floats specifying the amplitude values.

begin

A Float specifying the time at which the first amplitude data are given. Possible values are non-negative numbers. The default value is 0.0.

smooth

The SymbolicConstant SOLVER_DEFAULT or a Float specifying the degree of smoothing. Possible float values are 0 ≤≤ smoothing ≤≤ 0.5. If *smooth*=SOLVER_DEFAULT, the default degree of smoothing will be determined by the solver. The default value is SOLVER_DEFAULT.

timeSpan

A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:

An EquallySpacedAmplitude object.

Raises:

InvalidNameError

RangeError

Notes

This function can be accessed by:

mdb.models[name].EquallySpacedAmplitude
session.odbs[name].EquallySpacedAmplitude

Equation(name: str, terms: tuple) → Equation

This method creates an Equation object.

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.

Raises:

• If terms does not contain more than one entry:

  Equation must have two or more terms.

Notes

This function can be accessed by:

mdb.models[name].Equation

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

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

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

EulerianSection(name: str, data: str) → EulerianSection

This method creates a EulerianSection object.

Parameters:

name

A String specifying the repository key.

data

A String-to-String Dictionary specifying a dictionary mapping Material instance names to Material names. Internally the specified mapping gets sorted on Material instance name.

Returns:

An EulerianSection object.

Notes

This function can be accessed by:

mdb.models[name].EulerianSection
session.odbs[name].EulerianSection

EventSeries(name: str, createStepName: str, eventSeriesType: str, transformType: str = 'NONE', timeSpan: str = 'STEP_TIME', transformations: str = '', fileName: str = '', data: str = '') → EventSeries

This method creates an EventSeries object.

Parameters:

name

A String specifying the repository key.

createStepName

A string specifying the step name.

eventSeriesType

A string specifying the type of event series.

transformType

A Symbolic constant specifying the type of transformation. Possible values are NONE, BOTH, TRANSLATE, and ROTATE. The default value is NONE.

timeSpan

A Symbolic constant specifying time. Possible values are TOTAL_TIME and STEP_TIME. The default value is STEP_TIME.

transformations

An Array specifying the required transformations over event series data.

fileName

A String specifying the filename.

data

An Array of double specifying the values of fields provided in EventSeriesType.

Returns:

An EventSeries object.

Raises:

RangeError.

Notes

This function can be accessed by:

mdb.models[name].EventSeriesData

EventSeriesType(name: str, createStepName: str, fields: str = '') → EventSeriesType

This method creates an EventSeriesType object.

Parameters:

name

A String specifying the repository key.

createStepName

A string specifying the step name.

fields

A String array specifying fields. The default value is an empty array.

Returns:

A EventSeriesType object.

Raises:

RangeError.

Notes

This function can be accessed by:

mdb.models[name].EventSeriesType

ExpContactControl(name: str, globTrkChoice: SymbolicConstantType = 'DEFAULT', globTrkInc: int | None = None, fastLocalTrk: BooleanType = 1, scalePenalty: float = 1, warpCheckPeriod: int = 20, warpCutoff: float = 20) → ExpContactControl

This method creates an ExpContactControl object.

Parameters:

name

A String specifying the contact controls repository key.

globTrkChoice

A SymbolicConstant specifying whether or not the default value will be used for the maximum number of increments between global contact searches. Possible values are DEFAULT and SPECIFY. The default value is DEFAULT.

globTrkInc

An Int specifying the maximum number of increments between global contact searches. The globTrkInc argument applies only when *globTrkChoice*=SPECIFY. The default value is 100 for surface-to-surface contact and 4 for self-contact.

fastLocalTrk

A Boolean specifying whether to use the more computationally efficient local tracking method. The default value is ON.

scalePenalty

A Float specifying the factor by which Abaqus/Explicit will scale the default penalty stiffness to obtain the stiffnesses used for the penalty contact pairs. The default value is 1.0.

warpCheckPeriod

An Int specifying the number of increments between checks for highly warped facets on msater surfaces. The default value is 20.

warpCutoff

A Float specifying the out-of-plane warping angle (in degrees), at which a facet will be considered to be highly warped. The default value is 20.0.

Returns:

An ExpContactControl object.

Raises:

RangeError.

Notes

This function can be accessed by:

mdb.models[name].ExpContactControl

ExpInitialization(name: str, overclosureType: SymbolicConstantType = 'ADJUST', interferenceDistance: float | None = None, clearanceDistance: float | None = None, openingTolerance: float | None = None, overclosureTolerance: float | None = None, adjustNodalCoords: BooleanType = True, secondaryNodesetName: str | None = None, stepFraction: float = 1) → ExpInitialization

This method creates an ExpInitialization object.

Parameters:

name

A String specifying the contact initialization repository key.

overclosureType

A SymbolicConstant specifying the type of overclosure to be defined. Possible values are ADJUST, INTERFERENCE, and CLEARANCE. The default value is ADJUST.

interferenceDistance

None or a Float specifying the interference distance. This argument is valid only when *overclosureType*=INTERFERENCE. The default value is None.

clearanceDistance

None or a Float specifying the initial clearance distance. This argument is valid only when *overclosureType*=CLEARANCE and must be specified in that case. The default value is None.

openingTolerance

None or a Float specifying the distance tolerance within which initial openings will undergo strain-free adjustments. This argument is not valid when overclosureType*=INTERFERENCE unless a value has been specified for *interferenceDistance. The default value is None.

overclosureTolerance

None or a Float specifying the distance tolerance within which initial overclosures will undergo strain-free adjustments. The default value is None.

adjustNodalCoords

A Boolean specifying whether to resolve clearances/overclosures by adjusting the nodal coordinates without creating strain in the model. *adjustNodalCoords*=True can be used only for clearances/overclosures defined in the first step of an analysis. The default value is True.

slaveNodesetName

A String specifying the name of the node set containing the slave nodes to be included in the initial clearance specification. This argument is not valid when overclosureType*=INTERFERENCE and if *openingTolerance or overclosureTolerance is specified. The default value is None.

stepFraction

A Float specifying the fraction of the step time (between 0.0 and 1.0) in which the interference fit has to be solved. The default value is 1.0. This argument is valid only when *overclosureType*=INTERFERENCE.

Returns:

An ExpInitialization object.

Raises:

RangeError.

Notes

This function can be accessed by:

mdb.models[name].ExpInitialization

ExplicitDynamicsStep(name: str, previous: str, description: str = '', timePeriod: float = 1, nlgeom: BooleanType = 1, adiabatic: BooleanType = 0, timeIncrementationMethod: SymbolicConstantType = 'AUTOMATIC_GLOBAL', maxIncrement: float | None = None, scaleFactor: float = 1, massScaling: MassScalingArray = 'PREVIOUS_STEP', linearBulkViscosity: float = 0, quadBulkViscosity: float = 1, userDefinedInc: float | None = None, maintainAttributes: BooleanType = False, improvedDtMethod: BooleanType = 1) → ExplicitDynamicsStep

This method creates an ExplicitDynamicsStep object.

Parameters:

name

A String specifying the repository key.

previous

A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

description

A String specifying a description of the new step. The default value is an empty string.

timePeriod

A Float specifying the total time period for the step. The default value is 1.0.

nlgeom

A Boolean specifying whether geometric nonlinearities should be accounted for during the step. The default value is ON.

adiabatic

A Boolean specifying that an adiabatic stress analysis is to be performed. The default value is OFF.

timeIncrementationMethod

A SymbolicConstant specifying the time incrementation method to be used. Possible values are AUTOMATIC_GLOBAL, AUTOMATIC_EBE, FIXED_USER_DEFINED_INC, and FIXED_EBE. The default value is AUTOMATIC_GLOBAL.

maxIncrement

None or a Float specifying the maximum time increment. If there is no upper limit, *maxIncrement*=None. This argument is required only when *timeIncrementationMethod*=AUTOMATIC_GLOBAL or AUTOMATIC_EBE. The default value is None.

scaleFactor

A Float specifying the factor that is used to scale the time increment. This argument is required only when *timeIncrementationMethod*=AUTOMATIC_GLOBAL, AUTOMATIC_EBE, or FIXED_EBE. The default value is 1.0.

massScaling

A MassScalingArray object specifying mass scaling controls. The default value is PREVIOUS_STEP.

linearBulkViscosity

A Float specifying the linear bulk viscosity parameter, b1b1. The default value is 0.06.

quadBulkViscosity

A Float specifying the quadratic bulk viscosity parameter, b2b2. The default value is 1.2.

userDefinedInc

None or a Float specifying the user-defined time increment. This argument is required only when *timeIncrementationMethod*=FIXED_USER_DEFINED_INC. The default value is None.

maintainAttributes

A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is False.

improvedDtMethod

A Boolean specifying whether to use the “improved” (*improvedDtMethod*=ON) or “conservative” (*improvedDtMethod*=OFF) method to estimate the element stable time increment for three-dimensional continuum elements and elements with plane stress formulations (shell, membrane, and two-dimensional plane stress elements). The default value is ON.

Returns:

step: ExplicitDynamicsStep

An ExplicitDynamicsStep object.

Notes

This function can be accessed by:

mdb.models[name].ExplicitDynamicsStep

Field(name: str, createStepName: str, region: Region, outputVariable: str = '', fieldVariableNum: int | None = None, distributionType: SymbolicConstantType = 'UNIFORM', crossSectionDistribution: SymbolicConstantType = 'CONSTANT_THROUGH_THICKNESS', field: str = '', amplitude: str = 'UNSET', fileName: str = '', beginStep: SymbolicConstantType | None = None, beginIncrement: SymbolicConstantType | None = None, endStep: SymbolicConstantType | None = None, endIncrement: SymbolicConstantType | None = None, interpolate: SymbolicConstantType = 0, magnitudes: str = '') → Field

This method creates a Field object.

Parameters:

name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which the predefined field is created.

region

A Region object specifying the region to which the predefined field is applied. Region is ignored if the predefined field has a distributionType member available, and *distributionType*=FROM_FILE.

outputVariable

A String specifying the scalar nodal output variable that will be read from an output database and used to initialize a specified predefined field. This argument is a required argument if *distributionType*=FROM_FILE or *distributionType*=FROM_FILE_AND_USER_DEFINED.

fieldVariableNum

An Int specifying the field variable number.

distributionType

A SymbolicConstant specifying how the predefined field varies spatially. Possible values are UNIFORM, USER_DEFINED, FROM_FILE, FIELD, FROM_FILE_AND_USER_DEFINED, and DISCRETE_FIELD. The default value is UNIFORM.

crossSectionDistribution

A SymbolicConstant specifying how the predefined field is distributed over the cross-section of the region. Possible values are - CONSTANT_THROUGH_THICKNESS - GRADIENTS_THROUGH_SHELL_CS - GRADIENTS_THROUGH_BEAM_CS - POINTS_THROUGH_SECTION The default value is CONSTANT_THROUGH_THICKNESS.

field

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

amplitude

A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the predefined field has no amplitude reference. The default value is UNSET.Note:amplitude should be given only if it is valid for the specified step.

fileName

A String specifying the name of the file from which the Field values are to be read when *distributionType*=FROM_FILE or *distributionType*=FROM_FILE_AND_USER_DEFINED.

beginStep

An Int specifying the first step from which Field values are to be read or the SymbolicConstant FIRST_STEP or LAST_STEP. This argument is valid only when *distributionType*=FROM_FILE or *distributionType*=FROM_FILE_AND_USER_DEFINED. The default value is None.

beginIncrement

An Int specifying the first increment of the step set in beginStep or the SymbolicConstants STEP_START or STEP_END. This argument is valid only when *distributionType*=FROM_FILE or *distributionType*=FROM_FILE_AND_USER_DEFINED. The default value is None.

endStep

An Int specifying the last step from which Field values are to be read or the SymbolicConstants FIRST_STEP and LAST_STEP. This argument is valid only when *distributionType*=FROM_FILE or *distributionType*=FROM_FILE_AND_USER_DEFINED. The default value is None.

endIncrement

An Int specifying the last increment of the step set in endStep or the SymbolicConstants STEP_START and STEP_END. This argument is valid only when *distributionType*=FROM_FILE or *distributionType*=FROM_FILE_AND_USER_DEFINED. The default value is None.

interpolate

A SymbolicConstant specifying whether to interpolate a field read from an output database or results file. Possible values are OFF, ON, or MIDSIDE_ONLY. The default value is OFF.

magnitudes

A Sequence of Doubles specifying the Field values when distributionType*=UNIFORM or FIELD. The value of the *magnitudes argument is a function of the crossSectionDistribution argument, as shown in the following list: - If crossSectionDistribution*=CONSTANT_THROUGH_THICKNESS, *magnitudes is a Double specifying the Field. - If crossSectionDistribution*=GRADIENTS_THROUGH_SHELL_CS, *magnitudes is a sequence of Doubles specifying the mean value and the gradient in the thickness direction. - If crossSectionDistribution*=GRADIENTS_THROUGH_BEAM_CS, *magnitudes is a sequence of Doubles specifying the mean value, the gradient in the N1 direction, and the gradient in the N2 direction. - If crossSectionDistribution*=POINTS_THROUGH_SECTION, *magnitudes is a sequence of Doubles specifying the Field at each point.

Returns:

A Field object.

Notes

This function can be accessed by:

mdb.models[name].Field

FieldOutputRequest(name: str, createStepName: str, region: SymbolicConstantType = 'MODEL', variables: SymbolicConstantType = 'PRESELECT', frequency: SymbolicConstantType = 1, modes: SymbolicConstantType = 'ALL', timeInterval: SymbolicConstantType | float = 'EVERY_TIME_INCREMENT', numIntervals: int = 20, timeMarks: BooleanType = 0, boltLoad: str = '', sectionPoints: SymbolicConstantType = 'DEFAULT', interactions: str | None = None, rebar: SymbolicConstantType = 'EXCLUDE', filter: SymbolicConstantType | None = None, directions: BooleanType = 1, fasteners: str = '', assembledFastener: str = '', assembledFastenerSet: str = '', exteriorOnly: BooleanType = 0, layupNames: str = '', layupLocationMethod: str = 'SPECIFIED', outputAtPlyTop: BooleanType = False, outputAtPlyMid: BooleanType = True, outputAtPlyBottom: BooleanType = False, position: SymbolicConstantType = 'INTEGRATION_POINTS')

This method creates a FieldOutputRequest object.

Parameters:

name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which the object is created.

region

The SymbolicConstant MODEL or a Region object specifying the region from which output is requested. The SymbolicConstant MODEL represents the whole model. The default value is MODEL.

variables

A sequence of Strings specifying output request variable or component names, or the SymbolicConstant PRESELECT or ALL. PRESELECT represents all default output variables for the given step. ALL represents all valid output variables. The default value is PRESELECT.

frequency

The SymbolicConstant LAST_INCREMENT or an Int specifying the output frequency in increments. The default value is 1.

modes

The SymbolicConstant ALL or a sequence of Ints specifying a list of eigenmodes for which output is desired. The default value is ALL.

timeInterval

The SymbolicConstant EVERY_TIME_INCREMENT or a Float specifying the time interval at which the output states are to be written. The default value is EVERY_TIME_INCREMENT.

numIntervals

An Int specifying the number of intervals during the step at which output database states are to be written. The default value is 20.

timeMarks

A Boolean specifying when to write results to the output database. OFF indicates that output is written immediately after the time dictated by the specified number of intervals. ON indicates that output is written at the exact times dictated by the specified number of intervals. The default value is OFF.

boltLoad

A String specifying a bolt load from which output is requested.

sectionPoints

The SymbolicConstant DEFAULT or a sequence of Ints specifying the section points for which output requested. The default is DEFAULT.

interactions

None or a sequence of Strings specifying the interaction names. The default value is None.The sequence can contain only one String.

rebar

A SymbolicConstant specifying whether output is requested for rebar. Possible values are EXCLUDE, INCLUDE, and ONLY. The default value is EXCLUDE.

filter

The SymbolicConstant ANTIALIASING or a String specifying the name of an output filter object. The default value is None.

directions

A Boolean specifying whether to output directions of the local material coordinate system. The default value is ON.

fasteners

A String specifying the fastener name. The default value is an empty string.

assembledFastener

A String specifying the assembled fastener name. The default value is an empty string.

assembledFastenerSet

A String specifying the set name from the model referenced by the assembled fastener, assembledFastener. The default value is an empty string.

exteriorOnly

A Boolean specifying whether the output domain is restricted to the exterior of the model. This argument is only valid if *region*=MODEL. The default value is OFF.

layupNames

A List of Composite Layer Names.

layupLocationMethod

A Symbolic constant specifying the method used to indicate the output locations for composite layups. Possible values are ALL_LOCATIONS, SPECIFIED and TYPED_IN. The default value is SPECIFIED.

outputAtPlyTop

A Boolean specifying whether to output at the ply top section point. The default value is False.

outputAtPlyMid

A Boolean specifying whether to output at the ply mid section point. The default value is True.

outputAtPlyBottom

A Boolean specifying whether to output at the ply bottom section point. The default value is False.

position

A SymbolicConstant specifying the position on an element where output needs to be written. Possible values are INTEGRATION_POINTS, AVERAGED_AT_NODES, CENTROIDAL, and NODES. The default value is INTEGRATION_POINTS.

Returns:

A FieldOutputRequest object.

Notes

This function can be accessed by:

mdb.models[name].FieldOutputRequest

FilmCondition(name: str, createStepName: str, surface: Region, definition: SymbolicConstantType, interactionProperty: str = '', sinkTemperature: float = 0, sinkAmplitude: str = '', filmCoeff: float = 0, filmCoeffAmplitude: str = '', field: str = '', sinkFieldName: str = '', sinkDistributionType: SymbolicConstantType = 'UNIFORM') → FilmCondition

This method creates a FilmCondition object.

Parameters:

name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which the FilmCondition object is created.

surface

A Region object specifying the name of the surface to which the film condition interaction is applied.

definition

A SymbolicConstant specifying how the film condition is defined. Possible values are EMBEDDED_COEFF, PROPERTY_REF, USER_SUB, and FIELD.

interactionProperty

A String specifying the name of the FilmConditionProp object associated with this interaction. The interactionProperty argument applies only when *definition*=PROPERTY_REF. The default value is an empty string.

sinkTemperature

A Float specifying the reference sink temperature, θ0θ0. The default value is 0.0.

sinkAmplitude

A String specifying the name of the Amplitude object that gives the variation of the sink temperature, θ0θ0, with time. The default value is an empty string.Note:Use empty string in an Abaqus/Standard analysis to specify that the reference sink temperature is applied immediately at the beginning of the step or linearly over the step. Use empty string in an Abaqus/Explicit analysis to specify that the reference sink temperature is applied throughout the step.

filmCoeff

A Float specifying the reference film coefficient value, hh. The filmCoeff argument applies when *definition*=EMBEDDED_COEFF, *definition*=USER_SUB, or *definition*=FIELD. The default value is 0.0.

filmCoeffAmplitude

A String specifying the name of the Amplitude object that gives the variation of the film coefficient, hh, with time. The default value is an empty string. Note: Use empty string in an Abaqus/Standard analysis to specify that the reference film coefficient is applied immediately at the beginning of the step or linearly over the step. Use empty string in an Abaqus/Explicit analysis to specify that the reference film coefficient is applied throughout the step.

field

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

sinkFieldName

A String specifying the name of the AnalyticalField or DiscreteField object associated with the sink temperature. The sinkFieldName argument applies only when *sinkDistributionType*=ANALYTICAL_FIELD or *sinkDistributionType*=DISCRETE_FIELD. The default value is an empty string.

sinkDistributionType

A SymbolicConstant specifying how the sink temperature is distributed. Possible values are UNIFORM, ANALYTICAL_FIELD, and DISCRETE_FIELD. The default value is UNIFORM.

Returns:

A FilmCondition object.

Notes

This function can be accessed by:

mdb.models[name].FilmCondition

FilmConditionProp(name: str, temperatureDependency: BooleanType = 0, dependencies: int = 0, property: tuple = ()) → FilmConditionProp

This method creates a FilmConditionProp object.

Parameters:

name

A String specifying the interaction property repository key.

temperatureDependency

A Boolean specifying whether the data depend on temperature. The default value is OFF.

dependencies

An Int specifying the number of field variable dependencies. The default value is 0.

property

A sequence of sequences of Floats specifying the following: - The film coefficient, hh. - Temperature, if the data depend on temperature. - Value of the first field variable, if the data depend on field variables. - Value of the second field variable. - Etc.

Returns:

A FilmConditionProp object.

Notes

This function can be accessed by:

mdb.models[name].FilmConditionProp

FluidCavity(name: str, createStepName: str, cavityPoint: Region, cavitySurface: Region, interactionProperty: str, ambientPressure: float = 0, thickness: float = 1, useAdiabatic: BooleanType = 0, checkNormals: BooleanType = 1) → FluidCavity

This method creates an FluidCavity object.

Parameters:

name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which the FluidCavity object is created.

cavityPoint

A Region object specifying the fluid cavity reference point.

cavitySurface

A Region object specifying the surface forming the boundary of the fluid cavity.

interactionProperty

A String specifying the FluidCavityProperty object associated with this interaction.

ambientPressure

A Float specifying the magnitude of the ambient pressure. The default value is 0.0.

thickness

A Float specifying the out-of-plane thickness of the surface for two-dimensional models. This argument is valid only when using two-dimensional models. The default value is 1.0.

useAdiabatic

A Boolean specifying whether adiabatic behavior is assumed for the ideal gas. This argument is valid only when interactionProperty specifies a pneumatic definition. The default value is OFF.

checkNormals

A Boolean specifying whether the analysis will check the consistency of the surface normals. The default value is ON.

Returns:

A FluidCavity object.

Notes

This function can be accessed by:

mdb.models[name].FluidCavity

FluidCavityPressure(name: str, fluidCavity: str, fluidPressure: float) → FluidCavityPressure

This method creates a FluidCavityPressure object.

Parameters:

name

A String specifying the repository key.

fluidCavity

A String specifying the name of a Fluid Cavity Interaction.

fluidPressure

A Float specifying the initial fluid pressure.

Returns:

A FluidCavityPressure object.

Notes

This function can be accessed by:

mdb.models[name].FluidCavityPressure

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

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

FluidCavityProperty(name: str, definition: SymbolicConstantType = 'HYDRAULIC', fluidDensity: float | None = None, molecularWeight: float | None = None, useExpansion: BooleanType = 0, expansionTempDep: BooleanType = 0, expansionDependencies: int = 0, referenceTemperature: float = 0, expansionTable: tuple = (), useBulkModulus: BooleanType = 0, bulkModulusTempDep: BooleanType = 0, bulkModulusDependencies: int = 0, bulkModulusTable: tuple = (), useCapacity: BooleanType = 0, capacityType: SymbolicConstantType = 'POLYNOMIAL', capacityTempDep: BooleanType = 0, capacityDependencies: int = 0, capacityTable: tuple = ()) → FluidCavityProperty

This method creates a FluidCavityProperty object.

Parameters:

name

A String specifying the interaction property repository key.

definition

A SymbolicConstant specifying the type of fluid cavity property to be defined. Possible values are HYDRAULIC and PNEUMATIC. The default value is HYDRAULIC.

fluidDensity

None or a Float specifying the reference fluid density. This argument is applicable only when *definition*=HYDRAULIC, and is required in that case. The default value is None.

molecularWeight

None or a Float specifying the molecular weight of the ideal gas species. This argument is applicable only when *definition*=PNEUMATIC, and is required in that case. The default value is None.

useExpansion

A Boolean specifying whether thermal expansion coefficients will be defined. This argument is applicable only when *definition*=HYDRAULIC. The default value is OFF.

expansionTempDep

A Boolean specifying whether the thermal fluid expansion data will have temperature dependency. This argument is applicable only when *definition*=HYDRAULIC and when *useExpansion*=True. The default value is OFF.

expansionDependencies

An Int specifying the number of field variable dependencies in the thermal fluid expansion data. This argument is applicable only when *definition*=HYDRAULIC and when *useExpansion*=True. The default value is 0.

referenceTemperature

A Float specifying the reference temperature for the coefficient of thermal expansion. This argument is applicable only when definition*=HYDRAULIC, when *useExpansion*=True, and when either *expansionTempDep*=True or when *expansionDependencies is greater than 0. The default value is 0.0.

expansionTable

A sequence of sequences of Floats specifying the thermal expansion coefficients. This argument is applicable only when *definition*=HYDRAULIC and when *useExpansion*=True. Each sequence contains the following data: - The mean coefficient of thermal expansion. - Temperature, if the data depend on temperature. - Value of the first field variable, if the data depend on field variables. - Value of the second field variable. - Etc.

useBulkModulus

A Boolean specifying whether fluid bulk modulus values will be defined. This argument is applicable only when *definition*=HYDRAULIC. The default value is OFF.

bulkModulusTempDep

A Boolean specifying whether the fluid bulk modulus data will have temperature dependency. This argument is applicable only when *definition*=HYDRAULIC and when *useBulkModulus*=True. The default value is OFF.

bulkModulusDependencies

An Int specifying the number of field variable dependencies in the fluid bulk modulus data. This argument is applicable only when *definition*=HYDRAULIC and when *useBulkModulus*=True. The default value is 0.

bulkModulusTable

A sequence of sequences of Floats specifying the fluid bulk modulus values. This argument is applicable only when *definition*=HYDRAULIC and when *useBulkModulus*=True. Each sequence contains the following data: - The fluid bulk modulus. - Temperature, if the data depend on temperature. - Value of the first field variable, if the data depend on field variables. - Value of the second field variable. - Etc.

useCapacity

A Boolean specifying whether molar heat capacity values will be defined. This argument is applicable only when *definition*=PNEUMATIC. The default value is OFF.

capacityType

A SymbolicConstant specifying the method to define the molar heat capacity. Possible values are POLYNOMIAL and TABULAR. The default value is POLYNOMIAL.

capacityTempDep

A Boolean specifying whether the molar heat capacity data will have temperature dependency. This argument is applicable only when *definition*=PNEUMATIC, when *useCapacity*=True, and when *capacityType*=TABULAR. The default value is OFF.

capacityDependencies

An Int specifying the number of field variable dependencies in the molar heat capacity data. This argument is applicable only when *definition*=PNEUMATIC, when *useCapacity*=True, and when *capacityType*=TABULAR. The default value is 0.

capacityTable

A sequence of sequences of Floats specifying the molar heat capacity values in the form of a polynomial expression. This argument is applicable only when *definition*=PNEUMATIC, when *useCapacity*=True, and when *capacityType*=POLYNOMIAL. In this form, only one sequence is specified and that sequence contains the following data: - The first molar heat capacity coefficient. - The second molar heat capacity coefficient. - The third molar heat capacity coefficient. - The fourth molar heat capacity coefficient. - The fifth molar heat capacity coefficient. Alternatively, the sequence data may specify the molar heat capacity values at constant pressure for an ideal gas species. This argument is applicable only when *definition*=PNEUMATIC, when *useCapacity*=True, and when *capacityType*=TABULAR. Each sequence contains the following data: - The molar heat capacity at constant pressure. - Temperature, if the data depend on temperature. - Value of the first field variable, if the data depend on field variables. - Value of the second field variable. - Etc.

Returns:

A FluidCavityProperty object.

Notes

This function can be accessed by:

mdb.models[name].FluidCavityProperty

FluidExchange(name: str, createStepName: str, firstCavity: str, interactionProperty: str, definition: SymbolicConstantType = 'TO_ENVIRONMENT', secondCavity: str = '', exchangeArea: float = 1) → FluidExchange

This method creates an FluidExchange object.

Parameters:

name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which the FluidExchange object is created.

firstCavity

A String specifying the first FluidCavity object associated with this interaction. This will be the only cavity specified if *definition*=TO_ENVIRONMENT.

interactionProperty

A String specifying the FluidExchangeProperty object associated with this interaction.

definition

A SymbolicConstant specifying the type of fluid exchange to be defined. Possible values are TO_ENVIRONMENT and BETWEEN_CAVITIES. The default value is TO_ENVIRONMENT.

secondCavity

A String specifying the second FluidCavity object associated with this interaction. This argument is applicable only when *definition*=BETWEEN_CAVITIES.

exchangeArea

A Float specifying the effective exchange area. The default value is 1.0.

Returns:

A FluidExchange object.

Notes

This function can be accessed by:

mdb.models[name].FluidExchange

FluidExchangeProperty(name: str, dataTable: tuple, definition: SymbolicConstantType = 'BULK_VISCOSITY', pressureDependency: BooleanType = 0, temperatureDependency: BooleanType = 0, fieldDependencies: int = 0) → FluidExchangeProperty

This method creates a FluidExchangeProperty object.

Parameters:

name

A String specifying the interaction property repository key.

dataTable

A sequence of sequences of Floats specifying the viscous and hydrodynamic resistance coefficients when *definition*=BULK_VISCOSITY. Each sequence contains the following data: - The viscous resistance coefficient. - The hydrodynamic resistance coefficient. - The average absolute pressure, if the data depend on pressure. - The average temperature, if the data depend on temperature. - The value of the first field variable, if the data depend on field variables. - The value of the second field variable. - Etc. Alternatively, the sequence data may specify the mass flow rate. This is applicable only when *definition*=MASS_FLUX. In this form, only one sequence is specified and that sequence contains the following data: - The mass flow rate per unit area. Alternatively, the sequence data may specify the mass rate leakage. This is applicable only when *definition*=MASS_RATE_LEAK. Each sequence contains the following data: - The absolute value of the mass flow rate per unit area. (The first tabular value entered must always be zero.) - The absolute value of the pressure difference. (The first tabular value entered must always be zero.) - The average absolute pressure, if the data depend on pressure. - The average temperature, if the data depend on temperature. - The value of the first field variable, if the data depend on field variables. - The value of the second field variable. - Etc. Alternatively, the sequence data may specify the volume flow rate. This is applicable only when *definition*=VOL_FLUX. In this form, only one sequence is specified and that sequence contains the following data: - The volumetric flow rate per unit area. Alternatively, the sequence data may specify the volume rate leakage. This is applicable only when *definition*=VOL_RATE_LEAK. Each sequence contains the following data: - The absolute value of the volumetric flow rate per unit area. (The first tabular value entered must always be zero.) - The absolute value of the pressure difference. (The first tabular value entered must always be zero.) - The average absolute pressure, if the data depend on pressure. - The average temperature, if the data depend on temperature. - The value of the first field variable, if the data depend on field variables. - The value of the second field variable. - Etc.

definition

A SymbolicConstant specifying the type of fluid exchange property to be defined. Possible values are BULK_VISCOSITY, MASS_FLUX, MASS_RATE_LEAK, VOL_FLUX, and VOL_RATE_LEAK. The default value is BULK_VISCOSITY.

pressureDependency

A Boolean specifying whether the data will have pressure dependency. This argument is applicable only when *definition*=BULK_VISCOSITY, or when *definition*=MASS_RATE_LEAK, or when *definition*=VOL_RATE_LEAK. The default value is OFF.

temperatureDependency

A Boolean specifying whether the data will have temperature dependency. This argument is applicable only when *definition*=BULK_VISCOSITY, or when *definition*=MASS_RATE_LEAK, or when *definition*=VOL_RATE_LEAK. The default value is OFF.

fieldDependencies

An Int specifying the number of field variable dependencies in the data. This argument is applicable only when *definition*=BULK_VISCOSITY, or when *definition*=MASS_RATE_LEAK, or when *definition*=VOL_RATE_LEAK. The default value is 0.

Returns:

A FluidExchangeProperty object.

Notes

This function can be accessed by:

mdb.models[name].FluidExchangeProperty

FluidInflator(name: str, createStepName: str, cavity: str, interactionProperty: str, inflationTimeAmplitude: str = '', massFlowAmplitude: str = '') → FluidInflator

This method creates a FluidInflator object.

Parameters:

name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which the FluidInflator object is created.

cavity

A String specifying the first FluidCavity object associated with this interaction.

interactionProperty

A String specifying the FluidInflatorProperty object associated with this interaction.

inflationTimeAmplitude

A string specifying the name of the amplitude curve defining a mapping between the inflation time and the actual time.

massFlowAmplitude

A string specifying the name of the amplitude curve by which to modify the mass flow rate.

Returns:

A FluidInflator object.

Notes

This function can be accessed by:

mdb.models[name].FluidInflator

FluidInflatorProperty(name: str, definition: str, effectiveArea: float, tankVolume: float, dischargeCoefficient: float | None = None, dataTable: tuple = (), numFluids: int | None = None, mixtureType: str = '', inflationTime: tuple = (), fluidbehaviorName: tuple = (), massFraction: tuple = ()) → FluidInflatorProperty

This method creates a FluidInflatorProperty object.

Parameters:

name

A String specifying the interaction property repository key.

definition

A Symbolic constant specifying the method used for modeling the flow characteristics of inflators. The default value is *definition*=DUAL PRESSURE. The possible values are DUAL PRESSURE, PRESSURE AND MASS, TANK TEST, and TEMPERATURE AND MASS.

effectiveArea

A Float specifying the total inflator orifice area. This argument is applicable only if *definition*=DUAL PRESSURE or *definition*=PRESSURE AND MASS.

tankVolume

A Float specifying the tank volume. This argument is applicable only if *definition*=DUAL PRESSURE or *definition*=TANK TEST.

dischargeCoefficient

A Float specifying the discharge coefficient. This argument is applicable only if *definition*=DUAL PRESSURE or *definition*=PRESSURE AND MASS.

dataTable

A sequence of sequences of Floats specifying the items described in the “Table data” section below.

numFluids

An Int specifying the number of gas species used for this inflator.

mixtureType

A Symbolic constant specifying whether to use mass fraction or the molar fraction for a mixture of ideal gases. The default value is MASS FRACTION. The possible values are MASS FRACTION or MOLAR FRACTION.

inflationTime

A sequence of sequences of Floats specifying the inflation time.

fluidbehaviorName

A sequence of sequences of Strings specifying fluid behavior names.

massFraction

A sequence of sequences of Floats specifying the mass fraction or the molar fraction corresponding to entered fluid behavior.

Returns:

A FluidInflatorProperty object.

Notes

This function can be accessed by:

mdb.models[name].FluidInflatorProperty

FrequencyStep(name: str, previous: str, eigensolver: SymbolicConstantType, numEigen: SymbolicConstantType = 'ALL', description: str = '', shift: float = 0, minEigen: float | None = None, maxEigen: float | None = None, vectors: int | None = None, maxIterations: int = 30, blockSize: SymbolicConstantType = 'DEFAULT', maxBlocks: SymbolicConstantType = 'DEFAULT', normalization: SymbolicConstantType = 'DISPLACEMENT', propertyEvaluationFrequency: float | None = None, projectDamping: BooleanType = 1, acousticCoupling: SymbolicConstantType = 'AC_ON', acousticRangeFactor: float = 1, frictionDamping: BooleanType = 0, matrixStorage: SymbolicConstantType = 'SOLVER_DEFAULT', maintainAttributes: BooleanType = False, simLinearDynamics: BooleanType = 0, residualModes: BooleanType = 0, substructureCutoffMultiplier: float = 5, firstCutoffMultiplier: float = 1, secondCutoffMultiplier: float = 1, residualModeRegion: str | None = None, residualModeDof: str | None = None, limitSavedEigenvectorRegion: SymbolicConstantType | None = None) → FrequencyStep

This method creates a FrequencyStep object.

Parameters:

name

A String specifying the repository key.

previous

A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

eigensolver

A SymbolicConstant specifying the eigensolver. Possible values are LANCZOS, SUBSPACE, and AMS.The following optional arguments are ignored unless eigensolver*=LANCZOS: *blockSize, maxBlocks, normalization, propertyEvaluationFrequency.The following optional arguments are ignored unless eigensolver*=LANCZOS or AMS: *minEigen, maxEigen, and acousticCoupling.The following optional arguments are ignored unless eigensolver*=AMS: *projectDamping, acousticRangeFactor, substructureCutoffMultiplier, firstCutoffMultiplier, secondCutoffMultiplier, residualModeRegion, regionalModeDof, and limitSavedEigenvectorRegion.

numEigen

The SymbolicConstant ALL or an Int specifying the number of eigenvalues to be calculated or ALL. The default value is ALL.

description

A String specifying a description of the new step. The default value is an empty string.

shift

A Float specifying the shift point in cycles per time. The default value is 0.0.

minEigen

None or a Float specifying the minimum frequency of interest in cycles per time. The default value is None.

maxEigen

None or a Float specifying the maximum frequency of interest in cycles per time. The default value is None.

vectors

None or an Int specifying the number of vectors used in the iteration. The default is the minimum of (2*n*, n + 8), where n is the number of eigenvalues requested. The default value is None.

maxIterations

An Int specifying the maximum number of iterations. The default value is 30.

blockSize

A SymbolicConstant specifying the size of the Lanczos block steps. The default value is DEFAULT.

maxBlocks

A SymbolicConstant specifying the maximum number of Lanczos block steps within each Lanczos run. The default value is DEFAULT.

normalization

A SymbolicConstant specifying the method for normalizing eigenvectors. Possible values are DISPLACEMENT and MASS. The default value is DISPLACEMENT.A value of DISPLACEMENT indicates normalizing the eigenvectors so that the largest displacement entry in each vector is unity. A value of MASS indicates normalizing the eigenvectors with respect to the structure’s mass matrix, which results in scaling the eigenvectors so that the generalized mass for each vector is unity.

propertyEvaluationFrequency

None or a Float specifying the frequency at which to evaluate frequency-dependent properties for viscoelasticity, springs, and dashpots during the eigenvalue extraction. If the value is None, the analysis product will evaluate the stiffness associated with frequency-dependent springs and dashpots at zero frequency and will not consider the stiffness contributions from frequency-domain viscoelasticity in the step. The default value is None.

projectDamping

A Boolean specifying whether to include projection of viscous and structural damping operators during AMS eigenvalue extraction. Valid only when *eigenSolver*=AMS. The default value is ON.

acousticCoupling

A SymbolicConstant specifying the type of acoustic-structural coupling in models with acoustic and structural elements coupled using the TIE option or in models with ASI-type elements. Possible values are AC_ON, AC_OFF, and AC_PROJECTION. The default value is AC_ON.

acousticRangeFactor

A Float specifying the ratio of the maximum acoustic frequency to the maximum structural frequency. The default value is 1.0.

frictionDamping

A Boolean specifying whether to add to the damping matrix contributions due to friction effects. The default value is OFF.

matrixStorage

A SymbolicConstant specifying the type of matrix storage. Possible values are SYMMETRIC, UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT.

maintainAttributes

A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is False.

simLinearDynamics

A Boolean specifying whether to activate the SIM-based linear dynamics procedures. The default value is OFF.

residualModes

A Boolean specifying whether to include residual modes from an immediately preceding Static, Linear Perturbation step. The default value is OFF.

substructureCutoffMultiplier

A Float specifying the cutoff frequency for substructure eigenproblems, defined as a multiplier of the maximum frequency of interest. The default value is 5.0.

firstCutoffMultiplier

A Float specifying the first cutoff frequency for a reduced eigenproblem, defined as a multiplier of the maximum frequency of interest. The default value is 1.7.

secondCutoffMultiplier

A Float specifying the second cutoff frequency for a reduced eigenproblem defined as a multiplier of the maximum frequency of interest. The default value is 1.1.

residualModeRegion

None or a sequence of Strings specifying the name of a region for which residual modes are requested. The default value is None.

residualModeDof

None or a sequence of Ints specifying the degree of freedom for which residual modes are requested. The default value is None.

limitSavedEigenvectorRegion

None or a Region object specifying a region for which eigenvectors should be saved or the SymbolicConstant None representing the whole model. The default value is None.

Returns:

step: FrequencyStep

A FrequencyStep object.

Notes

This function can be accessed by:

mdb.models[name].FrequencyStep

GasketSection(name: str, material: str, crossSection: float = 1, initialGap: float = 0, initialThickness: SymbolicConstantType | float = 'DEFAULT', initialVoid: float = 0, stabilizationStiffness: SymbolicConstantType | float = 'DEFAULT') → GasketSection

This method creates a GasketSection object.

Parameters:

name

A String specifying the repository key.

material

A String specifying the name of the material of which the gasket is made or material that defines gasket behavior.

crossSection

A Float specifying the cross-sectional area, width, or out-of-plane thickness, if applicable, depending on the gasket element type. The default value is 1.0.

initialGap

A Float specifying the initial gap. The default value is 0.0.

initialThickness

The SymbolicConstant DEFAULT or a Float specifying the initial gasket thickness. If DEFAULT is specified, the initial thickness is determined using nodal coordinates. The default value is DEFAULT.

initialVoid

A Float specifying the initial void. The default value is 0.0.

stabilizationStiffness

The SymbolicConstant DEFAULT or a Float specifying the default stabilization stiffness used in all but link elements to stabilize gasket elements that are not supported at all nodes, such as those that extend outside neighboring components. If DEFAULT is specified, a value is used equal to 10–9 times the initial compressive stiffness in the thickness direction. The default value is DEFAULT.

Returns:

A GasketSection object. and ValueError.

Notes

This function can be accessed by:

mdb.models[name].GasketSection
session.odbs[name].GasketSection

GeneralStiffnessSection(name: str, stiffnessMatrix: tuple, referenceTemperature: float | None = None, applyThermalStress: BooleanType = 0, temperatureDependency: BooleanType = 0, dependencies: int = 0, poissonDefinition: SymbolicConstantType = 'DEFAULT', poisson: float = 0, useDensity: BooleanType = 0, density: float = 0, thermalStresses: tuple = (), scalingData: tuple = ()) → GeneralStiffnessSection

This method creates a GeneralStiffnessSection object.

Parameters:

name

A String specifying the repository key.

stiffnessMatrix

A sequence of Floats specifying the stiffness matrix for the section in the order D11, D12, D22, D13, D23, D33, …., D66. Twenty-one entries must be given.

referenceTemperature

None or a Float specifying the reference temperature for thermal expansion. The default value is None.

applyThermalStress

A Boolean specifying whether or not the section stiffness varies with thermal stresses. The default value is OFF.

temperatureDependency

A Boolean specifying whether the data depend on temperature. The default value is OFF.

dependencies

An Int specifying the number of field variable dependencies. The default value is 0.

poissonDefinition

A SymbolicConstant specifying whether to use the default value for the Poisson’s ratio. Possible values are:DEFAULT, specifying that the default value for the Poisson’s ratio is 0.5 in an Abaqus/Standard analysis and is obtained from the material definition in an Abaqus/Explicit analysis.VALUE, specifying that the Poisson’s ratio used in the analysis is the value provided in poisson.The default value is DEFAULT.

poisson

A Float specifying the Poisson’s ratio. Possible values are −1.0 ≤≤ poisson ≤≤ 0.5. This argument is valid only when *poissonDefinition*=VALUE. The default value is 0.5.

useDensity

A Boolean specifying whether or not to use the value of density. The default value is OFF.

density

A Float specifying the value of density to apply to this section. The default value is 0.0.

thermalStresses

A sequence of Floats specifying the generalized stress values caused by a unit temperature rise. Six entries must be given if the value of applyThermalStress is set to True. The default value is (“”).

scalingData

A sequence of sequences of Floats specifying the scaling factors for given temperatures and/or field data. Each row should contain (Y, alpha, T, F1,…,Fn). The default value is an empty sequence.

Returns:

A GeneralStiffnessSection object.

Notes

This function can be accessed by:

mdb.models[name].GeneralStiffnessSection
session.odbs[name].GeneralStiffnessSection

GeneralizedProfile(name: str, area: float, i11: float, i12: float, i22: float, j: float, gammaO: float, gammaW: float) → GeneralizedProfile

This method creates a GeneralizedProfile object.

Parameters:

name

A String specifying the repository key.

area

A Float specifying the cross-sectional area for the profile.

i11

A Float specifying the moment of inertia for bending about the 1-axis, I11I11.

i12

A Float specifying the moment of inertia for cross bending, I12I12.

i22

A Float specifying the moment of inertia for bending about the 2-axis, I22I22.

j

A Float specifying the torsional constant, JJ.

gammaO

A Float specifying the sectorial moment, Γ0Γ0.

gammaW

A Float specifying the warping constant, ΓWΓW.

Returns:

A GeneralizedProfile object.

Raises:

RangeError.

!img

Notes

This function can be accessed by:

mdb.models[name].GeneralizedProfile
session.odbs[name].GeneralizedProfile

GeostaticStep(name: str, previous: str, description: str = '', nlgeom: BooleanType = 0, matrixSolver: SymbolicConstantType = 'DIRECT', matrixStorage: SymbolicConstantType = 'SOLVER_DEFAULT', maintainAttributes: BooleanType = False, solutionTechnique: SymbolicConstantType = 'FULL_NEWTON', reformKernel: int = 8, convertSDI: SymbolicConstantType = 'PROPAGATED', utol: float | None = None, timePeriod: float = 1, timeIncrementationMethod: SymbolicConstantType = 'AUTOMATIC', maxNumInc: int = 100, initialInc: float | None = None, minInc: float | None = None, maxInc: float | None = None) → GeostaticStep

This method creates a GeostaticStep object.

Parameters:

name

A String specifying the repository key.

previous

A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

description

A String specifying a description of the new step. The default value is an empty string.

nlgeom

A Boolean specifying whether geometric nonlinearities should be accounted for during the step. The default value is OFF.

matrixSolver

A SymbolicConstant specifying the type of solver. Possible values are DIRECT and ITERATIVE. The default value is DIRECT.

matrixStorage

A SymbolicConstant specifying the type of matrix storage. Possible values are SYMMETRIC, UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT.

maintainAttributes

A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is False.

solutionTechnique

A SymbolicConstant specifying the technique used to for solving nonlinear equations. Possible values are FULL_NEWTON and QUASI_NEWTON. The default value is FULL_NEWTON.

reformKernel

An Int specifying the number of quasi-Newton iterations allowed before the kernel matrix is reformed.. The default value is 8.

convertSDI

A SymbolicConstant specifying whether to force a new iteration if severe discontinuities occur during an iteration. Possible values are PROPAGATED, CONVERT_SDI_OFF, and CONVERT_SDI_ON. The default value is PROPAGATED.

utol

None or a Float specifying the tolerance for maximum change of displacements. The default value is None.

timePeriod

A Float specifying the total time period. The default value is 1.0.Note:This parameter is ignored unless *timeIncrementationMethod*=AUTOMATIC.

timeIncrementationMethod

A SymbolicConstant specifying the time incrementation method to be used. Possible values are FIXED and AUTOMATIC. The default value is AUTOMATIC.

maxNumInc

An Int specifying the maximum number of increments in a step. The default value is 100.

initialInc

A Float specifying the initial time increment. The default value is the total time period for the step.Note:This parameter is ignored unless *timeIncrementationMethod*=AUTOMATIC.

minInc

A Float specifying the minimum time increment allowed. The default value is the smaller of the suggested initial time increment or 10−5 times the total time period.Note:This parameter is ignored unless *timeIncrementationMethod*=AUTOMATIC.

maxInc

A Float specifying the maximum time increment allowed. The default value is the total time period for the step.Note:This parameter is ignored unless *timeIncrementationMethod*=AUTOMATIC.

Returns:

step: GeostaticStep

A GeostaticStep object.

Notes

This function can be accessed by:

mdb.models[name].GeostaticStep

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

This method creates a Gravity object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created.

distributionType

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

field

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

region

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

comp1

A Float or a Complex specifying the component of the load in the 1-direction.Note:Although comp1, comp2, and comp3 are optional arguments, at least one of them must be nonzero.

comp2

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

comp3

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

amplitude

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

Returns:

A Gravity object.

Notes

This function can be accessed by:

mdb.models[name].Gravity

HeatTransferStep(name: str, previous: str, description: str = '', response: SymbolicConstantType = 'TRANSIENT', timePeriod: float = 1, timeIncrementationMethod: SymbolicConstantType = 'AUTOMATIC', maxNumInc: int = 100, initialInc: float | None = None, minInc: float | None = None, maxInc: float | None = None, end: float | None = None, deltmx: float = 0, mxdem: float = 0, amplitude: SymbolicConstantType = 'STEP', extrapolation: SymbolicConstantType = 'LINEAR', matrixSolver: SymbolicConstantType = 'DIRECT', matrixStorage: SymbolicConstantType = 'SOLVER_DEFAULT', maintainAttributes: BooleanType = False, solutionTechnique: SymbolicConstantType = 'FULL_NEWTON', reformKernel: int = 8, convertSDI: SymbolicConstantType = 'PROPAGATED') → HeatTransferStep

This method creates a HeatTransferStep object.

Parameters:

name

A String specifying the repository key.

previous

A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

description

A String specifying a description of the new step. The default value is an empty string.

response

A SymbolicConstant specifying the analysis type. Possible values are STEADY_STATE and TRANSIENT. The default value is TRANSIENT.

timePeriod

A Float specifying the total time period. The default value is 1.0.

timeIncrementationMethod

A SymbolicConstant specifying the time incrementation method to be used. Possible values are FIXED and AUTOMATIC. The default value is AUTOMATIC.

maxNumInc

An Int specifying the maximum number of increments in a step. The default value is 100.

initialInc

A Float specifying the initial time increment. The default value is the total time period for the step.

minInc

A Float specifying the minimum time increment allowed. The default value is the smaller of 0.8 times the initial time increment or 10−5 times the total time period.

maxInc

A Float specifying the maximum time increment allowed. The default value is the total time period for the step.

end

None or a Float specifying the temperature change rate (temperature per time) used to define steady state. When all nodal temperatures are changing at less than this rate, the solution terminates. The default value is None.Note:This parameter is ignored unless *response*=STEADY_STATE.

deltmx

A Float specifying the maximum temperature change to be allowed in an increment during a transient heat transfer analysis. The default value is 0.0.

mxdem

A Float specifying the maximum allowable emissivity change with temperature and field variables during an increment. The default value is 0.1.

amplitude

A SymbolicConstant specifying the amplitude variation for loading magnitudes during the step. The default is STEP. Possible values are STEP and RAMP.

extrapolation

A SymbolicConstant specifying the type of extrapolation to use in determining the incremental solution for a nonlinear analysis. Possible values are NONE, LINEAR, and PARABOLIC. The default value is LINEAR.

matrixSolver

A SymbolicConstant specifying the type of solver. Possible values are DIRECT and ITERATIVE. The default value is DIRECT.

matrixStorage

A SymbolicConstant specifying the type of matrix storage. Possible values are SYMMETRIC, UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT.

maintainAttributes

A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is False.

solutionTechnique

A SymbolicConstant specifying the technique used to for solving nonlinear equations. Possible values are FULL_NEWTON and QUASI_NEWTON. The default value is FULL_NEWTON.

reformKernel

An Int specifying the number of quasi-Newton iterations allowed before the kernel matrix is reformed.. The default value is 8.

convertSDI

A SymbolicConstant specifying whether to force a new iteration if severe discontinuities occur during an iteration. Possible values are PROPAGATED, CONVERT_SDI_OFF, and CONVERT_SDI_ON. The default value is PROPAGATED.

Returns:

step: HeatTransferStep

A HeatTransferStep object.

Notes

This function can be accessed by:

mdb.models[name].HeatTransferStep

HexagonalProfile(name: str, r: float, t: float) → HexagonalProfile

This method creates a HexagonalProfile object.

Parameters:

name

A String specifying the repository key.

r

A positive Float specifying the r dimension (outer radius) of the hexagonal profile. For more information, see [Beam cross-section library](https://help.3ds.com/2021/English/DSSIMULIA_Established/SIMACAEELMRefMap/simaelm-c-beamcrosssectlib.htm?ContextScope=all).

t

A positive Float specifying the t dimension (wall thickness) of the hexagonal profile, t < (sqrt(3)/2)r.

Returns:

A HexagonalProfile object.

Raises:

RangeError.

!img

Notes

This function can be accessed by:

mdb.models[name].HexagonalProfile
session.odbs[name].HexagonalProfile

HistoryOutputRequest(name: str, createStepName: str, region: SymbolicConstantType = 'MODEL', variables: SymbolicConstantType = 'PRESELECT', frequency: SymbolicConstantType = 1, modes: SymbolicConstantType = 'ALL', timeInterval: SymbolicConstantType | float = 'EVERY_TIME_INCREMENT', numIntervals: int = 20, boltLoad: str = '', sectionPoints: SymbolicConstantType = 'DEFAULT', stepName: str = '', interactions: str | None = None, contourIntegral: str | None = None, numberOfContours: int = 0, stressInitializationStep: str | None = None, contourType: SymbolicConstantType = 'J_INTEGRAL', kFactorDirection: SymbolicConstantType = 'MTS', rebar: SymbolicConstantType = 'EXCLUDE', integratedOutputSection: str = '', springs: tuple | None = None, filter: SymbolicConstantType | None = None, fasteners: str = '', assembledFastener: str = '', assembledFastenerSet: str = '', sensor: BooleanType = 0, useGlobal: BooleanType = True)

This method creates a HistoryOutputRequest object.

Parameters:

name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which the object is created.

region

The SymbolicConstant MODEL or a Region object specifying the region from which output is requested. The SymbolicConstant MODEL represents the whole model. The default value is MODEL.If the region is a surface region, the surface must lie within the general contact surface domain.

variables

A sequence of Strings specifying output request variable or component names, or the SymbolicConstant PRESELECT or ALL. PRESELECT represents all default output variables for the given step. ALL represents all valid output variables. The default value is PRESELECT.

frequency

The SymbolicConstant LAST_INCREMENT or an Int specifying the output frequency in increments. The default value is 1.

modes

The SymbolicConstant ALL or a sequence of Ints specifying a list of eigenmodes for which output is desired. The default value is ALL.

timeInterval

The SymbolicConstant EVERY_TIME_INCREMENT or a Float specifying the time interval at which the output states are to be written. The default value is EVERY_TIME_INCREMENT.

numIntervals

An Int specifying the number of intervals during the step at which output database states are to be written. The default value is 20.

boltLoad

A String specifying a bolt load from which output is requested. The default value is an empty string.

sectionPoints

The SymbolicConstant DEFAULT or a sequence of Ints specifying the section points for which output is requested. The default value is DEFAULT.

stepName

A String specifying the name of the step. The default value is an empty string.

interactions

None or a sequence of Strings specifying the interaction names. The default value is None.The sequence can contain only one String.

contourIntegral

A String specifying the contour integral name. The default value is None.

numberOfContours

An Int specifying the number of contour integrals to output for the contour integral object. The default value is 0.

stressInitializationStep

A String specifying the name of the stress initialization step. The default value is None.

contourType

A SymbolicConstant specifying the type of contour integral. Possible values are J_INTEGRAL, C_INTEGRAL, T_STRESS, and K_FACTORS. The default value is J_INTEGRAL.

kFactorDirection

A SymbolicConstant specifying the stress intensity factor direction. Possible values are MTS, MERR, and K110. The kFactorDirection argument is valid only if *contourType*=K_FACTORS. The default value is MTS.

rebar

A SymbolicConstant specifying whether output is requested for rebar. Possible values are EXCLUDE, INCLUDE, and ONLY. The default value is EXCLUDE.

integratedOutputSection

A String specifying the integrated output section. The default value is an empty string.

springs

A sequence of Strings specifying the springs/dashpots names. The default value is None. The sequence can contain only one String.

filter

The SymbolicConstant ANTIALIASING or a String specifying the name of an output filter object. The default value is None.

fasteners

A String specifying the fastener name. The default value is an empty string.

assembledFastener

A String specifying the assembled fastener name. The default value is an empty string.

assembledFastenerSet

A String specifying the set name from the model referenced by the assembled fastener, assembledFastener. The default value is an empty string.

sensor

A Boolean specifying whether to associate the output request with a sensor definition. The default value is OFF.

useGlobal

A Boolean specifying whether to output vector-valued nodal variables in the global directions. The default value is True.

Returns:

A HistoryOutputRequest object.

Notes

This function can be accessed by:

mdb.models[name].HistoryOutputRequest

HomogeneousShellSection(name: str, material: str, thickness: float = 0, numIntPts: int = 5, thicknessType: SymbolicConstantType = 'UNIFORM', preIntegrate: BooleanType = 0, poissonDefinition: SymbolicConstantType = 'DEFAULT', poisson: float = 0, integrationRule: SymbolicConstantType = 'SIMPSON', temperature: SymbolicConstantType = 'GRADIENT', idealization: SymbolicConstantType = 'NO_IDEALIZATION', nTemp: int | None = None, thicknessModulus: float | None = None, useDensity: BooleanType = 0, density: float = 0, thicknessField: str = '', nodalThicknessField: str = '') → HomogeneousShellSection

This method creates a HomogeneousShellSection object.

Parameters:

name

A String specifying the repository key.

material

A String specifying the name of the section material.

thickness

A Float specifying the thickness of the section. The thickness argument applies only when *thicknessType*=UNIFORM. The default value is 0.0.

numIntPts

An Int specifying the number of integration points to be used through the section. Possible values are numIntPts >> 0. The default value is 5.To use the default settings of the analysis products, set numIntPts to 5 if integrationRule*=SIMPSON or set *numIntPts to 7 if *integrationRule*=GAUSS.

thicknessType

A SymbolicConstant specifying the distribution used for defining the thickness of the elements. Possible values are UNIFORM, ANALYTICAL_FIELD, DISCRETE_FIELD, NODAL_ANALYTICAL_FIELD, and NODAL_DISCRETE_FIELD. The default value is UNIFORM.

preIntegrate

A Boolean specifying whether the shell section properties are specified by the user prior to the analysis (ON) or integrated during the analysis (OFF). The default value is OFF.

poissonDefinition

A SymbolicConstant specifying whether to use the default value for the Poisson’s ratio. Possible values are:DEFAULT, specifying that the default value for the Poisson’s ratio is 0.5 in an Abaqus/Standard analysis and is obtained from the material definition in an Abaqus/Explicit analysis.VALUE, specifying that the Poisson’s ratio used in the analysis is the value provided in poisson.The default value is DEFAULT.

poisson

A Float specifying the Poisson’s ratio. Possible values are −1.0 ≤≤ poisson ≤≤ 0.5. This argument is valid only when *poissonDefinition*=VALUE. The default value is 0.5.

integrationRule

A SymbolicConstant specifying the shell section integration rule. Possible values are SIMPSON and GAUSS. The default value is SIMPSON.

temperature

A SymbolicConstant specifying the mode used for temperature and field variable input across the section thickness. Possible values are GRADIENT and POINTWISE. The default value is GRADIENT.

idealization

A SymbolicConstant specifying the mechanical idealization used for the section calculations. This member is only applicable when preIntegrate is set to ON. Possible values are NO_IDEALIZATION, SMEAR_ALL_LAYERS, MEMBRANE, and BENDING. The default value is NO_IDEALIZATION.

nTemp

None or an Int specifying the number of temperature points to be input. This argument is valid only when *temperature*=POINTWISE. The default value is None.

thicknessModulus

None or a Float specifying the effective thickness modulus. This argument is relevant only for continuum shells and must be used in conjunction with the argument poisson. The default value is None.

useDensity

A Boolean specifying whether or not to use the value of density. The default value is OFF.

density

A Float specifying the value of density to apply to this section. The default value is 0.0.

thicknessField

A String specifying the name of the AnalyticalField or DiscreteField object used to define the thickness of the shell elements. The thicknessField argument applies only when *thicknessType*=ANALYTICAL_FIELD or *thicknessType*=DISCRETE_FIELD. The default value is an empty string.

nodalThicknessField

A String specifying the name of the AnalyticalField or DiscreteField object used to define the thickness of the shell elements at each node. The nodalThicknessField argument applies only when *thicknessType*=NODAL_ANALYTICAL_FIELD or *thicknessType*=NODAL_DISCRETE_FIELD. The default value is an empty string.

Returns:

A HomogeneousShellSection object.

Notes

This function can be accessed by:

mdb.models[name].parts[name].compositeLayups[i]            - .HomogeneousShellSection
mdb.models[name].HomogeneousShellSection
session.odbs[name].HomogeneousShellSection

HomogeneousSolidSection(name: str, material: str, thickness: float = 1) → HomogeneousSolidSection

This method creates a HomogeneousSolidSection object.

Parameters:

name

A String specifying the repository key.

material

A String specifying the name of the material.

thickness

A Float specifying the thickness of the section. Possible values are None or greater than zero. The default value is 1.0.

Returns:

A HomogeneousSolidSection object.

Raises:

InvalidNameError

RangeError

Notes

This function can be accessed by:

mdb.models[name].HomogeneousSolidSection
session.odbs[name].HomogeneousSolidSection

IProfile(name: str, l: float, h: float, b1: float, b2: float, t1: float, t2: float, t3: float) → IProfile

This method creates an IProfile object.

Parameters:

name

A String specifying the repository key.

l

A Float specifying the l dimension (offset of 1–axis from the bottom flange surface) of the I profile. For more information, see [Beam cross-section library](https://help.3ds.com/2021/English/DSSIMULIA_Established/SIMACAEELMRefMap/simaelm-c-beamcrosssectlib.htm?ContextScope=all).

h

A Float specifying the h dimension (height) of the I profile.

b1

A Float specifying the b1 dimension (bottom flange width) of the I profile.

b2

A Float specifying the b2 dimension (top flange width) of the I profile.

t1

A Float specifying the t1 dimension (bottom flange thickness) of the I profile.

t2

A Float specifying the t2 dimension (top flange thickness) of the I profile.

t3

A Float specifying the t3 dimension (web thickness) of the I profile.

Returns:

An IProfile object.

Raises:

RangeError.

!img

Notes

This function can be accessed by:

mdb.models[name].IProfile
session.odbs[name].IProfile

ImplicitDynamicsStep(name: str, previous: str, description: str = '', timePeriod: float = 1, nlgeom: BooleanType = 0, matrixStorage: SymbolicConstantType = 'SOLVER_DEFAULT', application: SymbolicConstantType = 'ANALYSIS_PRODUCT_DEFAULT', adiabatic: BooleanType = 0, timeIncrementationMethod: SymbolicConstantType = 'AUTOMATIC', maxNumInc: int = 100, initialInc: float | None = None, minInc: float | None = None, maxInc: SymbolicConstantType | float = 'DEFAULT', hafTolMethod: SymbolicConstantType = 'VALUE', haftol: float | None = None, halfIncScaleFactor: float | None = None, nohaf: BooleanType = 0, amplitude: SymbolicConstantType = 'STEP', alpha: SymbolicConstantType | float = 'DEFAULT', initialConditions: SymbolicConstantType = 'DEFAULT', extrapolation: SymbolicConstantType = 'ANALYSIS_PRODUCT_DEFAULT', noStop: BooleanType = 0, maintainAttributes: BooleanType = False, solutionTechnique: SymbolicConstantType = 'FULL_NEWTON', reformKernel: int = 8, convertSDI: SymbolicConstantType = 'PROPAGATED') → ImplicitDynamicsStep

This method creates an ImplicitDynamicsStep object.

Parameters:

name

A String specifying the repository key.

previous

A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

description

A String specifying a description of the new step. The default value is an empty string.

timePeriod

A Float specifying the total time period of the step. The default value is 1.0.

nlgeom

A Boolean specifying whether geometric nonlinearities should be accounted for during the step. The default value is based on the previous step.

matrixStorage

A SymbolicConstant specifying the type of matrix storage. Possible values are SYMMETRIC, UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT.

application

A SymbolicConstant specifying the application type of the step. Possible values are ANALYSIS_PRODUCT_DEFAULT, TRANSIENT_FIDELITY, MODERATE_DISSIPATION, and QUASI_STATIC. The default value is ANALYSIS_PRODUCT_DEFAULT.

adiabatic

A Boolean specifying whether an adiabatic stress analysis is to be performed. The default value is OFF.

timeIncrementationMethod

A SymbolicConstant specifying the time incrementation method to be used. Possible values are FIXED and AUTOMATIC. The default value is AUTOMATIC.

maxNumInc

An Int specifying the maximum number of increments in a step. The default value is 100.

initialInc

A Float specifying the initial time increment. The default value is the total time period for the step.

minInc

A Float specifying the minimum time increment allowed. The default value is the smaller of the suggested initial time increment or 10−5 times the total time period.

maxInc

The SymbolicConstant DEFAULT or a Float specifying the maximum time increment allowed.

hafTolMethod

A SymbolicConstant specifying the way of specifying half-increment residual tolerance with the automatic time incrementation scheme. Possible values are ANALYSIS_PRODUCT_DEFAULT, VALUE, and SCALE. The default value is VALUE.

haftol

None or a Float specifying the half-increment residual tolerance to be used with the automatic time incrementation scheme. The default value is None.

halfIncScaleFactor

None or a Float specifying the half-increment residual tolerance scale factor to be used with the automatic time incrementation scheme. The default value is None.

nohaf

A Boolean specifying whether to suppress calculation of the half-increment residual. The default value is OFF.

amplitude

A SymbolicConstant specifying the amplitude variation for loading magnitudes during the step. Possible values are STEP and RAMP. The default value is STEP.

alpha

The SymbolicConstant DEFAULT or a Float specifying the nondefault value of the numerical (artificial) damping control parameter, αα, in the implicit operator. Possible values are −.333 <α<<α< 0. The default value is DEFAULT.

initialConditions

A SymbolicConstant specifying whether accelerations should be calculated or recalculated at the beginning of the step. Possible values are DEFAULT, BYPASS, and ALLOW. The default value is DEFAULT.

extrapolation

A SymbolicConstant specifying the type of extrapolation to use in determining the incremental solution for a nonlinear analysis. Possible values are NONE, LINEAR, PARABOLIC, VELOCITY_PARABOLIC, and ANALYSIS_PRODUCT_DEFAULT. The default value is ANALYSIS_PRODUCT_DEFAULT.

noStop

A Boolean specifying whether to accept the solution to an increment after the maximum number of iterations allowed have been completed, even if the equilibrium tolerances are not satisfied. The default value is OFF.Warning:You should set *noStop*=OFF only in special cases when you have a thorough understanding of how to interpret the results.

maintainAttributes

A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is False.

solutionTechnique

A SymbolicConstant specifying the technique used to for solving nonlinear equations. Possible values are FULL_NEWTON and QUASI_NEWTON. The default value is FULL_NEWTON.

reformKernel

An Int specifying the number of quasi-Newton iterations allowed before the kernel matrix is reformed.. The default value is 8.

convertSDI

A SymbolicConstant specifying whether to force a new iteration if severe discontinuities occur during an iteration. Possible values are PROPAGATED, CONVERT_SDI_OFF, and CONVERT_SDI_ON. The default value is PROPAGATED.

Returns:

step: ImplicitDynamicsStep

An ImplicitDynamicsStep object.

Notes

This function can be accessed by:

mdb.models[name].ImplicitDynamicsStep

IncidentWave(name: str, createStepName: str, sourcePoint: Region, standoffPoint: Region, surface: Region, interactionProperty: str, definition: SymbolicConstantType = 'PRESSURE', amplitude: str = '', imaginaryAmplitude: str = '', surfaceNormal: tuple = (), initialDepth: float | None = None, referenceMagnitude: float | None = None, detonationTime: float | None = None, magnitudeFactor: float = 1) → IncidentWave

This method creates an IncidentWave object.

Parameters:

name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which the IncidentWave object is created.

sourcePoint

A Region object specifying the incident wave source point.

standoffPoint

A Region object specifying the incident wave standoff point.This argument is not valid when *definition*=CONWEP.

surface

A Region object specifying the surface defining the incident wave interaction. In problems involving fluid/surface boundaries, both the fluid surface and the solid surface comprising the boundary must have an incident wave interaction specified.

interactionProperty

A String specifying the IncidentWaveProperty object associated with this interaction.

definition

A SymbolicConstant specifying the type of incident wave to be defined. The value must be PRESSURE for linear perturbation steps. An Explicit step is required when the value is set to CONWEP. Possible values are PRESSURE, ACCELERATION, UNDEX, and CONWEP. The default value is PRESSURE.

amplitude

A String specifying the name of the Amplitude object that defines the fluid pressure time history at the standoff point, if *definition*=PRESSURE. If *definition*=ACCELERATION, then this string specifies the name of the Amplitude object that defines the fluid particle acceleration time history at the standoff point. This member can be specified only if *definition*=PRESSURE or ACCELERATION. The default value is an empty string.

imaginaryAmplitude

A String specifying the name of the Amplitude object that defines the imaginary component of the fluid pressure time history at the standoff point. This member is applicable only for linear perturbation steps and if *definition*=PRESSURE. The default value is an empty string.

surfaceNormal

A sequence of three Floats specifying the X, Y, and Z components of the direction cosine of the fluid surface normal.This argument is valid only when *definition*=UNDEX.

initialDepth

None or a Float specifying the initial depth of the UNDEX bubble. The default value is None.This argument is valid only when *definition*=UNDEX.

referenceMagnitude

A Float specifying the reference magnitude.This argument is not valid when *definition*=CONWEP.

detonationTime

A Float specifying the time of detonation, given in total time.This argument is valid only when *definition*=CONWEP.

magnitudeFactor

A Float specifying the magnitude scale factor. The default value is 1.0.This argument is valid only when *definition*=CONWEP.

Returns:

An IncidentWave object.

Notes

This function can be accessed by:

mdb.models[name].IncidentWave

IncidentWaveProperty(name: str, definition: SymbolicConstantType = 'PLANAR', propagationModel: SymbolicConstantType = 'ACOUSTIC', soundSpeed: float | None = None, fluidDensity: float | None = None, specificHeatRatio: float | None = None, gravity: float | None = None, atmosphericPressure: float | None = None, dragCoefficient: float | None = None, dragExponent: float = 2, waveEffects: BooleanType = 1, chargeDensity: float | None = None, chargeMass: float | None = None, constantK1: float | None = None, constantK2: float | None = None, constantA: float | None = None, constantB: float | None = None, constantKc: float | None = None, duration: float | None = None, maximumSteps: int = 1500, relativeStepControl: float | None = None, absoluteStepControl: float | None = None, stepControlExponent: float = 0, genDecayA: float = 0, genDecayB: float = 0, genDecayC: float = 0, seedNumber: int | None = None, massTNT: float | None = None, massFactor: float = 1, lengthFactor: float = 1, timeFactor: float = 1, pressureFactor: float = 1) → IncidentWaveProperty

This method creates an IncidentWaveProperty object.

Parameters:

name

A String specifying the interaction property repository key.

definition

A SymbolicConstant specifying the type of wave to be defined. Possible values are PLANAR, SPHERICAL, DIFFUSE, AIR_BLAST, and SURFACE_BLAST. The default value is PLANAR.

propagationModel

A SymbolicConstant specifying the spherical propagation model. Possible values are ACOUSTIC, UNDEX_CHARGE, and GENERALIZED_DECAY. The default value is ACOUSTIC.This argument is valid only when *definition*=SPHERICAL.

soundSpeed

A Float specifying the speed of sound in the fluid.This argument is not valid when *definition*=AIR_BLAST or when *definition*=SURFACE_BLAST.

fluidDensity

A Float specifying the fluid mass density.This argument is not valid when *definition*=AIR_BLAST or when *definition*=SURFACE_BLAST.

specificHeatRatio

None or a Float specifying the ratio of specific heats for gas. The default value is None.This argument is valid only when *definition*=SPHERICAL and *propagationModel*=UNDEX_CHARGE.

gravity

None or a Float specifying the acceleration due to gravity. The default value is None.This argument is valid only when *definition*=SPHERICAL and *propagationModel*=UNDEX_CHARGE.

atmosphericPressure

None or a Float specifying the atmospheric pressure. The default value is None.This argument is valid only when *definition*=SPHERICAL and *propagationModel*=UNDEX_CHARGE.

dragCoefficient

None or a Float specifying the fluid drag coefficient. The default value is None.This argument is valid only when *definition*=SPHERICAL and *propagationModel*=UNDEX_CHARGE.

dragExponent

A Float specifying the fluid drag exponent. The default value is 2.0.This argument is valid only when *definition*=SPHERICAL and *propagationModel*=UNDEX_CHARGE.

waveEffects

A Boolean specifying whether or not to include wave effects in the fluid and gas. The default value is ON.This argument is valid only when *definition*=SPHERICAL and *propagationModel*=UNDEX_CHARGE.

chargeDensity

None or a Float specifying the density of the charge material. The default value is None.This argument is valid only when *definition*=SPHERICAL and *propagationModel*=UNDEX_CHARGE.

chargeMass

None or a Float specifying the mass of the charge material. The default value is None.This argument is valid only when *definition*=SPHERICAL and *propagationModel*=UNDEX_CHARGE.

constantK1

None or a Float specifying the charge material constant K. The default value is None.This argument is valid only when *definition*=SPHERICAL and *propagationModel*=UNDEX_CHARGE.

constantK2

None or a Float specifying the charge material constant k. The default value is None.This argument is valid only when *definition*=SPHERICAL and *propagationModel*=UNDEX_CHARGE.

constantA

None or a Float specifying the charge material constant A. The default value is None.This argument is valid only when *definition*=SPHERICAL and *propagationModel*=UNDEX_CHARGE.

constantB

None or a Float specifying the charge material constant B. The default value is None.This argument is valid only when *definition*=SPHERICAL and *propagationModel*=UNDEX_CHARGE.

constantKc

None or a Float specifying the charge material constant Kc. The default value is None.This argument is valid only when *definition*=SPHERICAL and *propagationModel*=UNDEX_CHARGE.

duration

None or a Float specifying the time duration for the bubble simulation. The default value is None.This argument is valid only when *definition*=SPHERICAL and *propagationModel*=UNDEX_CHARGE.

maximumSteps

An Int specifying the maximum number of time steps for the bubble simulation. The default value is 1500.This argument is valid only when *definition*=SPHERICAL and *propagationModel*=UNDEX_CHARGE.

relativeStepControl

A Float specifying the relative step size control parameter. The default value is 1×10–11.This argument is valid only when *definition*=SPHERICAL and *propagationModel*=UNDEX_CHARGE.

absoluteStepControl

A Float specifying the absolute step size control parameter. The default value is 1×10–11.This argument is valid only when *definition*=SPHERICAL and *propagationModel*=UNDEX_CHARGE.

stepControlExponent

A Float specifying the step size control exponent. The default value is 0.2.This argument is valid only when *definition*=SPHERICAL and *propagationModel*=UNDEX_CHARGE.

genDecayA

A Float specifying the constant A associated with the generalized decay propagation model. The default value is 0.0.This argument is valid only when *definition*=SPHERICAL and *propagationModel*=GENERALIZED_DECAY.

genDecayB

A Float specifying the constant B associated with the generalized decay propagation model. The default value is 0.0.This argument is valid only when *definition*=SPHERICAL and *propagationModel*=GENERALIZED_DECAY.

genDecayC

A Float specifying the constant C associated with the generalized decay propagation model. The default value is 0.0.This argument is valid only when *definition*=SPHERICAL and *propagationModel*=GENERALIZED_DECAY.

seedNumber

An Int specifying the seed number (N) for the diffuse source calculation. N2 sources will be used in the simulation.This argument is valid only when *definition*=DIFFUSE.

massTNT

A Float specifying the equivalent mass of TNT, in any preferred mass unit.This argument is valid only when *definition*=AIR_BLAST or *definition*=SURFACE_BLAST.

massFactor

A Float specifying the multiplication factor to convert from the preferred mass unit to kilograms. The default value is 1.0.This argument is valid only when *definition*=AIR_BLAST or *definition*=SURFACE_BLAST.

lengthFactor

A Float specifying the multiplication factor to convert from the analysis length unit to meters. The default value is 1.0.This argument is valid only when *definition*=AIR_BLAST or *definition*=SURFACE_BLAST.

timeFactor

A Float specifying the multiplication factor to convert from the analysis time unit to seconds. The default value is 1.0.This argument is valid only when *definition*=AIR_BLAST or *definition*=SURFACE_BLAST.

pressureFactor

A Float specifying the multiplication factor to convert from the analysis pressure unit to pascals. The default value is 1.0.This argument is valid only when *definition*=AIR_BLAST or *definition*=SURFACE_BLAST.

Returns:

An IncidentWaveProperty object.

Notes

This function can be accessed by:

mdb.models[name].IncidentWaveProperty

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

This method creates an InertiaRelief object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created.

u1

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

u2

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

u3

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

ur1

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

ur2

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

ur3

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

referencePoint

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

localCoordinates

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

Returns:

An InertiaRelief object.

Notes

This function can be accessed by:

mdb.models[name].InertiaRelief

InitialState(name: str, instances: PartInstanceArray, fileName: str, endStep: SymbolicConstantType = 'LAST_STEP', endIncrement: SymbolicConstantType = 'STEP_END', updateReferenceConfiguration: BooleanType = 0) → InitialState

This method creates an InitialState predefined field object.

Parameters:

name

A String specifying the repository key.

instances

A PartInstanceArray object specifying the instances to which the predefined field is applied.

fileName

A String specifying the name of the job that generated the initial state data.

endStep

The SymbolicConstant LAST_STEP or an Int specifying the step from which the initial state values are to be read or the SymbolicConstant LAST_STEP. The default value is LAST_STEP.

endIncrement

The SymbolicConstant STEP_END or an Int specifying the increment, interval or iteration of the step set in endStep or the SymbolicConstant STEP_END. The default value is STEP_END.

updateReferenceConfiguration

A Boolean specifying whether to update the reference configuration based on the import data. The default value is OFF.

Returns:

An InitialState object.

Notes

This function can be accessed by:

mdb.models[name].InitialState

Instance(name: str, objectToCopy: PartInstance)

This method copies a PartInstance object from the specified model and creates a new PartInstance object.

Parameters:

name

A String specifying the repository key.

objectToCopy

A PartInstance object to be copied.

Returns:

A Model object.

Notes

This function can be accessed by:

mdb.models[name].Instance

IntegratedOutputSection(name: str, surface: ~abaqus.Region.Region.Region = <abaqus.Region.Region.Region object>, refPoint: ~abaqusConstants.SymbolicConstantType | None = None, refPointAtCenter: ~abaqusConstants.BooleanType = 0, refPointMotion: ~abaqusConstants.SymbolicConstantType = 'INDEPENDENT', localCsys: str | None = None, projectOrientation: ~abaqusConstants.BooleanType = 0) → IntegratedOutputSection

This method creates an IntegratedOutputSection object.

Parameters:

name

A String specifying the repository key.

surface

A Region object specifying the surface over which the output is based.

refPoint

None or a Region object specifying the anchor point about which the integrated moment over the output region is computed or the SymbolicConstant None representing the global origin. The default value is None.

refPointAtCenter

A Boolean specifying that the refPoint be adjusted so that it coincides with the center of the output region in the initial configuration. This argument is valid only when you include the refPoint argument. The default value is OFF.

refPointMotion

A SymbolicConstant specifying how to relate the motion of refPoint to the average motion of the output region. A value of INDEPENDENT will allow the refPoint to move independent of the output region. A value of AVERAGE_TRANSLATION will set the displacement of the refPoint equal to the average translation of the output region. A value of AVERAGE will set the displacement and rotation of the refPoint equal to the average translation of the output region. The default value is INDEPENDENT.This argument is valid only when you include the refPoint argument.

localCsys

None or a DatumCsys object specifying the local coordinate system used to express vector output. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

projectOrientation

A Boolean specifying that the coordinate system be projected onto the surface such that the 1–axis is normal to the surface. Projection onto a planar surface is such that the 1-axis is normal to the surface, and a projection onto a nonplanar surface is such that a least-squares fit surface will be used. The default value is OFF.

Returns:

An IntegratedOutputSection object.

Notes

This function can be accessed by:

mdb.models[name].IntegratedOutputSection

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

This method creates a InwardVolAccel object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created. This must be the name of the first analysis step.

region

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

magnitude

A Float specifying the load magnitude.

distributionType

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

field

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

amplitude

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

Returns:

An InwardVolAccel object.

Notes

This function can be accessed by:

mdb.models[name].InwardVolAccel

KinematicHardening(name: str, region: Region, numBackStress: int = 1, equivPlasticStrain: tuple = (), backStress: tuple = (), sectPtNum: tuple = (), definition: SymbolicConstantType = 'KINEMATIC_HARDENING', rebarLayerNames: tuple = (), distributionType: SymbolicConstantType = 'MAGNITUDE') → KinematicHardening

This method creates a KinematicHardening object.

Parameters:

name

A String specifying the repository key.

region

A Region object specifying the region to which the predefined field is applied.

numBackStress

An Int specifying the number of backstresses. The default value is 1.

equivPlasticStrain

A sequence of Floats specifying the initial equivalent Plastic strain.

backStress

A sequence of sequences of Floats specifying the initial backstress tensor for kinematic hardening models. The default value is an empty sequence.

sectPtNum

A sequence of Ints specifying section point numbers. This argument is valid only when *definition*=SECTION_PTS.

definition

A SymbolicConstant specifying different types of kinematic hardening. Possible values are KINEMATIC_HARDENING, CRUSHABLE_FOAM, REBAR, SECTION_PTS, and USER_DEFINED. The default value is KINEMATIC_HARDENING.

rebarLayerNames

A sequence of Strings specifying rebar layer names. This argument is valid only when *definition*=REBAR.

distributionType

A SymbolicConstant specifying whether the load is uniform. Possible values are MAGNITUDE and ANALYTICAL_FIELD. The default value is MAGNITUDE.

Returns:

A KinematicHardening object.

Notes

This function can be accessed by:

mdb.models[name].KinematicHardening

LProfile(name: str, a: float, b: float, t1: float, t2: float) → LProfile

This method creates a LProfile object.

Parameters:

name

A String specifying the repository key.

a

A positive Float specifying the a dimension (flange length) of the L profile. For more information, see [Beam cross-section library](https://help.3ds.com/2021/English/DSSIMULIA_Established/SIMACAEELMRefMap/simaelm-c-beamcrosssectlib.htm?ContextScope=all).

b

A positive Float specifying the b dimension (flange length) of the L profile.

t1

A positive Float specifying the t1 dimension (flange thickness) of the L profile (t1 < b).

t2

A positive Float specifying the t2 dimension (flange thickness) of the L profile (t2< a).

Returns:

A LProfile object.

Raises:

RangeError.

!img

Notes

This function can be accessed by:

mdb.models[name].LProfile
session.odbs[name].LProfile

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

This method creates a LineLoad object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created.

region

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

distributionType

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

field

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

comp1

A Float or a Complex specifying the component of the load in the global or the beam local 1-direction.Note:Although comp1, comp2, and comp3 are optional arguments, at least one of them must be nonzero unless *distributionType*=USER_DEFINED.

comp2

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

comp3

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

amplitude

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

system

A SymbolicConstant specifying whether the load is applied in a global or the beam local frame of reference. Possible values are GLOBAL and LOCAL. The default value is GLOBAL.

Returns:

A LineLoad object.

Notes

This function can be accessed by:

mdb.models[name].LineLoad

MPCSection(name: str, mpcType: SymbolicConstantType, userMode: SymbolicConstantType = 'DOF_MODE', userType: int = 0) → MPCSection

This method creates a MPCSection object.

Parameters:

name

A String specifying the repository key.

mpcType

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

userMode

A SymbolicConstant specifying the mode of the MPC when it is user-defined. Possible values are DOF_MODE and NODE_MODE. The default value is DOF_MODE.The userMode argument applies only when *mpcType*=USER_DEFINED.

userType

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

Returns:

A MPCSection object.

Raises:

RangeError and InvalidNameError.

Notes

This function can be accessed by:

mdb.models[name].MPCSection
session.odbs[name].MPCSection

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

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

MassDiffusionStep(name: str, previous: str, description: str = '', response: SymbolicConstantType = 'TRANSIENT', timePeriod: float = 1, timeIncrementationMethod: SymbolicConstantType = 'AUTOMATIC', maxNumInc: int = 100, initialInc: float | None = None, minInc: float | None = None, maxInc: float | None = None, end: SymbolicConstantType = 'PERIOD', dcmax: float = 0, amplitude: SymbolicConstantType = 'STEP', extrapolation: SymbolicConstantType = 'LINEAR', maintainAttributes: BooleanType = False, convertSDI: SymbolicConstantType = 'PROPAGATED') → MassDiffusionStep

This method creates a MassDiffusionStep object.

Parameters:

name

A String specifying the repository key.

previous

A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

description

A String specifying a description of the new step. The default value is an empty string.

response

A SymbolicConstant specifying the analysis type. Possible values are STEADY_STATE and TRANSIENT. The default value is TRANSIENT.

timePeriod

A Float specifying the total time period. The default value is 1.0.

timeIncrementationMethod

A SymbolicConstant specifying the time incrementation method to be used. Possible values are FIXED and AUTOMATIC. The default value is AUTOMATIC.

maxNumInc

An Int specifying the maximum number of increments in a step. The default value is 100.

initialInc

A Float specifying the initial time increment. The default value is the total time period for the step.

minInc

A Float specifying the minimum time increment allowed. The default value is the smaller of 0.8 times the initial time increment or 10−5 times the total time period.

maxInc

A Float specifying the maximum time increment allowed. The default value is the total time period for the step.

end

A SymbolicConstant specifying the time period to be analyzed in a transient analysis. Possible values are PERIOD and SS. The default value is PERIOD.

dcmax

A Float specifying the maximum normalized concentration change to be allowed in an increment. The default value is 0.0.

amplitude

A SymbolicConstant specifying the amplitude variation for loading magnitudes during the step. The default is STEP. Possible values are STEP and RAMP.

extrapolation

A SymbolicConstant specifying the type of extrapolation to use in determining the incremental solution for a nonlinear analysis. Possible values are NONE, LINEAR, and PARABOLIC. The default value is LINEAR.

maintainAttributes

A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is False.

convertSDI

A SymbolicConstant specifying whether to force a new iteration if severe discontinuities occur during an iteration. Possible values are PROPAGATED, CONVERT_SDI_OFF, and CONVERT_SDI_ON. The default value is PROPAGATED.

Returns:

step: MassDiffusionStep

A MassDiffusionStep object.

Notes

This function can be accessed by:

mdb.models[name].MassDiffusionStep

Material(name: str, description: str = '', materialIdentifier: str = '')

This method creates a Material object.

Parameters:

name

A String specifying the name of the new material.

description

A String specifying user description of the material. The default value is an empty string.

materialIdentifier

A String specifying material identifier for customer use. The default value is an empty string.

Returns:

A Material object.

Notes

This function can be accessed by:

mdb.models[name].Material

MaterialAssignment(name: str, instanceList: PartInstanceArray, useFields: BooleanType = 0, assignmentList: tuple = (), fieldList: tuple = (), colorList: tuple = ()) → MaterialAssignment

This method creates a MaterialAssignment predefined field object.

Parameters:

name

A String specifying the repository key.

instanceList

A PartInstanceArray object specifying the part instances to which the predefined field is applied. All instances must be assigned the same Eulerian section.

useFields

A Boolean specifying whether the volume fraction data will be uniform or defined by discrete fields. The default value is OFF.

assignmentList

A sequence of tuples specifying the uniform volume fractions to be assigned. This argument is valid only when useFields*=FALSE. Each tuple contains two entries:A Region object.A tuple of Floats specifying the uniform volume fraction values. The length of the tuple must match the number of material instance names specified in the Eulerain section assigned to part instances specified by *instanceList.

fieldList

A sequence of tuples specifying the discrete volume fractions to be assigned. This argument is valid only when useFields*=TRUE. Each tuple contains two entries:A Region object.A tuple of Strings specifying Discrete Field names. The length of the tuple must match the number of material instance names specified in the Eulerain section assigned to part instances specified by *instanceList.

colorList

A sequence of three Ints specifying colors used to display the material instance assignments. This is a sequence of R,G,B colors, where the values are represented by integers between 0 and 255. The default value is an empty sequence.

Returns:

A MaterialAssignment object.

Notes

This function can be accessed by:

mdb.models[name].MaterialAssignment

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

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

MembraneSection(name: str, material: str, thickness: float = 1, thicknessType: SymbolicConstantType = 'UNIFORM', poissonDefinition: SymbolicConstantType = 'DEFAULT', poisson: float = 0, thicknessField: str = '') → MembraneSection

This method creates a MembraneSection object.

Parameters:

name

A String specifying the repository key.

material

A String specifying the name of the material.

thickness

A Float specifying the thickness for the section. Possible values are thickness >> 0.0. The default value is 1.0.

thicknessType

A SymbolicConstant specifying the distribution used for defining the thickness of the elements. Possible values are UNIFORM, ANALYTICAL_FIELD, and DISCRETE_FIELD. The default value is UNIFORM.

poissonDefinition

A SymbolicConstant specifying whether to use the default value for the Poisson’s ratio. Possible values are:DEFAULT, specifying that the default value for the Poisson’s ratio is 0.5 in an Abaqus/Standard analysis and is obtained from the material definition in an Abaqus/Explicit analysis.VALUE, specifying that the Poisson’s ratio used in the analysis is the value provided in poisson.The default value is DEFAULT.

poisson

A Float specifying the section Poisson’s ratio. Possible values are −1.0 ≤≤ poisson ≤≤ 0.5. This argument is valid only when *poissonDefinition*=VALUE. The default value is 0.5.

thicknessField

A String specifying the name of the AnalyticalField or DiscreteField object used to define the thickness of the shell elements. The thicknessField argument applies only when *thicknessType*=ANALYTICAL_FIELD or *thicknessType*=DISCRETE_FIELD. The default value is an empty string.

Returns:

A MembraneSection object.

Raises:

RangeError and InvalidNameError.

Notes

This function can be accessed by:

mdb.models[name].MembraneSection
session.odbs[name].MembraneSection

ModalDynamicsStep(name: str, previous: str, description: str = '', continueAnalysis: ~abaqusConstants.BooleanType = 0, timePeriod: float = 1, incSize: float = 1, directDamping: ~abaqus.StepMiscellaneous.DirectDamping.DirectDamping = <abaqus.StepMiscellaneous.DirectDamping.DirectDamping object>, compositeDamping: ~abaqus.StepMiscellaneous.CompositeDamping.CompositeDamping = <abaqus.StepMiscellaneous.CompositeDamping.CompositeDamping object>, rayleighDamping: ~abaqus.StepMiscellaneous.RayleighDamping.RayleighDamping = <abaqus.StepMiscellaneous.RayleighDamping.RayleighDamping object>, amplitude: ~abaqusConstants.SymbolicConstantType = 'STEP', maintainAttributes: ~abaqusConstants.BooleanType = False, directDampingByFrequency: ~abaqus.StepMiscellaneous.DirectDampingByFrequency.DirectDampingByFrequency = <abaqus.StepMiscellaneous.DirectDampingByFrequency.DirectDampingByFrequency object>, rayleighDampingByFrequency: ~abaqus.StepMiscellaneous.RayleighDampingByFrequency.RayleighDampingByFrequency = <abaqus.StepMiscellaneous.RayleighDampingByFrequency.RayleighDampingByFrequency object>) → ModalDynamicsStep

This method creates a ModalDynamicsStep object.

Parameters:

name

A String specifying the repository key.

previous

A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

description

A String specifying a description of the new step. The default value is an empty string.

continueAnalysis

A Boolean specifying that the step starts with zero initial conditions. The default value is OFF.

timePeriod

A Float specifying the total time period. The default value is 1.0.

incSize

A Float specifying the time increment to be used. The default value is 1.0.

directDamping

A DirectDamping object.

compositeDamping

A CompositeDamping object.

rayleighDamping

A RayleighDamping object.

amplitude

A SymbolicConstant specifying the amplitude variation for loading magnitudes during the step. Possible values are STEP and RAMP. The default value is STEP.

maintainAttributes

A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is False.

directDampingByFrequency

A DirectDampingByFrequency object.

rayleighDampingByFrequency

A RayleighDampingByFrequency object.

Returns:

step: ModalDynamicsStep

A ModalDynamicsStep object.

Notes

This function can be accessed by:

mdb.models[name].ModalDynamicsStep

ModelChange(name: str, createStepName: str, isRestart: ~abaqusConstants.BooleanType = 0, regionType: ~abaqusConstants.SymbolicConstantType = 'GEOMETRY', region: ~abaqus.Region.Region.Region = <abaqus.Region.Region.Region object>, activeInStep: ~abaqusConstants.BooleanType = 0, includeStrain: ~abaqusConstants.BooleanType = 0) → ModelChange

This method creates a ModelChange object.

Parameters:

name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which the ModelChange object is created.

isRestart

A Boolean specifying whether this interaction is being used solely to indicate that model change may be required in a subsequent restart analysis (either for elements or contact pairs). The default value is OFF.

regionType

A SymbolicConstant specifying the region selection type. This argument is valid only when *isRestart*=False. Possible values are GEOMETRY, SKINS, STRINGERS, and ELEMENTS. The default value is GEOMETRY.

region

A Region object specifying the elements to be removed or reactivated. This argument is valid only when *isRestart*=False.

activeInStep

A Boolean specifying whether elements are being removed or reactivated. This argument is valid only when *isRestart*=False. The default value is OFF.

includeStrain

A Boolean specifying whether stress/displacement elements are reactivated with strain. This argument is valid only when *isRestart*=False and when *activeInStep*=True. The default value is OFF.

Returns:

A ModelChange object.

Notes

This function can be accessed by:

mdb.models[name].ModelChange

ModelFromInputFile(name: str, inputFileName: str)

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

Parameters:

name

A String specifying the repository key.

inputFileName

A String specifying the name of the input file (including the .inp extension) to be parsed into the new model. This String can also be the full path to the input file if it is located in another directory.

Returns:

A Model object.

Notes

This function can be accessed by:

mdb.Model

ModelFromNastranFile(modelName: str, inputFileName: str, sectionConsolidation: SymbolicConstantType = 'PRESERVE_SECTION', preIntegratedShell: BooleanType = 0, weightMassScaling: BooleanType = 1, loadCases: BooleanType = 1, coupleBeamOffsets: BooleanType = 1, cbar: str = 'B31', cquad4: str = 'S4', chexa: str = 'C3D8I', ctetra: str = 'C3D10', keepTranslatedFiles: BooleanType = 1)

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. The default values is discussed in following and can be defined alternatively in the Abaqus environment file as the one used for the translator from Nastran to Abaqus. For more information, see Translating Nastran data to Abaqus files.

Parameters:

modelName

A String specifying the repository key.

inputFileName

A String specifying the name of the Nastran input file (including the .bdf, .dat, .nas, .nastran, .blk, .bulk extension) to be read into the new model. This String can also be the full path to the Nastran input file if it is located in another directory.

sectionConsolidation

A SymbolicConstant specifying the method used to create shell section. Possible values are PRESERVE_SECTION, GROUP_BY_MATERIAL, and NONE. If PRESERVE_SECTION is used, an Abaqus section is created corresponding to each shell property ID. If GROUP_BY_MATERIAL is used, a single Abaqus section is created for all homogeneous elements referencing the same material. In both cases, material orientations and offsets are created using discrete fields. If NONE is used, a separate shell section is created for each combination of orientation, material offset, and/or thickness. The default is PRESERVE_SECTION.

preIntegratedShell

A Boolean specifying whether the pre-integrated shell section is created in default for shell element. The default value is OFF.

weightMassScaling

A Boolean specifying whether the value on the Nastran data line PARAM, WTMASS is used as a multiplier for all density, mass, and rotary inertia values created in the Abaqus input file. The default value is ON.

loadCases

A Boolean specifying whether each SUBCASE for linear static analyses is translated to a LOAD CASE option, and all such LOAD CASE options are grouped in a single STEP option. The default value is ON.

coupleBeamOffsets

A Boolean specifying whether to translate the beam element connectivity to newly created nodes at the offset location and rigidly coupling the new and original nodes. If not, beam element offsets are translated to the CENTROID and SHEAR CENTER options, which are suboptions of the BEAM GENERAL SECTION option. The default value is ON. When the beam element references a PBARL or PBEAML property or if the beam offset has a significant component in the direction of the beam axis, the setting for this argument is always ON.

cbar

A String specifying the 2-node beam that is created from CBAR and CBEAM elements. Possible values are B31 and B33. The default is B31.

cquad4

A String specifying the 4-node shell that is created from CQUAD4 elements. Possible values are S4 and S4R. The default is S4. If a reduced-integration element is chosen, the enhanced hourglass formulation is applied automatically.

chexa

A String specifying the 8-node brick that is created from CHEXA elements. Possible values are C3D8I, C3D8 and C3D8R. The default is C3D8I. If a reduced-integration element is chosen, the enhanced hourglass formulation is applied automatically.

ctetra

A String specifying the 10-node tetrahedron that is created from CTETRA elements. Possible values are C3D10 and C3D10M. The default is C3D10.

keepTranslatedFiles

A Boolean specifying whether to keep the generated Abaqus input file after the model is created from the Nastran input file. The default value is ON.

Returns:

A Model object.

Notes

This function can be accessed by:

mdb.Model

ModelFromOdbFile(name: str, odbFileName: str)

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

Parameters:

name

A String specifying the repository key.

odbFileName

A String specifying the name of the output database file (including the .odb extension) to be read into the new model. This String can also be the full path to the output database file if it is located in another directory.

Returns:

A Model object.

Notes

This function can be accessed by:

mdb.Model

ModulatedAmplitude(name: str, initial: float, magnitude: float, start: float, frequency1: float, frequency2: float, timeSpan: SymbolicConstantType = 'STEP') → ModulatedAmplitude

This method creates a ModulatedAmplitude object.

Parameters:

name

A String specifying the repository key.

initial

A Float specifying the constant A0A0.

magnitude

A Float specifying the coefficient AA.

start

A Float specifying the starting time t0t0. Possible values are non-negative numbers.

frequency1

A Float specifying the circular frequency 1 (ω1ω1). Possible values are positive numbers.

frequency2

A Float specifying the circular frequency 2 (ω2ω2). Possible values are positive numbers.

timeSpan

A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:

A ModulatedAmplitude object.

Raises:

InvalidNameError

RangeError

Notes

This function can be accessed by:

mdb.models[name].ModulatedAmplitude
session.odbs[name].ModulatedAmplitude

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

This method creates a Moment object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created.

region

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

cm1

A Float or a Complex specifying the load component in the 4-direction.Note:Although comp1, comp2, and comp3 are optional arguments, at least one of them must be nonzero.

cm2

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

cm3

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

amplitude

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

follower

A Boolean specifying whether the direction of the force rotates with the rotation of the node. You should provide the follower argument only if it is valid for the specified step. The default value is OFF.

localCsys

None or a DatumCsys object specifying the ID of the Datum coordinate system used as the local coordinate system of the load. If *localCsys*=None, the load is defined in the global coordinate system. When this member is queried, it returns an Int. The default value is None.

distributionType

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

field

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

Returns:

A Moment object.

Notes

This function can be accessed by:

mdb.models[name].Moment

MultipointConstraint(name: str, surface: Region, controlPoint: Region, mpcType: SymbolicConstantType, csys: str | None = None, userType: int = 0, userMode: SymbolicConstantType = 'DOF_MODE_MPC') → MultipointConstraint

This method creates a MultipointConstraint object.

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

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

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.

Notes

This function can be accessed by:

mdb.models[name].MultipointConstraint

OperatorFilter(name: str, cutoffFrequency: float, order: int = 2, operation: SymbolicConstantType = 'NONE', halt: BooleanType = 0, limit: float | None = None, invariant: SymbolicConstantType = 'NONE') → OperatorFilter

This method creates an OperatorFilter object.

Parameters:

name

A String specifying the repository key. This name ANTIALIASING is reserved for filters generated internally by the program.

cutoffFrequency

A Float specifying the attenuation point of the filter. Possible values are non-negative numbers. Order is not available for OperatorFilter.

order

An Int specifying the highest power of the filter transfer function. Possible values are non-negative numbers less than or equal to 20. Order is not available for OperatorFilter. The default value is 2.

operation

A SymbolicConstant specifying the filter operator. Possible values are NONE, MIN, MAX, and ABS. The default value is NONE.

halt

A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is OFF.

limit

None or a Float specifying the threshold limit, an upper or lower bound for output values depending on the operation, or a bound for stopping the analysis when Halt is used. The default value is None.

invariant

A SymbolicConstant specifying the invariant to which filtering is applied. Possible values are NONE, FIRST, and SECOND. The default value is NONE.

Returns:

An OperatorFilter object.

Raises:

InvalidNameError

RangeError

Notes

This function can be accessed by:

mdb.models[name].OperatorFilter
session.odbs[name].OperatorFilter

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

This method creates a PEGLoad object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created.

region

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

distributionType

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

field

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

comp1

A Float or a Complex specifying the load component at dof 1 of reference node 1.Note:Although comp1, comp2, and comp3 are optional arguments, at least one of them must be nonzero.

comp2

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

comp3

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

amplitude

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

Returns:

A PEGLoad object.

Notes

This function can be accessed by:

mdb.models[name].PEGLoad

PEGSection(name: str, material: str, thickness: float = 1, wedgeAngle1: float = 0, wedgeAngle2: float = 0) → PEGSection

This method creates a PEGSection object.

Parameters:

name

A String specifying the repository key.

material

A String specifying the name of the material.

thickness

A Float specifying the thickness of the section. Possible values are thickness >> 0.0. The default value is 1.0.

wedgeAngle1

A Float specifying the value of the x component of the angle between the bounding planes, ΔϕxΔ⁢ϕx. The default value is 0.0.

wedgeAngle2

A Float specifying the value of the y component of the angle between the bounding planes, ΔϕyΔ⁢ϕy. The default value is 0.0.

Returns:

A PEGSection object.

Raises:

InvalidNameError

RangeError

Notes

This function can be accessed by:

mdb.models[name].PEGSection
session.odbs[name].PEGSection

Part(name: str, dimensionality: SymbolicConstantType, type: SymbolicConstantType, twist: BooleanType = 0)

This method creates a Part object and places it in the parts repository.

Parameters:

name

A String specifying the repository key.

dimensionality

A SymbolicConstant specifying the dimensionality of the part. Possible values are THREE_D, TWO_D_PLANAR, and AXISYMMETRIC.

type

A SymbolicConstant specifying the type of the part. Possible values are DEFORMABLE_BODY, EULERIAN, DISCRETE_RIGID_SURFACE, and ANALYTIC_RIGID_SURFACE.

twist

A Boolean specifying whether to include a twist DEGREE OF FREEDOM in the part (only available when *dimensionality*=AXISYMMETRIC and *type*=DEFORMABLE_BODY). The default value is OFF.

Returns:

A Part object.

Notes

This function can be accessed by:

mdb.models[name].Part

PeriodicAmplitude(name: str, frequency: float, start: float, a_0: float, data: tuple, timeSpan: SymbolicConstantType = 'STEP') → PeriodicAmplitude

This method creates a PeriodicAmplitude object.

Parameters:

name

A String specifying the repository key.

frequency

A Float specifying the circular frequency ωω. Possible values are positive numbers.

start

A Float specifying the starting time t0t0. Possible values are positive numbers.

a_0

A Float specifying the constant A0A0.

data

A sequence of pairs of Floats specifying AiAi and BiBi pairs.

timeSpan

A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:

A PeriodicAmplitude object.

Raises:

InvalidNameError

RangeError

Notes

This function can be accessed by:

mdb.models[name].PeriodicAmplitude
session.odbs[name].PeriodicAmplitude

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

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

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

This method creates a Pressure object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the pressure is created.

region

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

magnitude

A Float specifying the pressure magnitude.Note:magnitude is optional if *distributionType*=USER_DEFINED.

diameter

A Float specifying the effective inner or outer diameter.

hZero

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

hReference

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

field

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

amplitude

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

distributionType

A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM, HYDROSTATIC, USER_DEFINED, and FIELD. The default value is UNIFORM.

side

A SymbolicConstant specifying whether the pressure is applied internally or externally. Possible values are INTERNAL and EXTERNAL. The default value is INTERNAL.

Returns:

A PipePressure object.

Notes

This function can be accessed by:

mdb.models[name].PipePressure

PipeProfile(name: str, r: float, t: float) → PipeProfile

This method creates a PipeProfile object.

Parameters:

name

A String specifying the repository key.

r

A Float specifying the outer radius of the pipe. For more information, see [Beam cross-section library](https://help.3ds.com/2021/English/DSSIMULIA_Established/SIMACAEELMRefMap/simaelm-c-beamcrosssectlib.htm?ContextScope=all).

t

A Float specifying the wall thickness of the pipe.

Returns:

A PipeProfile object.

Raises:

RangeError.

!img

Notes

This function can be accessed by:

mdb.models[name].PipeProfile
session.odbs[name].PipeProfile

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

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

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

This method creates a Pressure object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the pressure is created.

region

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

magnitude

A Float or a Complex specifying the pressure magnitude.Note:magnitude is optional if *distributionType*=USER_DEFINED.

hZero

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

hReference

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

field

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

refPoint

A Region specifying the reference point from which the relative velocity is determined when *distributionType*=STAGNATION or VISCOUS.

distributionType

A SymbolicConstant specifying how the pressure is distributed spatially. Possible values are UNIFORM, USER_DEFINED, FIELD, HYDROSTATIC, STAGNATION, VISCOUS, TOTAL_FORCE, and DISCRETE_FIELD. The default value is UNIFORM.

amplitude

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

Returns:

A Pressure object.

Notes

This function can be accessed by:

mdb.models[name].Pressure

PressurePenetration(name: str, createStepName: str, contactInteraction: str, mainPoints: RegionArray, secondaryPoints: RegionArray, penetrationPressure: float, criticalPressure: float, amplitude: str = 'UNSET', penetrationTime: float = 0) → PressurePenetration

This method creates a PressurePenetration object.

Parameters:

name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which the PressurePenetration object is created.

contactInteraction

A String specifying the name of the Surface-to-surface contact (Standard) interaction.

mainPoints

A RegionArray object specifying the points on the master surface that are exposed to the fluid.

secondaryPoints

A RegionArray object specifying the points on the slave surface that are exposed to the fluid.

penetrationPressure

A tuple of Floats specifying the fluid pressure magnitude. For steady state dynamic analyses, a tuple of Complexes specifying the fluid pressure magnitude.

criticalPressure

A tuple of Floats specifying the critical contact pressure below which fluid penetration starts to occur.

amplitude

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

penetrationTime

A Float specifying the fraction of the current step time over which the fluid pressure on newly penetrated contact surface segments is ramped up to the current magnitude. The default value is 0.001.

Returns:

A PressurePenetration object.

Notes

This function can be accessed by:

mdb.models[name].PressurePenetration

PsdDefinition(name: str, data: tuple, unitType: SymbolicConstantType = 'FORCE', referenceGravityAcceleration: float = 1, referenecePower: float = 0, user: BooleanType = 0, timeSpan: SymbolicConstantType = 'STEP', amplitude: str = '') → PsdDefinition

This method creates a PsdDefinition object.

Parameters:

name

A String specifying the repository key.

data

A sequence of sequences of Floats specifying the real part of the frequency function, the imaginary part of the frequency function, and the frequency or frequency band number values, depending on the value of unitType.

unitType

A SymbolicConstant specifying the type of units for specifying the frequency function. FORCE implies power units. BASE implies gravity used to define base motion. DB implies decibel units. Possible values are FORCE, BASE, and DB. The default value is FORCE.

referenceGravityAcceleration

A Float specifying the reference gravity acceleration. This argument applies when unitType = BASE. The default value is 1.0.

referenecePower

A Float specifying the reference power value, in load units squared. This argument applies when unitType = DB. The default value is 0.0.

user

A Boolean specifying whether the frequency function is defined in user subroutine UPSD. If specified, then data is not applicable, and the unitType value must not be DB. The default value is OFF.

timeSpan

A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

amplitude

A String specifying the name of the amplitude that describes the dynamic event used to define the cross-spectral density frequency function. The default value is an empty string.

Returns:

A PsdDefinition object.

Raises:

InvalidNameError

RangeError

Notes

This function can be accessed by:

mdb.models[name].PsdDefinition
session.odbs[name].PsdDefinition

RadiationToAmbient(name: str, createStepName: str, surface: Region, emissivity: float, field: str = '', distributionType: SymbolicConstantType = 'UNIFORM', radiationType: SymbolicConstantType = 'AMBIENT', ambientTemperature: float = 0, ambientTemperatureAmp: str = '') → RadiationToAmbient

This method creates a RadiationToAmbient object.

Parameters:

name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which the RadiationToAmbient object is created.

surface

A Region object specifying the surface to which the radiation interaction is applied.

emissivity

A Float specifying the emissivity, ϵϵ.

field

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

distributionType

A SymbolicConstant specifying how the radiation is distributed. This argument applies only when *radiationType*=AMBIENT. Possible values are UNIFORM and ANALYTICAL_FIELD. The default value is UNIFORM.

radiationType

A SymbolicConstant specifying whether to use the default surface radiation behavior, or the cavity radiation approximation. Possible values are AMBIENT and CAVITY. The default value is AMBIENT.

ambientTemperature

A Float specifying the reference ambient temperature, θ0θ0. This argument applies only when *radiationType*=AMBIENT. The default value is 0.0.

ambientTemperatureAmp

A String specifying the name of the Amplitude object that gives the variation of the ambient temperature with time.Note:Use None in an Abaqus/Standard analysis to specify that the reference ambient temperature is applied immediately at the beginning of the step or linearly over the step. Use None in an Abaqus/Explicit analysis to specify that the reference ambient temperature is applied throughout the step. This argument applies only when *radiationType*=AMBIENT.

Returns:

A RadiationToAmbient object.

Notes

This function can be accessed by:

mdb.models[name].RadiationToAmbient

RandomResponseStep(name: str, previous: str, freq: ~abaqus.StepMiscellaneous.RandomResponseFrequencyArray.RandomResponseFrequencyArray, description: str = '', scale: ~abaqusConstants.SymbolicConstantType = 'LOG', directDamping: ~abaqus.StepMiscellaneous.DirectDamping.DirectDamping = <abaqus.StepMiscellaneous.DirectDamping.DirectDamping object>, compositeDamping: ~abaqus.StepMiscellaneous.CompositeDamping.CompositeDamping = <abaqus.StepMiscellaneous.CompositeDamping.CompositeDamping object>, rayleighDamping: ~abaqus.StepMiscellaneous.RayleighDamping.RayleighDamping = <abaqus.StepMiscellaneous.RayleighDamping.RayleighDamping object>, structuralDamping: ~abaqus.StepMiscellaneous.StructuralDamping.StructuralDamping = <abaqus.StepMiscellaneous.StructuralDamping.StructuralDamping object>, directDampingByFrequency: ~abaqus.StepMiscellaneous.DirectDampingByFrequency.DirectDampingByFrequency = <abaqus.StepMiscellaneous.DirectDampingByFrequency.DirectDampingByFrequency object>, rayleighDampingByFrequency: ~abaqus.StepMiscellaneous.RayleighDampingByFrequency.RayleighDampingByFrequency = <abaqus.StepMiscellaneous.RayleighDampingByFrequency.RayleighDampingByFrequency object>, structuralDampingByFrequency: ~abaqus.StepMiscellaneous.StructuralDampingByFrequency.StructuralDampingByFrequency = <abaqus.StepMiscellaneous.StructuralDampingByFrequency.StructuralDampingByFrequency object>, maintainAttributes: ~abaqusConstants.BooleanType = False) → RandomResponseStep

This method creates a RandomResponseStep object.

Parameters:

name

A String specifying the repository key.

previous

A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

freq

A RandomResponseFrequencyArray object specifying frequencies over ranges of modes.

description

A String specifying a description of the new step. The default value is an empty string.

scale

A SymbolicConstant specifying the frequency scale. Possible values are LINEAR and LOG. The default value is LOG.

directDamping

A DirectDamping object.

compositeDamping

A CompositeDamping object.

rayleighDamping

A RayleighDamping object.

structuralDamping

A StructuralDamping object.

directDampingByFrequency

A DirectDampingByFrequency object.

rayleighDampingByFrequency

A RayleighDampingByFrequency object.

structuralDampingByFrequency

A StructuralDampingByFrequency object.

maintainAttributes

A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is False.

Returns:

step: RandomResponseStep

A RandomResponseStep object.

Notes

This function can be accessed by:

mdb.models[name].RandomResponseStep

RectangularProfile(name: str, a: float, b: float) → RectangularProfile

This method creates a RectangularProfile object.

Parameters:

name

A String specifying the repository key.

a

A positive Float specifying the a dimension of the rectangular profile. For more information, see [Beam cross-section library](https://help.3ds.com/2021/English/DSSIMULIA_Established/SIMACAEELMRefMap/simaelm-c-beamcrosssectlib.htm?ContextScope=all).

b

A positive Float specifying the b dimension of the rectangular profile.

Returns:

A RectangularProfile object.

Raises:

RangeError.

!img

Notes

This function can be accessed by:

mdb.models[name].RectangularProfile
session.odbs[name].RectangularProfile

RemeshingRule(name: str, stepName: str, variables: tuple, description: str = '', region: SymbolicConstantType = 'MODEL', sizingMethod: SymbolicConstantType = 'DEFAULT', errorTarget: float = 0, maxSolutionErrorTarget: float = 0, minSolutionErrorTarget: float = 0, meshBias: int = 0, minElementSize: float = 0, maxElementSize: float = 0, outputFrequency: SymbolicConstantType = 'LAST_INCREMENT', specifyMinSize: BooleanType = 0, specifyMaxSize: BooleanType = 1, coarseningFactor: SymbolicConstantType = 'DEFAULT_LIMIT', refinementFactor: SymbolicConstantType = 'DEFAULT_LIMIT', elementCountLimit: int | None = None) → RemeshingRule

This method creates a RemeshingRule object.

Parameters:

name

A String specifying the name of the object.

stepName

A String specifying the name of the step in which resizing should occur for this rule.

variables

A sequence of Strings specifying the output request variables that Abaqus will use as error indicators.

description

A String specifying a descriptive string for this rule. The default value is an empty string.

region

The SymbolicConstant MODEL or a Region object specifying the region in which Abaqus will remesh and generate output. The SymbolicConstant MODEL represents the entire applicable model. The default value is MODEL.

sizingMethod

A SymbolicConstant specifying the method for calculating the new mesh sizes. The SymbolicConstant DEFAULT indicates that Abaqus will use the default calculation method for each individual variable. Possible values are DEFAULT, UNIFORM_ERROR, and MINIMUM_MAXIMUM. The default value is DEFAULT.

errorTarget

A Float specifying the target error percentage for each variable in the region. A value of 0.0 indicates that Abaqus will use automated error target reduction for the region. You use the errorTarget argument when *sizingMethod*=UNIFORM_ERROR. The default value is 0.0.

maxSolutionErrorTarget

A Float specifying the target error percentage at the location of the maximum solution value in the region. A value of 0.0 indicates that Abaqus will use automated error target reduction for the region. You use the maxSolutionErrorTarget argument when *sizingMethod*=MINIMUM_MAXIMUM. The default value is 0.0.

minSolutionErrorTarget

A Float specifying the target error percentage at the location of the minimum solution value in the region. A value of 0.0 indicates that Abaqus will use automated error target reduction for the region. You use the minSolutionErrorTarget argument when *sizingMethod*=MINIMUM_MAXIMUM. The default value is 0.0.

meshBias

An Int specifying an indication of how much Abaqus will bias the mesh toward the location of the maximum solution value in the region. The higher the value, the more the mesh will bias towards the location of the maximum solution value. You use the meshBias argument when *sizingMethod*=MINIMUM_MAXIMUM. The default value is 0.0.

minElementSize

A Float specifying the minimum size of any single element. The default value is 0.0.

maxElementSize

A Float specifying the maximum size of any single element. The default value is 0.0.

outputFrequency

A SymbolicConstant specifying the frequency with which the error indicators are saved to the output database file (.odb). Possible values are LAST_INCREMENT and ALL_INCREMENTS. The default value is LAST_INCREMENT.

specifyMinSize

A Boolean specifying an indication of whether to use a user-supplied minimum element size or to calculate a characteristic minimum element size. The default value is OFF.

specifyMaxSize

A Boolean specifying an indication of whether to use a user-supplied maximum element size or to calculate a characteristic maximum element size. The default value is ON.

coarseningFactor

A SymbolicConstant or an Int specifying an indication of the upper limit on the element growth from one remeshing iteration to the next. Possible values are DEFAULT_LIMIT and NOT_ALLOWED. The default value is DEFAULT_LIMIT.

refinementFactor

A SymbolicConstant or an Int specifying an indication of the upper limit on element shrinkage from one remeshing iteration to the next. Possible values are DEFAULT_LIMIT and NOT_ALLOWED. The default value is DEFAULT_LIMIT.

elementCountLimit

None or an Int specifying an approximate limit on the number of elements that will be created during remeshing. Use None to indicate there is not upper limit. The default value is None.

Returns:

A RemeshingRule object

Notes

This function can be accessed by:

mdb.models[name].AdaptiveMeshConstraint

ResponseSpectrumStep(name: str, previous: str, components: ~abaqus.StepMiscellaneous.ResponseSpectrumComponentArray.ResponseSpectrumComponentArray, description: str = '', comp: ~abaqusConstants.SymbolicConstantType = 'SINGLE_DIRECTION', sum: ~abaqusConstants.SymbolicConstantType = 'ABS', directDamping: ~abaqus.StepMiscellaneous.DirectDamping.DirectDamping = <abaqus.StepMiscellaneous.DirectDamping.DirectDamping object>, compositeDamping: ~abaqus.StepMiscellaneous.CompositeDamping.CompositeDamping = <abaqus.StepMiscellaneous.CompositeDamping.CompositeDamping object>, rayleighDamping: ~abaqus.StepMiscellaneous.RayleighDamping.RayleighDamping = <abaqus.StepMiscellaneous.RayleighDamping.RayleighDamping object>, directDampingByFrequency: ~abaqus.StepMiscellaneous.DirectDampingByFrequency.DirectDampingByFrequency = <abaqus.StepMiscellaneous.DirectDampingByFrequency.DirectDampingByFrequency object>, rayleighDampingByFrequency: ~abaqus.StepMiscellaneous.RayleighDampingByFrequency.RayleighDampingByFrequency = <abaqus.StepMiscellaneous.RayleighDampingByFrequency.RayleighDampingByFrequency object>, maintainAttributes: ~abaqusConstants.BooleanType = False) → ResponseSpectrumStep

This method creates a ResponseSpectrumStep object.

Parameters:

name

A String specifying the repository key.

previous

A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

components

A ResponseSpectrumComponentArray object.

description

A String specifying a description of the new step. The default value is an empty string.

comp

A SymbolicConstant specifying the order and method used to sum the components. Possible values are SINGLE_DIRECTION, MULTIPLE_DIRECTION_ABSOLUTE_SUM, MULTIPLE_DIRECTION_SRSS_SUM, MULTIPLE_DIRECTION_THIRTY_PERCENT_RULE, and MULTIPLE_DIRECTION_FORTY_PERCENT_RULE. The default value is SINGLE_DIRECTION.

sum

A SymbolicConstant specifying the method used to sum the components. Possible values are ABS, CQC, NRL, SRSS, TENP, DSC, and GRP. The default value is ABS.

directDamping

A DirectDamping object.

compositeDamping

A CompositeDamping object.

rayleighDamping

A RayleighDamping object.

directDampingByFrequency

A DirectDampingByFrequency object.

rayleighDampingByFrequency

A RayleighDampingByFrequency object.

maintainAttributes

A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is False.

Returns:

step: ResponseSpectrumStep

A ResponseSpectrumStep object.

Notes

This function can be accessed by:

mdb.models[name].ResponseSpectrumStep

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

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

RigidBody(name: str, refPointRegion: Region, bodyRegion: str | None = None, tieRegion: str | None = None, pinRegion: str | None = None, surfaceRegion: str | None = None, refPointAtCOM: BooleanType = 0, isothermal: BooleanType = 0) → RigidBody

This method creates a RigidBody object.

Parameters:

name

A String specifying the constraint repository key.

refPointRegion

A Region object specifying the reference point.

bodyRegion

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

tieRegion

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

pinRegion

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

surfaceRegion

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

refPointAtCOM

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

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

Returns:

A RigidBody object.

Notes

This function can be accessed by:

mdb.models[name].RigidBody

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

This method creates a RotationalBodyForce object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created. This must be the first analysis step name.

region

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

magnitude

A Float specifying the load magnitude.

point1

A sequence of Floats specifying the first point on the axis of rotation for the load.

point2

A sequence of Floats specifying the second point on the axis of rotation for the load.

distributionType

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

field

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

centrifugal

A Boolean specifying whether or not the effect of the load is centrifugal. The default value is OFF.Note:At least one of centrifugal or rotaryAcceleration must be specified and only one must have the value ON.

rotaryAcceleration

A Boolean specifying whether or not the effect of the load is rotary acceleration. The default value is OFF.Note:At least one of centrifugal or rotaryAcceleration must be specified and only one must have the value ON.

amplitude

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

Returns:

A RotationalBodyForce object.

Notes

This function can be accessed by:

mdb.models[name].RotationalBodyForce

SecondaryBaseBC(name: str, createStepName: str, regions: RegionArray, dofs: tuple) → SecondaryBaseBC

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

SelfContactExp(name: str, createStepName: str, surface: Region, interactionProperty: str, mechanicalConstraint: SymbolicConstantType = 'KINEMATIC', contactControls: str = '') → SelfContactExp

This method creates a SelfContactExp object.

Parameters:

name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which the SelfContactExp object is created.

surface

A Region object specifying the surface where self-contact is defined.

interactionProperty

A String specifying the name of the ContactProperty object associated with this interaction.

mechanicalConstraint

A SymbolicConstant specifying the mechanical constraint formulation. Possible values are KINEMATIC and PENALTY. The default value is KINEMATIC.

contactControls

A String specifying the name of the ContactControl object associated with this interaction. An empty string indicates that the default contact controls will be used. The default value is an empty string.

Returns:

A SelfContactExp object.

Notes

This function can be accessed by:

mdb.models[name].SelfContactExp

SelfContactStd(name: str, createStepName: str, surface: Region, interactionProperty: str, enforcement: SymbolicConstantType = 'SURFACE_TO_SURFACE', thickness: BooleanType = 1, smooth: float = 0, contactControls: str = '') → SelfContactStd

This method creates a SelfContactStd object.

Parameters:

name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which the SelfContactStd object is created.

surface

A Region object specifying the surface where self-contact is defined.

interactionProperty

A String specifying the name of the ContactProperty object associated with this interaction.

enforcement

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

thickness

A Boolean specifying whether shell/membrane element thickness is considered. The default value is ON.This argument in valid only when *enforcement*=SURFACE_TO_SURFACE.

smooth

A Float specifying the degree of smoothing used for deformable or rigid main surfaces involved when *enforcement*=NODE_TO_SURFACE. The value given must lie between 0.0 and 0.5. The default value is 0.2.

contactControls

A String specifying the name of the ContactControl object associated with this interaction. An empty string indicates that the default contact controls will be used. The default value is an empty string.

Returns:

A SelfContactStd object.

Notes

This function can be accessed by:

mdb.models[name].SelfContactStd

ShapeTask(name: str, abaqusSensitivities: BooleanType = True, absoluteStepSizeControl: SymbolicConstantType = 'MINIMUM', activateDurability: BooleanType = 1, additionalDurabilityFiles: str = '', algorithm: SymbolicConstantType = 'CONDITION_BASED_OPTIMIZATION', constrainedLaplacianConvergenceLevel: SymbolicConstantType = 'NORMAL', curvatureSmoothingEdgeLength: float = 5, durabilityInputfile: str = '', durabilitySolver: str = 'FE_SAFE', equalityConstraintTolerance: float | None = None, featureRecognitionAngle: float = 30, filterExponent: float = 1, filterMaxRadius: float | None = None, filterRadiusReduction: float | None = None, firstCycleDeletedVolumeTechnique: SymbolicConstantType = 0, freezeBoundaryConditionRegions: BooleanType = 0, frozenBoundaryConditionRegion: SymbolicConstantType = 'MODEL', geometricRestrictionEvaluationFrequency: SymbolicConstantType = 'LOW', growthScaleFactor: float = 1, haltUponViolation: BooleanType = 0, layerReferenceRegion: str | None = None, meshSmoothingRegionMethod: SymbolicConstantType = 'TASK_REGION_LAYERS', meshSmoothingStrategy: SymbolicConstantType = 'CONSTRAINED_LAPLACIAN', midsideInterpolation: SymbolicConstantType = 'POSITIONS', numFreeNodeLayers: SymbolicConstantType = 0, numSmoothedElementLayers: int | None = None, presumeFeasibleBCRegionAtStart: BooleanType = 1, quadMaxAngle: float = 160, quadMinAngle: float = 20, quadSkew: float = 30, quadTaper: float = 0, region: SymbolicConstantType = 'MODEL', reportPoorQualityElements: BooleanType = 0, reportQualityViolation: BooleanType = 0, shrinkScaleFactor: float = 1, smoothingRegion: str | None = None, targetMeshQuality: SymbolicConstantType = 'LOW', tetAspectRatio: float = 100, tetMaxAspect: float = 8, tetMinAspect: float = 0, tetSkew: float = 100, triMaxAngle: float = 140, triMinAngle: float = 20, updateShapeBasisVectors: SymbolicConstantType = 'EVERY_CYCLE', groupOperator: BooleanType = 0) → ShapeTask

This method creates a ShapeTask object.

Parameters:

name

A String specifying the optimization task repository key.

abaqusSensitivities

A Boolean specifying whether to use Abaqus to compute the design responses and their sensitivities. The default value is True.

absoluteStepSizeControl

A SymbolicConstant specifying whether to control the permitted absolute step size by the average optimization displacement or minimum optimization displacement. Possible values are MINIMUM and AVERAGE. The default value is MINIMUM.

activateDurability

A boolean specifying whether or not the durability approach of optimization is turned on. The default value is ON.

additionalDurabilityFiles

A String specifying the path of additional files pertaining to durability optimization. Only valid if the activateDurability argument is ON.

algorithm

A SymbolicConstant specifying the optimization task algorithm. Possible values are GENERAL_OPTIMIZATION and CONDITION_BASED_OPTIMIZATION. The default value is CONDITION_BASED_OPTIMIZATION.

constrainedLaplacianConvergenceLevel

A SymbolicConstant specifying the constrained Laplacian convergence level. Possible values are NORMAL, CONSERVATIVE, and AGGRESSIVE. The default value is NORMAL.

curvatureSmoothingEdgeLength

A Float specifying the edge length for the movement vector. The default value is 5.0.

durabilityInputfile

A string specifying the path of the input file. Only valid if the activateDurability argument is ON and is a required argument in that case.

durabilitySolver

A String specifying the type of solver for durability optimization. Possible values are: FE_SAFE, FEMFAT, FLANS, MSC_FATIGUE, FE_FATIGUE, DESIGN_LIFE, CUSTOM, FEMSITE. The default value is FE_SAFE. Only valid if the activateDurability argument is ON.

equalityConstraintTolerance

A Float specifying the equality constraint tolerance. The default value is 10–3.

featureRecognitionAngle

A Float specifying the mesh smoothing feature recognition angle for edges and corners. The default value is 30.0.

filterExponent

A Float specifying the weight depending on the radius, used when filterMaxRadius is specified. The default value is 1.0.

filterMaxRadius

None or a Float specifying the maximum influence radius for equivalent stress. The default value is None.

filterRadiusReduction

None or a Float specifying the reduction of the radius depending on surface bending, used when filterMaxRadius is specified. The default value is None.

firstCycleDeletedVolumeTechnique

A SymbolicConstant specifying the method of specifying volume that can be removed immediately in the first design cycle. Possible values are OFF, PERCENTAGE, and ABSOLUTE. The default value is OFF.

freezeBoundaryConditionRegions

A Boolean specifying whether to exclude nodes with boundary conditions from the optimization. The default value is OFF.

frozenBoundaryConditionRegion

The SymbolicConstant MODEL or a Region object specifying the region in which to freeze boundary condition regions, or the SymbolicConstant MODEL, used with freezeBoundaryConditionRegions. The default value is MODEL.

geometricRestrictionEvaluationFrequency

A SymbolicConstant specifying the frequency of evaluating geometric restrictions during mesh smoothing. Possible values are LOW, MEDIUM, and HIGH. The default value is LOW.

growthScaleFactor

A Float specifying the scale factor to apply to optimization displacements for nodes with growth. The default value is 1.0.

haltUponViolation

A Boolean specifying whether to halt the optimization if quality criteria are not satisified. The default value is OFF.

layerReferenceRegion

None or a Region object specifying the region specifying the first node layer for mesh smoothing, used when meshSmoothingRegionMethod is TASK_REGION_LAYERS. The default value is None.

meshSmoothingRegionMethod

A SymbolicConstant specifying the method used to determine the mesh smoothing region. The REGION value uses the smoothingRegion. The NUMBER_OF_LAYERS value uses the layerReferenceRegion. The TASK_REGION_LAYERS value will smooth six layers using the task region. Possible values are TASK_REGION_LAYERS, REGION, and NUMBER_OF_LAYERS. The default value is TASK_REGION_LAYERS.

meshSmoothingStrategy

A SymbolicConstant specifying the method smoothing strategy. Possible values are CONSTRAINED_LAPLACIAN and LOCAL_GRADIENT. The default value is CONSTRAINED_LAPLACIAN.

midsideInterpolation

A SymbolicConstant specifying the approach used when treating midside node positions during optimization. POSITIONS indicates midside node positions are interpolated linearly by position. OPTIMIZATION_DISPLACEMENT indicates they are interpolated by optimization displacement of corner nodes. Possible values are POSITIONS and OPTIMIZATION_DISPLACEMENT. The default value is POSITIONS.

numFreeNodeLayers

The SymbolicConstant FIX_NONE or an Int specifying the number of node layers adjoining the task region to remain free during mesh smoothing. A value of 0 indicates that no layers are free and all layers are fixed. The default value is 0.

numSmoothedElementLayers

None or an Int specifying the number of layers for mesh smoothing when meshSmoothingRegionMethod is NUMBER_OF_LAYERS. The default value is None.

presumeFeasibleBCRegionAtStart

A Boolean specifying whether to ignore automatically frozen boundary condition regions in the first design cycle. This is used with freezeBoundaryConditionRegions. The default value is ON.

quadMaxAngle

A Float specifying the maximum angle for quad elements during mesh smoothing. The default value is 160.0.

quadMinAngle

A Float specifying the minimum angle for quad elements during mesh smoothing. The default value is 20.0.

quadSkew

A Float specifying the skew angle for quad elements during mesh smoothing, used with reportQualityViolation. The default value is 30.0.

quadTaper

A Float specifying the taper for quad elements during mesh smoothing, used with reportQualityViolation. The default value is 0.5.

region

The SymbolicConstant MODEL or a Region object specifying the region to which the optimization task is applied. The default value is MODEL.

reportPoorQualityElements

A Boolean specifying whether to report poor quality elements during mesh smoothing. The default value is OFF.

reportQualityViolation

A Boolean specifying whether to report a quality criteria violation during mesh smoothing. The default value is OFF.

shrinkScaleFactor

A Float specifying the scale factor to apply to optimization displacements for nodes with shrinkage. The default value is 1.0.

smoothingRegion

None or a Region object specifying the mesh smoothing region, used when meshSmoothingRegionMethod is REGION. The default value is None.

targetMeshQuality

A SymbolicConstant specifying the target mesh quality for mesh smoothing. Possible values are NONE, LOW, MEDIUM, and HIGH. The default value is LOW.

tetAspectRatio

A Float specifying the tet element aspect ratio during mesh smoothing. The default value is 100.0.

tetMaxAspect

A Float specifying the maximum tet element aspect ratio during mesh smoothing. The default value is 8.0.

tetMinAspect

A Float specifying the minimum tet element aspect ratio during mesh smoothing. The default value is 0.222.

tetSkew

A Float specifying the tet element skew value during mesh smoothing. The default value is 100.0.

triMaxAngle

A Float specifying the tri element maximum angle during mesh smoothing. The default value is 140.0.

triMinAngle

A Float specifying the tri element maximum angle during mesh smoothing. The default value is 20.0.

updateShapeBasisVectors

A SymbolicConstant specifying whether to update shape basis vectors in the first design cycle or every design cycle. Possible values are EVERY_CYCLE and FIRST_CYCLE. The default value is EVERY_CYCLE.

Returns:

A ShapeTask object.

Notes

This function can be accessed by:

mdb.models[name].ShapeTask

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

This method creates a ShellEdgeLoad object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created.

region

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

magnitude

A Float or Complex specifying the load magnitude. magnitude is optional if *distributionType*=USER_DEFINED

distributionType

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

field

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

amplitude

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

angle

A Float specifying an additional rotation of directionVector about an axis. The default value is 0.This parameter is available only if traction is GENERAL.

axis

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

localCsys

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

userCsys

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

directionVector

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

follower

A Boolean specifying whether the direction of the force changes with rotation. The default value is ON. This parameter may be modified only if traction is GENERAL. You should provide the follower argument only if it is valid for the specified step.

resultant

A Boolean specifying whether to maintain a constant resultant force by defining traction per unit undeformed area. If resultant is OFF, traction is defined per unit deformed area. The default value is OFF. You should provide the resultant argument only if it is valid for the specified step.

traction

A SymbolicConstant specifying how to apply surface traction. Possible values are NORMAL, TRANSVERSE, SHEAR, MOMENT and GENERAL. The default value is NORMAL.

Returns:

A ShellEdgeLoad object.

Notes

This function can be accessed by:

mdb.models[name].ShellEdgeLoad

ShellSolidCoupling(name: str, shellEdge: Region, solidFace: Region, positionToleranceMethod: SymbolicConstantType = 'COMPUTED', positionTolerance: float = 0, influenceDistanceMethod: SymbolicConstantType = 'DEFAULT', influenceDistance: float = 0) → ShellSolidCoupling

This method creates a ShellSolidCoupling object.

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

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

positionTolerance

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

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

influenceDistance

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

Returns:

A ShellSolidCoupling object.

Notes

This function can be accessed by:

mdb.models[name].ShellSolidCoupling

SizingTask(name: str, abaqusSensitivities: BooleanType = True, elementThicknessDeltaStopCriteria: float = 0, freezeBoundaryConditionRegions: BooleanType = 0, freezeLoadRegions: BooleanType = 1, modeTrackingRegion: str = 'MODEL', numFulfilledStopCriteria: int = 2, numTrackedModes: int = 5, objectiveFunctionDeltaStopCriteria: float = 0, stopCriteriaDesignCycle: int = 4, thicknessMoveLimit: float = 0, thicknessUpdateStrategy: SymbolicConstantType = 'NORMAL', groupOperator: BooleanType = 0) → SizingTask

This method creates a SizingTask object.

Parameters:

name

A String specifying the optimization task repository key.

abaqusSensitivities

A Boolean specifying whether to use Abaqus to compute the design responses and their sensitivities. The default value is True.

elementThicknessDeltaStopCriteria

A Float specifying the stop criteria based on the change in element thickness. The default value is 0.5 × 10–2.

freezeBoundaryConditionRegions

A Boolean specifying whether to exclude elements with boundary conditions from the optimization. The default value is OFF.

freezeLoadRegions

A Boolean specifying whether to exclude elements with loads and elements with loaded nodes from the optimization. The default value is ON.

modeTrackingRegion

The SymbolicConstatnt MODEL or a Region object specifying the region to use for mode tracking. The default value is MODEL.

numFulfilledStopCriteria

An Int specifying the number of stop criteria. The default value is 2.

numTrackedModes

An Int specifying the number of modes included in mode tracking. The default value is 5.

objectiveFunctionDeltaStopCriteria

A Float specifying the stop criteria based on the change in objective function. The default value is 0.001.

stopCriteriaDesignCycle

An Int specifying the first design cycle used to evaluate convergence criteria. The default value is 4.

thicknessMoveLimit

A Float specifying the maximum change in thickness per design cycle. The default value is 0.25.

thicknessUpdateStrategy

A SymbolicConstant specifying the strategy for how the thickness is updated in the method of moving asymptotes. Possible values are NORMAL, CONSERVATIVE, and AGGRESSIVE. The default value is NORMAL.

Returns:

A SizingTask object.

Notes

This function can be accessed by:

mdb.models[name].SizingTask

SmoothStepAmplitude(name: str, data: tuple, timeSpan: SymbolicConstantType = 'STEP') → SmoothStepAmplitude

This method creates a SmoothStepAmplitude object.

Parameters:

name

A String specifying the repository key.

data

A sequence of pairs of Floats specifying time/frequency and amplitude pairs. Possible values for time/frequency are positive numbers.

timeSpan

A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:

A SmoothStepAmplitude object.

Raises:

InvalidNameError

RangeError

Notes

This function can be accessed by:

mdb.models[name].SmoothStepAmplitude
session.odbs[name].SmoothStepAmplitude

SoilsStep(name: str, previous: str, description: str = '', response: SymbolicConstantType = 'TRANSIENT', timePeriod: float = 1, nlgeom: BooleanType = 0, stabilizationMethod: SymbolicConstantType = 'NONE', stabilizationMagnitude: float | None = None, creep: BooleanType = 1, timeIncrementationMethod: SymbolicConstantType = 'AUTOMATIC', initialInc: float | None = None, minInc: float | None = None, maxInc: float | None = None, maxNumInc: int = 100, end: SymbolicConstantType = 'PERIOD', utol: float | None = None, cetol: float = 0, amplitude: SymbolicConstantType = 'STEP', extrapolation: SymbolicConstantType = 'LINEAR', matrixSolver: SymbolicConstantType = 'DIRECT', matrixStorage: SymbolicConstantType = 'SOLVER_DEFAULT', maintainAttributes: BooleanType = False, solutionTechnique: SymbolicConstantType = 'FULL_NEWTON', reformKernel: int = 8, convertSDI: SymbolicConstantType = 'PROPAGATED', adaptiveDampingRatio: float = 0, continueDampingFactors: BooleanType = 0) → SoilsStep

This method creates a SoilsStep object.

Parameters:

name

A String specifying the repository key.

previous

A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

description

A String specifying a description of the new step. The default value is an empty string.

response

A SymbolicConstant specifying the analysis type. Possible values are STEADY_STATE and TRANSIENT. The default value is TRANSIENT.

timePeriod

A Float specifying the total time period. The default value is 1.0.

nlgeom

A Boolean specifying whether geometric nonlinearities should be accounted for during the step. The default value is OFF.

stabilizationMethod

A SymbolicConstant specifying the stabilization type. Possible values are NONE, DISSIPATED_ENERGY_FRACTION, and DAMPING_FACTOR. The default value is NONE.

stabilizationMagnitude

A Float specifying the damping intensity of the automatic damping algorithm if the problem is expected to be unstable, and stabilizationMethod is not NONE. The default value is 2×10–4.

creep

A Boolean specifying whether a creep response occurs during this step. The default value is ON.

timeIncrementationMethod

A SymbolicConstant specifying the time incrementation method to be used. Possible values are FIXED and AUTOMATIC. The default value is AUTOMATIC.

initialInc

A Float specifying the initial time increment. The default value is the total time period for the step.

minInc

A Float specifying the minimum time increment allowed. The default value is the smaller of the suggested initial time increment or 10−5 times the total time period.

maxInc

A Float specifying the maximum time increment allowed. The default value is the total time period for the step.

maxNumInc

An Int specifying the maximum number of increments in a step. The default value is 100.

end

A SymbolicConstant specifying the time period to be analyzed in a transient analysis. Possible values are PERIOD and SS. The default value is PERIOD.

utol

None or a Float specifying the maximum pore pressure change permitted in any increment (in pressure units) in a transient consolidation analysis. The default value is None.

cetol

A Float specifying the maximum allowable difference in the creep strain increment calculated from the creep strain rates at the beginning and end of the increment. The default value is 0.0.

amplitude

A SymbolicConstant specifying the amplitude variation for loading magnitudes during the step. The default value is STEP. Possible values are STEP and RAMP.

extrapolation

A SymbolicConstant specifying the type of extrapolation to use in determining the incremental solution for a nonlinear analysis. Possible values are NONE, LINEAR, and PARABOLIC. The default value is LINEAR.

matrixSolver

A SymbolicConstant specifying the type of solver. Possible values are DIRECT and ITERATIVE. The default value is DIRECT.

matrixStorage

A SymbolicConstant specifying the type of matrix storage. Possible values are SYMMETRIC, UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT.

maintainAttributes

A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is False.

solutionTechnique

A SymbolicConstant specifying the technique used to for solving nonlinear equations. Possible values are FULL_NEWTON and QUASI_NEWTON. The default value is FULL_NEWTON.

reformKernel

An Int specifying the number of quasi-Newton iterations allowed before the kernel matrix is reformed.. The default value is 8.

convertSDI

A SymbolicConstant specifying whether to force a new iteration if severe discontinuities occur during an iteration. Possible values are PROPAGATED, CONVERT_SDI_OFF, and CONVERT_SDI_ON. The default value is PROPAGATED.

adaptiveDampingRatio

A Float specifying the maximum allowable ratio of the stabilization energy to the total strain energy and can be used only if stabilizationMethod is not NONE. The default value is 0.05.

continueDampingFactors

A Boolean specifying whether this step will carry over the damping factors from the results of the preceding general step. This parameter must be used in conjunction with the adaptiveDampingRatio parameter. The default value is OFF.

Returns:

step: SoilsStep

A SoilsStep object.

Notes

This function can be accessed by:

mdb.models[name].SoilsStep

SolutionDependentAmplitude(name: str, initial: float = 1, minimum: float = 0, maximum: float = 1000, timeSpan: SymbolicConstantType = 'STEP') → SolutionDependentAmplitude

This method creates a SolutionDependentAmplitude object.

Parameters:

name

A String specifying the repository key.

initial

A Float specifying the initial amplitude value. Possible values are those between minimum and maximum. The default value is 1.0.

minimum

A Float specifying the minimum amplitude value. Possible values are those smaller than maximum and initial. The default value is 0.1.

maximum

A Float specifying the maximum amplitude value. Possible values are those larger than minimum and initial. The default value is 1000.0.

timeSpan

A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:

A SolutionDependentAmplitude object.

Raises:

InvalidNameError

RangeError

Notes

This function can be accessed by:

mdb.models[name].SolutionDependentAmplitude
session.odbs[name].SolutionDependentAmplitude

SpectrumAmplitude(name: str, method: SymbolicConstantType, data: tuple, specificationUnits: SymbolicConstantType = 'ACCELERATION', eventUnits: SymbolicConstantType = 'EVENT_ACCELERATION', solution: SymbolicConstantType = 'ABSOLUTE_VALUE', timeIncrement: float = 0, gravity: float = 1, criticalDamping: BooleanType = 0, timeSpan: SymbolicConstantType = 'STEP', amplitude: str = '') → SpectrumAmplitude

This method creates a SpectrumAmplitude object.

Parameters:

name

A String specifying the repository key.

method

A SymbolicConstant specifying the method for specifying the spectrum. Possible values are DEFINE and CALCULATE.

data

A sequence of sequences of Floats specifying the magnitude, frequency, and damping values.

specificationUnits

A SymbolicConstant specifying the units used for specifying the spectrum. Possible values are DISPLACEMENT, VELOCITY, ACCELERATION, and GRAVITY. The default value is ACCELERATION.

eventUnits

A SymbolicConstant specifying the units used to describe the dynamic event in the amplitude used for the calculation. Possible values are EVENT_DISPLACEMENT, EVENT_VELOCITY, EVENT_ACCELERATION, and EVENT_GRAVITY. The default value is EVENT_ACCELERATION.

solution

A SymbolicConstant specifying the solution method for the dynamic equations. Possible values are ABSOLUTE_VALUE and RELATIVE_VALUE. The default value is ABSOLUTE_VALUE.

timeIncrement

A Float specifying the implicit time increment used to calculate the spectrum. This argument is required when the method = CALCULATE. The default value is 0.0.

gravity

A Float specifying the acceleration due to gravity. This argument applies only when specificationUnits = GRAVITY or*eventUnits* = GRAVITY. The default value is 1.0.

criticalDamping

A Boolean specifying whether to calculate the spectrum for only the specified range of critical damping values or a list of values. If criticalDamping = ON, the spectrum is calculated only for the specified range of critical damping values. If criticalDamping = OFF, the spectrum is calculated for a list of damping values. The default value is OFF.

timeSpan

A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

amplitude

A String specifying the name of the amplitude that describes the dynamic event used to calculate the spectrum. The default value is an empty string.

Returns:

A SpectrumAmplitude object.

Raises:

InvalidNameError

RangeError

Notes

This function can be accessed by:

mdb.models[name].SpectrumAmplitude
session.odbs[name].SpectrumAmplitude

StaticLinearPerturbationStep(name: str, previous: str, description: str = '', matrixSolver: SymbolicConstantType = 'DIRECT', matrixStorage: SymbolicConstantType = 'SOLVER_DEFAULT', maintainAttributes: BooleanType = False) → StaticLinearPerturbationStep

This method creates a StaticLinearPerturbationStep object.

Parameters:

name

A String specifying the repository key.

previous

A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

description

A String specifying a description of the new step. The default value is an empty string.

matrixSolver

A SymbolicConstant specifying the type of solver. Possible values are DIRECT and ITERATIVE. The default value is DIRECT.

matrixStorage

A SymbolicConstant specifying the type of matrix storage. Possible values are SYMMETRIC, UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT.

maintainAttributes

A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is False.

Returns:

step: StaticLinearPerturbationStep

A StaticLinearPerturbationStep object.

Notes

This function can be accessed by:

mdb.models[name].StaticLinearPerturbationStep

StaticRiksStep(name: str, previous: str, description: str = '', nlgeom: ~abaqusConstants.BooleanType = 0, adiabatic: ~abaqusConstants.BooleanType = 0, maxLPF: float | None = None, nodeOn: ~abaqusConstants.BooleanType = 0, maximumDisplacement: float = 0, dof: int = 0, region: ~abaqus.Region.Region.Region = <abaqus.Region.Region.Region object>, timeIncrementationMethod: ~abaqusConstants.SymbolicConstantType = 'AUTOMATIC', maxNumInc: int = 100, totalArcLength: float = 1, initialArcInc: float | None = None, minArcInc: float | None = None, maxArcInc: float | None = None, matrixStorage: ~abaqusConstants.SymbolicConstantType = 'SOLVER_DEFAULT', extrapolation: ~abaqusConstants.SymbolicConstantType = 'LINEAR', fullyPlastic: str = '', noStop: ~abaqusConstants.BooleanType = 0, maintainAttributes: ~abaqusConstants.BooleanType = False, useLongTermSolution: ~abaqusConstants.BooleanType = 0, convertSDI: ~abaqusConstants.SymbolicConstantType = 'PROPAGATED') → StaticRiksStep

This method creates a StaticRiksStep object.

Parameters:

name

A String specifying the repository key.

previous

A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

description

A String specifying a description of the new step. The default value is an empty string.

nlgeom

A Boolean specifying whether to allow for geometric nonlinearity. The default value is OFF.

adiabatic

A Boolean specifying whether to perform an adiabatic stress analysis. The default value is OFF.

maxLPF

None or a Float specifying the maximum value of the load proportionality factor. The default value is None.

nodeOn

A Boolean specifying whether to monitor the finishing displacement value at a node. The default value is OFF.

maximumDisplacement

A Float specifying the value of the total displacement (or rotation) at the node and degree of freedom that, if crossed during an increment, ends the step at the current increment. This argument is required when *nodeOn*=ON. The default value is 0.0.

dof

An Int specifying the degree of freedom being monitored. This argument is required when *nodeOn*=ON. The default value is 0.

region

A Region object specifying the vertex at which the finishing displacement value is being monitored. This argument is required when *nodeOn*=ON.

timeIncrementationMethod

A SymbolicConstant specifying the time incrementation method to be used. Possible values are FIXED and AUTOMATIC. The default value is AUTOMATIC.

maxNumInc

An Int specifying the maximum number of increments in a step. The default value is 100.

totalArcLength

A Float specifying the total load proportionality factor associated with the load in this step. The default value is 1.0.

initialArcInc

A Float specifying the initial load proportionality factor. The default value is the total load proportionality factor for the step.

minArcInc

A Float specifying the minimum arc length increment allowed. The default value is the smaller of the suggested initial load proportionality factor or 10−5 times the total load proportionality factor for the step.

maxArcInc

A Float specifying the maximum arc length increment allowed. The default value is the total load proportionality factor for the step.

matrixStorage

A SymbolicConstant specifying the type of matrix storage. Possible values are SYMMETRIC, UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT.

extrapolation

A SymbolicConstant specifying the type of extrapolation to use in determining the incremental solution for a nonlinear analysis. Possible values are NONE, LINEAR, and PARABOLIC. The default value is LINEAR.

fullyPlastic

A String specifying the name of the region being monitored for fully Plastic behavior. The default value is an empty string.

noStop

A Boolean specifying whether to accept the solution to an increment after the maximum number of iterations allowed have been completed, even if the equilibrium tolerances are not satisfied. The default value is OFF.Warning:You should set *noStop*=ON only in special cases when you have a thorough understanding of how to interpret the results.

maintainAttributes

A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is False.

useLongTermSolution

A Boolean specifying wether to obtain the fully relaxed long-term elastic solution with time-domain viscoelasticity or the long-term elastic-Plastic solution for two-layer viscoplasticity. The default value is OFF.

convertSDI

A SymbolicConstant specifying whether to force a new iteration if severe discontinuities occur during an iteration. Possible values are PROPAGATED, CONVERT_SDI_OFF, and CONVERT_SDI_ON. The default value is PROPAGATED.

Returns:

step: StaticRiksStep

A StaticRiksStep object.

Notes

This function can be accessed by:

mdb.models[name].StaticRiksStep

StaticStep(name: str, previous: str, description: str = '', timePeriod: float = 1, nlgeom: BooleanType = 0, stabilizationMethod: SymbolicConstantType = 'NONE', stabilizationMagnitude: float | None = None, adiabatic: BooleanType = 0, timeIncrementationMethod: SymbolicConstantType = 'AUTOMATIC', maxNumInc: int = 100, initialInc: float | None = None, minInc: float | None = None, maxInc: float | None = None, matrixSolver: SymbolicConstantType = 'DIRECT', matrixStorage: SymbolicConstantType = 'SOLVER_DEFAULT', amplitude: SymbolicConstantType = 'RAMP', extrapolation: SymbolicConstantType = 'LINEAR', fullyPlastic: str = '', noStop: BooleanType = 0, maintainAttributes: BooleanType = False, useLongTermSolution: BooleanType = 0, solutionTechnique: SymbolicConstantType = 'FULL_NEWTON', reformKernel: int = 8, convertSDI: SymbolicConstantType = 'PROPAGATED', adaptiveDampingRatio: float = 0, continueDampingFactors: BooleanType = 0) → StaticStep

This method creates a StaticStep object.

Parameters:

name

A String specifying the repository key.

previous

A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

description

A String specifying a description of the new step. The default value is an empty string.

timePeriod

A Float specifying the total time period. The default value is 1.0.

nlgeom

A Boolean specifying whether to allow for geometric nonlinearity. The default value is OFF.

stabilizationMethod

A SymbolicConstant specifying the stabilization type. Possible values are NONE, DISSIPATED_ENERGY_FRACTION, and DAMPING_FACTOR. The default value is NONE.

stabilizationMagnitude

A Float specifying the damping intensity of the automatic damping algorithm if the problem is expected to be unstable, and stabilizationMethod is not NONE. The default value is 2×10–4.

adiabatic

A Boolean specifying whether to perform an adiabatic stress analysis. The default value is OFF.

timeIncrementationMethod

A SymbolicConstant specifying the time incrementation method to be used. Possible values are FIXED and AUTOMATIC. The default value is AUTOMATIC.

maxNumInc

An Int specifying the maximum number of increments in a step. The default value is 100.

initialInc

A Float specifying the initial time increment. The default value is the total time period for the step.

minInc

A Float specifying the minimum time increment allowed. The default value is the smaller of the suggested initial time increment or 10–5 times the total time period.

maxInc

A Float specifying the maximum time increment allowed. The default value is the total time period for the step.

matrixSolver

A SymbolicConstant specifying the type of solver. Possible values are DIRECT and ITERATIVE. The default value is DIRECT.

matrixStorage

A SymbolicConstant specifying the type of matrix storage. Possible values are SYMMETRIC, UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT.

amplitude

A SymbolicConstant specifying the amplitude variation for loading magnitudes during the step. Possible values are STEP and RAMP. The default value is RAMP.

extrapolation

A SymbolicConstant specifying the type of extrapolation to use in determining the incremental solution for a nonlinear analysis. Possible values are NONE, LINEAR, and PARABOLIC. The default value is LINEAR.

fullyPlastic

A String specifying the region being monitored for fully Plastic behavior. The default value is an empty string.

noStop

A Boolean specifying whether to accept the solution to an increment after the maximum number of iterations allowed has been completed, even if the equilibrium tolerances are not satisfied. The default value is OFF.Warning:You should set *noStop*=ON only in special cases when you have a thorough understanding of how to interpret the results.

maintainAttributes

A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is False.

useLongTermSolution

A Boolean specifying wether to obtain the fully relaxed long-term elastic solution with time-domain viscoelasticity or the long-term elastic-Plastic solution for two-layer viscoplasticity. The default value is OFF.

solutionTechnique

A SymbolicConstant specifying the technique used to for solving nonlinear equations. Possible values are FULL_NEWTON and QUASI_NEWTON. The default value is FULL_NEWTON.

reformKernel

An Int specifying the number of quasi-Newton iterations allowed before the kernel matrix is reformed.. The default value is 8.

convertSDI

A SymbolicConstant specifying whether to force a new iteration if severe discontinuities occur during an iteration. Possible values are PROPAGATED, CONVERT_SDI_OFF, and CONVERT_SDI_ON. The default value is PROPAGATED.

adaptiveDampingRatio

A Float specifying the maximum allowable ratio of the stabilization energy to the total strain energy and can be used only if stabilizationMethod is not NONE. The default value is 0.05.

continueDampingFactors

A Boolean specifying whether this step will carry over the damping factors from the results of the preceding general step. This parameter must be used in conjunction with the adaptiveDampingRatio parameter. The default value is OFF.

Returns:

step: StaticRiksStep

A StaticRiksStep object.

Notes

This function can be accessed by:

mdb.models[name].StaticStep

StdContactControl(name: str, stiffnessScaleFactor: float = 1, penetrationTolChoice: SymbolicConstantType = 'RELATIVE', relativePenetrationTolerance: float | None = None, absolutePenetrationTolerance: float | None = None, frictionOnset: SymbolicConstantType | None = None, automaticTolerances: BooleanType = 0, maxchp: int = 0, perrmx: float = 0, uerrmx: float = 0, stabilizeChoice: SymbolicConstantType = 'NONE', dampFactor: float = 1, dampCoef: float = 0, tangFraction: float = 1, eosFraction: float = 0, zeroDampingChoice: SymbolicConstantType = 'COMPUTE', zeroDamping: float | None = None, enforceWithLagrangeMultipliers: SymbolicConstantType = 'DEFAULT') → StdContactControl

This method creates an StdContactControl object.

Parameters:

name

A String specifying the contact controls repository key.

stiffnessScaleFactor

A Float specifying the factor by which Abaqus/Standard will scale the default penalty stiffness to obtain the stiffnesses used for the contact pairs. Only contact interactions defined with augmented Lagrangian surface behavior will be affected by this argument. The default value is 1.0.

penetrationTolChoice

A SymbolicConstant specifying whether the allowable penetration is an absolute value or a value relative to the characteristic contact surface face dimension. Only contact interactions defined with augmented Lagrangian surface behavior will be affected by this argument. Possible values are RELATIVE and ABSOLUTE. The default value is RELATIVE.

relativePenetrationTolerance

A Float specifying the ratio of the allowable penetration to the characteristic contact surface face dimension. The float values represent percentages (e.g.: 0.001=0.1%). Only contact interactions defined with augmented Lagrangian surface behavior will be affected by this argument. The default value is 10–3.The relativePenetrationTolerance argument applies only when penetrationTolChoice*=RELATIVE. The *relativePenetrationTolerance and absolutePenetrationTolerance arguments are mutually exclusive.

absolutePenetrationTolerance

None or a Float specifying the allowable penetration. Only contact interactions defined with augmented Lagrangian surface behavior will be affected by this argument. The absolutePenetrationTolerance argument applies only when penetrationTolChoice*=ABSOLUTE. The *relativePenetrationTolerance and absolutePenetrationTolerance arguments are mutually exclusive. The default value is None.

frictionOnset

A SymbolicConstant specifying when the application of friction occurs. Possible values are: - IMMEDIATE, specifying the friction is included in the increment when contact occurs. - DELAYED, specifying the application of friction is delayed until the increment after contact occurs.

automaticTolerances

A Boolean specifying whether Abaqus/Standard should automatically compute an overclosure tolerance and a separation tolerance to prevent chattering in contact. The default value is OFF.The automaticTolerances argument cannot be used with the maxchp, perrmx, and uerrmx arguments.

maxchp

An Int specifying the maximum number of points that are permitted to violate contact conditions in any increment. The default value is 0.Either the perrmx or the uerrmx argument must be specified in conjunction with the maxchp argument.

perrmx

A Float specifying the maximum value of tensile stress (tensile force in GAP- or ITT-type contact elements) allowed to be transmitted at a contact point. The default value is 0.0.The perrmx argument must be specified in conjunction with the maxchp argument.

uerrmx

A Float specifying the maximum overclosure distance allowed at a slave node that is considered to be open. The default value is 0.0.The uerrmx argument must be specified in conjunction with the maxchp argument.

stabilizeChoice

A SymbolicConstant specifying whether or not viscous damping will be specified, and if so, how it will be specified. Possible values are NONE, AUTOMATIC, and COEFFICIENT. The default value is NONE.

dampFactor

A Float specifying the value of the damping factor. This value is multiplied by the calculated damping coefficient. The default value is 1.0.This argument is only valid when *stabilizeChoice*=AUTOMATIC.

dampCoef

A Float specifying the damping coefficient. The default value is 0.0.This argument is only valid when *stabilizeChoice*=COEFFICIENT.

tangFraction

A Float specifying the tangential stabilization as a fraction of the normal stabilization (damping). The default value is 1.0.This argument is valid only if stabilizeChoice = AUTOMATIC or COEFFICIENT.

eosFraction

A Float specifying the fraction of the damping that remains at the end of the step. The default value is 0.0.This argument is valid only if stabilizeChoice = AUTOMATIC or COEFFICIENT.

zeroDampingChoice

A SymbolicConstant specifying how the zero-damping clearance will be specified. Possible values are COMPUTE and SPECIFY. The default value is COMPUTE.This argument is valid only if stabilizeChoice = AUTOMATIC or COEFFICIENT.

zeroDamping

None or a Float specifying the clearance at which damping becomes zero. This argument is valid only when zeroDampingChoice*=SPECIFY. This argument is valid only if *stabilizeChoice = AUTOMATIC or COEFFICIENT. The default value is None.

enforceWithLagrangeMultipliers

A SymbolicConstant specifying whether to enforce the contact constraints with Lagrange multipliers. Possible values are DEFAULT, ENFORCEMENT_OFF, and ENFORCEMENT_ON. The default value is DEFAULT.

Returns:

A StdContactControl object.

Raises:

RangeError.

Notes

This function can be accessed by:

mdb.models[name].StdContactControl

StdInitialization(name: str, overclosureType: SymbolicConstantType = 'ADJUST', interferenceDistance: float | None = None, clearanceDistance: float | None = None, openingTolerance: float | None = None, overclosureTolerance: float | None = None) → StdInitialization

This method creates a StdInitialization object.

Parameters:

name

A String specifying the contact initialization repository key.

overclosureType

A SymbolicConstant specifying the type of overclosure to be defined. Possible values are ADJUST, INTERFERENCE, and CLEARANCE. The default value is ADJUST.

interferenceDistance

None or a Float specifying the interference distance. This argument is valid only when *overclosureType*=INTERFERENCE. The default value is None.

clearanceDistance

None or a Float specifying the initial clearance distance. This argument is valid only when *overclosureType*=CLEARANCE, and must be specified in that case. The default value is None.

openingTolerance

None or a Float specifying the distance tolerance within which initial openings will undergo strain-free adjustments. This argument is not valid when overclosureType*=INTERFERENCE unless a value has been specified for *interferenceDistance. The default value is None.

overclosureTolerance

None or a Float specifying the distance tolerance within which initial overclosures will undergo strain-free adjustments.. The default value is None.

Returns:

A StdInitialization object.

Raises:

RangeError.

Notes

This function can be accessed by:

mdb.models[name].StdInitialization

StdStabilization(name: str, zeroDistance: float | None = None, reductionFactor: float = 0, scaleFactor: float = 1, tangentialFactor: float = 0, amplitude: str = '', reset: BooleanType = 0) → StdStabilization

This method creates a StdStabilization object.

Parameters:

name

A String specifying the contact stabilization repository key.

zeroDistance

None or a Float specifying the clearance distance at which the stabilization becomes zero. The default value is None.

reductionFactor

A Float specifying the factor by which the analysis will reduce the contact stabilization coefficient per increment. The default value is 0.1.

scaleFactor

A Float specifying the factor by which the analysis will scale the contact stabilization coefficient. The default value is 1.0.

tangentialFactor

A Float specifying the factor that scales the contact stabilization coefficient in the tangential direction. The default value is 0.0.

amplitude

A String specifying the name of the Amplitude object that defines a time-dependent scale factor for contact stabilization over the step. The default value is an empty string.

reset

A Boolean specifying whether to cancel carryover effects from contact stabilization specifications involving nondefault amplitudes that appeared in previous steps. The default value is OFF.

Returns:

A StdStabilization object.

Raises:

RangeError.

Notes

This function can be accessed by:

mdb.models[name].StdStabilization

StdXplCosimulation(name: str, createStepName: str, region: Region, incrementation: SymbolicConstantType = 'ALLOW_SUBCYCLING', stepSize: float = 0, stepSizeDefinition: SymbolicConstantType = 'DEFAULT') → StdXplCosimulation

This method creates a StdXplCosimulation object.

Parameters:

name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which the StdXplCosimulation object is created.

region

A Region object specifying the import and export region upon which the co-simulation exchanges data with the coupled analysis program.

incrementation

A SymbolicConstant specifying whether the analysis programs use the same time increments or one is allowed to use more time increments than the other before exchanging data. Possible values are ALLOW_SUBCYCLING and LOCKSTEP. The default value is ALLOW_SUBCYCLING.

stepSize

A Float specifying the size of the increments to be used by Abaqus/Standard and Abaqus/Explicit. The default value is 0.0.

stepSizeDefinition

A SymbolicConstant specifying whether the increment size is the analysis default or a supplied variable. Possible values are DEFAULT and SPECIFIED. The default value is DEFAULT.

Returns:

A StdXplCosimulation object.

Notes

This function can be accessed by:

mdb.models[name].StdXplCosimulation

SteadyStateDirectStep(name: str, previous: str, frequencyRange: SteadyStateDirectFrequencyArray, description: str = '', factorization: SymbolicConstantType = 'COMPLEX', scale: SymbolicConstantType = 'LOGARITHMIC', matrixStorage: SymbolicConstantType = 'SOLVER_DEFAULT', maintainAttributes: BooleanType = False, subdivideUsingEigenfrequencies: BooleanType = 0, frictionDamping: BooleanType = 0) → SteadyStateDirectStep

This method creates a SteadyStateDirectStep object.

Parameters:

name

A String specifying the repository key.

previous

A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

frequencyRange

A SteadyStateDirectFrequencyArray object.

description

A String specifying a description of the new step. The default value is an empty string.

factorization

A SymbolicConstant specifying whether damping terms are to be ignored so that a real, rather than a complex, system matrix is factored. Possible values are REAL_ONLY and COMPLEX. The default value is COMPLEX.

scale

A SymbolicConstant specifying whether a logarithmic or linear scale is used for output. Possible values are LOGARITHMIC and LINEAR. The default value is LOGARITHMIC.

matrixStorage

A SymbolicConstant specifying the type of matrix storage. Possible values are SYMMETRIC, UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT.

maintainAttributes

A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is False.

subdivideUsingEigenfrequencies

A Boolean specifying whether to subdivide each frequency range using the eigenfrequencies of the system. The default value is OFF.

frictionDamping

A Boolean specifying whether to add to the damping matrix contributions due to friction effects. The default value is OFF.

Returns:

step: SteadyStateDirectStep

A SteadyStateDirectStep object.

Notes

This function can be accessed by:

mdb.models[name].SteadyStateDirectStep

SteadyStateModalStep(name: str, previous: str, frequencyRange: ~abaqus.StepMiscellaneous.SteadyStateModalFrequencyArray.SteadyStateModalFrequencyArray, description: str = '', scale: ~abaqusConstants.SymbolicConstantType = 'LOGARITHMIC', directDamping: ~abaqus.StepMiscellaneous.DirectDamping.DirectDamping = <abaqus.StepMiscellaneous.DirectDamping.DirectDamping object>, compositeDamping: ~abaqus.StepMiscellaneous.CompositeDamping.CompositeDamping = <abaqus.StepMiscellaneous.CompositeDamping.CompositeDamping object>, rayleighDamping: ~abaqus.StepMiscellaneous.RayleighDamping.RayleighDamping = <abaqus.StepMiscellaneous.RayleighDamping.RayleighDamping object>, structuralDamping: ~abaqus.StepMiscellaneous.StructuralDamping.StructuralDamping = <abaqus.StepMiscellaneous.StructuralDamping.StructuralDamping object>, directDampingByFrequency: ~abaqus.StepMiscellaneous.DirectDampingByFrequency.DirectDampingByFrequency = <abaqus.StepMiscellaneous.DirectDampingByFrequency.DirectDampingByFrequency object>, rayleighDampingByFrequency: ~abaqus.StepMiscellaneous.RayleighDampingByFrequency.RayleighDampingByFrequency = <abaqus.StepMiscellaneous.RayleighDampingByFrequency.RayleighDampingByFrequency object>, structuralDampingByFrequency: ~abaqus.StepMiscellaneous.StructuralDampingByFrequency.StructuralDampingByFrequency = <abaqus.StepMiscellaneous.StructuralDampingByFrequency.StructuralDampingByFrequency object>, maintainAttributes: ~abaqusConstants.BooleanType = False, subdivideUsingEigenfrequencies: ~abaqusConstants.BooleanType = 1) → SteadyStateModalStep

This method creates a SteadyStateModalStep object.

Parameters:

name

A String specifying the repository key.

previous

A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

frequencyRange

A SteadyStateModalFrequencyArray object.

description

A String specifying a description of the new step. The default value is an empty string.

scale

A SymbolicConstant specifying whether a logarithmic or linear scale is used for output. Possible values are LOGARITHMIC and LINEAR. The default value is LOGARITHMIC.

directDamping

A DirectDamping object.

compositeDamping

A CompositeDamping object.

rayleighDamping

A RayleighDamping object.

structuralDamping

A StructuralDamping object.

directDampingByFrequency

A DirectDampingByFrequency object.

rayleighDampingByFrequency

A RayleighDampingByFrequency object.

structuralDampingByFrequency

A StructuralDampingByFrequency object.

maintainAttributes

A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is False.

subdivideUsingEigenfrequencies

A Boolean specifying whether to subdivide each frequency range using the eigenfrequencies of the system. The default value is ON.

Returns:

step: SteadyStateModalStep

A SteadyStateModalStep object.

Notes

This function can be accessed by:

mdb.models[name].SteadyStateModalStep

SteadyStateSubspaceStep(name: str, previous: str, frequencyRange: SteadyStateSubspaceFrequencyArray, description: str = '', factorization: SymbolicConstantType = 'COMPLEX', scale: SymbolicConstantType = 'LOGARITHMIC', matrixStorage: SymbolicConstantType = 'SOLVER_DEFAULT', maintainAttributes: BooleanType = False, subdivideUsingEigenfrequencies: BooleanType = 1, projection: SymbolicConstantType = 'ALL_FREQUENCIES', maxDampingChange: float = 0, maxStiffnessChange: float = 0, frictionDamping: BooleanType = 0) → SteadyStateSubspaceStep

This method creates a SteadyStateSubspaceStep object.

Parameters:

name

A String specifying the repository key.

previous

A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

frequencyRange

A SteadyStateSubspaceFrequencyArray object.

description

A String specifying a description of the new step. The default value is an empty string.

factorization

A SymbolicConstant specifying whether damping terms are to be ignored so that a real, rather than a complex, system matrix is factored. Possible values are REAL_ONLY and COMPLEX. The default value is COMPLEX.

scale

A SymbolicConstant specifying whether a logarithmic or linear scale is used for output. Possible values are LOGARITHMIC and LINEAR. The default value is LOGARITHMIC.

matrixStorage

A SymbolicConstant specifying the type of matrix storage. Possible values are SYMMETRIC, UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT.

maintainAttributes

A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is False.

subdivideUsingEigenfrequencies

A Boolean specifying whether to subdivide each frequency range using the eigenfrequencies of the system. The default value is ON.

projection

A SymbolicConstant specifying how often to perform subspace projections onto the modal subspace. Possible values are ALL_FREQUENCIES, CONSTANT, EIGENFREQUENCY, PROPERTY_CHANGE, and RANGE. The default value is ALL_FREQUENCIES.

maxDampingChange

A Float specifying the maximum relative change in damping material properties before a new projection is to be performed. The default value is 0.1.

maxStiffnessChange

A Float specifying the maximum relative change in stiffness material properties before a new projection is to be performed. The default value is 0.1.

frictionDamping

A Boolean specifying whether to add to the damping matrix contributions due to friction effects. The default value is OFF.

Returns:

step: SteadyStateSubspaceStep

A SteadyStateSubspaceStep object.

Notes

This function can be accessed by:

mdb.models[name].SteadyStateSubspaceStep

Stress(name: str, region: Region, distributionType: SymbolicConstantType = 'UNIFORM', sigma11: float | None = None, sigma22: float | None = None, sigma33: float | None = None, sigma12: float | None = None, sigma13: float | None = None, sigma23: float | None = None) → Stress

This method creates a Stress predefined field object.

Parameters:

name

A String specifying the repository key.

region

A Region object specifying the region to which the predefined field is applied. Region is ignored if the predefined field has *distributionType*=FROM_FILE.

distributionType

A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM and FROM_FILE. The default value is UNIFORM.

sigma11

A Float specifying the first principal component of the stress.

sigma22

A Float specifying the second principal component of the stress.

sigma33

A Float specifying the third principal component of the stress.

sigma12

A Float specifying the first shear component of the stress.

sigma13

A Float specifying the second shear component of the stress.

sigma23

A Float specifying the third shear component of the stress.

Returns:

A Stress object.

Notes

This function can be accessed by:

mdb.models[name].Stress

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

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

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

This method creates a SubmodelSB object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created.

region

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

globalStep

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

globalDrivingRegion

A String specifying the element set in the global model that will be searched for elements whose responses will be used to drive the submodel. An empty string indicates that the entire global model will be searched. The default value is an empty string.

absoluteExteriorTolerance

None or a Float specifying the absolute value by which a driven node of the submodel can lie outside the region of the elements of the global model. The default value is None.

exteriorTolerance

None or a Float specifying the fraction of the average element size in the global model by which a driven node of the submodel can lie outside the region of the elements of the global model. The default value is 0.05.

globalIncrement

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

Returns:

A SubmodelSB object.

Notes

This function can be accessed by:

mdb.models[name].SubmodelSB

SubspaceDynamicsStep(name: str, previous: str, description: str = '', timePeriod: float = 1, vectors: SymbolicConstantType = 'ALL', nlgeom: BooleanType = 0, maxNumInc: int = 100, incSize: float = 0, amplitude: SymbolicConstantType = 'STEP', maintainAttributes: BooleanType = False) → SubspaceDynamicsStep

This method creates a SubspaceDynamicsStep object.

Parameters:

name

A String specifying the repository key.

previous

A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

description

A String specifying a description of the new step. The default value is an empty string.

timePeriod

A Float specifying the total time period of the step. The default value is 1.0.

vectors

The SymbolicConstant ALL or an Int specifying the number of modes to be used for subspace projection. The possible value for the SymbolicConstant is ALL. The default value is ALL.

nlgeom

A Boolean specifying whether to allow for geometric nonlinearity. The default value is OFF.

maxNumInc

An Int specifying the maximum number of increments in a step. The default value is 100.

incSize

A Float specifying the suggested time increment. The default value is 0.0.

amplitude

A SymbolicConstant specifying the amplitude variation for loading magnitudes during the step. Possible values are STEP and RAMP. The default value is STEP.

maintainAttributes

A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is False.

Returns:

step: SubspaceDynamicsStep

A SubspaceDynamicsStep object.

Notes

This function can be accessed by:

mdb.models[name].SubspaceDynamicsStep

SubstructureGenerateStep(name: str, previous: str, substructureIdentifier: int, description: str = '', recoveryMatrix: ~abaqusConstants.SymbolicConstantType = 'WHOLE_MODEL', recoveryRegion: ~abaqus.Region.Region.Region = <abaqus.Region.Region.Region object>, computeGravityLoadVectors: ~abaqusConstants.BooleanType = False, computeReducedMassMatrix: ~abaqusConstants.BooleanType = False, computeReducedStructuralDampingMatrix: ~abaqusConstants.BooleanType = False, computeReducedViscousDampingMatrix: ~abaqusConstants.BooleanType = False, evaluateFrequencyDependentProperties: ~abaqusConstants.BooleanType = False, frequency: float = 0, retainedEigenmodesMethod: ~abaqusConstants.SymbolicConstantType = 'NONE', modeRange: ~abaqus.StepMiscellaneous.SubstructureGenerateModesArray.SubstructureGenerateModesArray | None = None, frequencyRange: ~abaqus.StepMiscellaneous.SubstructureGenerateFrequencyArray.SubstructureGenerateFrequencyArray | None = None, globalDampingField: ~abaqusConstants.SymbolicConstantType = 'NONE', alphaDampingRatio: float = 0, betaDampingRatio: float = 0, structuralDampingRatio: float = 0, viscousDampingControl: ~abaqusConstants.SymbolicConstantType = 'NONE', structuralDampingControl: ~abaqusConstants.SymbolicConstantType = 'NONE') → SubstructureGenerateStep

This method creates a SubstructureGenerateStep object.

Parameters:

name

A String specifying the repository key.

previous

A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

substructureIdentifier

An Integer specifying a unique identifier for the substructure.

description

A String specifying a description of the new step. The default value is an empty string.

recoveryMatrix

A SymbolicConstant specifying the subtructure recovery to be computed. Possible values are WHOLE_MODEL, REGION, and NONE. The default value is WHOLE_MODEL.

recoveryRegion

A Region object specifying the region for substructure recovery. This argument is required when *recoveryMatrix*=REGION.

computeGravityLoadVectors

A Boolean specifying whether to compute the gravity load vectors. The default value is False.

computeReducedMassMatrix

A Boolean specifying whether to compute the reduced mass matrix. The default value is False.

computeReducedStructuralDampingMatrix

A Boolean specifying whether to compute the reduced structural damping matrix. The default value is False.

computeReducedViscousDampingMatrix

A Boolean specifying whether to compute the reduced viscous damping matrix. The default value is False.

evaluateFrequencyDependentProperties

A Boolean specifying whether to evaluate the frequency dependent properties. The default value is False.

frequency

A Float specifying the frequency at which to evaluate the frequency dependent properties. The default value is 0.0.

retainedEigenmodesMethod

A SymbolicConstant specifying the eigenmodes to be retained. Possible values are MODE_RANGE, FREQUENCY_RANGE, and NONE. The default value is NONE.

modeRange

A SubstructureGenerateModesArray object.

frequencyRange

A SubstructureGenerateFrequencyArray object.

globalDampingField

A SymbolicConstant specifying the field to which the global damping factors should be applied. Possible values are ALL, ACOUSTIC, MECHANICAL, and NONE. The default value is NONE.

alphaDampingRatio

A Float specifying the factor to create global Rayleigh mass proportional damping. The default value is 0.0.

betaDampingRatio

A Float specifying the factor to create global Rayleigh stiffness proportional damping. The default value is 0.0.

structuralDampingRatio

A Float specifying the factor to create frequency-independent stiffness proportional structural damping. The default value is 0.0.

viscousDampingControl

A SymbolicConstant specifying the damping control to include the viscous damping matrix. Possible values are ELEMENT, FACTOR, COMBINED, and NONE. The default value is NONE.

structuralDampingControl

A SymbolicConstant specifying the damping control to include the structural damping matrix. Possible values are ELEMENT, FACTOR, COMBINED, and NONE. The default value is NONE.

Returns:

step: SubstructureGenerateStep

A SubstructureGenerateStep object.

Notes

This function can be accessed by:

mdb.models[name].SubstructureGenerateStep

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

This method creates a SubstructureLoad object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the substructure load is created.

region

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

loadCaseNames

A list of names of the load cases that should be activated by this substructure load.

magnitude

A Float specifying the multiplier for the load case magnitude.

amplitude

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

Returns:

A SubstructureLoad object.

Notes

This function can be accessed by:

mdb.models[name].SubstructureLoad

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

This method creates a SurfaceCharge object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created. This must be the first analysis step name.

region

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

magnitude

A Float specifying the load magnitude.

distributionType

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

field

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

amplitude

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

Returns:

A SurfaceCharge object.

Notes

This function can be accessed by:

mdb.models[name].SurfaceCharge

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

This method creates a SurfaceConcentrationFlux object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created.

region

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

magnitude

A Float specifying the surface concentration flux magnitude. magnitude is optional if *distributionType*=USER_DEFINED.

field

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

distributionType

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

amplitude

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

Returns:

A SurfaceConcentrationFlux object.

Notes

This function can be accessed by:

mdb.models[name].SurfaceConcentrationFlux

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

This method creates a SurfaceCurrent object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created. This must be the first analysis step name.

region

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

magnitude

A Float specifying the load magnitude.

distributionType

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

field

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

amplitude

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

Returns:

A SurfaceCurrent object.

Notes

This function can be accessed by:

mdb.models[name].SurfaceCurrent

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

This method creates a SurfaceCurrentDensity object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created. This must be the first analysis step name.

region

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

comp1

A Complex specifying the first component of the load.

comp2

A Complex specifying the second component of the load.

comp3

A Complex specifying the third component of the load.

distributionType

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

amplitude

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

Returns:

A SurfaceCurrentDensity object.

Notes

This function can be accessed by:

mdb.models[name].SurfaceCurrentDensity

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

This method creates a SurfaceHeatFlux object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created.

region

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

magnitude

A Float specifying the surface heat flux magnitude. magnitude is optional if *distributionType*=USER_DEFINED.

field

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

distributionType

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

amplitude

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

Returns:

A SurfaceHeatFlux object.

Notes

This function can be accessed by:

mdb.models[name].SurfaceHeatFlux

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

This method creates a SurfacePoreFluid object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created.

region

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

magnitude

A Float specifying the surface pore fluid flow magnitude. magnitude is optional if *distributionType*=USER_DEFINED.

field

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

distributionType

A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM, USER_DEFINED, and FIELD. The default value is UNIFORM.

amplitude

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

Returns:

A SurfacePoreFluid object.

Notes

This function can be accessed by:

mdb.models[name].SurfacePoreFluid

SurfaceSection(name: str, useDensity: BooleanType = 0, density: float = 0) → SurfaceSection

This method creates a SurfaceSection object.

Parameters:

name

A String specifying the repository key.

useDensity

A Boolean specifying whether or not to use the value of density. The default value is OFF.

density

A Float specifying the value of density to apply to this section. The default value is 0.0.

Returns:

A SurfaceSection object.

Raises:

RangeError and InvalidNameError.

Notes

This function can be accessed by:

mdb.models[name].SurfaceSection
session.odbs[name].SurfaceSection

SurfaceToSurfaceContactExp(name: str, createStepName: str, main: ~abaqus.Region.Region.Region, secondary: ~abaqus.Region.Region.Region, sliding: ~abaqusConstants.SymbolicConstantType, interactionProperty: str, mechanicalConstraint: ~abaqusConstants.SymbolicConstantType = 'KINEMATIC', weightingFactorType: ~abaqusConstants.SymbolicConstantType = 'DEFAULT', weightingFactor: float = 0, contactControls: str = '', initialClearance: ~abaqusConstants.SymbolicConstantType | float = 'OMIT', halfThreadAngle: str | None = None, pitch: str | None = None, majorBoltDiameter: ~abaqusConstants.SymbolicConstantType | float = 'COMPUTED', meanBoltDiameter: ~abaqusConstants.SymbolicConstantType | float = 'COMPUTED', datumAxis: ~abaqus.Datum.DatumAxis.DatumAxis = <abaqus.Datum.DatumAxis.DatumAxis object>, useReverseDatumAxis: ~abaqusConstants.BooleanType = 0, clearanceRegion: ~abaqus.Region.Region.Region = <abaqus.Region.Region.Region object>) → SurfaceToSurfaceContactExp

This method creates a SurfaceToSurfaceContactExp object.

Parameters:

name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which the SurfaceToSurfaceContactExp object is created.

master

A Region object specifying the master surface.

slave

A Region object specifying the slave surface.

sliding

A SymbolicConstant specifying the contact formulation. Possible values are FINITE and SMALL.

interactionProperty

A String specifying the name of the ContactProperty object associated with this interaction.

mechanicalConstraint

A SymbolicConstant specifying the mechanical constraint formulation. Possible values are KINEMATIC and PENALTY. The default value is KINEMATIC.

weightingFactorType

A SymbolicConstant specifying the weighting for node-to-face contact. Possible values are DEFAULT and SPECIFIED. The default value is DEFAULT.

weightingFactor

A Float specifying the weighting factor for the contact surfaces when *weightingFactorType*=SPECIFIED. The default value is 0.0.

contactControls

A String specifying the name of the ContactControl object associated with this interaction. An empty string indicates that the default contact controls will be used. The default value is an empty string.

initialClearance

A SymbolicConstant or a Float specifying the initial clearance at regions of contact. Possible values are OMIT and COMPUTED. The default value is OMIT.

halfThreadAngle

None or a sequence of Floats specifying the half thread angle used for bolt clearance. The default value is None.

pitch

None or a sequence of Floats specifying the pitch used for bolt clearance. The default value is None.

majorBoltDiameter

The SymbolicConstant COMPUTED or a Float specifying the major diameter of the bolt used for bolt clearance. The default value is COMPUTED.

meanBoltDiameter

The SymbolicConstant COMPUTED or a Float specifying the mean diameter of the bolt used for bolt clearance. The default value is COMPUTED.

datumAxis

A DatumAxis object specifying the orientation of the bolt hole when specifying bolt clearance.

useReverseDatumAxis

A Boolean specifying whether to reverse the bolt clearance direction given by the datum axis. The default value is OFF.

clearanceRegion

A Region object specifying the contact region for which clearance is specified.

Returns:

A SurfaceToSurfaceContactExp object.

Notes

This function can be accessed by:

mdb.models[name].SurfaceToSurfaceContactExp

SurfaceToSurfaceContactStd(name: str, createStepName: str, main: ~abaqus.Region.Region.Region, secondary: ~abaqus.Region.Region.Region, sliding: ~abaqusConstants.SymbolicConstantType, interactionProperty: str, interferenceType: ~abaqusConstants.SymbolicConstantType = 'NONE', overclosure: float = 0, interferenceDirectionType: ~abaqusConstants.SymbolicConstantType = 'COMPUTED', direction: tuple = (), amplitude: str = '', smooth: float = 0, hcrit: float = 0, extensionZone: float = 0, adjustMethod: ~abaqusConstants.SymbolicConstantType = 'NONE', adjustTolerance: float = 0, adjustSet: ~abaqus.Region.Region.Region = <abaqus.Region.Region.Region object>, enforcement: ~abaqusConstants.SymbolicConstantType = 'SURFACE_TO_SURFACE', thickness: ~abaqusConstants.BooleanType = 1, contactControls: str = '', tied: ~abaqusConstants.BooleanType = 0, initialClearance: ~abaqusConstants.SymbolicConstantType | float = 'OMIT', halfThreadAngle: str | None = None, pitch: str | None = None, majorBoltDiameter: ~abaqusConstants.SymbolicConstantType | float = 'COMPUTED', meanBoltDiameter: ~abaqusConstants.SymbolicConstantType | float = 'COMPUTED', datumAxis: ~abaqus.Datum.DatumAxis.DatumAxis = <abaqus.Datum.DatumAxis.DatumAxis object>, useReverseDatumAxis: ~abaqusConstants.BooleanType = 0, clearanceRegion: ~abaqus.Region.Region.Region = <abaqus.Region.Region.Region object>, surfaceSmoothing: ~abaqusConstants.SymbolicConstantType = 'NONE', bondingSet: ~abaqus.Region.Region.Region = <abaqus.Region.Region.Region object>, handedness: ~abaqusConstants.SymbolicConstantType = 'RIGHT', normalAdjustment: ~abaqusConstants.SymbolicConstantType | None = None) → SurfaceToSurfaceContactStd

This method creates a SurfaceToSurfaceContactStd object.

Parameters:

name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which the SurfaceToSurfaceContactStd object is created.

main

A Region object specifying the master surface.

secondary

A Region object specifying the slave surface.

sliding

A SymbolicConstant specifying the contact formulation. Possible values are FINITE and SMALL.

interactionProperty

A String specifying the name of the ContactProperty object associated with this interaction.

interferenceType

A SymbolicConstant specifying the type of time-dependent allowable interference for contact pairs and contact elements. Possible values are: - NONE, specifying no allowable contact interference. - SHRINK_FIT. - UNIFORM. The default value is NONE.

overclosure

A Float specifying the maximum overclosure distance allowed. This argument applies only when *interferenceType*=UNIFORM. The default value is 0.0.

interferenceDirectionType

A SymbolicConstant specifying the method used to determine the interference direction. Possible values are COMPUTED and DIRECTION_COSINE. The default value is COMPUTED.

direction

A sequence of three Floats specifying the following: - XX-direction cosine of the interference direction vector. - YY-direction cosine of the interference direction vector. - ZZ-direction cosine of the interference direction vector. This argument is required only when *interferenceDirectionType*=DIRECTION_COSINE.

amplitude

A String specifying the name of the amplitude curve that defines the magnitude of the prescribed interference during the step. Use None to specify that the prescribed interference is applied immediately at the beginning of the step and ramped down to zero linearly over the step.

smooth

A Float specifying the degree of smoothing used for deformable or rigid master surfaces involved when *enforcement*=NODE_TO_SURFACE. The value given must lie between 0.0 and 0.5. The default value is 0.2.

hcrit

A Float specifying the distance by which a slave node must penetrate the master surface before Abaqus/Standard abandons the current increment and tries again with a smaller increment. The default value is 0.0.

extensionZone

A Float specifying a fraction of the end segment or facet edge length by which the master surface is to be extended to avoid numerical round-off errors associated with contact modeling. The value given must lie between 0.0 and 0.2. The default value is 0.1.

adjustMethod

A SymbolicConstant specifying the adjust method. Possible values are NONE, OVERCLOSED, TOLERANCE, and SET. The default value is NONE.

adjustTolerance

A Float specifying the adjust tolerance. The default value is 0.0.

adjustSet

A Region object specifying the Set object to which the adjustment is to be applied.

enforcement

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

thickness

A Boolean specifying whether shell/membrane element thickness is considered. The default value is ON.This argument is not valid when *sliding*=FINITE and *enforcement*=NODE_TO_SURFACE.

contactControls

A String specifying the name of the ContactControl object associated with this interaction. The empty string indicates that the default contact controls will be used. The default value is an empty string.

tied

A Boolean specifying whether the surfaces are to be “tied” together for the duration of the simulation. The default value is OFF.

initialClearance

A SymbolicConstant or a Float specifying the initial clearance at regions of contact. Possible values are OMIT and COMPUTED. The default value is OMIT.

halfThreadAngle

None or a sequence of Floats specifying the half thread angle used for bolt clearance. The default value is None.

pitch

None or a sequence of Floats specifying the pitch used for bolt clearance. The default value is None.

majorBoltDiameter

The SymbolicConstant COMPUTED or a Float specifying the major diameter of the bolt used for bolt clearance. The default value is COMPUTED.

meanBoltDiameter

The SymbolicConstant COMPUTED or a Float specifying the mean diameter of the bolt used for bolt clearance. The default value is COMPUTED.

datumAxis

A DatumAxis object specifying the orientation of the bolt hole when specifying bolt clearance.

useReverseDatumAxis

A Boolean specifying whether to reverse the bolt clearance direction given by the datum axis. The default value is OFF.

clearanceRegion

A Region object specifying the contact region for which clearance is specified.

surfaceSmoothing

A SymbolicConstant specifying whether to use surface smoothing for geometric surfaces in SurfaceToSurfaceContactStd interactions. Possible values are AUTOMATIC and NONE. The default value is NONE.

bondingSet

A Region object specifying the slave node sub-set for bonding, used only when the contact property CohesiveBehavior option specifies use.

handedness

A SymbolicConstant specifying the bolt handedness formulation. Possible values are RIGHT and LEFT. The default value is RIGHT.

normalAdjustment

A SymbolicConstant specifying the bolt normal adjustment formulation for all slave nodes. Possible values are UNIFORM AXIAL COMPONENT and LOCATION DEPENDENT. The default value is UNIFORM AXIAL COMPONENT.

Returns:

A SurfaceToSurfaceContactStd object.

Notes

This function can be accessed by:

mdb.models[name].SurfaceToSurfaceContactStd

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

This method creates a SurfaceTraction object.

Parameters:

name

A String specifying the load repository key.

createStepName

A String specifying the name of the step in which the load is created.

region

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

magnitude

A Float or Complex specifying the load magnitude. magnitude is optional if *distributionType*=USER_DEFINED.

distributionType

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

field

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

amplitude

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

angle

A Float specifying an additional rotation of directionVector about an axis. The default value is 0.0.

axis

A SymbolicConstant specifying the axis about which to apply an additional rotation of directionVector. Possible values are AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_1.

localCsys

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

userCsys

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

directionVector

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

follower

A Boolean specifying whether the direction of the force changes with rotation. The default value is ON.This parameter may be modified only if traction is GENERAL. You should provide the follower argument only if it is valid for the specified step.

resultant

A Boolean specifying whether the to maintain a constant resultant force by defining traction per unit undeformed area. If resultant is OFF, traction is defined per unit deformed area. The default value is OFF.You should provide the resultant argument only if it is valid for the specified step.

traction

A SymbolicConstant specifying how to apply surface traction. Possible values are SHEAR and GENERAL. The default value is SHEAR.

Returns:

A SurfaceTraction object.

Notes

This function can be accessed by:

mdb.models[name].SurfaceTraction

TProfile(name: str, b: float, h: float, l: float, tf: float, tw: float) → TProfile

This method creates a TProfile object.

Parameters:

name

A String specifying the repository key.

b

A positive Float specifying the b dimension (flange width) of the T profile. For more information, see [Beam cross-section library](https://help.3ds.com/2021/English/DSSIMULIA_Established/SIMACAEELMRefMap/simaelm-c-beamcrosssectlib.htm?ContextScope=all).

h

A positive Float specifying the h dimension (height) of the T profile.

l

A positive Float specifying the l dimension (offset of 1–axis from the edge of web) of the T profile.

tf

A positive Float specifying the tf dimension (flange thickness) of the T profile (tf < h).

tw

A positive Float specifying the tw dimension (web thickness) of the T profile (tw< b).

Returns:

A TProfile object.

Raises:

RangeError.

!img

Notes

This function can be accessed by:

mdb.models[name].TProfile
session.odbs[name].TProfile

TabularAmplitude(name: str, data: tuple, smooth: SymbolicConstantType | float = 'SOLVER_DEFAULT', timeSpan: SymbolicConstantType = 'STEP') → TabularAmplitude

This method creates a TabularAmplitude object.

Parameters:

name

A String specifying the repository key.

data

A sequence of pairs of Floats specifying time/frequency and amplitude pairs. Possible values for time/frequency are positive numbers.

smooth

The SymbolicConstant SOLVER_DEFAULT or a Float specifying the degree of smoothing. Possible float values are between 0 and 0.5. If *smooth*=SOLVER_DEFAULT, the default degree of smoothing will be determined by the solver. The default value is SOLVER_DEFAULT.

timeSpan

A SymbolicConstant specifying the time span of the amplitude. Possible values are STEP and TOTAL. The default value is STEP.

Returns:

A TabularAmplitude object.

Raises:

InvalidNameError

RangeError

Notes

This function can be accessed by:

mdb.models[name].TabularAmplitude
session.odbs[name].TabularAmplitude

TempDisplacementDynamicsStep(name: str, previous: str, description: str = '', timePeriod: float = 1, nlgeom: BooleanType = 0, timeIncrementationMethod: SymbolicConstantType = 'AUTOMATIC_GLOBAL', maxIncrement: float | None = None, scaleFactor: float = 1, userDefinedInc: float | None = None, massScaling: MassScalingArray = 'PREVIOUS_STEP', linearBulkViscosity: float = 0, quadBulkViscosity: float = 1, maintainAttributes: BooleanType = False, improvedDtMethod: BooleanType = 1) → TempDisplacementDynamicsStep

This method creates a TempDisplacementDynamicsStep object.

Parameters:

name

A String specifying the repository key.

previous

A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

description

A String specifying a description of the new step. The default value is an empty string.

timePeriod

A Float specifying the time period of the step. The default value is 1.0.

nlgeom

A Boolean specifying whether geometric nonlinearities should be accounted for during the step. The default value is OFF.

timeIncrementationMethod

A SymbolicConstant specifying the time incrementation method to be used. Possible values are AUTOMATIC_GLOBAL, AUTOMATIC_EBE, FIXED_USER_DEFINED_INC, and FIXED_EBE. The default value is AUTOMATIC_GLOBAL.

maxIncrement

None or a Float specifying the maximum time increment allowed. If there is no upper limit, *maxIncrement*=None. The default value is None.

scaleFactor

A Float specifying the factor that is used to scale the time increment. This argument is required only when *timeIncrementationMethod*=AUTOMATIC_GLOBAL, AUTOMATIC_EBE, or FIXED_EBE. The default value is 1.0.

userDefinedInc

None or a Float specifying the user-defined time increment. The default value is None.

massScaling

A MassScalingArray object specifying mass scaling controls. The default value is PREVIOUS_STEP.

linearBulkViscosity

A Float specifying the linear bulk viscosity parameter, b1b1. The default value is 0.06.

quadBulkViscosity

A Float specifying the quadratic bulk viscosity parameter, b2b2. The default value is 1.2.

maintainAttributes

A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is False.

improvedDtMethod

A Boolean specifying whether to use the “improved” (*improvedDtMethod*=ON) or “conservative” (*improvedDtMethod*=OFF) method to estimate the element stable time increment for three-dimensional continuum elements and elements with plane stress formulations (shell, membrane, and two-dimensional plane stress elements). The default value is ON.

Returns:

step: TempDisplacementDynamicsStep

A TempDisplacementDynamicsStep object.

Notes

This function can be accessed by:

mdb.models[name].TempDisplacementDynamicsStep

Temperature(name: str, createStepName: str, region: Region, distributionType: SymbolicConstantType = 'UNIFORM', crossSectionDistribution: SymbolicConstantType = 'CONSTANT_THROUGH_THICKNESS', field: str = '', amplitude: str = 'UNSET', fileName: str = '', beginStep: SymbolicConstantType | None = None, beginIncrement: SymbolicConstantType | None = None, endStep: SymbolicConstantType | None = None, endIncrement: SymbolicConstantType | None = None, interpolate: SymbolicConstantType = 0, magnitudes: str = '', absoluteExteriorTolerance: float = 0, exteriorTolerance: float = 0) → Temperature

This method creates a Temperature object.

Parameters:

name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which the predefined field is created.

region

A Region object specifying the region to which the predefined field is applied. Region is ignored if the predefined field has a distributionType member available, and *distributionType*=FROM_FILE .

distributionType

A SymbolicConstant specifying how the predefined field varies spatially. Possible values are UNIFORM, USER_DEFINED, FROM_FILE, FIELD, FROM_FILE_AND_USER_DEFINED, and DISCRETE_FIELD. The default value is UNIFORM.

crossSectionDistribution

A SymbolicConstant specifying how the predefined field is distributed over the cross section of the region. Possible values are - CONSTANT_THROUGH_THICKNESS - GRADIENTS_THROUGH_SHELL_CS - GRADIENTS_THROUGH_BEAM_CS - POINTS_THROUGH_SECTION The default value is CONSTANT_THROUGH_THICKNESS.

field

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

amplitude

A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the predefined field has no amplitude reference. The default value is UNSET.Note:amplitude should be given only if it is valid for the specified step.

fileName

A String specifying the name of the file from which the temperature values are to be read when *distributionType*=FROM_FILE or *distributionType*=FROM_FILE_AND_USER_DEFINED.

beginStep

An Int specifying the first step from which temperature values are to be read or the SymbolicConstant FIRST_STEP or LAST_STEP. This argument is valid only when *distributionType*=FROM_FILE or *distributionType*=FROM_FILE_AND_USER_DEFINED. The default value is None.

beginIncrement

An Int specifying the first increment of the step set in beginStep or the SymbolicConstants STEP_START or STEP_END. This argument is valid only when *distributionType*=FROM_FILE or *distributionType*=FROM_FILE_AND_USER_DEFINED. The default value is None.

endStep

An Int specifying the last step from which temperature values are to be read or the SymbolicConstants FIRST_STEP and LAST_STEP. This argument is valid only when *distributionType*=FROM_FILE or *distributionType*=FROM_FILE_AND_USER_DEFINED. The default value is None.

endIncrement

An Int specifying the last increment of the step set in endStep or the SymbolicConstants STEP_START and STEP_END. This argument is valid only when *distributionType*=FROM_FILE or *distributionType*=FROM_FILE_AND_USER_DEFINED. The default value is None.

interpolate

A SymbolicConstant specifying whether to interpolate a field read from an output database or results file. Possible values are OFF, ON or MIDSIDE_ONLY. The default value is OFF.

magnitudes

A Sequence of Doubles specifying the temperature values when distributionType*=UNIFORM or FIELD. The value of the *magnitudes argument is a function of the crossSectionDistribution argument, as shown in the following list: - If crossSectionDistribution*=CONSTANT_THROUGH_THICKNESS then *magnitudes is a Double specifying the temperature. - If crossSectionDistribution*=GRADIENTS_THROUGH_SHELL_CS then *magnitudes is a sequence of Doubles specifying the mean value and the gradient in the thickness direction. - If crossSectionDistribution*=GRADIENTS_THROUGH_BEAM_CS then *magnitudes is a sequence of Doubles specifying the mean value, the gradient in the N1 direction, and the gradient in the N2 direction. - If crossSectionDistribution*=POINTS_THROUGH_SECTION then *magnitudes is a sequence of Doubles specifying the temperature at each point.

absoluteExteriorTolerance

A Float specifying the absolute value by which a driven node of the field can lie outside the region of the elements of the global model. The default value is 0.0. This argument cannot be used with midside.

exteriorTolerance

A Float specifying the fraction of the average element size in the global model by which a driven node of the field can lie outside the region of the elements of the global model. The default value is 0.0. This argument cannot be used with midside.

Returns:

A Temperature object.

Notes

This function can be accessed by:

mdb.models[name].Temperature

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

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

Tie(name: str, main: Region, secondary: Region, adjust: BooleanType = 1, positionToleranceMethod: SymbolicConstantType = 'COMPUTED', positionTolerance: float = 0, tieRotations: BooleanType = 1, constraintRatioMethod: SymbolicConstantType = 'DEFAULT', constraintRatio: float = 0, constraintEnforcement: SymbolicConstantType = 'SOLVER_DEFAULT', thickness: BooleanType = 1) → Tie

This method creates a Tie object.

Parameters:

name

A String specifying the constraint repository key.

main

A Region object specifying the name of the master surface.

secondary

A Region object specifying the name of the slave surface.

adjust

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

positionToleranceMethod

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

positionTolerance

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

tieRotations

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

constraintRatioMethod

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

constraintRatio

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

constraintEnforcement

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

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

Returns:

A Tie object.

Notes

This function can be accessed by:

mdb.models[name].Tie

TimePoint(name: str, points: tuple) → TimePoint

This method creates a TimePoint object.

Parameters:

name

A String specifying the repository key.

points

A sequence of sequences of Floats specifying time points at which data are written to the output database or restart files.

Returns:

A TimePoint object.

Raises:

InvalidNameError

RangeError

Notes

This function can be accessed by:

mdb.models[name].TimePoint

TopologyTask(name: str, abaqusSensitivities: BooleanType = True, algorithm: SymbolicConstantType = 'GENERAL_OPTIMIZATION', densityMoveLimit: float = 0, densityUpdateStrategy: SymbolicConstantType = 'NORMAL', elementDensityDeltaStopCriteria: float = 0, filterRadius: float | None = None, firstCycleDeletedVolume: float = 5, firstCycleDeletedVolumeTechnique: SymbolicConstantType = 0, freezeBoundaryConditionRegions: BooleanType = 0, freezeLoadRegions: BooleanType = 1, frequencySpectrumWeight: float = 6, initialDensity: SymbolicConstantType = 'DEFAULT', materialInterpolationPenalty: float = 3, materialInterpolationTechnique: SymbolicConstantType = 'DEFAULT', maxDensity: float = 1, minDensity: float | None = None, modeTrackingRegion: SymbolicConstantType = 'MODEL', numDesignCycles: int = 15, numFulfilledStopCriteria: int = 2, numTrackedModes: int = 5, objectiveFunctionDeltaStopCriteria: float | None = None, region: SymbolicConstantType = 'MODEL', softDeletionMethod: SymbolicConstantType = 'STANDARD', softDeletionRadius: float = 0, softDeletionRegion: str | None = None, softDeletionThreshold: float | None = None, stepSize: SymbolicConstantType = 'MEDIUM', stiffnessMassDamping: SymbolicConstantType | float = 'AVERAGE_EDGE_LENGTH', stopCriteriaDesignCycle: int = 4, structuralMassDamping: float | None = None, viscousMassDamping: float | None = None, viscousStiffnessDamping: float | None = None, groupOperator: BooleanType = 0) → TopologyTask

This method creates a TopologyTask object.

Parameters:

name

A String specifying the optimization task repository key.

abaqusSensitivities

A Boolean specifying whether to use Abaqus to compute the design responses and their sensitivities. The default value is True.

algorithm

A SymbolicConstant specifying the optimization task algorithm. Possible values are GENERAL_OPTIMIZATION and CONDITION_BASED_OPTIMIZATION. The default value is GENERAL_OPTIMIZATION.

densityMoveLimit

A Float specifying the maximum density change per design cycle. The default value is 0.25.

densityUpdateStrategy

A SymbolicConstant specifying the strategy for how the densities are updated in the method of moving asymptotes. Possible values are NORMAL, CONSERVATIVE, and AGGRESSIVE. The default value is NORMAL.

elementDensityDeltaStopCriteria

A Float specifying the stop criteria based upon the change in element densities. The default value is 0.5×10–2.

filterRadius

None or a Float specifying the mesh filter radius for mesh independence and minimum size. The default value is None.

firstCycleDeletedVolume

A Float specifying the volume that can be removed immediately in the first design cycle. The default value is 5.0.

firstCycleDeletedVolumeTechnique

A SymbolicConstant specifying the method of quantifying volume that can be removed immediately in the first design cycle. Possible values are OFF, PERCENTAGE, and ABSOLUTE. The default value is OFF.

freezeBoundaryConditionRegions

A Boolean specifying whether to exclude elements with boundary conditions from the optimization. The default value is OFF.

freezeLoadRegions

A Boolean specifying whether to exclude elements with loads and elements with loaded nodes from the optimization. The default value is ON.

frequencySpectrumWeight

A Float specifying the weighting factor for frequency spectrum peaks. The default value is 6.0.

initialDensity

A SymbolicConstant specifying the Optimization product default or a float specifying the initial density. The default value is DEFAULT.

materialInterpolationPenalty

A Float specifying the penalty factor for the material interpolation technique. The default value is 3.0.

materialInterpolationTechnique

A SymbolicConstant specifying the material interpolation technique: optimization product default, solid isotropic material with penalization, or rational approximation of material properties. Possible values are DEFAULT, SIMP, and RAMP. The default value is DEFAULT.

maxDensity

A Float specifying the maximum density in the density update. The default value is 1.0.

minDensity

A Float specifying the minimum density in the density update. The default value is 10–3.

modeTrackingRegion

The SymbolicConstant MODEL or a Region object specifying the region to use for mode tracking. The default value is MODEL.

numDesignCycles

An Int specifying the number of design cycles permitted when stepSize is DYNAMIC. The default value is 15.

numFulfilledStopCriteria

An Int specifying the number of stop criteria. The default value is 2.

numTrackedModes

An Int specifying the number of modes included in mode tracking. The default value is 5.

objectiveFunctionDeltaStopCriteria

A Float specifying the stop criteria based on the change in objective function. The default value is 10–3.

region

The SymbolicConstant MODEL or a Region object specifying the region to which the optimization task is applied. The default value is MODEL.

softDeletionMethod

A SymbolicConstant specifying the method used when softDeletionRegion is specified. The STANDARD method avoids creating disconnected regions. The AGGRESSIVE method only considers the softDeletionThreshold. The MAX_SHEAR_STRAIN, MAX_ELASTOPLASTIC_STRAIN and VOLUME_COMPRESSION methods do not need the softDeletionRadius. Possible values are STANDARD, AGGRESSIVE, MAX_SHEAR_STRAIN, MIN_PRINCIPAL_STRAIN, MAX_ELASTOPLASTIC_STRAIN and VOLUME_COMPRESSION. The default value is STANDARD.

softDeletionRadius

A Float specifying the radius to use when considering neighboring soft elements to delete. The default value is 0.0.

softDeletionRegion

None or a Region object specifying the region in which the soft elements should be deleted during optimization. The default value is None.

softDeletionThreshold

A Float specifying the relative material density value used to identify soft elements. Those with values below the threshold are considered for removal. For STANDARD and AGGRESSIVE methods positive values are accepted and the default value is 0.05. For MAX_SHEAR_STRAIN and MAX_ELASTOPLASTIC_STRAIN methods positive values are accepted whereas for MIN_PRINCIPAL_STRAIN and VOLUME_COMPRESSION methods negative values are accepted.

stepSize

A SymbolicConstant specifying the size of the increment for volume modification. Possible values are DYNAMIC, VERY_SMALL, SMALL, MODERATE, MEDIUM, and LARGE. The default value is MEDIUM.

stiffnessMassDamping

The SymbolicConstant AVERAGE_EDGE_LENGTH or a Float specifying the stiffness mass damping for the task region. The default value is AVERAGE_EDGE_LENGTH.

stopCriteriaDesignCycle

An Int specifying the first design cycle used to evaluate convergence criteria. The default value is 4.

structuralMassDamping

None or a Float specifying the structural mass damping for the task region. The default value is None.

viscousMassDamping

None or a Float specifying the viscous mass damping for the task region. The default value is None.

viscousStiffnessDamping

None or a Float specifying the viscous stiffness damping for the task region. The default value is None.

Returns:

A TopologyTask object.

Notes

This function can be accessed by:

mdb.models[name].TopologyTask

TrapezoidalProfile(name: str, a: float, b: float, c: float, d: float) → TrapezoidalProfile

This method creates a TrapezoidalProfile object.

Parameters:

name

A String specifying the repository key.

a

A positive Float specifying the a dimension of the Trapezoidal profile. For more information, see [Beam cross-section library](https://help.3ds.com/2021/English/DSSIMULIA_Established/SIMACAEELMRefMap/simaelm-c-beamcrosssectlib.htm?ContextScope=all).

b

A positive Float specifying the b dimension of the Trapezoidal profile.

c

A positive Float specifying the c dimension of the Trapezoidal profile.

d

A Float specifying the d dimension of the Trapezoidal profile.

Returns:

A TrapezoidalProfile object.

Raises:

RangeError.

!img

Notes

This function can be accessed by:

mdb.models[name].TrapezoidalProfile
session.odbs[name].TrapezoidalProfile

TrussSection(name: str, material: str, area: float = 1) → TrussSection

This method creates a TrussSection object.

Parameters:

name

A String specifying the repository key.

material

A String specifying the name of the material.

area

A Float specifying the cross-sectional area for the section. Possible values are area >> 0. The default value is 1.0.

Returns:

A TrussSection object.

Raises:

RangeError and InvalidNameError.

Notes

This function can be accessed by:

mdb.models[name].TrussSection
session.odbs[name].TrussSection

Velocity(name: str, region: Region, velocity1: float, velocity2: float, velocity3: float, omega: float, axisBegin: tuple, axisEnd: tuple, field: str = '', distributionType: SymbolicConstantType = 'MAGNITUDE') → Velocity

This method creates a Velocity predefined field object.

Parameters:

name

A String specifying the repository key.

region

A Region object specifying the region to which the predefined field is applied.

velocity1

A Float specifying the first component of the velocity.

velocity2

A Float specifying the second component of the velocity.

velocity3

A Float specifying the third component of the velocity.

omega

A Float specifying the angular velocity.

axisBegin

A sequence of Floats specifying the X-, Y-, and Z- coordinates of the starting point of the axis about which omega is defined.

axisEnd

A sequence of Floats specifying the X-, Y-, and Z- coordinates of the end point of the axis about which omega is defined.

field

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

distributionType

A SymbolicConstant specifying whether the load is uniform. Possible values are MAGNITUDE and FIELD_ANALYTICAL. The default value is MAGNITUDE.

Returns:

A Velocity object.

Notes

This function can be accessed by:

mdb.models[name].Velocity

VelocityAdaptiveMeshConstraint(name: str, createStepName: str, region: Region, 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, motionType: SymbolicConstantType = 'INDEPENDENT') → VelocityAdaptiveMeshConstraint

This method creates a VelocityAdaptiveMeshConstraint object.

Parameters:

name

A String specifying the adaptive mesh constraint repository key.

createStepName

A String specifying the name of the step in which the adaptive mesh constraint is created.

region

A Region object specifying the region to which the adaptive mesh constraint is applied.

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 adaptive mesh constraint 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 adaptive mesh constraint’s degrees of freedom. If *localCsys*=None, the degrees of freedom are defined in the global coordinate system. The default value is None.

motionType

A SymbolicConstant specifying the mesh motion in relation to the underlying material. Possible values are INDEPENDENT, FOLLOW and USER_DEFINED. The default value is INDEPENDENT.

Returns:

A VelocityAdaptiveMeshConstraint object

Notes

This function can be accessed by:

mdb.models[name].AdaptiveMeshConstraint

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

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

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

ViscoStep(name: str, previous: str, description: str = '', timePeriod: float = 1, nlgeom: BooleanType = 0, stabilizationMethod: SymbolicConstantType = 'NONE', stabilizationMagnitude: float | None = None, timeIncrementationMethod: SymbolicConstantType = 'AUTOMATIC', matrixSolver: SymbolicConstantType = 'DIRECT', matrixStorage: SymbolicConstantType = 'SOLVER_DEFAULT', initialInc: float | None = None, maxNumInc: int = 100, minInc: float | None = None, maxInc: float = 1, integration: SymbolicConstantType = 'IMPLICIT_EXPLICIT', cetol: float = 0, amplitude: SymbolicConstantType = 'STEP', extrapolation: SymbolicConstantType = 'LINEAR', maintainAttributes: BooleanType = False, solutionTechnique: SymbolicConstantType = 'FULL_NEWTON', reformKernel: int = 8, convertSDI: SymbolicConstantType = 'PROPAGATED', adaptiveDampingRatio: float = 0, continueDampingFactors: BooleanType = 0) → ViscoStep

This method creates a ViscoStep object.

Parameters:

name

A String specifying the repository key.

previous

A String specifying the name of the previous step. The new step appears after this step in the list of analysis steps.

description

A String specifying a description of the new step. The default value is an empty string.

timePeriod

A Float specifying the total time period. The default value is 1.0.

nlgeom

A Boolean specifying whether to allow for geometric nonlinearity. The default value is OFF.

stabilizationMethod

A SymbolicConstant specifying the stabilization type. Possible values are NONE, DISSIPATED_ENERGY_FRACTION, and DAMPING_FACTOR. The default value is NONE.

stabilizationMagnitude

A Float specifying the damping intensity of the automatic damping algorithm if the problem is expected to be unstable, and stabilizationMethod is not NONE. The default value is 2×10–4.

timeIncrementationMethod

A SymbolicConstant specifying the time incrementation method to be used. Possible values are FIXED and AUTOMATIC. The default value is AUTOMATIC.

matrixSolver

A SymbolicConstant specifying the type of solver. Possible values are DIRECT and ITERATIVE. The default value is DIRECT.

matrixStorage

A SymbolicConstant specifying the type of matrix storage. Possible values are SYMMETRIC, UNSYMMETRIC, and SOLVER_DEFAULT. The default value is SOLVER_DEFAULT.

initialInc

A Float specifying the initial time increment. The default value is the total time period for the step.

maxNumInc

An Int specifying the maximum number of increments in a step. The default value is 100.

minInc

A Float specifying the minimum time increment allowed. The default value is the smaller of the suggested initial time increment or 10−5 times the total time period.

maxInc

A Float specifying the maximum time increment allowed. The default is the total time period for the step. The default value is 1.0.

integration

A SymbolicConstant specifying which type of integration to use throughout the step. Possible values are IMPLICIT_EXPLICIT and EXPLICIT_ONLY. The default value is IMPLICIT_EXPLICIT.

cetol

A Float specifying the maximum difference in the creep strain increment calculated from the creep strain rates at the beginning and end of the increment. The default value is 0.0.

amplitude

A SymbolicConstant specifying the amplitude variation for loading magnitudes during the step. Possible values are STEP and RAMP. The default value is STEP.

extrapolation

A SymbolicConstant specifying the type of extrapolation to use in determining the incremental solution for a nonlinear analysis. Possible values are NONE, LINEAR, and PARABOLIC. The default value is LINEAR.

maintainAttributes

A Boolean specifying whether to retain attributes from an existing step with the same name. The default value is False.

solutionTechnique

A SymbolicConstant specifying the technique used to for solving nonlinear equations. Possible values are FULL_NEWTON and QUASI_NEWTON. The default value is FULL_NEWTON.

reformKernel

An Int specifying the number of quasi-Newton iterations allowed before the kernel matrix is reformed.. The default value is 8.

convertSDI

A SymbolicConstant specifying whether to force a new iteration if severe discontinuities occur during an iteration. Possible values are PROPAGATED, CONVERT_SDI_OFF, and CONVERT_SDI_ON. The default value is PROPAGATED.

adaptiveDampingRatio

A Float specifying the maximum allowable ratio of the stabilization energy to the total strain energy and can be used only if stabilizationMethod is not NONE. The default value is 0.05.

continueDampingFactors

A Boolean specifying whether this step will carry over the damping factors from the results of the preceding general step. This parameter must be used in conjunction with the adaptiveDampingRatio parameter. The default value is OFF.

Returns:

step: ViscoStep

A ViscoStep object.

Notes

This function can be accessed by:

mdb.models[name].ViscoStep

XFEMCrackGrowth(name: str, createStepName: str, crackName: str, allowGrowth: BooleanType = 1) → XFEMCrackGrowth

This method creates an XFEMCrackGrowth object.

Parameters:

name

A String specifying the repository key.

createStepName

A String specifying the name of the step in which the XFEMCrackGrowth object is created.

crackName

A String specifying the XFEMCrack object associated with this interaction.

allowGrowth

A Boolean specifying whether the crack is allowed to grow (propagate) during this analysis step. The default value is ON.

Returns:

A XFEMCrackGrowth object.

Notes

This function can be accessed by:

mdb.models[name].XFEMCrackGrowth

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

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

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

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

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

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

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

adaptiveRemesh(odb: Odb)

This method remeshes the model using the active remesh rules in the model and the error indicator results from a previous analysis.

Parameters:

odb

An Odb object containing error output field results.

Returns:

An AdaptivityIteration object.

beamProfilesFromOdb(fileName: str)

This method creates Profile objects by reading an output database. The new profiles are placed in the profiles repository.

Parameters:

fileName

A String specifying the name of the output database file (including the .odb extension) to be read. The String can also be the full path to the output database file if it is located in another directory.

Returns:

A python:list of Profile objects..

!img

Notes

This function can be accessed by:

mdb.models[name].beamProfilesFromOdb

contactDetection(name: str = '', createStepName: str = '', searchDomain: SymbolicConstantType = 'MODEL', defaultType: SymbolicConstantType = 'CONTACT', interactionProperty: str = '', separationTolerance: float | None = None, extendByAngle: float = 20, mergeWithinAngle: float = 20, searchSingleInstances: BooleanType = 0, nameEachSurfaceFound: BooleanType = 1, createUnionOfMainSurfaces: BooleanType = 0, createUnionOfSecondarySurfaces: BooleanType = 0, createUnionOfMainSecondarySurfaces: BooleanType = 0, includePlanar: BooleanType = 1, includeCylindricalSphericalToric: BooleanType = 1, includeSplineBased: BooleanType = 1, includeMeshSolid: BooleanType = 1, includeMeshShell: BooleanType = 1, includeMeshMembrane: BooleanType = 0, includeOverclosed: BooleanType = 1, includeNonOverlapping: BooleanType = 0, meshedGeometrySearchTechnique: SymbolicConstantType = 'USE_GEOMETRY', useShellThickness: BooleanType = 1, surfaceSmoothing: SymbolicConstantType | None = None)

This method uses contact detection to create SurfaceToSurfaceContactStd, SurfaceToSurfaceContactExp, and Tie objects.

Parameters:

name

A String specifying the prefix used to generate repository keys. The default value is “CP-”

createStepName

A String specifying the name of the step in which the SurfaceToSurfaceContactStd, SurfaceToSurfaceContactExp, and Tie objects are created. The default value is “Initial.”

searchDomain

A SymbolicConstant MODEL or a sequence of Strings specifying the names of instances to search. MODEL indicates the whole model is searched. The default value is MODEL.

defaultType

A SymbolicConstant specifying the default type of object to create. Possible values are CONTACT, CONTACT_STANDARD, CONTACT_EXPLICIT, and TIE. If CONTACT is used, the behavior is determined by the type of Step in the model. If an ExplicitDynamicsStep or TempDisplacementDynamicsStep exists, then SurfaceToSurfaceContactExp is created by default. Otherwise SurfaceToSurfaceContactStd is created by default. The default value is CONTACT.

interactionProperty

A String specifying the name of the ContactProperty object associated with any interactions created.

separationTolerance

A Float specifying the maximum separation for considering two surfaces to be candidates for contact, where separation is the maximum distance between the points of closest approach on the two surfaces. The default value is a function of the model.

extendByAngle

None or a Float specifying the angle for extending surface definitions to include adjacent faces. The default value is 20.

mergeWithinAngle

None or a Float specifying the angle for merging adjacent contact pairs that lie within the angle. The default value is 20.

searchSingleInstances

A Boolean specifying whether to include surface pairs within a single instance. The default value is OFF.

nameEachSurfaceFound

A Boolean specifying whether to assign a name to each surface found. The default value is ON.

createUnionOfMasterSurfaces

A Boolean specifying whether to create a surface that is the union of all master surfaces found. The default value is OFF.

createUnionOfSlaveSurfaces

A Boolean specifying whether to create a surface that is the union of all slave surfaces found. The default value is OFF.

createUnionOfMasterSlaveSurfaces

A Boolean specifying whether to create a surface that is the union of all master and slave surfaces found. The default value is OFF.

includePlanar

A Boolean specifying whether to include planar geometry. The default value is ON.

includeCylindricalSphericalToric

A Boolean specifying whether to include cylindrical, spherical, and toric geometry. The default value is ON.

includeSplineBased

A Boolean specifying whether to include spline-based geometry. The default value is ON.

includeMeshSolid

A Boolean specifying whether to include solid mesh entities. The default value is ON.

includeMeshShell

A Boolean specifying whether to include shell mesh entities. The default value is ON.

includeMeshMembrane

A Boolean specifying whether to include mesh membrane entities. The default value is OFF.

includeOverclosed

A Boolean specifying whether to include overclosed pairs. The default value is ON.

includeNonOverlapping

A Boolean specifying whether to include opposing geometry surfaces that do not overlap. The default value is OFF.

meshedGeometrySearchTechnique

A SymbolicConstant USE_GEOMETRY or USE_MESH specifying whether to locate pairs in meshed geometry using the geometric entities or mesh entities. The default value is USE_GEOMETRY.

useShellThickness

A Boolean specifying whether to account for shell thickness and offset during contact detection. The default value is ON.

surfaceSmoothing

A SymbolicConstant specifying whether to use surface smoothing for geometric surfaces in SurfaceToSurfaceContactStd interactions. Possible values are NONE and AUTOMATIC. The default value isAUTOMATIC.

Returns:

None.

convertAllSketches(regenerate: BooleanType = True, convertReversedSketches: BooleanType = True)

This method converts all sketches from Abaqus 6.5 or earlier to the equivalent ConstrainedSketch objects.

Parameters:

regenerate

A Boolean specifying if all the features in assembly as well as in all the parts in the model should be regenerated after the conversion. The default value is True.

convertReversedSketches

A Boolean specifying whether sketches in analytic rigid parts should be converted even if they cause the orientation of surfaces defined on them to be flipped. The default value is True.

Returns:

A python:list of strings describing any warnings or errors encountered during the conversion

process.

delete(indices: tuple)

This method allows you to delete existing fields.

Parameters:

indices

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

getSurfaceSeparation()

This method returns a list of all possible contacts that can be created using the ContactDetection method.

Returns:

Tuple of tuples, where each python:tuple holds information, to be used in contact creation as

follows:

A python:str specifying the name of the master surface used in contact.

A python:str specifying the name of the slave surface used in contact.

A python:float specifying the separation distance between the master surface and the slave

surface.

A bool specifying whether or not contact surfaces are overclosed..

linkInstances(instancesMap: tuple)

This method links the selected PartInstance objects to the corresponding PartInstance objects from the specified models. If all instances of a Part are selected for linking, the Part will be linked as well. If not, a new linked child Part object will be created and added to the repository.

Parameters:

instancesMap

A tuple of tuples containing the instance name to be linked and the corresponding PartInstance object to which it will be linked.

Returns:

A python:list of strings describing any warnings or errors encountered during the conversion

process.

move(fromStepName: str, toStepName: str)

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

Parameters:

fromStepName

A String specifying the name of the step from which the PredefinedFieldState is moved.

toStepName

A String specifying the name of the step to which the PredefinedFieldState is moved.

Raises:

TextError.

resume()

This method resumes the predefined field that was previously suppressed.

setValues(description: str = '', noPartsInputFile: BooleanType = 0, absoluteZero: float | None = None, stefanBoltzmann: float | None = None, waveFormulation: SymbolicConstantType = 'NOT_SET', universalGas: float | None = None, restartJob: str = '', restartStep: str = '', restartIncrement: SymbolicConstantType | None = None, endRestartStep: BooleanType = 0, globalJob: str = '', shellToSolid: BooleanType = 0, copyConstraints: BooleanType = 0, copyConnectors: BooleanType = 0, copyInteractions: BooleanType = 0)

This method modifies the Model object.

Parameters:

description

A String specifying the purpose and contents of the Model object. The default value is an empty string.

noPartsInputFile

A Boolean specifying whether an input file should be written without parts and assemblies. The default value is OFF.

absoluteZero

None or a Float specifying the absolute zero constant. The default value is None.

stefanBoltzmann

None or a Float specifying the Stefan-Boltzmann constant. The default value is None.

waveFormulation

A SymbolicConstant specifying the type of incident wave formulation to be used in acoustic problems. Possible values are NOT_SET, SCATTERED, and TOTAL. The default value is NOT_SET.

universalGas

None or a Float specifying the universal gas constant. The default value is None.

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.

restartIncrement

An Int specifying the increment, interval, iteration or cycle where the restart analysis will start. To select the end of the step use the SymbolicConstant STEP_END.

endRestartStep

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

globalJob

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

shellToSolid

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

copyConstraints

A Boolean specifying whether to copy the constraints created in the model to the model that instances this model.

copyConnectors

A Boolean specifying whether to copy the connectors created in the model to the model that instances this model

copyInteractions

A Boolean specifying whether to copy the interactions created in the model to the model that instances this model.

setValuesInStep(stepName: str, outputVariable: str = '', fieldVariableNum: int | None = None, field: str = '', amplitude: str = 'UNSET', fileName: str = '', beginStep: SymbolicConstantType | None = None, beginIncrement: SymbolicConstantType | None = None, endStep: SymbolicConstantType | None = None, endIncrement: SymbolicConstantType | None = None, interpolate: SymbolicConstantType = 0, magnitudes: str = '')

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

Parameters:

stepName

A String specifying the name of the step in which the predefined field is modified.

outputVariable

A String specifying the scalar nodal output variable that will be read from an output database and used to initialize a specified predefined field. This argument is a required argument if *distributionType*=FROM_FILE or *distributionType*=FROM_FILE_AND_USER_DEFINED.

fieldVariableNum

An Int specifying the field variable number.

field

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

amplitude

A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the predefined field has no amplitude reference. The default value is UNSET.Note:amplitude should be given only if it is valid for the specified step.

fileName

A String specifying the name of the file from which the Field values are to be read when *distributionType*=FROM_FILE or *distributionType*=FROM_FILE_AND_USER_DEFINED.

beginStep

An Int specifying the first step from which Field values are to be read or the SymbolicConstant FIRST_STEP or LAST_STEP. This argument is valid only when *distributionType*=FROM_FILE or *distributionType*=FROM_FILE_AND_USER_DEFINED. The default value is None.

beginIncrement

An Int specifying the first increment of the step set in beginStep or the SymbolicConstants STEP_START or STEP_END. This argument is valid only when *distributionType*=FROM_FILE or *distributionType*=FROM_FILE_AND_USER_DEFINED. The default value is None.

endStep

An Int specifying the last step from which Field values are to be read or the SymbolicConstants FIRST_STEP and LAST_STEP. This argument is valid only when *distributionType*=FROM_FILE or *distributionType*=FROM_FILE_AND_USER_DEFINED. The default value is None.

endIncrement

An Int specifying the last increment of the step set in endStep or the SymbolicConstants STEP_START and STEP_END. This argument is valid only when *distributionType*=FROM_FILE or *distributionType*=FROM_FILE_AND_USER_DEFINED. The default value is None.

interpolate

A SymbolicConstant specifying whether to interpolate a field read from an output database or results file. Possible values are OFF, ON, or MIDSIDE_ONLY. The default value is OFF.

magnitudes

A Sequence of Doubles specifying the Field values when distributionType*=UNIFORM or FIELD. The value of the *magnitudes argument is a function of the crossSectionDistribution argument, as shown in the following list: - If crossSectionDistribution*=CONSTANT_THROUGH_THICKNESS, *magnitudes is a Double specifying the Field. - If crossSectionDistribution*=GRADIENTS_THROUGH_SHELL_CS, *magnitudes is a sequence of Doubles specifying the mean value and the gradient in the thickness direction. - If crossSectionDistribution*=GRADIENTS_THROUGH_BEAM_CS, *magnitudes is a sequence of Doubles specifying the mean value, the gradient in the N1 direction, and the gradient in the N2 direction. - If crossSectionDistribution*=POINTS_THROUGH_SECTION, *magnitudes is a sequence of Doubles specifying the Field at each point.

suppress()

This method suppresses the predefined field.

KeywordBlock

class KeywordBlock

The KeywordBlock object contains a representation of its model in the Abaqus input file format. You may edit the contents of the KeywordBlock to add solver functionality that is not supported by Abaqus/CAE. As a general rule, edits to the KeywordBlock object should be made as the last step prior to writing the actual Abaqus input file, thus avoiding possible conflicts with changes made using other MDB commands. The KeywordBlock object has no constructor. A KeywordBlock object is created when you create a model object. A model object contains only one KeywordBlock object.

Notes

This object can be accessed by:

mdb.models[name].keywordBlock

Attributes:

edited: Boolean

A Boolean specifying whether the Keywords Editor has been used to change the model.

lastSynchCount: float

A Float specifying the value of the counter associated with the Mdb object at the most recent synchronization.

sieBlocks: tuple

A tuple of Strings specifying a sequence of Strings that is identical to the information written to the Abaqus input file. Each String in the sequence represents an Abaqus input file keyword along with the parameters and data lines associated with the keyword. A String can also be a comment in the input file. You initialize this data member by calling synchVersions. After you initialize the data member, you use calls to replace and insert to record your edits in the correct location. If the last call to synchVersions used the argument storeNodesAndElements=False, the entry for the keywords NODE and ELEMENT will contain only the keyword and its parameters, not the data lines.

Methods

insert(position, text)	This method inserts a String at a specified position in the sieBlocks member.
replace(position, text)	This method replaces a String at a specified position in the sieBlocks member.
setValues([edited])	This method modifies the KeywordBlock object.
synchVersions(storeNodesAndElements)	This method synchronizes, or merges, the edits made in this object with those made in the model using other scripting commands or the user interface.

insert(position: int, text: str)

This method inserts a String at a specified position in the sieBlocks member.

Parameters:

position

An Int specifying the position in the sieBlocks member after which the new string will be inserted.

text

A String specifying the text to be inserted. The text represents an Abaqus input file keyword and its associated data

Raises:

IndexError.

replace(position: int, text: str)

This method replaces a String at a specified position in the sieBlocks member.

Parameters:

position

An Int specifying the position of the String to be replaced in the sieBlocks member.

text

A String specifying the text to be replaced. The text represents an Abaqus input file keyword and its associated data.

Raises:

IndexError.

setValues(edited: BooleanType = 0)

This method modifies the KeywordBlock object.

Parameters:

edited

A Boolean specifying whether this objects sieBlocks member has been edited. Setting edited=False will set the sieBlocks member to an empty tuple, thereby discarding all previous edits.

synchVersions(storeNodesAndElements: BooleanType)

This method synchronizes, or merges, the edits made in this object with those made in the model using other scripting commands or the user interface. The synchVersions method updates the sieBlocks member. The sieBlocks member is empty prior to the first call to synchVersions. As a side effect, synchVersions sets lastSynchCount to the current value of the counter associated with the Mdb object, which is used to determine if synchronization is necessary.

Parameters:

storeNodesAndElements

A Boolean specifying whether the nodal coordinates and element connectivities (i.e. the data lines for the NODE and *ELEMENT keyword blocks) are to be stored in the *sieBlocks member. All other keywords and their data lines are always stored. The default value is True. If storeNodesAndElements is True, the size of the keywordBlock data will be similar to that of the input file. Since the KeywordBlock is stored in the Abaqus/CAE database, this will result in a larger database. It will also result in a slower execution of the synchVersions command. If storeNodesAndElements is False, the data lines are not stored in sieBlocks. Consequently, only set *storeNodesAndElements*=True if you wish to make changes to the *NODE or *ELEMENT data lines themselves. If your task is limited to reading nodal coordinates and element connectivities (i.e. not editing this information) then it is generally better to access this information from other parts of the Mdb.

Raises:

IndexError.