Interaction

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

Create interactions

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

Bases: InteractionContactControlModel, InteractionContactInitializationModel, InteractionContactStabilizationModel, InteractionPropertyModel

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

Note

This object can be accessed by:

mdb.models[name]

This method creates a Model object.

Note

This function can be accessed by:

mdb.Model
Parameters:
  • name (str) – A String specifying the repository key.

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

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

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

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

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

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

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

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

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

Returns:

A Model object.

Return type:

Model

Public Data Attributes:

Inherited from ModelBase

name

A String specifying the repository key.

stefanBoltzmann

None or a Float specifying the Stefan-Boltzmann constant.

absoluteZero

None or a Float specifying the absolute zero constant.

waveFormulation

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

universalGas

None or a Float specifying the universal gas constant.

noPartsInputFile

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

endRestartStep

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

shellToSolid

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

lastChangedCount

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

description

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

restartJob

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

restartStep

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

globalJob

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

copyConstraints

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

copyConnectors

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

copyInteractions

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

keywordBlock

A KeywordBlock object.

rootAssembly

An Assembly object.

amplitudes

A repository of Amplitude objects.

profiles

A repository of Profile objects.

boundaryConditions

A repository of BoundaryCondition objects.

constraints

A repository of ConstrainedSketchConstraint objects.

analyticalFields

A repository of AnalyticalField objects.

discreteFields

A repository of DiscreteField objects.

predefinedFields

A repository of PredefinedField objects.

interactions

A repository of Interaction objects.

interactionProperties

A repository of InteractionProperty objects.

contactControls

A repository of ContactControl objects.

contactInitializations

A repository of ContactInitialization objects.

contactStabilizations

A repository of ContactStabilization objects.

linkedInstances

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

linkedParts

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

loads

A repository of Load objects.

materials

A repository of Material objects.

calibrations

A repository of Calibration objects.

sections

A repository of Section objects.

remeshingRules

A repository of RemeshingRule objects.

sketches

A repository of ConstrainedSketch objects.

parts

A repository of Part objects.

steps

A repository of Step objects.

featureOptions

A FeatureOptions object.

adaptiveMeshConstraints

A repository of AdaptiveMeshConstraint objects.

adaptiveMeshControls

A repository of AdaptiveMeshControl objects.

timePoints

A repository of TimePoint objects.

filters

A repository of Filter objects.

integratedOutputSections

A repository of IntegratedOutputSection objects.

fieldOutputRequests

A repository of FieldOutputRequest objects.

historyOutputRequests

A repository of HistoryOutputRequest objects.

optimizationTasks

A repository of OptimizationTask objects.

tableCollections

A repository of TableCollection objects.

eventSeriesTypes

A repository of EventSeriesType objects.

eventSeriesDatas

A repository of EventSeriesData objects.

restartIncrement

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

Public Methods:

contactDetection([name, createStepName, ...])

This method uses contact detection to create SurfaceToSurfaceContactStd, SurfaceToSurfaceContactExp, and Tie objects.

getSurfaceSeparation()

This method returns a list of all possible contacts that can be created using the ContactDetection method.

AcousticImpedance(name, createStepName, surface)

This method creates an AcousticImpedance object.

ActuatorSensor(name, createStepName, point, ...)

This method creates an ActuatorSensor object.

CavityRadiation(name, createStepName, surfaces)

This method creates a CavityRadiation object.

ConcentratedFilmCondition(name, ...[, ...])

This method creates a ConcentratedFilmCondition object.

ConcentratedRadiationToAmbient(name, ...[, ...])

This method creates a ConcentratedRadiationToAmbient object.

ContactExp(name, createStepName[, ...])

This method creates a ContactExp object.

ContactStd(name, createStepName[, ...])

This method creates a ContactStd object.

CyclicSymmetry(name, createStepName, main, ...)

This method creates a CyclicSymmetry object.

ElasticFoundation(name, createStepName, ...)

This method creates an ElasticFoundation object.

FilmCondition(name, createStepName, surface, ...)

This method creates a FilmCondition object.

FluidCavity(name, createStepName, ...[, ...])

This method creates an FluidCavity object.

FluidExchange(name, createStepName, ...[, ...])

This method creates an FluidExchange object.

FluidInflator(name, createStepName, cavity, ...)

This method creates a FluidInflator object.

IncidentWave(name, createStepName, ...[, ...])

This method creates an IncidentWave object.

ModelChange(name, createStepName[, ...])

This method creates a ModelChange object.

PressurePenetration(name, createStepName, ...)

This method creates a PressurePenetration object.

RadiationToAmbient(name, createStepName, ...)

This method creates a RadiationToAmbient object.

SelfContactExp(name, createStepName, ...[, ...])

This method creates a SelfContactExp object.

SelfContactStd(name, createStepName, ...[, ...])

This method creates a SelfContactStd object.

StdXplCosimulation(name, createStepName, region)

This method creates a StdXplCosimulation object.

SurfaceToSurfaceContactExp(name, ...[, ...])

This method creates a SurfaceToSurfaceContactExp object.

SurfaceToSurfaceContactStd(name, ...[, ...])

This method creates a SurfaceToSurfaceContactStd object.

XFEMCrackGrowth(name, createStepName, crackName)

This method creates an XFEMCrackGrowth object.

Inherited from InteractionContactControlModel

ExpContactControl(name[, globTrkChoice, ...])

This method creates an ExpContactControl object.

StdContactControl(name[, ...])

This method creates an StdContactControl object.

Inherited from InteractionContactInitializationModel

ExpInitialization(name[, overclosureType, ...])

This method creates an ExpInitialization object.

StdInitialization(name[, overclosureType, ...])

This method creates a StdInitialization object.

Inherited from InteractionContactStabilizationModel

StdStabilization(name[, zeroDistance, ...])

This method creates a StdStabilization object.

Inherited from InteractionPropertyModel

AcousticImpedanceProp(name, tableType, table)

This method creates an AcousticImpedanceProp object.

ActuatorSensorProp(name[, realProperties, ...])

This method creates an ActuatorSensorProp object.

CavityRadiationProp(name[, ...])

This method creates a CavityRadiationProp object.

ContactProperty(name)

This method creates a ContactProperty object.

FilmConditionProp(name[, ...])

This method creates a FilmConditionProp object.

FluidCavityProperty(name[, definition, ...])

This method creates a FluidCavityProperty object.

FluidExchangeProperty(name, dataTable[, ...])

This method creates a FluidExchangeProperty object.

FluidInflatorProperty(name, definition, ...)

This method creates a FluidInflatorProperty object.

IncidentWaveProperty(name[, definition, ...])

This method creates an IncidentWaveProperty object.

Inherited from ModelBase

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

This method creates a Model object.

ModelFromInputFile(name, inputFileName)

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

ModelFromOdbFile(name, odbFileName)

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

ModelFromNastranFile(modelName, inputFileName)

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

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

This method modifies the Model object.


Member Details:

AcousticImpedance(name, createStepName, surface, definition=abaqusConstants.TABULAR, interactionProperty='', nonreflectingType=abaqusConstants.PLANE, radius=1, semimajorAxis=1, eccentricity=0, centerCoordinates=(), directionCosine=())[source]

This method creates an AcousticImpedance object.

Note

This function can be accessed by:

mdb.models[name].AcousticImpedance
Parameters:
  • name (str) – A String specifying the repository key.

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

  • surface (Region) – A Region object specifying the acoustic boundary surface.

  • definition (Literal[TABULAR, NONREFLECTING], default: TABULAR) – A SymbolicConstant specifying the type of acoustic impedance to be defined. Possible values are TABULAR and NONREFLECTING. The default value is TABULAR.

  • interactionProperty (str, default: '') – A String specifying the AcousticImpedanceProp object associated with this interaction.

  • nonreflectingType (Literal[PLANE, ELLIPTICAL, IMPROVED, SPHERICAL, PROLATE, CIRCULAR, NONREFLECTING], default: PLANE) – 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 (float, default: 1) – 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 (float, default: 1) – 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 (float, default: 0) – 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 (tuple, default: ()) – 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 (tuple, default: ()) – 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.

Return type:

AcousticImpedance

ActuatorSensor(name, createStepName, point, interactionProperty, noCoordComponents, unsymm, noSolutionDepVar, userSubUel, dof, solutionDepVars)[source]

This method creates an ActuatorSensor object.

Note

This function can be accessed by:

mdb.models[name].ActuatorSensor
Parameters:
  • name (str) – A String specifying the repository key.

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

  • point (Region) – A Region object specifying the point at which the constraint is applied.

  • interactionProperty (str) – A String specifying the ActuatorSensorProp object associated with this interaction.

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

  • unsymm (Union[AbaqusBoolean, bool]) – A Boolean specifying whether the element matrices are symmetric (ON) or unsymmetric (OFF). The default value is OFF.

  • noSolutionDepVar (int) – An Int specifying the number of solution-dependent variables. The default value is 0.

  • userSubUel (str) – A String specifying the name of the user subroutine (UEL) that defines the user element.

  • dof (str) – A String specifying the degrees of freedom, separated by commas.

  • solutionDepVars (tuple) – A sequence of Floats specifying the initial values of the solution-dependent variables.

Returns:

An ActuatorSensor object.

Return type:

ActuatorSensor

CavityRadiation(name, createStepName, surfaces, surfaceEmissivities=(), ambientTemp=None, blocking=abaqusConstants.BLOCKING_ALL, blockingSurfaces=None, rangeOfView=None, surfaceReflection=1, viewfactorAccurTol=0, minInfinitesimalRatio=64, numPointsPerEdge=3, minLumpedAreaDS=5, cyclicSymmetry=0, cyclicImages=2, cyclicRotPt=None, cyclicRotEndPt=None, cyclicSymPt=None, periodicSymmetries=0, periodicImages_1=2, periodicImages_2=2, periodicImages_3=2, periodicSymAxis_1='', periodicSymAxis_2='', periodicSymPlane_1='', periodicSymPlane_2='', periodicSymPlane_3='', periodicDistance_1=(), periodicDistance_2=(), periodicDistance_3=(), periodicSymZ=None, periodicDistZ=None, reflectionSymmetries=0, reflectionSymAxis_1='', reflectionSymAxis_2='', reflectionSymPlane_1='', reflectionSymPlane_2='', reflectionSymPlane_3='', reflectionSymZ=None)[source]

This method creates a CavityRadiation object.

Note

This function can be accessed by:

mdb.models[name].CavityRadiation
Parameters:
  • name (str) – A String specifying the repository key.

  • createStepName (str) – A String specifying the name of the step in which the cavity radiation interaction should be created.

  • surfaces (List[Region]) – A RegionArray object specifying the surfaces for which radiation viewfactor control is being specified.

  • surfaceEmissivities (tuple, default: ()) – 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 (Optional[float], default: None) – 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 (Literal[NO_BLOCKING, BLOCKING_ALL, PARTIAL_BLOCKING], default: BLOCKING_ALL) – 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 (Optional[List[Region]], default: None) – A RegionArray object specifying the surfaces that provide blocking inside the cavity. This argument applies only when blocking = PARTIAL_BLOCKING.

  • rangeOfView (Optional[float], default: None) – 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 (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether heat reflections are to be included in the cavity radiation calculations. The default value is ON.

  • viewfactorAccurTol (float, default: 0) – A Float specifying the acceptable tolerance for the viewfactor calculations. The default value is 0.05.

  • minInfinitesimalRatio (float, default: 64) – 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 (int, default: 3) – 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 (float, default: 5) – 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 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether cyclic symmetry will be applied. This argument cannot be specified for axisymmetric models. The default value is OFF.

  • cyclicImages (int, default: 2) – 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 (Optional[ModelDot], default: None) – A ModelDot object specifying the rotation axis point. This argument applies only when cyclicSymmetry = ON.

  • cyclicRotEndPt (Optional[ModelDot], default: None) – A ModelDot object specifying the rotation axis end point. This argument applies only for three-dimensional models, and only when cyclicSymmetry = ON.

  • cyclicSymPt (Optional[ModelDot], default: None) – A ModelDot object specifying the symmetry axis end point. This argument applies only when cyclicSymmetry = ON.

  • periodicSymmetries (int, default: 0) – An Int specifying the number of periodic symmetries that will be applied. The default value is 0.

  • periodicImages_1 (int, default: 2) – 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 (int, default: 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 (int, default: 2) – 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 (str, default: '') – 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 (str, default: '') – 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 (str, default: '') – 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 (str, default: '') – 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 (str, default: '') – 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 (tuple, default: ()) – 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 (tuple, default: ()) – 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 (tuple, default: ()) – 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 (Optional[float], default: None) – 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 (Optional[float], default: None) – 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 (int, default: 0) – An Int specifying the number of reflection symmetries will be applied. The default value is 0.

  • reflectionSymAxis_1 (str, default: '') – 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 (str, default: '') – 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 (str, default: '') – 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 (str, default: '') – 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 (str, default: '') – 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 (Optional[float], default: None) – 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.

Return type:

CavityRadiation

ConcentratedFilmCondition(name, createStepName, region, definition, nodalArea=1, explicitRegionType=abaqusConstants.LAGRANGIAN, interactionProperty='', field='', sinkTemperature=0, sinkAmplitude='', filmCoeff=0, filmCoeffAmplitude='', sinkFieldName='', sinkDistributionType=abaqusConstants.UNIFORM)[source]

This method creates a ConcentratedFilmCondition object.

Note

This function can be accessed by:

mdb.models[name].ConcentratedFilmCondition
Parameters:
  • name (str) – A String specifying the repository key.

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

  • region (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 (Literal[EMBEDDED_COEFF, FIELD, USER_SUB, PROPERTY_REF]) – A SymbolicConstant specifying how the concentrated film condition is defined. Possible values are EMBEDDED_COEFF, PROPERTY_REF, USER_SUB, and FIELD.

  • nodalArea (float, default: 1) – A Float specifying the area associated with the node where the concentrated film condition is applied. The default value is 1.0.

  • explicitRegionType (Literal[LAGRANGIAN, SLIDING, EULERIAN], default: LAGRANGIAN) – 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 (str, default: '') – 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 (str, default: '') – 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 (float, default: 0) – A Float specifying the reference sink temperature, θ0θ0. The default value is 0.0.

  • sinkAmplitude (str, default: '') – 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 (float, default: 0) – 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 (str, default: '') – 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 (str, default: '') – 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 (Literal[DISCRETE_FIELD, UNIFORM, ANALYTICAL_FIELD], default: UNIFORM) – 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.

Return type:

ConcentratedFilmCondition

ConcentratedRadiationToAmbient(name, createStepName, region, ambientTemperature, ambientTemperatureAmp, emissivity, nodalArea=1, explicitRegionType=abaqusConstants.LAGRANGIAN, field='', distributionType=abaqusConstants.UNIFORM)[source]

This method creates a ConcentratedRadiationToAmbient object.

Note

This function can be accessed by:

mdb.models[name].ConcentratedRadiationToAmbient
Parameters:
  • name (str) – A String specifying the repository key.

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

  • region (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 (float) – A Float specifying the reference ambient temperature, θ0θ0.

  • ambientTemperatureAmp (str) – 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 (float) – A Float specifying the emissivity, ϵϵ.

  • nodalArea (float, default: 1) – A Float specifying the area associated with the node where the concentrated radiation interaction is applied. The default value is 1.0.

  • explicitRegionType (Literal[LAGRANGIAN, SLIDING, EULERIAN], default: LAGRANGIAN) – 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 (str, default: '') – 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 (Literal[UNIFORM, ANALYTICAL_FIELD], default: UNIFORM) – A SymbolicConstant specifying how the radiation is defined. Possible values are UNIFORM and ANALYTICAL_FIELD. The default value is UNIFORM.

Returns:

A ConcentratedRadiationToAmbient object.

Return type:

ConcentratedRadiationToAmbient

ContactExp(name, createStepName, useAllstar=0, globalSmoothing=1, includedPairs=None, excludedPairs=None, contactPropertyAssignments=None, surfaceThicknessAssignments=None, surfaceOffsetAssignments=None, surfaceFeatureAssignments=None, smoothingAssignments=None, surfaceCrushTriggerAssignments=<abaqus.Interaction.SurfaceCrushTriggerAssignment.SurfaceCrushTriggerAssignment object>, surfaceFrictionAssignments=<abaqus.Interaction.SurfaceFrictionAssignment.SurfaceFrictionAssignment object>, mainSecondaryAssignments=None, polarityAssignments=<abaqus.Interaction.PolarityAssignments.PolarityAssignments object>)[source]

This method creates a ContactExp object.

Note

This function can be accessed by:

mdb.models[name].ContactExp
Parameters:
  • name (str) – A String specifying the repository key.

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

  • useAllstar (Union[AbaqusBoolean, bool], default: 0) – 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 (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether surface smoothing (geometric correction) is automatically applied to all eligible surfaces. The default value is ON.

  • includedPairs (Optional[RegionPairs], default: None) – A RegionPairs object specifying the domain pairs included in contact.

  • excludedPairs (Optional[RegionPairs], default: None) – A RegionPairs object specifying the domain pairs excluded from contact.

  • contactPropertyAssignments (Optional[ContactPropertyAssignment], default: None) – A ContactPropertyAssignment object specifying the contact property assignments in the contact domain.

  • surfaceThicknessAssignments (Optional[SurfaceThicknessAssignment], default: None) – A SurfaceThicknessAssignment object specifying the surface thickness assignments in the contact domain.

  • surfaceOffsetAssignments (Optional[SurfaceOffsetAssignment], default: None) – A SurfaceOffsetAssignment object specifying the surface offset fraction assignments in the contact domain.

  • surfaceFeatureAssignments (Optional[SurfaceFeatureAssignment], default: None) – A SurfaceFeatureAssignment object specifying the surface feature angle assignments in the contact domain.

  • smoothingAssignments (Optional[SmoothingAssignment], default: None) – A SmoothingAssignment object specifying the surface smoothing assignments in the contact domain.

  • surfaceCrushTriggerAssignments (SurfaceCrushTriggerAssignment, default: <abaqus.Interaction.SurfaceCrushTriggerAssignment.SurfaceCrushTriggerAssignment object at 0x7f5b3e5beed0>) –

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

    New in version 2021: The surfaceCrushTriggerAssignments argument was added.

  • surfaceFrictionAssignments (SurfaceFrictionAssignment, default: <abaqus.Interaction.SurfaceFrictionAssignment.SurfaceFrictionAssignment object at 0x7f5b3d5a0610>) –

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

    New in version 2021: The surfaceFrictionAssignments argument was added.

  • mainSecondaryAssignments (Optional[MainSecondaryAssignment], default: None) –

    A MainSecondaryAssignment object specifying the main-secondary assignments in the contact domain.

    Changed in version 2022: The argument masterSlaveAssignments was renamed to mainSecondaryAssignments.

  • polarityAssignments (PolarityAssignments, default: <abaqus.Interaction.PolarityAssignments.PolarityAssignments object at 0x7f5b3d5a3bd0>) –

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

    New in version 2020: The polarityAssignments argument was added.

Returns:

A ContactExp object.

Return type:

ContactExp

ContactStd(name, createStepName, useAllstar=0, globalSmoothing=1, includedPairs=None, excludedPairs=None, contactPropertyAssignments=None, surfaceThicknessAssignments=None, surfaceOffsetAssignments=None, surfaceFeatureAssignments=None, surfaceBeamSmoothingAssignments=<abaqus.Interaction.SurfaceBeamSmoothingAssignment.SurfaceBeamSmoothingAssignment object>, surfaceVertexCriteriaAssignments=<abaqus.Interaction.SurfaceVertexCriteriaAssignment.SurfaceVertexCriteriaAssignment object>, slidingFormulationAssignments=None, mainSecondaryAssignments=None, initializationAssignments=None, stabilizationAssignments=None, smoothingAssignments=None, slidingTransitionAssignments=None)[source]

This method creates a ContactStd object.

Note

This function can be accessed by:

mdb.models[name].ContactStd
Parameters:
  • name (str) – A String specifying the repository key.

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

  • useAllstar (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether the contacting surface pairs consist of all exterior faces in the model.

  • globalSmoothing (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether surface smoothing (geometric correction) is automatically applied to all eligible surfaces. The default value is ON.

  • includedPairs (Optional[RegionPairs], default: None) – A RegionPairs object specifying the domain pairs included in contact.

  • excludedPairs (Optional[RegionPairs], default: None) – A RegionPairs object specifying the domain pairs excluded from contact.

  • contactPropertyAssignments (Optional[ContactPropertyAssignment], default: None) – A ContactPropertyAssignment object specifying the contact property assignments in the contact domain.

  • surfaceThicknessAssignments (Optional[SurfaceThicknessAssignment], default: None) – A SurfaceThicknessAssignment object specifying the surface thickness assignments in the contact domain.

  • surfaceOffsetAssignments (Optional[SurfaceOffsetAssignment], default: None) – A SurfaceOffsetAssignment object specifying the surface offset fraction assignments in the contact domain.

  • surfaceFeatureAssignments (Optional[SurfaceFeatureAssignment], default: None) – A SurfaceFeatureAssignment object specifying the surface feature angle assignments in the contact domain.

  • surfaceBeamSmoothingAssignments (SurfaceBeamSmoothingAssignment, default: <abaqus.Interaction.SurfaceBeamSmoothingAssignment.SurfaceBeamSmoothingAssignment object at 0x7f5b3e600a50>) –

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

    New in version 2021: The surfaceBeamSmoothingAssignments argument was added.

  • surfaceVertexCriteriaAssignments (SurfaceVertexCriteriaAssignment, default: <abaqus.Interaction.SurfaceVertexCriteriaAssignment.SurfaceVertexCriteriaAssignment object at 0x7f5b3e6010d0>) –

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

    New in version 2021: The surfaceVertexCriteriaAssignments argument was added.

  • slidingFormulationAssignments (Optional[Sequence[SlidingFormulationAssignment]], default: None) –

    A sequence of tuples of SlidingFormulationAssignment specifying the sliding formulation assignments. Each tuple contains two entries:

    • A region object or the SymbolicConstant GLOBAL specifying the surface to which the sliding formulation attribute is assigned.

    • A SymbolicConstant specifying the overriding the smoothness value to be used for the first surface. Possible values of the SymbolicConstant are NONE and SMALL_SLIDING.

    New in version 2021: The slidingFormulationAssignments argument was added.

  • mainSecondaryAssignments (Optional[MainSecondaryAssignment], default: None) –

    A MainSecondaryAssignment object specifying the main-secondary assignments in the contact domain.

    Changed in version 2022: The argument masterSlaveAssignments was renamed to mainSecondaryAssignments.

  • initializationAssignments (Optional[InitializationAssignment], default: None) – An InitializationAssignment object specifying the contact initialization assignments in the contact domain.

  • stabilizationAssignments (Optional[StabilizationAssignment], default: None) – A StabilizationAssignment object specifying the contact stabilization assignments in the contact domain.

  • smoothingAssignments (Optional[SmoothingAssignment], default: None) – A SmoothingAssignment object specifying the surface smoothing assignments in the contact domain.

  • slidingTransitionAssignments (Optional[SlidingTransitionAssignment], default: None) – A SlidingTransitionAssignments object specifying the sliding transition assignments in the contact domain.

Returns:

A ContactStd object.

Return type:

ContactStd

CyclicSymmetry(name, createStepName, main, secondary, repetitiveSectors, axisPoint1, axisPoint2, extractedNodalDiameter=abaqusConstants.ALL_NODAL_DIAMETER, lowestNodalDiameter=0, highestNodalDiameter=0, excitationNodalDiameter=0, adjustTie=1, positionTolerance=0, positionToleranceMethod=abaqusConstants.COMPUTED_TOLERANCE)[source]

This method creates a CyclicSymmetry object.

Note

This function can be accessed by:

mdb.models[name].CyclicSymmetry
Parameters:
  • name (str) – A String specifying the repository key.

  • createStepName (str) – A String specifying the name of the step in which the cyclic symmetry interaction should be created.

  • main (Region) –

    A Region object specifying the main surface.

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

  • secondary (Region) –

    A Region object specifying the secondary surface.

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

  • repetitiveSectors (int) – An Int specifying the total number of sectors in the cyclic symmetric model.

  • axisPoint1 (Region) – 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 (Region) – 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 (Literal[ALL_NODAL_DIAMETER, SPECIFIED_NODAL_DIAMETER], default: ALL_NODAL_DIAMETER) – 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 (int, default: 0) – An Int specifying the lowest nodal diameter to be used in the eigenfrequency analysis. The default value is 0.

  • highestNodalDiameter (int, default: 0) – 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 (int, default: 0) – 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 (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether or not to adjust the secondary surface of the cyclic symmetry to tie it to the main surface. The default value is ON.

  • positionTolerance (float, default: 0) – A Float specifying the position tolerance. The*positionTolerance* argument applies only when positionToleranceMethod = SPECIFY_TOLERANCE. The default value is 0.0.

  • positionToleranceMethod (Literal[SPECIFY_TOLERANCE, COMPUTED_TOLERANCE], default: COMPUTED_TOLERANCE) – 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.

Return type:

CyclicSymmetry

ElasticFoundation(name, createStepName, surface, stiffness)[source]

This method creates an ElasticFoundation object.

Note

This function can be accessed by:

mdb.models[name].ElasticFoundation
Parameters:
  • name (str) – A String specifying the repository key.

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

  • surface (Region) – A Region object specifying the surface to which the foundation applies.

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

Returns:

An ElasticFoundation object.

Return type:

ElasticFoundation

FilmCondition(name, createStepName, surface, definition, interactionProperty='', sinkTemperature=0, sinkAmplitude='', filmCoeff=0, filmCoeffAmplitude='', field='', sinkFieldName='', sinkDistributionType=abaqusConstants.UNIFORM)[source]

This method creates a FilmCondition object.

Note

This function can be accessed by:

mdb.models[name].FilmCondition
Parameters:
  • name (str) – A String specifying the repository key.

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

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

  • definition (Literal[EMBEDDED_COEFF, FIELD, USER_SUB, PROPERTY_REF]) – A SymbolicConstant specifying how the film condition is defined. Possible values are EMBEDDED_COEFF, PROPERTY_REF, USER_SUB, and FIELD.

  • interactionProperty (str, default: '') – 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 (float, default: 0) – A Float specifying the reference sink temperature, θ0θ0. The default value is 0.0.

  • sinkAmplitude (str, default: '') – 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 (float, default: 0) – 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 (str, default: '') – 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 (str, default: '') – 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 (str, default: '') – 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 (Literal[DISCRETE_FIELD, UNIFORM, ANALYTICAL_FIELD], default: UNIFORM) – 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.

Return type:

FilmCondition

FluidCavity(name, createStepName, cavityPoint, cavitySurface, interactionProperty, ambientPressure=0, thickness=1, useAdiabatic=0, checkNormals=1)[source]

This method creates an FluidCavity object.

Note

This function can be accessed by:

mdb.models[name].FluidCavity
Parameters:
  • name (str) – A String specifying the repository key.

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

  • cavityPoint (Region) – A Region object specifying the fluid cavity reference point.

  • cavitySurface (Region) – A Region object specifying the surface forming the boundary of the fluid cavity.

  • interactionProperty (str) – A String specifying the FluidCavityProperty object associated with this interaction.

  • ambientPressure (float, default: 0) – A Float specifying the magnitude of the ambient pressure. The default value is 0.0.

  • thickness (float, default: 1) – 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 (Union[AbaqusBoolean, bool], default: 0) – 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 (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether the analysis will check the consistency of the surface normals. The default value is ON.

Returns:

A FluidCavity object.

Return type:

FluidCavity

FluidExchange(name, createStepName, firstCavity, interactionProperty, definition=abaqusConstants.TO_ENVIRONMENT, secondCavity='', exchangeArea=1)[source]

This method creates an FluidExchange object.

Note

This function can be accessed by:

mdb.models[name].FluidExchange
Parameters:
  • name (str) – A String specifying the repository key.

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

  • firstCavity (str) – A String specifying the first FluidCavity object associated with this interaction. This will be the only cavity specified if definition = TO_ENVIRONMENT.

  • interactionProperty (str) – A String specifying the FluidExchangeProperty object associated with this interaction.

  • definition (Literal[BETWEEN_CAVITIES, TO_ENVIRONMENT], default: TO_ENVIRONMENT) – 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 (str, default: '') – A String specifying the second FluidCavity object associated with this interaction. This argument is applicable only when definition = BETWEEN_CAVITIES.

  • exchangeArea (float, default: 1) – A Float specifying the effective exchange area. The default value is 1.0.

Returns:

A FluidExchange object.

Return type:

FluidExchange

FluidInflator(name, createStepName, cavity, interactionProperty, inflationTimeAmplitude='', massFlowAmplitude='')[source]

This method creates a FluidInflator object.

Note

This function can be accessed by:

mdb.models[name].FluidInflator

New in version 2019: The FluidInflator method was added.

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

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

  • cavity (str) – A String specifying the first FluidCavity object associated with this interaction.

  • interactionProperty (str) – A String specifying the FluidInflatorProperty object associated with this interaction.

  • inflationTimeAmplitude (str, default: '') – A string specifying the name of the amplitude curve defining a mapping between the inflation time and the actual time.

  • massFlowAmplitude (str, default: '') – A string specifying the name of the amplitude curve by which to modify the mass flow rate.

Returns:

A FluidInflator object.

IncidentWave(name, createStepName, sourcePoint, standoffPoint, surface, interactionProperty, definition=abaqusConstants.PRESSURE, amplitude='', imaginaryAmplitude='', surfaceNormal=(), initialDepth=None, referenceMagnitude=None, detonationTime=None, magnitudeFactor=1)[source]

This method creates an IncidentWave object.

Note

This function can be accessed by:

mdb.models[name].IncidentWave
Parameters:
  • name (str) – A String specifying the repository key.

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

  • sourcePoint (Region) – A Region object specifying the incident wave source point.

  • standoffPoint (Region) – A Region object specifying the incident wave standoff point.This argument is not valid when definition = CONWEP.

  • surface (Region) – 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 (str) – A String specifying the IncidentWaveProperty object associated with this interaction.

  • definition (Literal[PRESSURE, UNDEX, CONWEP, ACCELERATION], default: PRESSURE) – 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 (str, default: '') – 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 (str, default: '') – 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 (tuple, default: ()) – 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 (Optional[float], default: None) – 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 (Optional[float], default: None) – A Float specifying the reference magnitude.This argument is not valid when definition = CONWEP.

  • detonationTime (Optional[float], default: None) – A Float specifying the time of detonation, given in total time.This argument is valid only when definition = CONWEP.

  • magnitudeFactor (float, default: 1) – 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.

Return type:

IncidentWave

ModelChange(name, createStepName, isRestart=0, regionType=abaqusConstants.GEOMETRY, region=None, activeInStep=0, includeStrain=0)[source]

This method creates a ModelChange object.

Note

This function can be accessed by:

mdb.models[name].ModelChange
Parameters:
  • name (str) – A String specifying the repository key.

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

  • isRestart (Union[AbaqusBoolean, bool], default: 0) – 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 (Literal[SKINS, GEOMETRY, ELEMENTS, STRINGERS], default: GEOMETRY) – 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 (Optional[Region], default: None) – A Region object specifying the elements to be removed or reactivated. This argument is valid only when isRestart = False.

  • activeInStep (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether elements are being removed or reactivated. This argument is valid only when isRestart = False. The default value is OFF.

  • includeStrain (Union[AbaqusBoolean, bool], default: 0) – 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.

Return type:

ModelChange

PressurePenetration(name, createStepName, contactInteraction, mainPoints, secondaryPoints, penetrationPressure, criticalPressure, amplitude=abaqusConstants.UNSET, penetrationTime=0)[source]

This method creates a PressurePenetration object.

Note

This function can be accessed by:

mdb.models[name].PressurePenetration
Parameters:
  • name (str) – A String specifying the repository key.

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

  • contactInteraction (str) – A String specifying the name of the Surface-to-surface contact (Standard) interaction.

  • mainPoints (List[Region]) –

    A RegionArray object specifying the points on the main surface that are exposed to the fluid.

    Changed in version 2022: The argument masterPoints was renamed to mainPoints.

  • secondaryPoints (List[Region]) –

    A RegionArray object specifying the points on the secondary surface that are exposed to the fluid.

    Changed in version 2022: The argument slavePoints was renamed to secondaryPoints.

  • penetrationPressure (float) – A tuple of Floats specifying the fluid pressure magnitude. For steady state dynamic analyses, a tuple of Complexes specifying the fluid pressure magnitude.

  • criticalPressure (float) – A tuple of Floats specifying the critical contact pressure below which fluid penetration starts to occur.

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

  • penetrationTime (float, default: 0) – 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.

Return type:

PressurePenetration

RadiationToAmbient(name, createStepName, surface, emissivity, field='', distributionType=abaqusConstants.UNIFORM, radiationType=abaqusConstants.AMBIENT, ambientTemperature=0, ambientTemperatureAmp='')[source]

This method creates a RadiationToAmbient object.

Note

This function can be accessed by:

mdb.models[name].RadiationToAmbient
Parameters:
  • name (str) – A String specifying the repository key.

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

  • surface (Region) – A Region object specifying the surface to which the radiation interaction is applied.

  • emissivity (float) – A Float specifying the emissivity, ϵϵ.

  • field (str, default: '') – 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 (Literal[AMBIENT, UNIFORM, ANALYTICAL_FIELD], default: UNIFORM) – 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 (Literal[AMBIENT, CAVITY], default: AMBIENT) – 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 (float, default: 0) – A Float specifying the reference ambient temperature, θ0θ0. This argument applies only when radiationType = AMBIENT. The default value is 0.0.

  • ambientTemperatureAmp (str, default: '') – 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.

Return type:

RadiationToAmbient

SelfContactExp(name, createStepName, surface, interactionProperty, mechanicalConstraint=abaqusConstants.KINEMATIC, contactControls='')[source]

This method creates a SelfContactExp object.

Note

This function can be accessed by:

mdb.models[name].SelfContactExp
Parameters:
  • name (str) – A String specifying the repository key.

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

  • surface (Region) – A Region object specifying the surface where self-contact is defined.

  • interactionProperty (str) – A String specifying the name of the ContactProperty object associated with this interaction.

  • mechanicalConstraint (Literal[PENALTY, KINEMATIC], default: KINEMATIC) – A SymbolicConstant specifying the mechanical constraint formulation. Possible values are KINEMATIC and PENALTY. The default value is KINEMATIC.

  • contactControls (str, default: '') – 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.

Return type:

SelfContactExp

SelfContactStd(name, createStepName, surface, interactionProperty, enforcement=abaqusConstants.SURFACE_TO_SURFACE, thickness=1, smooth=0, contactControls='')[source]

This method creates a SelfContactStd object.

Note

This function can be accessed by:

mdb.models[name].SelfContactStd
Parameters:
  • name (str) – A String specifying the repository key.

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

  • surface (Region) – A Region object specifying the surface where self-contact is defined.

  • interactionProperty (str) – A String specifying the name of the ContactProperty object associated with this interaction.

  • enforcement (Literal[NODE_TO_SURFACE, SURFACE_TO_SURFACE], default: SURFACE_TO_SURFACE) – A SymbolicConstant specifying the discretization method. Possible values are NODE_TO_SURFACE and SURFACE_TO_SURFACE. The default value is SURFACE_TO_SURFACE.

  • thickness (Union[AbaqusBoolean, bool], default: 1) – 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 (float, default: 0) –

    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.

    Changed in version 2022: Rigid master surfaces was changed to rigid main surfaces.

  • contactControls (str, default: '') – 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.

Return type:

SelfContactStd

StdXplCosimulation(name, createStepName, region, incrementation=abaqusConstants.ALLOW_SUBCYCLING, stepSize=0, stepSizeDefinition=abaqusConstants.DEFAULT)[source]

This method creates a StdXplCosimulation object.

Note

This function can be accessed by:

mdb.models[name].StdXplCosimulation
Parameters:
  • name (str) – A String specifying the repository key.

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

  • region (Region) – A Region object specifying the import and export region upon which the co-simulation exchanges data with the coupled analysis program.

  • incrementation (Literal[LOCKSTEP, ALLOW_SUBCYCLING], default: ALLOW_SUBCYCLING) – 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 (float, default: 0) – A Float specifying the size of the increments to be used by Abaqus/Standard and Abaqus/Explicit. The default value is 0.0.

  • stepSizeDefinition (Literal[DEFAULT, SPECIFIED], default: DEFAULT) – 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.

Return type:

StdXplCosimulation

SurfaceToSurfaceContactExp(name, createStepName, main, secondary, sliding, interactionProperty, mechanicalConstraint=abaqusConstants.KINEMATIC, weightingFactorType=abaqusConstants.DEFAULT, weightingFactor=0, contactControls='', initialClearance=abaqusConstants.OMIT, halfThreadAngle=None, pitch=None, majorBoltDiameter=abaqusConstants.COMPUTED, meanBoltDiameter=abaqusConstants.COMPUTED, datumAxis=None, useReverseDatumAxis=0, clearanceRegion=None)[source]

This method creates a SurfaceToSurfaceContactExp object.

Note

This function can be accessed by:

mdb.models[name].SurfaceToSurfaceContactExp
Parameters:
  • name (str) – A String specifying the repository key.

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

  • main (Region) –

    A Region object specifying the main surface.

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

  • secondary (Region) –

    A Region object specifying the secondary surface.

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

  • sliding (Literal[SMALL, FINITE]) – A SymbolicConstant specifying the contact formulation. Possible values are FINITE and SMALL.

  • interactionProperty (str) – A String specifying the name of the ContactProperty object associated with this interaction.

  • mechanicalConstraint (Literal[PENALTY, KINEMATIC], default: KINEMATIC) – A SymbolicConstant specifying the mechanical constraint formulation. Possible values are KINEMATIC and PENALTY. The default value is KINEMATIC.

  • weightingFactorType (Literal[DEFAULT, SPECIFIED], default: DEFAULT) – A SymbolicConstant specifying the weighting for node-to-face contact. Possible values are DEFAULT and SPECIFIED. The default value is DEFAULT.

  • weightingFactor (float, default: 0) – A Float specifying the weighting factor for the contact surfaces when weightingFactorType = SPECIFIED. The default value is 0.0.

  • contactControls (str, default: '') – 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 (Union[Literal[OMIT, COMPUTED], float], default: OMIT) – 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 (Optional[str], default: None) – None or a sequence of Floats specifying the half thread angle used for bolt clearance. The default value is None.

  • pitch (Optional[str], default: None) – None or a sequence of Floats specifying the pitch used for bolt clearance. The default value is None.

  • majorBoltDiameter (Union[Literal[COMPUTED], float], default: COMPUTED) – The SymbolicConstant COMPUTED or a Float specifying the major diameter of the bolt used for bolt clearance. The default value is COMPUTED.

  • meanBoltDiameter (Union[Literal[COMPUTED], float], default: COMPUTED) – The SymbolicConstant COMPUTED or a Float specifying the mean diameter of the bolt used for bolt clearance. The default value is COMPUTED.

  • datumAxis (Optional[DatumAxis], default: None) – A DatumAxis object specifying the orientation of the bolt hole when specifying bolt clearance.

  • useReverseDatumAxis (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to reverse the bolt clearance direction given by the datum axis. The default value is OFF.

  • clearanceRegion (Optional[Region], default: None) – A Region object specifying the contact region for which clearance is specified.

Returns:

A SurfaceToSurfaceContactExp object.

Return type:

SurfaceToSurfaceContactExp

SurfaceToSurfaceContactStd(name, createStepName, master, slave, sliding, interactionProperty, interferenceType=abaqusConstants.NONE, overclosure=0, interferenceDirectionType=abaqusConstants.COMPUTED, direction=(), amplitude='', smooth=0, hcrit=0, extensionZone=0, adjustMethod=abaqusConstants.NONE, adjustTolerance=0, adjustSet=None, enforcement=abaqusConstants.SURFACE_TO_SURFACE, thickness=1, contactControls='', tied=0, initialClearance=abaqusConstants.OMIT, halfThreadAngle=None, pitch=None, majorBoltDiameter=abaqusConstants.COMPUTED, meanBoltDiameter=abaqusConstants.COMPUTED, datumAxis=None, useReverseDatumAxis=0, clearanceRegion=None, surfaceSmoothing=abaqusConstants.NONE, bondingSet=None, handedness=abaqusConstants.RIGHT, normalAdjustment=None)[source]

This method creates a SurfaceToSurfaceContactStd object.

Note

This function can be accessed by:

mdb.models[name].SurfaceToSurfaceContactStd
Parameters:
  • name (str) – A String specifying the repository key.

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

  • master (Region) – A Region object specifying the main surface.

  • slave (Region) – A Region object specifying the secondary surface.

  • sliding (Literal[SMALL, FINITE]) – A SymbolicConstant specifying the contact formulation. Possible values are FINITE and SMALL.

  • interactionProperty (str) – A String specifying the name of the ContactProperty object associated with this interaction.

  • interferenceType (Literal[UNIFORM, NONE, SHRINK_FIT], default: NONE) –

    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 (float, default: 0) – A Float specifying the maximum overclosure distance allowed. This argument applies only when interferenceType = UNIFORM. The default value is 0.0.

  • interferenceDirectionType (Literal[COMPUTED, DIRECTION_COSINE], default: COMPUTED) – A SymbolicConstant specifying the method used to determine the interference direction. Possible values are COMPUTED and DIRECTION_COSINE. The default value is COMPUTED.

  • direction (tuple, default: ()) –

    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 (str, default: '') – 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 (float, default: 0) – 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.

  • hcrit (float, default: 0) – A Float specifying the distance by which a secondary node must penetrate the main surface before Abaqus/Standard abandons the current increment and tries again with a smaller increment. The default value is 0.0.

  • extensionZone (float, default: 0) – A Float specifying a fraction of the end segment or facet edge length by which the main 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 (Literal[SET, TOLERANCE, OVERCLOSED, NONE], default: NONE) – A SymbolicConstant specifying the adjust method. Possible values are NONE, OVERCLOSED, TOLERANCE, and SET. The default value is NONE.

  • adjustTolerance (float, default: 0) – A Float specifying the adjust tolerance. The default value is 0.0.

  • adjustSet (Optional[Region], default: None) – A Region object specifying the Set object to which the adjustment is to be applied.

  • enforcement (Literal[NODE_TO_SURFACE, SURFACE_TO_SURFACE], default: SURFACE_TO_SURFACE) – A SymbolicConstant specifying the discretization method. Possible values are NODE_TO_SURFACE and SURFACE_TO_SURFACE. The default value is SURFACE_TO_SURFACE.

  • thickness (Union[AbaqusBoolean, bool], default: 1) – 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 (str, default: '') – 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 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether the surfaces are to be “tied” together for the duration of the simulation. The default value is OFF.

  • initialClearance (Union[Literal[OMIT, COMPUTED], float], default: OMIT) – 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 (Optional[str], default: None) – None or a sequence of Floats specifying the half thread angle used for bolt clearance. The default value is None.

  • pitch (Optional[str], default: None) – None or a sequence of Floats specifying the pitch used for bolt clearance. The default value is None.

  • majorBoltDiameter (Union[Literal[COMPUTED], float], default: COMPUTED) – The SymbolicConstant COMPUTED or a Float specifying the major diameter of the bolt used for bolt clearance. The default value is COMPUTED.

  • meanBoltDiameter (Union[Literal[COMPUTED], float], default: COMPUTED) – The SymbolicConstant COMPUTED or a Float specifying the mean diameter of the bolt used for bolt clearance. The default value is COMPUTED.

  • datumAxis (Optional[DatumAxis], default: None) – A DatumAxis object specifying the orientation of the bolt hole when specifying bolt clearance.

  • useReverseDatumAxis (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to reverse the bolt clearance direction given by the datum axis. The default value is OFF.

  • clearanceRegion (Optional[Region], default: None) – A Region object specifying the contact region for which clearance is specified.

  • surfaceSmoothing (Literal[AUTOMATIC, NONE], default: NONE) – 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 (Optional[Region], default: None) – A Region object specifying the secondary node sub-set for bonding, used only when the contact property CohesiveBehavior option specifies use.

  • handedness (Literal[RIGHT, LEFT], default: RIGHT) –

    A SymbolicConstant specifying the bolt handedness formulation. Possible values are RIGHT and LEFT. The default value is RIGHT.

    New in version 2019: The normalAdjustment argument was added.

  • normalAdjustment (Optional[Literal[AXIAL, LOCATION, COMPONENT, UNIFORM, DEPENDENT]], default: None) –

    A SymbolicConstant specifying the bolt normal adjustment formulation for all secondary nodes. Possible values are UNIFORM AXIAL COMPONENT and LOCATION DEPENDENT. The default value is UNIFORM AXIAL COMPONENT.

    New in version 2019: The normalAdjustment argument was added.

Returns:

A SurfaceToSurfaceContactStd object.

Return type:

SurfaceToSurfaceContactStd

XFEMCrackGrowth(name, createStepName, crackName, allowGrowth=1)[source]

This method creates an XFEMCrackGrowth object.

Note

This function can be accessed by:

mdb.models[name].XFEMCrackGrowth
Parameters:
  • name (str) – A String specifying the repository key.

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

  • crackName (str) – A String specifying the XFEMCrack object associated with this interaction.

  • allowGrowth (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether the crack is allowed to grow (propagate) during this analysis step. The default value is ON.

Returns:

A XFEMCrackGrowth object.

Return type:

XFEMCrackGrowth

contactDetection(name='', createStepName='', searchDomain=abaqusConstants.MODEL, defaultType=abaqusConstants.CONTACT, interactionProperty='', separationTolerance=None, extendByAngle=20, mergeWithinAngle=20, searchSingleInstances=0, nameEachSurfaceFound=1, createUnionOfMainSurfaces=0, createUnionOfSecondarySurfaces=0, createUnionOfMainSecondarySurfaces=0, includePlanar=1, includeCylindricalSphericalToric=1, includeSplineBased=1, includeMeshSolid=1, includeMeshShell=1, includeMeshMembrane=0, includeOverclosed=1, includeNonOverlapping=0, meshedGeometrySearchTechnique=abaqusConstants.USE_GEOMETRY, useShellThickness=1, surfaceSmoothing=None)[source]

This method uses contact detection to create SurfaceToSurfaceContactStd, SurfaceToSurfaceContactExp, and Tie objects.

Parameters:
  • name (str, default: '') – A String specifying the prefix used to generate repository keys. The default value is “CP-”

  • createStepName (str, default: '') – A String specifying the name of the step in which the SurfaceToSurfaceContactStd, SurfaceToSurfaceContactExp, and Tie objects are created. The default value is “Initial.”

  • searchDomain (Literal[MODEL], default: MODEL) – 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 (Literal[CONTACT, CONTACT_EXPLICIT, TIE, CONTACT_STANDARD], default: CONTACT) – 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 (str, default: '') – A String specifying the name of the ContactProperty object associated with any interactions created.

  • separationTolerance (Optional[float], default: None) – 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 (float, default: 20) – None or a Float specifying the angle for extending surface definitions to include adjacent faces. The default value is 20.

  • mergeWithinAngle (float, default: 20) – None or a Float specifying the angle for merging adjacent contact pairs that lie within the angle. The default value is 20.

  • searchSingleInstances (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to include surface pairs within a single instance. The default value is OFF.

  • nameEachSurfaceFound (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to assign a name to each surface found. The default value is ON.

  • createUnionOfMainSurfaces (Union[AbaqusBoolean, bool], default: 0) –

    A Boolean specifying whether to create a surface that is the union of all main surfaces found. The default value is OFF.

    Changed in version 2022: The argument createUnionOfMasterSurfaces was renamed to createUnionOfMainSurfaces.

  • createUnionOfSecondarySurfaces (Union[AbaqusBoolean, bool], default: 0) –

    A Boolean specifying whether to create a surface that is the union of all secondary surfaces found. The default value is OFF.

    Changed in version 2022: The argument createUnionOfSlaveSurfaces was renamed to createUnionOfSecondarySurfaces.

  • createUnionOfMainSecondarySurfaces (Union[AbaqusBoolean, bool], default: 0) –

    A Boolean specifying whether to create a surface that is the union of all main and secondary surfaces found. The default value is OFF.

    Changed in version 2022: The argument createUnionOfMasterSlaveSurfaces was renamed to createUnionOfMainSecondarySurfaces.

  • includePlanar (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to include planar geometry. The default value is ON.

  • includeCylindricalSphericalToric (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to include cylindrical, spherical, and toric geometry. The default value is ON.

  • includeSplineBased (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to include spline-based geometry. The default value is ON.

  • includeMeshSolid (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to include solid mesh entities. The default value is ON.

  • includeMeshShell (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to include shell mesh entities. The default value is ON.

  • includeMeshMembrane (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to include mesh membrane entities. The default value is OFF.

  • includeOverclosed (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to include overclosed pairs. The default value is ON.

  • includeNonOverlapping (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to include opposing geometry surfaces that do not overlap. The default value is OFF.

  • meshedGeometrySearchTechnique (Literal[USE_MESH, USE_GEOMETRY], default: USE_GEOMETRY) – 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 (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to account for shell thickness and offset during contact detection. The default value is ON.

  • surfaceSmoothing (Optional[Literal[AUTOMATIC, NONE]], default: None) – A SymbolicConstant specifying whether to use surface smoothing for geometric surfaces in SurfaceToSurfaceContactStd interactions. Possible values are NONE and AUTOMATIC. The default value isAUTOMATIC.

Return type:

None.

getSurfaceSeparation()[source]

This method returns a list of all possible contacts that can be created using the ContactDetection method.

Returns:

Tuple of tuples, where each tuple holds information, to be used in contact creation as follows:

  • A string specifying the name of the main surface used in contact.

  • A string specifying the name of the secondary surface used in contact.

  • A float specifying the separation distance between the main surface and the secondary surface.

  • A boolean specifying whether or not contact surfaces are overclosed.

Return type:

tuple[tuple[str, str, float, bool]]

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

Bases: ModelBase

This method creates a Model object.

Note

This function can be accessed by:

mdb.Model
Parameters:
  • name (str) – A String specifying the repository key.

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

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

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

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

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

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

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

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

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

Returns:

A Model object.

Return type:

Model

Public Data Attributes:

Inherited from ModelBase

name

A String specifying the repository key.

stefanBoltzmann

None or a Float specifying the Stefan-Boltzmann constant.

absoluteZero

None or a Float specifying the absolute zero constant.

waveFormulation

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

universalGas

None or a Float specifying the universal gas constant.

noPartsInputFile

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

endRestartStep

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

shellToSolid

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

lastChangedCount

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

description

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

restartJob

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

restartStep

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

globalJob

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

copyConstraints

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

copyConnectors

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

copyInteractions

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

keywordBlock

A KeywordBlock object.

rootAssembly

An Assembly object.

amplitudes

A repository of Amplitude objects.

profiles

A repository of Profile objects.

boundaryConditions

A repository of BoundaryCondition objects.

constraints

A repository of ConstrainedSketchConstraint objects.

analyticalFields

A repository of AnalyticalField objects.

discreteFields

A repository of DiscreteField objects.

predefinedFields

A repository of PredefinedField objects.

interactions

A repository of Interaction objects.

interactionProperties

A repository of InteractionProperty objects.

contactControls

A repository of ContactControl objects.

contactInitializations

A repository of ContactInitialization objects.

contactStabilizations

A repository of ContactStabilization objects.

linkedInstances

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

linkedParts

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

loads

A repository of Load objects.

materials

A repository of Material objects.

calibrations

A repository of Calibration objects.

sections

A repository of Section objects.

remeshingRules

A repository of RemeshingRule objects.

sketches

A repository of ConstrainedSketch objects.

parts

A repository of Part objects.

steps

A repository of Step objects.

featureOptions

A FeatureOptions object.

adaptiveMeshConstraints

A repository of AdaptiveMeshConstraint objects.

adaptiveMeshControls

A repository of AdaptiveMeshControl objects.

timePoints

A repository of TimePoint objects.

filters

A repository of Filter objects.

integratedOutputSections

A repository of IntegratedOutputSection objects.

fieldOutputRequests

A repository of FieldOutputRequest objects.

historyOutputRequests

A repository of HistoryOutputRequest objects.

optimizationTasks

A repository of OptimizationTask objects.

tableCollections

A repository of TableCollection objects.

eventSeriesTypes

A repository of EventSeriesType objects.

eventSeriesDatas

A repository of EventSeriesData objects.

restartIncrement

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

Public Methods:

ExpContactControl(name[, globTrkChoice, ...])

This method creates an ExpContactControl object.

StdContactControl(name[, ...])

This method creates an StdContactControl object.

Inherited from ModelBase

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

This method creates a Model object.

ModelFromInputFile(name, inputFileName)

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

ModelFromOdbFile(name, odbFileName)

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

ModelFromNastranFile(modelName, inputFileName)

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

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

This method modifies the Model object.


Member Details:

ExpContactControl(name, globTrkChoice=abaqusConstants.DEFAULT, globTrkInc=None, fastLocalTrk=1, scalePenalty=1, warpCheckPeriod=20, warpCutoff=20)[source]

This method creates an ExpContactControl object.

Note

This function can be accessed by:

mdb.models[name].ExpContactControl
Parameters:
  • name (str) – A String specifying the contact controls repository key.

  • globTrkChoice (Literal[SPECIFY, DEFAULT], default: DEFAULT) – 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 (Optional[int], default: None) – 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 (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to use the more computationally efficient local tracking method. The default value is ON.

  • scalePenalty (float, default: 1) – 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 (int, default: 20) – An Int specifying the number of increments between checks for highly warped facets on main surfaces. The default value is 20.

  • warpCutoff (float, default: 20) – 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.

Return type:

ExpContactControl

Raises:

RangeError

StdContactControl(name, stiffnessScaleFactor=1, penetrationTolChoice=abaqusConstants.RELATIVE, relativePenetrationTolerance=None, absolutePenetrationTolerance=None, frictionOnset=None, automaticTolerances=0, maxchp=0, perrmx=0, uerrmx=0, stabilizeChoice=abaqusConstants.NONE, dampFactor=1, dampCoef=0, tangFraction=1, eosFraction=0, zeroDampingChoice=abaqusConstants.COMPUTE, zeroDamping=None, enforceWithLagrangeMultipliers=abaqusConstants.DEFAULT)[source]

This method creates an StdContactControl object.

Note

This function can be accessed by:

mdb.models[name].StdContactControl
Parameters:
  • name (str) – A String specifying the contact controls repository key.

  • stiffnessScaleFactor (float, default: 1) – 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 (Literal[RELATIVE, ABSOLUTE], default: RELATIVE) – 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 (Optional[float], default: None) – 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⁻³.The relativePenetrationTolerance argument applies only when penetrationTolChoice = RELATIVE. The relativePenetrationTolerance and absolutePenetrationTolerance arguments are mutually exclusive.

  • absolutePenetrationTolerance (Optional[float], default: None) – 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 (Optional[Literal[IMMEDIATE, DELAYED]], default: None) –

    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 (Union[AbaqusBoolean, bool], default: 0) – 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 (int, default: 0) – 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 (float, default: 0) – 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 (float, default: 0) –

    A Float specifying the maximum overclosure distance allowed at a secondary 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.

    Changed in version 2022: Slave node was changed to secondary node.

  • stabilizeChoice (Literal[AUTOMATIC, NONE, COEFFICIENT], default: NONE) – 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 (float, default: 1) – 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 (float, default: 0) – A Float specifying the damping coefficient. The default value is 0.0.This argument is only valid when stabilizeChoice = COEFFICIENT.

  • tangFraction (float, default: 1) – 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 (float, default: 0) – 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 (Literal[COMPUTE, AUTOMATIC, SPECIFY, COEFFICIENT], default: COMPUTE) – 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 (Optional[float], default: None) – 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 (Literal[ENFORCEMENT_OFF, DEFAULT, ENFORCEMENT_ON], default: DEFAULT) – 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.

Return type:

StdContactControl

Raises:

RangeError

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

Bases: ModelBase

This method creates a Model object.

Note

This function can be accessed by:

mdb.Model
Parameters:
  • name (str) – A String specifying the repository key.

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

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

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

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

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

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

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

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

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

Returns:

A Model object.

Return type:

Model

Public Data Attributes:

Inherited from ModelBase

name

A String specifying the repository key.

stefanBoltzmann

None or a Float specifying the Stefan-Boltzmann constant.

absoluteZero

None or a Float specifying the absolute zero constant.

waveFormulation

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

universalGas

None or a Float specifying the universal gas constant.

noPartsInputFile

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

endRestartStep

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

shellToSolid

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

lastChangedCount

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

description

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

restartJob

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

restartStep

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

globalJob

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

copyConstraints

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

copyConnectors

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

copyInteractions

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

keywordBlock

A KeywordBlock object.

rootAssembly

An Assembly object.

amplitudes

A repository of Amplitude objects.

profiles

A repository of Profile objects.

boundaryConditions

A repository of BoundaryCondition objects.

constraints

A repository of ConstrainedSketchConstraint objects.

analyticalFields

A repository of AnalyticalField objects.

discreteFields

A repository of DiscreteField objects.

predefinedFields

A repository of PredefinedField objects.

interactions

A repository of Interaction objects.

interactionProperties

A repository of InteractionProperty objects.

contactControls

A repository of ContactControl objects.

contactInitializations

A repository of ContactInitialization objects.

contactStabilizations

A repository of ContactStabilization objects.

linkedInstances

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

linkedParts

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

loads

A repository of Load objects.

materials

A repository of Material objects.

calibrations

A repository of Calibration objects.

sections

A repository of Section objects.

remeshingRules

A repository of RemeshingRule objects.

sketches

A repository of ConstrainedSketch objects.

parts

A repository of Part objects.

steps

A repository of Step objects.

featureOptions

A FeatureOptions object.

adaptiveMeshConstraints

A repository of AdaptiveMeshConstraint objects.

adaptiveMeshControls

A repository of AdaptiveMeshControl objects.

timePoints

A repository of TimePoint objects.

filters

A repository of Filter objects.

integratedOutputSections

A repository of IntegratedOutputSection objects.

fieldOutputRequests

A repository of FieldOutputRequest objects.

historyOutputRequests

A repository of HistoryOutputRequest objects.

optimizationTasks

A repository of OptimizationTask objects.

tableCollections

A repository of TableCollection objects.

eventSeriesTypes

A repository of EventSeriesType objects.

eventSeriesDatas

A repository of EventSeriesData objects.

restartIncrement

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

Public Methods:

ExpInitialization(name[, overclosureType, ...])

This method creates an ExpInitialization object.

StdInitialization(name[, overclosureType, ...])

This method creates a StdInitialization object.

Inherited from ModelBase

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

This method creates a Model object.

ModelFromInputFile(name, inputFileName)

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

ModelFromOdbFile(name, odbFileName)

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

ModelFromNastranFile(modelName, inputFileName)

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

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

This method modifies the Model object.


Member Details:

ExpInitialization(name, overclosureType=abaqusConstants.ADJUST, interferenceDistance=None, clearanceDistance=None, openingTolerance=None, overclosureTolerance=None, adjustNodalCoords=True, secondaryNodesetName=None, stepFraction=1)[source]

This method creates an ExpInitialization object.

Note

This function can be accessed by:

mdb.models[name].ExpInitialization
Parameters:
  • name (str) – A String specifying the contact initialization repository key.

  • overclosureType (Literal[INTERFERENCE, ADJUST, CLEARANCE], default: ADJUST) – A SymbolicConstant specifying the type of overclosure to be defined. Possible values are ADJUST, INTERFERENCE, and CLEARANCE. The default value is ADJUST.

  • interferenceDistance (Optional[float], default: None) – None or a Float specifying the interference distance. This argument is valid only when overclosureType = INTERFERENCE. The default value is None.

  • clearanceDistance (Optional[float], default: None) – 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 (Optional[float], default: None) – 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 (Optional[float], default: None) – None or a Float specifying the distance tolerance within which initial overclosures will undergo strain-free adjustments. The default value is None.

  • adjustNodalCoords (Union[AbaqusBoolean, bool], default: True) – 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.

  • secondaryNodesetName (Optional[str], default: None) –

    A String specifying the name of the node set containing the secondary 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.

    Changed in version 2022: The argument slaveNodesetName was renamed to secondaryNodesetName.

  • stepFraction (float, default: 1) – 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.

Return type:

ExpInitialization

Raises:

RangeError

StdInitialization(name, overclosureType=abaqusConstants.ADJUST, interferenceDistance=None, clearanceDistance=None, openingTolerance=None, overclosureTolerance=None)[source]

This method creates a StdInitialization object.

Note

This function can be accessed by:

mdb.models[name].StdInitialization

New in version 2020: The ExpInitialization method was added.

Parameters:
  • name (str) – A String specifying the contact initialization repository key.

  • overclosureType (Literal[INTERFERENCE, ADJUST, CLEARANCE], default: ADJUST) – A SymbolicConstant specifying the type of overclosure to be defined. Possible values are ADJUST, INTERFERENCE, and CLEARANCE. The default value is ADJUST.

  • interferenceDistance (Optional[float], default: None) – None or a Float specifying the interference distance. This argument is valid only when overclosureType = INTERFERENCE. The default value is None.

  • clearanceDistance (Optional[float], default: None) – 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 (Optional[float], default: None) – 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 (Optional[float], default: None) – 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.

Return type:

StdInitialization

Raises:

RangeError

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

Bases: ModelBase

This method creates a Model object.

Note

This function can be accessed by:

mdb.Model
Parameters:
  • name (str) – A String specifying the repository key.

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

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

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

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

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

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

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

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

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

Returns:

A Model object.

Return type:

Model

Public Data Attributes:

Inherited from ModelBase

name

A String specifying the repository key.

stefanBoltzmann

None or a Float specifying the Stefan-Boltzmann constant.

absoluteZero

None or a Float specifying the absolute zero constant.

waveFormulation

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

universalGas

None or a Float specifying the universal gas constant.

noPartsInputFile

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

endRestartStep

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

shellToSolid

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

lastChangedCount

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

description

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

restartJob

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

restartStep

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

globalJob

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

copyConstraints

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

copyConnectors

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

copyInteractions

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

keywordBlock

A KeywordBlock object.

rootAssembly

An Assembly object.

amplitudes

A repository of Amplitude objects.

profiles

A repository of Profile objects.

boundaryConditions

A repository of BoundaryCondition objects.

constraints

A repository of ConstrainedSketchConstraint objects.

analyticalFields

A repository of AnalyticalField objects.

discreteFields

A repository of DiscreteField objects.

predefinedFields

A repository of PredefinedField objects.

interactions

A repository of Interaction objects.

interactionProperties

A repository of InteractionProperty objects.

contactControls

A repository of ContactControl objects.

contactInitializations

A repository of ContactInitialization objects.

contactStabilizations

A repository of ContactStabilization objects.

linkedInstances

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

linkedParts

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

loads

A repository of Load objects.

materials

A repository of Material objects.

calibrations

A repository of Calibration objects.

sections

A repository of Section objects.

remeshingRules

A repository of RemeshingRule objects.

sketches

A repository of ConstrainedSketch objects.

parts

A repository of Part objects.

steps

A repository of Step objects.

featureOptions

A FeatureOptions object.

adaptiveMeshConstraints

A repository of AdaptiveMeshConstraint objects.

adaptiveMeshControls

A repository of AdaptiveMeshControl objects.

timePoints

A repository of TimePoint objects.

filters

A repository of Filter objects.

integratedOutputSections

A repository of IntegratedOutputSection objects.

fieldOutputRequests

A repository of FieldOutputRequest objects.

historyOutputRequests

A repository of HistoryOutputRequest objects.

optimizationTasks

A repository of OptimizationTask objects.

tableCollections

A repository of TableCollection objects.

eventSeriesTypes

A repository of EventSeriesType objects.

eventSeriesDatas

A repository of EventSeriesData objects.

restartIncrement

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

Public Methods:

StdStabilization(name[, zeroDistance, ...])

This method creates a StdStabilization object.

Inherited from ModelBase

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

This method creates a Model object.

ModelFromInputFile(name, inputFileName)

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

ModelFromOdbFile(name, odbFileName)

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

ModelFromNastranFile(modelName, inputFileName)

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

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

This method modifies the Model object.


Member Details:

StdStabilization(name, zeroDistance=None, reductionFactor=0, scaleFactor=1, tangentialFactor=0, amplitude='', reset=0)[source]

This method creates a StdStabilization object.

Note

This function can be accessed by:

mdb.models[name].StdStabilization
Parameters:
  • name (str) – A String specifying the contact stabilization repository key.

  • zeroDistance (Optional[float], default: None) – None or a Float specifying the clearance distance at which the stabilization becomes zero. The default value is None.

  • reductionFactor (float, default: 0) – A Float specifying the factor by which the analysis will reduce the contact stabilization coefficient per increment. The default value is 0.1.

  • scaleFactor (float, default: 1) – A Float specifying the factor by which the analysis will scale the contact stabilization coefficient. The default value is 1.0.

  • tangentialFactor (float, default: 0) – A Float specifying the factor that scales the contact stabilization coefficient in the tangential direction. The default value is 0.0.

  • amplitude (str, default: '') – 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 (Union[AbaqusBoolean, bool], default: 0) – 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.

Return type:

StdStabilization

Raises:

RangeError

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

Bases: ModelBase

This method creates a Model object.

Note

This function can be accessed by:

mdb.Model
Parameters:
  • name (str) – A String specifying the repository key.

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

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

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

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

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

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

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

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

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

Returns:

A Model object.

Return type:

Model

Public Data Attributes:

Inherited from ModelBase

name

A String specifying the repository key.

stefanBoltzmann

None or a Float specifying the Stefan-Boltzmann constant.

absoluteZero

None or a Float specifying the absolute zero constant.

waveFormulation

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

universalGas

None or a Float specifying the universal gas constant.

noPartsInputFile

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

endRestartStep

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

shellToSolid

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

lastChangedCount

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

description

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

restartJob

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

restartStep

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

globalJob

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

copyConstraints

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

copyConnectors

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

copyInteractions

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

keywordBlock

A KeywordBlock object.

rootAssembly

An Assembly object.

amplitudes

A repository of Amplitude objects.

profiles

A repository of Profile objects.

boundaryConditions

A repository of BoundaryCondition objects.

constraints

A repository of ConstrainedSketchConstraint objects.

analyticalFields

A repository of AnalyticalField objects.

discreteFields

A repository of DiscreteField objects.

predefinedFields

A repository of PredefinedField objects.

interactions

A repository of Interaction objects.

interactionProperties

A repository of InteractionProperty objects.

contactControls

A repository of ContactControl objects.

contactInitializations

A repository of ContactInitialization objects.

contactStabilizations

A repository of ContactStabilization objects.

linkedInstances

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

linkedParts

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

loads

A repository of Load objects.

materials

A repository of Material objects.

calibrations

A repository of Calibration objects.

sections

A repository of Section objects.

remeshingRules

A repository of RemeshingRule objects.

sketches

A repository of ConstrainedSketch objects.

parts

A repository of Part objects.

steps

A repository of Step objects.

featureOptions

A FeatureOptions object.

adaptiveMeshConstraints

A repository of AdaptiveMeshConstraint objects.

adaptiveMeshControls

A repository of AdaptiveMeshControl objects.

timePoints

A repository of TimePoint objects.

filters

A repository of Filter objects.

integratedOutputSections

A repository of IntegratedOutputSection objects.

fieldOutputRequests

A repository of FieldOutputRequest objects.

historyOutputRequests

A repository of HistoryOutputRequest objects.

optimizationTasks

A repository of OptimizationTask objects.

tableCollections

A repository of TableCollection objects.

eventSeriesTypes

A repository of EventSeriesType objects.

eventSeriesDatas

A repository of EventSeriesData objects.

restartIncrement

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

Public Methods:

AcousticImpedanceProp(name, tableType, table)

This method creates an AcousticImpedanceProp object.

ActuatorSensorProp(name[, realProperties, ...])

This method creates an ActuatorSensorProp object.

CavityRadiationProp(name[, ...])

This method creates a CavityRadiationProp object.

ContactProperty(name)

This method creates a ContactProperty object.

FilmConditionProp(name[, ...])

This method creates a FilmConditionProp object.

FluidCavityProperty(name[, definition, ...])

This method creates a FluidCavityProperty object.

FluidExchangeProperty(name, dataTable[, ...])

This method creates a FluidExchangeProperty object.

FluidInflatorProperty(name, definition, ...)

This method creates a FluidInflatorProperty object.

IncidentWaveProperty(name[, definition, ...])

This method creates an IncidentWaveProperty object.

Inherited from ModelBase

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

This method creates a Model object.

ModelFromInputFile(name, inputFileName)

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

ModelFromOdbFile(name, odbFileName)

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

ModelFromNastranFile(modelName, inputFileName)

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

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

This method modifies the Model object.


Member Details:

AcousticImpedanceProp(name, tableType, table, frequencyDependency=0)[source]

This method creates an AcousticImpedanceProp object.

Note

This function can be accessed by:

mdb.models[name].AcousticImpedanceProp
Parameters:
  • name (str) – A String specifying the interaction property repository key.

  • tableType (Literal[ADMITTANCE, IMPEDANCE]) – A SymbolicConstant specifying the type of tabular data to be defined. Possible values are IMPEDANCE and ADMITTANCE.

  • table (tuple) – 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 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether the table data depend on frequency. The default value is OFF.

Returns:

An AcousticImpedanceProp object.

Return type:

AcousticImpedanceProp

ActuatorSensorProp(name, realProperties=(), integerProperties=())[source]

This method creates an ActuatorSensorProp object.

Note

This function can be accessed by:

mdb.models[name].ActuatorSensorProp
Parameters:
  • name (str) – A String specifying the interaction property repository key.

  • realProperties (tuple, default: ()) – A sequence of Floats specifying the PROPS array used by user subroutine UEL. The default value is an empty sequence.

  • integerProperties (tuple, default: ()) – A sequence of Ints specifying the JPROPS array used by user subroutine UEL. The default value is an empty sequence.

Returns:

An ActuatorSensorProp object.

Return type:

ActuatorSensorProp

CavityRadiationProp(name, temperatureDependency=0, dependencies=0, property=())[source]

This method creates a CavityRadiationProp object.

Note

This function can be accessed by:

mdb.models[name].CavityRadiationProp
Parameters:
  • name (str) – A String specifying the interaction property repository key.

  • temperatureDependency (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether the data depend on temperature. The default value is OFF.

  • dependencies (int, default: 0) – An Int specifying the number of field variable dependencies. The default value is 0.

  • property (tuple, default: ()) – 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.

Return type:

CavityRadiationProp

ContactProperty(name)[source]

This method creates a ContactProperty object.

Note

This function can be accessed by:

mdb.models[name].ContactProperty
Parameters:

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

Returns:

A ContactProperty object.

Return type:

ContactProperty

FilmConditionProp(name, temperatureDependency=0, dependencies=0, property=())[source]

This method creates a FilmConditionProp object.

Note

This function can be accessed by:

mdb.models[name].FilmConditionProp
Parameters:
  • name (str) – A String specifying the interaction property repository key.

  • temperatureDependency (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether the data depend on temperature. The default value is OFF.

  • dependencies (int, default: 0) – An Int specifying the number of field variable dependencies. The default value is 0.

  • property (tuple, default: ()) –

    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.

Return type:

FilmConditionProp

FluidCavityProperty(name, definition=abaqusConstants.HYDRAULIC, fluidDensity=None, molecularWeight=None, useExpansion=0, expansionTempDep=0, expansionDependencies=0, referenceTemperature=0, expansionTable=(), useBulkModulus=0, bulkModulusTempDep=0, bulkModulusDependencies=0, bulkModulusTable=(), useCapacity=0, capacityType=abaqusConstants.POLYNOMIAL, capacityTempDep=0, capacityDependencies=0, capacityTable=())[source]

This method creates a FluidCavityProperty object.

Note

This function can be accessed by:

mdb.models[name].FluidCavityProperty
Parameters:
  • name (str) – A String specifying the interaction property repository key.

  • definition (Literal[PNEUMATIC, HYDRAULIC], default: HYDRAULIC) – A SymbolicConstant specifying the type of fluid cavity property to be defined. Possible values are HYDRAULIC and PNEUMATIC. The default value is HYDRAULIC.

  • fluidDensity (Optional[float], default: None) – 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 (Optional[float], default: None) – 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 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether thermal expansion coefficients will be defined. This argument is applicable only when definition = HYDRAULIC. The default value is OFF.

  • expansionTempDep (Union[AbaqusBoolean, bool], default: 0) – 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 (int, default: 0) – 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 (float, default: 0) – 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 (tuple, default: ()) –

    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 (Union[AbaqusBoolean, bool], default: 0) – 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 (Union[AbaqusBoolean, bool], default: 0) – 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 (int, default: 0) – 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 (tuple, default: ()) –

    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 (Union[AbaqusBoolean, bool], default: 0) – 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 (Literal[POLYNOMIAL, TABULAR], default: POLYNOMIAL) – A SymbolicConstant specifying the method to define the molar heat capacity. Possible values are POLYNOMIAL and TABULAR. The default value is POLYNOMIAL.

  • capacityTempDep (Union[AbaqusBoolean, bool], default: 0) – 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 (int, default: 0) – 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 (tuple, default: ()) –

    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.

Return type:

FluidCavityProperty

FluidExchangeProperty(name, dataTable, definition=abaqusConstants.BULK_VISCOSITY, pressureDependency=0, temperatureDependency=0, fieldDependencies=0)[source]

This method creates a FluidExchangeProperty object.

Note

This function can be accessed by:

mdb.models[name].FluidExchangeProperty
Parameters:
  • name (str) – A String specifying the interaction property repository key.

  • dataTable (tuple) –

    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 (Literal[VOL_FLUX, VOL_RATE_LEAK, BULK_VISCOSITY, MASS_RATE_LEAK, MASS_FLUX], default: BULK_VISCOSITY) – 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 (Union[AbaqusBoolean, bool], default: 0) – 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 (Union[AbaqusBoolean, bool], default: 0) – 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 (int, default: 0) – 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.

Return type:

FluidExchangeProperty

FluidInflatorProperty(name, definition, effectiveArea, tankVolume, dischargeCoefficient=None, dataTable=(), numFluids=None, mixtureType='', inflationTime=(), fluidbehaviorName=(), massFraction=())[source]

This method creates a FluidInflatorProperty object.

Note

This function can be accessed by:

mdb.models[name].FluidInflatorProperty

New in version 2019: The FluidInflatorProperty method was added.

Parameters:
  • name (str) – A String specifying the interaction property repository key.

  • definition (str) – 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 (float) – A Float specifying the total inflator orifice area. This argument is applicable only if definition = DUAL PRESSURE or definition = PRESSURE AND MASS.

  • tankVolume (float) – A Float specifying the tank volume. This argument is applicable only if definition = DUAL PRESSURE or definition = TANK TEST.

  • dischargeCoefficient (Optional[float], default: None) – A Float specifying the discharge coefficient. This argument is applicable only if definition = DUAL PRESSURE or definition = PRESSURE AND MASS.

  • dataTable (tuple, default: ()) – A sequence of sequences of Floats specifying the items described in the “Table data” section below.

  • numFluids (Optional[int], default: None) – An Int specifying the number of gas species used for this inflator.

  • mixtureType (str, default: '') – 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 (tuple, default: ()) – A sequence of sequences of Floats specifying the inflation time.

  • fluidbehaviorName (tuple, default: ()) – A sequence of sequences of Strings specifying fluid behavior names.

  • massFraction (tuple, default: ()) – A sequence of sequences of Floats specifying the mass fraction or the molar fraction corresponding to entered fluid behavior.

Returns:

A FluidInflatorProperty object.

IncidentWaveProperty(name, definition=abaqusConstants.PLANAR, propagationModel=abaqusConstants.ACOUSTIC, soundSpeed=None, fluidDensity=None, specificHeatRatio=None, gravity=None, atmosphericPressure=None, dragCoefficient=None, dragExponent=2, waveEffects=1, chargeDensity=None, chargeMass=None, constantK1=None, constantK2=None, constantA=None, constantB=None, constantKc=None, duration=None, maximumSteps=1500, relativeStepControl=None, absoluteStepControl=None, stepControlExponent=0, genDecayA=0, genDecayB=0, genDecayC=0, seedNumber=None, massTNT=None, massFactor=1, lengthFactor=1, timeFactor=1, pressureFactor=1)[source]

This method creates an IncidentWaveProperty object.

Note

This function can be accessed by:

mdb.models[name].IncidentWaveProperty
Parameters:
  • name (str) – A String specifying the interaction property repository key.

  • definition (Literal[PLANAR, SPHERICAL, DIFFUSE, SURFACE_BLAST, AIR_BLAST], default: PLANAR) – 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 (Literal[ACOUSTIC, SPHERICAL, GENERALIZED_DECAY, UNDEX_CHARGE], default: ACOUSTIC) – 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 (Optional[float], default: None) – 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 (Optional[float], default: None) – A Float specifying the fluid mass density.This argument is not valid when definition = AIR_BLAST or when definition = SURFACE_BLAST.

  • specificHeatRatio (Optional[float], default: None) – 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 (Optional[float], default: None) – 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 (Optional[float], default: None) – 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 (Optional[float], default: None) – 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 (float, default: 2) – 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 (Union[AbaqusBoolean, bool], default: 1) – 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 (Optional[float], default: None) – 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 (Optional[float], default: None) – 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 (Optional[float], default: None) – 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 (Optional[float], default: None) – 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 (Optional[float], default: None) – 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 (Optional[float], default: None) – 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 (Optional[float], default: None) – 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 (Optional[float], default: None) – 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 (int, default: 1500) – 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 (Optional[float], default: None) – A Float specifying the relative step size control parameter. The default value is 1x10⁻¹¹.This argument is valid only when definition = SPHERICAL and propagationModel = UNDEX_CHARGE.

  • absoluteStepControl (Optional[float], default: None) – A Float specifying the absolute step size control parameter. The default value is 1x10⁻¹¹.This argument is valid only when definition = SPHERICAL and propagationModel = UNDEX_CHARGE.

  • stepControlExponent (float, default: 0) – 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 (float, default: 0) – 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 (float, default: 0) – 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 (float, default: 0) – 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 (Optional[int], default: None) – 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 (Optional[float], default: None) – 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 (float, default: 1) – 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 (float, default: 1) – 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 (float, default: 1) – 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 (float, default: 1) – 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.

Return type:

IncidentWaveProperty

Other Classes

class AcousticImpedance(name, createStepName, surface, definition=abaqusConstants.TABULAR, interactionProperty='', nonreflectingType=abaqusConstants.PLANE, radius=1, semimajorAxis=1, eccentricity=0, centerCoordinates=(), directionCosine=())[source]

Bases: Interaction

The AcousticImpedance object defines surface impedance information or nonreflecting boundaries for acoustic and coupled acoustic-structural analyses. The AcousticImpedance object is derived from the Interaction object.

Note

This object can be accessed by:

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

The corresponding analysis keywords are:

  • SIMPEDANCE

This method creates an AcousticImpedance object.

Note

This function can be accessed by:

mdb.models[name].AcousticImpedance
Parameters:
  • name (str) – A String specifying the repository key.

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

  • surface (Region) – A Region object specifying the acoustic boundary surface.

  • definition (Literal[TABULAR, NONREFLECTING], default: TABULAR) – A SymbolicConstant specifying the type of acoustic impedance to be defined. Possible values are TABULAR and NONREFLECTING. The default value is TABULAR.

  • interactionProperty (str, default: '') – A String specifying the AcousticImpedanceProp object associated with this interaction.

  • nonreflectingType (Literal[PLANE, ELLIPTICAL, IMPROVED, SPHERICAL, PROLATE, CIRCULAR, NONREFLECTING], default: PLANE) – 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 (float, default: 1) – 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 (float, default: 1) – 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 (float, default: 0) – 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 (tuple, default: ()) – 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 (tuple, default: ()) – 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.

Return type:

AcousticImpedance

Member Details:

centerCoordinates: tuple = ()[source]

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.

createStepName: str[source]

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

definition: SymbolicConstant = 'TABULAR'[source]

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

directionCosine: tuple = ()[source]

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.

eccentricity: float = 0[source]

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.

interactionProperty: str = ''[source]

A String specifying the AcousticImpedanceProp object associated with this interaction.

nonreflectingType: SymbolicConstant = 'PLANE'[source]

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: float = 1[source]

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: float = 1[source]

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.

setValues(definition=abaqusConstants.TABULAR, interactionProperty='', nonreflectingType=abaqusConstants.PLANE, radius=1, semimajorAxis=1, eccentricity=0, centerCoordinates=(), directionCosine=())[source]

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

Parameters:
  • definition (Literal[TABULAR, NONREFLECTING], default: TABULAR) – A SymbolicConstant specifying the type of acoustic impedance to be defined. Possible values are TABULAR and NONREFLECTING. The default value is TABULAR.

  • interactionProperty (str, default: '') – A String specifying the AcousticImpedanceProp object associated with this interaction.

  • nonreflectingType (Literal[PLANE, ELLIPTICAL, IMPROVED, SPHERICAL, PROLATE, CIRCULAR, NONREFLECTING], default: PLANE) – 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 (float, default: 1) – 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 (float, default: 1) – 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 (float, default: 0) – 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 (tuple, default: ()) – 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 (tuple, default: ()) – 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.

setValuesInStep(stepName, interactionProperty='')[source]

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

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

  • interactionProperty (str, default: '') – A String specifying the AcousticImpedanceProp object associated with this interaction.

surface: Region[source]

A Region object specifying the acoustic boundary surface.

class Interaction[source]

Bases: object

The Interaction object is the abstract base type for other Interaction objects. The Interaction object has no explicit constructor. Each of the Interaction objects has the.

following methods: - deactivate - move - reset - resume - suppress - delete The methods are described below.

Note

This object can be accessed by:

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

Member Details:

deactivate(stepName)[source]

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

Parameters:

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

delete(indices)[source]

This method allows you to delete existing interactions.

Parameters:

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

move(fromStepName, toStepName)[source]

This method moves an interaction from one step to another.

Parameters:
  • fromStepName (str) – A String specifying the name of the step from which to move the interaction.

  • toStepName (str) – A String specifying the name of the step to which to move the interaction.

name: str = ''[source]

A String specifying the repository key.

reset(stepName)[source]

This method reactivates an interaction that was deactivated previously. The reset method is available during the step in which the interaction was deactivated originally.

Parameters:

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

resume()[source]

This method resumes an interaction that was previously suppressed.

suppress()[source]

This method suppresses an interaction.

class AcousticImpedanceProp(name, tableType, table, frequencyDependency=0)[source]

Bases: ContactProperty

The AcousticImpedanceProp object is an interaction property that defines the properties referred to by an AcousticImpedance object. The AcousticImpedanceProp object is derived from the InteractionProperty object.

Note

This object can be accessed by:

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

The corresponding analysis keywords are:

  • IMPEDANCE PROPERTY

This method creates an AcousticImpedanceProp object.

Note

This function can be accessed by:

mdb.models[name].AcousticImpedanceProp
Parameters:
  • name (str) – A String specifying the interaction property repository key.

  • tableType (Literal[ADMITTANCE, IMPEDANCE]) – A SymbolicConstant specifying the type of tabular data to be defined. Possible values are IMPEDANCE and ADMITTANCE.

  • table (tuple) – 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 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether the table data depend on frequency. The default value is OFF.

Returns:

An AcousticImpedanceProp object.

Return type:

AcousticImpedanceProp

Member Details:

frequencyDependency: Union[AbaqusBoolean, bool] = 0[source]

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

name: str[source]

A String specifying the interaction property repository key.

setValues(frequencyDependency=0)[source]

This method modifies the AcousticImpedanceProp object.

Parameters:

frequencyDependency (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether the table data depend on frequency. The default value is OFF.

table: tuple[source]

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.

tableType: SymbolicConstant[source]

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

class ContactProperty(name)[source]

Bases: InteractionProperty

The ContactProperty object defines a contact interaction property. The ContactProperty object is derived from the InteractionProperty object.

Note

This object can be accessed by:

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

The corresponding analysis keywords are:

  • SURFACE INTERACTION

This method creates a ContactProperty object.

Note

This function can be accessed by:

mdb.models[name].ContactProperty
Parameters:

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

Returns:

A ContactProperty object.

Return type:

ContactProperty

Member Details:

CohesiveBehavior(repeatedContacts=0, eligibility=abaqusConstants.ALL_NODES, defaultPenalties=1, coupling=abaqusConstants.UNCOUPLED, temperatureDependency=0, dependencies=0, table=())[source]

This method creates a CohesiveBehavior object.

Note

This function can be accessed by:

mdb.models[name].ContactProperty
Parameters:
  • repeatedContacts (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to enforce cohesive behavior for recurrent contacts at nodes on the secondary surface subsequent to ultimate failure. The default value is OFF.

  • eligibility (Literal[INITIAL_NODES, SPECIFIED, ALL_NODES], default: ALL_NODES) – A SymbolicConstant specifying the eligible secondary nodes. Possible values are ALL_NODES, INITIAL_NODES, and SPECIFIED. The default value is ALL_NODES.

  • defaultPenalties (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to use the default contact penalties. The default value is ON.

  • coupling (Literal[COUPLED, UNCOUPLED], default: UNCOUPLED) – A SymbolicConstant specifying whether the traction-separation coefficients are coupled or uncoupled. This argument is valid only for defaultPenalties = OFF. Possible values are UNCOUPLED and COUPLED. The default value is UNCOUPLED.

  • temperatureDependency (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether the coefficient data depend on temperature. This argument is valid only for defaultPenalties = OFF. The default value is OFF.

  • dependencies (int, default: 0) – An Int specifying the number of field variables. This argument is valid only for defaultPenalties = OFF. The default value is 0.

  • table (tuple, default: ()) – A sequence of sequences of Floats specifying the traction-separation coefficients. The items in the table data are described below. This argument is valid only for defaultPenalties = OFF.

Returns:

A CohesiveBehavior object.

Return type:

CohesiveBehavior

Damage(initTable, criterion=abaqusConstants.MAX_STRESS, initTempDep=0, initDependencies=0, useEvolution=0, evolutionType=abaqusConstants.DISPLACEMENT, softening=abaqusConstants.LINEAR, useMixedMode=0, mixedModeType=abaqusConstants.TABULAR, modeMixRatio=abaqusConstants.ENERGY, exponent=None, evolTempDep=0, evolDependencies=0, evolTable=(), useStabilization=0, viscosityCoef=None)[source]

This method creates a ContactDamage object.

Note

This function can be accessed by:

mdb.models[name].ContactProperty
Parameters:
  • initTable (tuple) – A sequence of sequences of Floats specifying the values defining the damage initiation. The items in the table data are described below.

  • criterion (Literal[MAX_STRESS, QUAD_SEPARATION, MAX_SEPARATION, QUAD_TRACTION], default: MAX_STRESS) – A SymbolicConstant specifying the type of data used to define the initiation of damage. Possible values are MAX_STRESS, MAX_SEPARATION, QUAD_TRACTION, and QUAD_SEPARATION. The default value is MAX_STRESS.

  • initTempDep (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether the initiation data depend on temperature. The default value is OFF.

  • initDependencies (int, default: 0) – An Int specifying the number of initiation data field variables. The default value is 0.

  • useEvolution (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether evolution data will be defined. The default value is OFF.

  • evolutionType (Literal[ENERGY, DISPLACEMENT], default: DISPLACEMENT) – A SymbolicConstant specifying the type of data used to define the evolution of damage. This argument is valid only when useEvolution = ON. Possible values are DISPLACEMENT and ENERGY. The default value is DISPLACEMENT.

  • softening (Literal[EXPONENTIAL, LINEAR, TABULAR, DISPLACEMENT], default: LINEAR) – A SymbolicConstant specifying the type of data used to define the evolution softening response. This argument is valid only when useEvolution = ON. The TABULAR value can be used only when evolutionType = DISPLACEMENT. Possible values are LINEAR, EXPONENTIAL, and TABULAR. The default value is LINEAR.

  • useMixedMode (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether evolution data be defined using dependent behavior modes. This argument is valid only when useEvolution = ON. The default value is OFF.

  • mixedModeType (Literal[BK, ENERGY, POWER_LAW, TABULAR], default: TABULAR) – A SymbolicConstant specifying the mode mix fracture criterion. This argument is valid only when useEvolution = ON and when useMixedMode = ON. The POWER_LAW and BK values can be used only when evolutionType = ENERGY. Possible values are TABULAR, POWER_LAW, and BK. The default value is TABULAR.

  • modeMixRatio (Literal[TRACTION, ENERGY, TABULAR], default: ENERGY) – A SymbolicConstant specifying the mode mix ratio type. This argument is valid only when useEvolution = ON and when useMixedMode = ON. The TRACTION value can be used only when mixedModeType = TABULAR. Possible values are ENERGY and TRACTION. The default value is ENERGY.

  • exponent (Optional[float], default: None) – None or a Float specifying the exponent in the power-law or BK criterion that defines the variation of fracture energy with mode mix. This argument is valid only when useEvolution = ON and when mixedModeType = POWER_LAW or BK. The default value is None.

  • evolTempDep (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether the evolution data depend on temperature. This argument is valid only when useEvolution = ON. The default value is OFF.

  • evolDependencies (int, default: 0) – An Int specifying the number of evolution data field variables. This argument is valid only when useEvolution = ON. The default value is 0.

  • evolTable (tuple, default: ()) – A sequence of sequences of Floats specifying the values defining the damage evolution. The items in the table data are described below. This argument is valid only when useEvolution = ON.

  • useStabilization (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether stabilization data will be defined. This argument is valid only when useEvolution = ON. The default value is OFF.

  • viscosityCoef (Optional[float], default: None) – None or a Float specifying the viscosity coefficient. This argument is valid only when useStabilization = ON. The default value is None.

Returns:

A ContactDamage object.

Return type:

ContactDamage

Damping(definition=abaqusConstants.DAMPING_COEFFICIENT, tangentFraction=abaqusConstants.DEFAULT, clearanceDependence=abaqusConstants.STEP, table=())[source]

This method creates a ContactDamping object.

Note

This function can be accessed by:

mdb.models[name].ContactProperty
Parameters:
  • definition (Literal[DAMPING_COEFFICIENT, CRITICAL_DAMPING_FRACTION], default: DAMPING_COEFFICIENT) – A SymbolicConstant specifying the method used to define the damping. Possible values are DAMPING_COEFFICIENT and CRITICAL_DAMPING_FRACTION. The default value is DAMPING_COEFFICIENT.

  • tangentFraction (Union[Literal[DEFAULT], float], default: DEFAULT) – The SymbolicConstant DEFAULT or a Float specifying the tangential damping coefficient divided by the normal damping coefficient. The default value is DEFAULT.

  • clearanceDependence (Literal[STEP, CRITICAL_DAMPING_FRACTION, BILINEAR, LINEAR], default: STEP) – A SymbolicConstant specifying the variation of the damping coefficient or fraction with respect to clearance. Possible values are STEP, LINEAR, and BILINEAR. The default value is STEP.If definition = CRITICAL_DAMPING_FRACTION, the only possible value is STEP.

  • table (tuple, default: ()) – A sequence of pairs of Floats specifying the damping properties. The items in the table data are described below.

Returns:

A ContactDamping object.

Return type:

ContactDamping

ElectricalConductance(definition=abaqusConstants.TABULAR, clearanceDependency=1, pressureDependency=0, temperatureDependencyC=0, dependenciesC=0, clearanceDepTable=(), temperatureDependencyP=0, dependenciesP=0, pressureDepTable=())[source]

This method creates a GapElectricalConductance object.

Note

This function can be accessed by:

mdb.models[name].ContactProperty
Parameters:
  • definition (Literal[USER_DEFINED, TABULAR], default: TABULAR) – A SymbolicConstant specifying how the electrical conductance is defined. Possible values are TABULAR and USER_DEFINED. The default value is TABULAR.

  • clearanceDependency (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to use clearance-dependent data. The default value is ON.

  • pressureDependency (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to use pressure-dependent data. The default value is OFF.

  • temperatureDependencyC (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to use temperature-dependent data with clearance dependency. The default value is OFF.

  • dependenciesC (int, default: 0) – An Int specifying the number of field variables to use with clearance dependency. The default value is 0.

  • clearanceDepTable (tuple, default: ()) – A sequence of sequences of Floats specifying clearance dependency data. The items in the table data are described below.

  • temperatureDependencyP (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to use temperature-dependent data with pressure dependency. The default value is OFF.

  • dependenciesP (int, default: 0) – An Int specifying the number of field variables to use with pressure dependency. The default value is 0.

  • pressureDepTable (tuple, default: ()) – A sequence of sequences of Floats specifying pressure dependency data. The items in the table data are described below.

Returns:

A GapElectricalConductance object.

Return type:

GapElectricalConductance

FractureCriterion(initTable, type=abaqusConstants.VCCT, mixedModeBehavior=abaqusConstants.BK, temperatureDependency=0, dependencies=0, tolerance=0, specifyUnstableCrackProp=0, unstableTolerance=abaqusConstants.DEFAULT)[source]

This method creates a FractureCriterion object.

Note

This function can be accessed by:

mdb.models[name].ContactProperty
Parameters:
  • initTable (tuple) – A sequence of sequences of Floats specifying the value defining the fracture criterion. The items in the table data are described below.

  • type (Literal[ENHANCED, VCCT], default: VCCT) – A SymbolicConstant specifying the type of data used to define the fracture criterion. Possible values are VCCT and ENHANCED VCCT. The default value is VCCT.

  • mixedModeBehavior (Literal[REEDER, BK, POWER], default: BK) – A SymbolicConstant specifying the mixed mode behavior type used to define fracture criterion. Possible values are BK, POWER, and REEDER. The default value is BK.

  • temperatureDependency (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether the fracture criterion data depend on temperature. The default value is OFF.

  • dependencies (int, default: 0) – An Int specifying the number of fracture criterion data field variables. The default value is 0.

  • tolerance (float, default: 0) – A Float specifying the tolerance for VCCT Enhanced VCCT type. The default value is 0.2.

  • specifyUnstableCrackProp (Union[SymbolicConstant, AbaqusBoolean, bool], default: 0) – A SymbolicConstant specifying whether to include unstable crack growth tolerance in fracture criterion. Possible values are ON and OFF. The default value is OFF.

  • unstableTolerance (Union[Literal[DEFAULT], float], default: DEFAULT) – The SymbolicConstant DEFAULT or a Float specifying the tolerance for unstable crack propagation. This parameter specified only if specifyUnstableCrackProp = ON. The default value is DEFAULT.

Returns:

A FractureCriterion object.

Return type:

FractureCriterion

GeometricProperties(contactArea=1, padThickness=None, trackingThickness=None, dependentVariables=0, numProperties=0, useUnsymmetricEqunProcedure=0, modelType=None)[source]

This method creates a GeometricProperties object.

Note

This function can be accessed by:

mdb.models[name].ContactProperty
Parameters:
  • contactArea (float, default: 1) – A Float specifying the out-of-plane thickness of the surface for a two-dimensional model or cross-sectional area for every node in the node-based surface. The default value is 1.0.

  • padThickness (Optional[float], default: None) – None or a Float specifying the thickness of an interfacial layer between the contacting surfaces. If padThickness = None, there is no interfacial layer. The default value is None.

  • trackingThickness (Optional[float], default: None) – None or a Float specifying the thickness that determines the contacting surfaces to be tracked. The input value for this parameter cannot be negative. An internal default value is used if a zero value is input or if the parameter is omitted.

  • dependentVariables (int, default: 0) – An Int specifying the number of state-dependent variables. The default value is 0. This argument is applicable only if modelType = MODELTYPE_USER or modelType = MODELTYPE_USER_INTERACTION.

  • numProperties (int, default: 0) – An Int specifying the number of property values required. The default value is 0. This argument is applicable only if modelType = MODELTYPE_USER or modelType = MODELTYPE_USER_INTERACTION.

  • useUnsymmetricEqunProcedure (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to use unsymmetric equation solution procedures. This argument is applicable only if modelType = MODELTYPE_USER or modelType = MODELTYPE_USER_INTERACTION.

  • modelType (Optional[SymbolicConstant], default: None) – A SymbolicConstant specifying the surface interaction model type.

Returns:

A GeometricProperties object.

Return type:

GeometricProperties

HeatGeneration(conversionFraction=1, secondaryFraction=0)[source]

This method creates a GapHeatGeneration object.

Note

This function can be accessed by:

mdb.models[name].ContactProperty
Parameters:
  • conversionFraction (float, default: 1) – A Float specifying the fraction of dissipated energy caused by friction or electric currents that is converted to heat. The default value is 1.0.

  • secondaryFraction (float, default: 0) –

    A Float specifying the fraction of converted heat distributed to the secondary surface. The default value is 0.5.

    Changed in version 2022: The argument slaveFraction was renamed to secondaryFraction.

Returns:

A GapHeatGeneration object.

Return type:

GapHeatGeneration

NormalBehavior(contactStiffness=abaqusConstants.DEFAULT, pressureOverclosure=abaqusConstants.HARD, allowSeparation=1, maxStiffness=None, table=(), constraintEnforcementMethod=abaqusConstants.DEFAULT, overclosureFactor=0, overclosureMeasure=0, contactStiffnessScaleFactor=1, initialStiffnessScaleFactor=1, clearanceAtZeroContactPressure=0, stiffnessBehavior=abaqusConstants.LINEAR, stiffnessRatio=0, upperQuadraticFactor=0, lowerQuadraticRatio=0)[source]

This method creates a NormalBehavior object.

Note

This function can be accessed by:

mdb.models[name].ContactProperty
Parameters:
  • contactStiffness (Union[Literal[AUGMENTED_LAGRANGE, PENALTY, DEFAULT, HARD, LINEAR], float], default: DEFAULT) – The SymbolicConstant DEFAULT or a Float specifying the contact stiffness. This argument is valid for pressureOverclosure = LINEAR. This argument is also valid for pressureOverclosure = HARD when constraintEnforcementMethod = AUGMENTED_LAGRANGE or PENALTY. A value of DEFAULT is valid only when the later conditions are met. A value of zero is equivalent to specifying DEFAULT. The default value is DEFAULT.

  • pressureOverclosure (Literal[EXPONENTIAL, TABULAR, HARD, LINEAR, SCALE_FACTOR], default: HARD) – A SymbolicConstant specifying the pressure-overclosure relationship to be used. Possible values are HARD, EXPONENTIAL, LINEAR, TABULAR, and SCALE_FACTOR. The default value is HARD.

  • allowSeparation (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to allow separation after contact. The default value is ON.

  • maxStiffness (Optional[float], default: None) – None or a Float specifying the maximum stiffness. If maxStiffness = None, there is no upper limit. The default value is None.

  • table (tuple, default: ()) – A sequence of sequences of Floats specifying the normal behavior properties. This argument is valid only for pressureOverclosure = EXPONENTIAL or TABULAR. The items in the table data are described below.

  • constraintEnforcementMethod (Literal[AUGMENTED_LAGRANGE, DEFAULT, DIRECT, PENALTY], default: DEFAULT) – A SymbolicConstant specifying the method for enforcement of the contact constraint. Possible values are DEFAULT, AUGMENTED_LAGRANGE, PENALTY, and DIRECT. The default value is DEFAULT.

  • overclosureFactor (float, default: 0) – A Float specifying the overclosure measure (used to delineate the segments of the pressure-overclosure curve) as a percentage of the minimum element size in the contact region. The default value is 0.0.

  • overclosureMeasure (float, default: 0) – A Float specifying the overclosure measure (used to delineate the segments of the pressure-overclosure curve) directly. The default value is 0.0.

  • contactStiffnessScaleFactor (float, default: 1) – A Float specifying scale factor for the penalty stiffness or the geometric scaling of the “base” stiffness. The default value is 1.0.

  • initialStiffnessScaleFactor (float, default: 1) – A Float specifying an additional scale factor for the “base” default contact stiffness. The default value is 1.0.

  • clearanceAtZeroContactPressure (float, default: 0) – A Float specifying the clearance at which the contact pressure is zero. The default value is 0.0.

  • stiffnessBehavior (Literal[PENALTY, NONLINEAR, LINEAR], default: LINEAR) – A SymbolicConstant specifying the type of penalty stiffness to be defined. This argument is valid only when constraintEnforcementMethod = PENALTY. Possible values are LINEAR and NONLINEAR. The default value is LINEAR.

  • stiffnessRatio (float, default: 0) – A Float specifying the ratio of the initial stiffness divided by the final stiffness. This argument is valid only when stiffnessBehavior = NONLINEAR. Possible values are 0 ≤ stiffnessRatio < 1. The default value is 0.01.

  • upperQuadraticFactor (float, default: 0) – A Float specifying the ratio of the overclosure at the maximum stiffness divided by the characteristic facet length. This argument is valid only when stiffnessBehavior = NONLINEAR. The default value is 0.03.

  • lowerQuadraticRatio (float, default: 0) – A Float specifying the ratio of the overclosure at the initial stiffness divided by the overclosure at the maximum stiffness, both relative to the clearance at which the contact pressure is zero. This argument is valid only when stiffnessBehavior = NONLINEAR. Possible values are 0 ≤ stiffnessRatio < 1. The default value is 0.33333.

Returns:

A NormalBehavior object.

Return type:

NormalBehavior

Radiation(mainEmissivity, secondaryEmissivity, table)[source]

This method creates a Radiation object.

Note

This function can be accessed by:

mdb.models[name].ContactProperty
Parameters:
  • mainEmissivity (float) –

    A Float specifying the emissivity of the main surface.

    Changed in version 2022: The argument masterEmissivity was renamed to mainEmissivity.

  • secondaryEmissivity (float) –

    A Float specifying the emissivity of the secondary surface.

    Changed in version 2022: The argument slaveEmissivity was renamed to secondaryEmissivity.

  • table (tuple) – A sequence of sequences of Floats specifying the following:Effective viewfactor, FF.Gap clearance, dd.

Returns:

A Radiation object.

Return type:

Radiation

TangentialBehavior(formulation=abaqusConstants.FRICTIONLESS, directionality=abaqusConstants.ISOTROPIC, slipRateDependency=0, pressureDependency=0, temperatureDependency=0, dependencies=0, exponentialDecayDefinition=abaqusConstants.COEFFICIENTS, table=(), shearStressLimit=None, maximumElasticSlip=abaqusConstants.FRACTION, fraction=0, absoluteDistance=0, elasticSlipStiffness=None, nStateDependentVars=0, useProperties=0)[source]

This method creates a ContactTangentialBehavior object.

Note

This function can be accessed by:

mdb.models[name].ContactProperty
Parameters:
  • formulation (Literal[FRICTIONLESS, PENALTY, ROUGH, EXPONENTIAL_DECAY, USER_DEFINED, LAGRANGE], default: FRICTIONLESS) – A SymbolicConstant specifying the friction formulation. Possible values are FRICTIONLESS, PENALTY, EXPONENTIAL_DECAY, ROUGH, LAGRANGE, and USER_DEFINED. The default value is FRICTIONLESS.

  • directionality (Literal[ANISOTROPIC, ISOTROPIC], default: ISOTROPIC) – A SymbolicConstant specifying the directionality of the friction. Possible values are ISOTROPIC and ANISOTROPIC. The default value is ISOTROPIC.

  • slipRateDependency (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether the data depend on slip rate. The default value is OFF.

  • pressureDependency (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether the data depend on contact pressure. The default value is OFF.

  • temperatureDependency (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether the data depend on temperature. The default value is OFF.

  • dependencies (int, default: 0) – An Int specifying the number of field variables. The default value is 0.

  • exponentialDecayDefinition (Literal[TEST_DATA, COEFFICIENTS], default: COEFFICIENTS) – A SymbolicConstant specifying the exponential decay definition. Possible values are COEFFICIENTS and TEST_DATA. The default value is COEFFICIENTS.

  • table (tuple, default: ()) – A sequence of sequences of Floats specifying tangential behavior. The items in the table data are described below.

  • shearStressLimit (Optional[float], default: None) – None or a Float specifying the shear stress limit. If shearStressLimit = None, there is no upper limit. The default value is None.

  • maximumElasticSlip (Literal[FRACTION, ABSOLUTE_DISTANCE], default: FRACTION) – A SymbolicConstant specifying what the maximum elastic slip will be. Possible values are FRACTION and ABSOLUTE_DISTANCE. The default value is FRACTION.

  • fraction (float, default: 0) – A Float specifying the fraction of a characteristic surface dimension. The default value is 0.0.

  • absoluteDistance (float, default: 0) – A Float specifying the absolute distance. The default value is 0.0.

  • elasticSlipStiffness (Optional[float], default: None) – None or a Float specifying the elastic slip stiffness. If elasticSlipStiffness = None, there is no upper limit. The default value is None.

  • nStateDependentVars (int, default: 0) – An Int specifying the number of state-dependent variables. The default value is 0.

  • useProperties (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether property values will be used. The default value is OFF.

Returns:

A ContactTangentialBehavior object.

Return type:

ContactTangentialBehavior

ThermalConductance(definition=abaqusConstants.TABULAR, clearanceDependency=1, pressureDependency=0, temperatureDependencyC=0, massFlowRateDependencyC=0, dependenciesC=0, clearanceDepTable=(), temperatureDependencyP=0, massFlowRateDependencyP=0, dependenciesP=0, pressureDepTable=())[source]

This method creates a ThermalConductance object.

Note

This function can be accessed by:

mdb.models[name].ContactProperty
Parameters:
  • definition (Literal[USER_DEFINED, TABULAR], default: TABULAR) – A SymbolicConstant specifying how the thermal conductance is defined. Possible values are TABULAR and USER_DEFINED. The default value is TABULAR.

  • clearanceDependency (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to use clearance-dependent data. The default value is ON.

  • pressureDependency (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to use pressure-dependent data. The default value is OFF.

  • temperatureDependencyC (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to use temperature-dependent data with clearance dependency. The default value is OFF.

  • massFlowRateDependencyC (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to use mass-flow-rate-dependent data with clearance dependency. The default value is OFF.

  • dependenciesC (int, default: 0) – An Int specifying the number of field variables to use with clearance dependency. The default value is 0.

  • clearanceDepTable (tuple, default: ()) – A sequence of sequences of Floats specifying clearance dependency data. The items in the table data are described below.

  • temperatureDependencyP (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to use temperature-dependent data with pressure dependency. The default value is OFF.

  • massFlowRateDependencyP (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to use mass-flow-rate-dependent data with pressure dependency. The default value is OFF.

  • dependenciesP (int, default: 0) – An Int specifying the number of field variables to use with pressure dependency. The default value is 0.

  • pressureDepTable (tuple, default: ()) – A sequence of sequences of Floats specifying pressure dependency data. The items in the table data are described below.

Returns:

A ThermalConductance object.

Return type:

ThermalConductance

cohesiveBehavior: CohesiveBehavior = <abaqus.Interaction.CohesiveBehavior.CohesiveBehavior object>[source]

A CohesiveBehavior object.

damage: ContactDamage = <abaqus.Interaction.ContactDamage.ContactDamage object>[source]

A ContactDamage object.

damping: ContactDamping = <abaqus.Interaction.ContactDamping.ContactDamping object>[source]

A ContactDamping object.

electricalConductance: GapElectricalConductance = <abaqus.Interaction.GapElectricalConductance.GapElectricalConductance object>[source]

A GapElectricalConductance object.

fractureCriterion: FractureCriterion = <abaqus.Interaction.FractureCriterion.FractureCriterion object>[source]

A FractureCriterion object.

geometricProperties: GeometricProperties = <abaqus.Interaction.GeometricProperties.GeometricProperties object>[source]

A GeometricProperties object.

heatGeneration: GapHeatGeneration = <abaqus.Interaction.GapHeatGeneration.GapHeatGeneration object>[source]

A GapHeatGeneration object.

normalBehavior: NormalBehavior = <abaqus.Interaction.NormalBehavior.NormalBehavior object>[source]

A NormalBehavior object.

radiation: Optional[Radiation] = None[source]

A Radiation object.

tangentialBehavior: ContactTangentialBehavior = <abaqus.Interaction.ContactTangentialBehavior.ContactTangentialBehavior object>[source]

A ContactTangentialBehavior object.

thermalConductance: ThermalConductance = <abaqus.Interaction.ThermalConductance.ThermalConductance object>[source]

A ThermalConductance object.

class AcousticImpedanceState[source]

Bases: InteractionState

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

Note

This object can be accessed by:

import interaction
mdb.models[name].steps[name].interactionStates[name]

The corresponding analysis keywords are:

  • SIMPEDANCE

Member Details:

interactionProperty: str = ''[source]

A String specifying the name of the AcousticImpedanceProp object associated with this interaction.

interactionPropertyState: SymbolicConstant[source]

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

status: SymbolicConstant[source]

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

  • NOT_YET_ACTIVE

  • CREATED

  • PROPAGATED

  • MODIFIED

  • DEACTIVATED

  • NO_LONGER_ACTIVE

  • TYPE_NOT_APPLICABLE

  • INSTANCE_NOT_APPLICABLE

  • BUILT_INTO_BASE_STATE

class InteractionState[source]

Bases: object

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

Note

This object can be accessed by:

import interaction
mdb.models[name].steps[name].interactionStates[name]

Member Details:

status: SymbolicConstant[source]

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

  • NOT_YET_ACTIVE

  • CREATED

  • PROPAGATED

  • MODIFIED

  • DEACTIVATED

  • NO_LONGER_ACTIVE

  • TYPE_NOT_APPLICABLE

  • INSTANCE_NOT_APPLICABLE

  • BUILT_INTO_BASE_STATE

class ActuatorSensor(name, createStepName, point, interactionProperty, noCoordComponents, unsymm, noSolutionDepVar, userSubUel, dof, solutionDepVars)[source]

Bases: Interaction

The ActuatorSensor object defines a single point actuator where the actuation is determined by a user subroutine (UEL). The subroutine senses the data at the same point as the actuator. The ActuatorSensor object is derived from the Interaction object.

Note

This object can be accessed by:

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

The corresponding analysis keywords are:

  • ELEMENT

  • USER ELEMENT

  • INITIAL CONDITIONS

This method creates an ActuatorSensor object.

Note

This function can be accessed by:

mdb.models[name].ActuatorSensor
Parameters:
  • name (str) – A String specifying the repository key.

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

  • point (Region) – A Region object specifying the point at which the constraint is applied.

  • interactionProperty (str) – A String specifying the ActuatorSensorProp object associated with this interaction.

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

  • unsymm (Union[AbaqusBoolean, bool]) – A Boolean specifying whether the element matrices are symmetric (ON) or unsymmetric (OFF). The default value is OFF.

  • noSolutionDepVar (int) – An Int specifying the number of solution-dependent variables. The default value is 0.

  • userSubUel (str) – A String specifying the name of the user subroutine (UEL) that defines the user element.

  • dof (str) – A String specifying the degrees of freedom, separated by commas.

  • solutionDepVars (tuple) – A sequence of Floats specifying the initial values of the solution-dependent variables.

Returns:

An ActuatorSensor object.

Return type:

ActuatorSensor

Member Details:

createStepName: str[source]

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

dof: str[source]

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

interactionProperty: str[source]

A String specifying the ActuatorSensorProp object associated with this interaction.

noCoordComponents: int[source]

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

noSolutionDepVar: int[source]

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

point: Region[source]

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

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

This method modifies the ActuatorSensor object.

solutionDepVars: tuple[source]

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

unsymm: Union[AbaqusBoolean, bool][source]

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

userSubUel: str[source]

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

class ActuatorSensorProp(name, realProperties=(), integerProperties=())[source]

Bases: ContactProperty

The ActuatorSensorProp object is an interaction property that defines the properties referred to by an ActuatorSensor object. The ActuatorSensorProp object is derived from the InteractionProperty object.

Note

This object can be accessed by:

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

The corresponding analysis keywords are:

  • UEL PROPERTY

This method creates an ActuatorSensorProp object.

Note

This function can be accessed by:

mdb.models[name].ActuatorSensorProp
Parameters:
  • name (str) – A String specifying the interaction property repository key.

  • realProperties (tuple, default: ()) – A sequence of Floats specifying the PROPS array used by user subroutine UEL. The default value is an empty sequence.

  • integerProperties (tuple, default: ()) – A sequence of Ints specifying the JPROPS array used by user subroutine UEL. The default value is an empty sequence.

Returns:

An ActuatorSensorProp object.

Return type:

ActuatorSensorProp

Member Details:

integerProperties: tuple = ()[source]

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

name: str[source]

A String specifying the interaction property repository key.

realProperties: tuple = ()[source]

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

setValues(realProperties=(), integerProperties=())[source]

This method modifies the ActuatorSensorProp object.

Parameters:
  • realProperties (tuple, default: ()) – A sequence of Floats specifying the PROPS array used by user subroutine UEL. The default value is an empty sequence.

  • integerProperties (tuple, default: ()) – A sequence of Ints specifying the JPROPS array used by user subroutine UEL. The default value is an empty sequence.

class ActuatorSensorState[source]

Bases: InteractionState

The ActuatorSensorState object stores the propagating data of an actuator sensor in a step. One instance of this object is created internally by the ActuatorSensor object for each step. The instance is also deleted internally by the ActuatorSensor object. The ActuatorSensorState object has no constructor, methods, or members. The ActuatorSensorState object is derived from the InteractionState object.

Note

This object can be accessed by:

import interaction
mdb.models[name].steps[name].interactionStates[name]

Member Details:

status: SymbolicConstant[source]

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

  • NOT_YET_ACTIVE

  • CREATED

  • PROPAGATED

  • MODIFIED

  • DEACTIVATED

  • NO_LONGER_ACTIVE

  • TYPE_NOT_APPLICABLE

  • INSTANCE_NOT_APPLICABLE

  • BUILT_INTO_BASE_STATE

class CavityRadiation(name, createStepName, surfaces, surfaceEmissivities, ambientTemp=None, blocking=abaqusConstants.BLOCKING_ALL, blockingSurfaces=None, rangeOfView=None, surfaceReflection=1, viewfactorAccurTol=0, minInfinitesimalRatio=64, numPointsPerEdge=3, minLumpedAreaDS=5, cyclicSymmetry=0, cyclicImages=2, cyclicRotPt=None, cyclicRotEndPt=None, cyclicSymPt=None, periodicSymmetries=0, periodicImages_1=2, periodicImages_2=2, periodicImages_3=2, periodicSymAxis_1='', periodicSymAxis_2='', periodicSymPlane_1='', periodicSymPlane_2='', periodicSymPlane_3='', periodicDistance_1=(), periodicDistance_2=(), periodicDistance_3=(), periodicSymZ=None, periodicDistZ=None, reflectionSymmetries=0, reflectionSymAxis_1='', reflectionSymAxis_2='', reflectionSymPlane_1='', reflectionSymPlane_2='', reflectionSymPlane_3='', reflectionSymZ=None)[source]

Bases: Interaction

The CavityRadiation object defines cavities for thermal radiation heat transfer and controls the calculation of viewfactors. The CavityRadiation object is derived from the Interaction object.

Note

This object can be accessed by:

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

The corresponding analysis keywords are:

  • CAVITY DEFINITION

  • CYCLIC

  • EMISSIVITY

  • PERIODIC

  • RADIATION SYMMETRY

  • RADIATION VIEWFACTOR

  • REFLECTION

This method creates a CavityRadiation object.

Note

This function can be accessed by:

mdb.models[name].CavityRadiation
Parameters:
  • name (str) – A String specifying the repository key.

  • createStepName (str) – A String specifying the name of the step in which the cavity radiation interaction should be created.

  • surfaces (List[Region]) – A RegionArray object specifying the surfaces for which radiation viewfactor control is being specified.

  • surfaceEmissivities (tuple) – 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 (Optional[float], default: None) – 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 (Literal[NO_BLOCKING, BLOCKING_ALL, PARTIAL_BLOCKING], default: BLOCKING_ALL) – 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 (Optional[List[Region]], default: None) – A RegionArray object specifying the surfaces that provide blocking inside the cavity. This argument applies only when blocking = PARTIAL_BLOCKING.

  • rangeOfView (Optional[float], default: None) – 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 (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether heat reflections are to be included in the cavity radiation calculations. The default value is ON.

  • viewfactorAccurTol (float, default: 0) – A Float specifying the acceptable tolerance for the viewfactor calculations. The default value is 0.05.

  • minInfinitesimalRatio (float, default: 64) – 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 (int, default: 3) – 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 (float, default: 5) – 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 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether cyclic symmetry will be applied. This argument cannot be specified for axisymmetric models. The default value is OFF.

  • cyclicImages (int, default: 2) – 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 (Optional[ModelDot], default: None) – A ModelDot object specifying the rotation axis point. This argument applies only when cyclicSymmetry = ON.

  • cyclicRotEndPt (Optional[ModelDot], default: None) – A ModelDot object specifying the rotation axis end point. This argument applies only for three-dimensional models, and only when cyclicSymmetry = ON.

  • cyclicSymPt (Optional[ModelDot], default: None) – A ModelDot object specifying the symmetry axis end point. This argument applies only when cyclicSymmetry = ON.

  • periodicSymmetries (int, default: 0) – An Int specifying the number of periodic symmetries that will be applied. The default value is 0.

  • periodicImages_1 (int, default: 2) – 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 (int, default: 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 (int, default: 2) – 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 (str, default: '') – 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 (str, default: '') – 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 (str, default: '') – 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 (str, default: '') – 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 (str, default: '') – 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 (tuple, default: ()) – 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 (tuple, default: ()) – 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 (tuple, default: ()) – 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 (Optional[float], default: None) – 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 (Optional[float], default: None) – 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 (int, default: 0) – An Int specifying the number of reflection symmetries will be applied. The default value is 0.

  • reflectionSymAxis_1 (str, default: '') – 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 (str, default: '') – 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 (str, default: '') – 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 (str, default: '') – 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 (str, default: '') – 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 (Optional[float], default: None) – 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.

Return type:

CavityRadiation

Member Details:

ambientTemp: Optional[float] = None[source]

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

createStepName: str = ''[source]

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

cyclicImages: int = 2[source]

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.

cyclicRotEndPt: ModelDot = <abaqus.BasicGeometry.ModelDot.ModelDot object>[source]

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

cyclicRotPt: ModelDot = <abaqus.BasicGeometry.ModelDot.ModelDot object>[source]

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

cyclicSymPt: ModelDot = <abaqus.BasicGeometry.ModelDot.ModelDot object>[source]

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

cyclicSymmetry: Union[AbaqusBoolean, bool] = 0[source]

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

minInfinitesimalRatio: float = 64[source]

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.

minLumpedAreaDS: float = 5[source]

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.

name: str = ''[source]

A String specifying the repository key.

numPointsPerEdge: int = 3[source]

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.

periodicDistZ: Optional[float] = None[source]

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.

periodicDistance_1: tuple = ()[source]

A tuple of tuples 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: tuple = ()[source]

A tuple of tuples 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: tuple = ()[source]

A tuple of tuples 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.

periodicImages_1: int = 2[source]

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: int = 2[source]

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: int = 2[source]

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.

periodicSymZ: Optional[float] = None[source]

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.

periodicSymmetries: int = 0[source]

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

reflectionSymZ: Optional[float] = None[source]

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.

reflectionSymmetries: int = 0[source]

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

setValues(surfaceEmissivities=(), ambientTemp=None, blocking=abaqusConstants.BLOCKING_ALL, blockingSurfaces=None, rangeOfView=None, surfaceReflection=1, viewfactorAccurTol=0, minInfinitesimalRatio=64, numPointsPerEdge=3, minLumpedAreaDS=5, cyclicSymmetry=0, cyclicImages=2, cyclicRotPt=None, cyclicRotEndPt=None, cyclicSymPt=None, periodicSymmetries=0, periodicImages_1=2, periodicImages_2=2, periodicImages_3=2, periodicSymAxis_1='', periodicSymAxis_2='', periodicSymPlane_1='', periodicSymPlane_2='', periodicSymPlane_3='', periodicDistance_1=(), periodicDistance_2=(), periodicDistance_3=(), periodicSymZ=None, periodicDistZ=None, reflectionSymmetries=0, reflectionSymAxis_1='', reflectionSymAxis_2='', reflectionSymPlane_1='', reflectionSymPlane_2='', reflectionSymPlane_3='', reflectionSymZ=None)[source]

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

Parameters:
  • surfaceEmissivities (tuple, default: ()) – 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 (Optional[float], default: None) – 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 (Literal[NO_BLOCKING, BLOCKING_ALL, PARTIAL_BLOCKING], default: BLOCKING_ALL) – 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 (Optional[List[Region]], default: None) – A RegionArray object specifying the surfaces that provide blocking inside the cavity. This argument applies only when blocking = PARTIAL_BLOCKING.

  • rangeOfView (Optional[float], default: None) – 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 (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether heat reflections are to be included in the cavity radiation calculations. The default value is ON.

  • viewfactorAccurTol (float, default: 0) – A Float specifying the acceptable tolerance for the viewfactor calculations. The default value is 0.05.

  • minInfinitesimalRatio (float, default: 64) – 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 (int, default: 3) – 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 (float, default: 5) – 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 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether cyclic symmetry will be applied. This argument cannot be specified for axisymmetric models. The default value is OFF.

  • cyclicImages (int, default: 2) – 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 (Optional[ModelDot], default: None) – A ModelDot object specifying the rotation axis point. This argument applies only when cyclicSymmetry = ON.

  • cyclicRotEndPt (Optional[ModelDot], default: None) – A ModelDot object specifying the rotation axis end point. This argument applies only for three-dimensional models, and only when cyclicSymmetry = ON.

  • cyclicSymPt (Optional[ModelDot], default: None) – A ModelDot object specifying the symmetry axis end point. This argument applies only when cyclicSymmetry = ON.

  • periodicSymmetries (int, default: 0) – An Int specifying the number of periodic symmetries that will be applied. The default value is 0.

  • periodicImages_1 (int, default: 2) – 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 (int, default: 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 (int, default: 2) – 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 (str, default: '') – 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 (str, default: '') – 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 (str, default: '') – 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 (str, default: '') – 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 (str, default: '') – 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 (tuple, default: ()) – 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 (tuple, default: ()) – 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 (tuple, default: ()) – 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 (Optional[float], default: None) – 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 (Optional[float], default: None) – 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 (int, default: 0) – An Int specifying the number of reflection symmetries will be applied. The default value is 0.

  • reflectionSymAxis_1 (str, default: '') – 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 (str, default: '') – 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 (str, default: '') – 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 (str, default: '') – 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 (str, default: '') – 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 (Optional[float], default: None) – 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.

setValuesInStep(stepName, blocking=abaqusConstants.BLOCKING_ALL, blockingSurfaces=None, rangeOfView=None, surfaceReflection=1, viewfactorAccurTol=0)[source]

This method modifies the propagating data of an existing CavityRadiation object in the specified step.

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

  • blocking (Literal[NO_BLOCKING, BLOCKING_ALL, PARTIAL_BLOCKING], default: BLOCKING_ALL) – 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 (Optional[List[