Optimization

Optimization commands are used to perform topology, shape, or sizing optimization of your model given a set of objectives and a set of restrictions.

Create optimization tasks

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

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:

BeadTask(name[,Β abaqusSensitivities,Β ...])

This method creates a BeadTask object.

ShapeTask(name[,Β abaqusSensitivities,Β ...])

This method creates a ShapeTask object.

SizingTask(name[,Β abaqusSensitivities,Β ...])

This method creates a SizingTask object.

TopologyTask(name[,Β abaqusSensitivities,Β ...])

This method creates a TopologyTask 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:

BeadTask(name, abaqusSensitivities=True, algorithm=abaqusConstants.GENERAL_OPTIMIZATION, areBCRegionsFrozen=0, beadIter=1, beadMaxMembraneStress=0, beadMinStress=0, beadPerturbation=0, beadWidth=abaqusConstants.DEFAULT, curveSmooth=5, filterRadius=4, filterRadiusBy=abaqusConstants.VALUE, flipNormalDir=0, frozenBoundaryConditionRegion=abaqusConstants.MODEL, isSensCalcOnlyOnDesignNodes=0, modeTrackingRegion=abaqusConstants.MODEL, nodalMoveLimit=0, nodeSmooth=abaqusConstants.DEFAULT, nodeUpdateStrategy=abaqusConstants.CONSERVATIVE, numTrackedModes=5, updateShapeBasisVectors=abaqusConstants.EVERY_CYCLE, groupOperator=0)[source]

This method creates a BeadTask object.

Note

This function can be accessed by:

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

  • abaqusSensitivities (Union[AbaqusBoolean, bool], default: True) –

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

    New in version 2019: The abaqusSensitivities argument was added.

  • algorithm (Literal[CONDITION_BASED_OPTIMIZATION, GENERAL_OPTIMIZATION], default: GENERAL_OPTIMIZATION) – A SymbolicConstant specifying the optimization task algorithm. Possible values are GENERAL_OPTIMIZATION and CONDITION_BASED_OPTIMIZATION. The default value is GENERAL_OPTIMIZATION.

  • areBCRegionsFrozen (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to exclude elements with boundary conditions from the optimization. The default value is OFF.

  • beadIter (int, default: 1) – An int specifying the step size of the optimization. The default value is 1.

  • beadMaxMembraneStress (float, default: 0) – A float specifying maximum membrane/bending stress. The default value is 0.1.

  • beadMinStress (float, default: 0) – A float specifying minimum stress. The default value is 0.001.

  • beadPerturbation (float, default: 0) – A Sets perturbation size for finite differences. The default value is 0.0001.

  • beadWidth (Literal[DEFAULT], default: DEFAULT) – A SymbolicConstant specifying the Optimization product default or a float specifying the bead width. The default value is DEFAULT.

  • curveSmooth (float, default: 5) – A float specifying relative value to the middle element edge length such that normals in this area do not cross each other. The default value is 5.

  • filterRadius (float, default: 4) – A float specifying the filter radius. The default value is 4.

  • filterRadiusBy (Literal[VALUE, REFERENCE], default: VALUE) – A SymbolicConstant specifying the method used to define filter radius. Possible values are VALUE and REFERENCE. The default is VALUE.

  • flipNormalDir (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether the growth direction is along the normal direction of elements or opposite to the normal direction. The default value is OFF

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

  • isSensCalcOnlyOnDesignNodes (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to calculate the sensitivities only on design nodes or the whole model. The default value is ON

  • modeTrackingRegion (Literal[MODEL], default: MODEL) – The SymbolicConstant MODEL or a Region object specifying the region to use for mode tracking. The default value is MODEL.

  • nodalMoveLimit (float, default: 0) – A Float specifying the maximum change in nodal displacement per design cycle. The default value is 0.1.

  • nodeSmooth (Literal[DEFAULT], default: DEFAULT) – A SymbolicConstant specifying the Optimization product default or a float specifying the node smooth. The default value is DEFAULT.

  • nodeUpdateStrategy (Literal[AGGRESSIVE, NORMAL, CONSERVATIVE], default: CONSERVATIVE) – A SymbolicConstant specifying the strategy for how the nodal displacements are updated in the method of moving asymptotes. Possible values are NORMAL, CONSERVATIVE, and AGGRESSIVE. The default value is CONSERVATIVE.

  • numTrackedModes (int, default: 5) – An Int specifying the number of modes included in mode tracking. The default value is 5.

  • updateShapeBasisVectors (Literal[EVERY_CYCLE, FIRST_CYCLE], default: EVERY_CYCLE) – A SymbolicConstant specifying whether to update shape basis vectors in the first design cycle or every design cycle. Possible values are EVERY_CYCLE and FIRST_CYCLE. The default value is EVERY_CYCLE.

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

    A Boolean specifying whether the group in the design response will be evaluated using the existing algorithm or a new algorithm based on Abaqus sensitivities. The default value of False means that the existing algorithm will be used.

    New in version 2022: The groupOperator argument was added.

Returns:

A BeadTask object.

Return type:

BeadTask

ShapeTask(name, abaqusSensitivities=True, absoluteStepSizeControl=abaqusConstants.MINIMUM, activateDurability=1, additionalDurabilityFiles='', constrainedLaplacianConvergenceLevel=abaqusConstants.NORMAL, curvatureSmoothingEdgeLength=5, durabilityInputfile='', durabilitySolver=abaqusConstants.FE_SAFE, equalityConstraintTolerance=None, featureRecognitionAngle=30, filterExponent=1, filterMaxRadius=None, filterRadiusReduction=None, firstCycleDeletedVolumeTechnique=0, freezeBoundaryConditionRegions=0, frozenBoundaryConditionRegion=abaqusConstants.MODEL, geometricRestrictionEvaluationFrequency=abaqusConstants.LOW, growthScaleFactor=1, haltUponViolation=0, layerReferenceRegion=None, meshSmoothingRegionMethod=abaqusConstants.TASK_REGION_LAYERS, meshSmoothingStrategy=abaqusConstants.CONSTRAINED_LAPLACIAN, midsideInterpolation=abaqusConstants.POSITIONS, numFreeNodeLayers=0, numSmoothedElementLayers=None, presumeFeasibleBCRegionAtStart=1, quadMaxAngle=160, quadMinAngle=20, quadSkew=30, quadTaper=0, region=abaqusConstants.MODEL, reportPoorQualityElements=0, reportQualityViolation=0, shrinkScaleFactor=1, smoothingRegion=None, targetMeshQuality=abaqusConstants.LOW, tetAspectRatio=100, tetMaxAspect=8, tetMinAspect=0, tetSkew=100, triMaxAngle=140, triMinAngle=20, updateShapeBasisVectors=abaqusConstants.EVERY_CYCLE, groupOperator=0)[source]

This method creates a ShapeTask object.

Note

This function can be accessed by:

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

  • abaqusSensitivities (Union[AbaqusBoolean, bool], default: True) –

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

    New in version 2019: The abaqusSensitivities argument was added.

  • absoluteStepSizeControl (Literal[MINIMUM, AVERAGE], default: MINIMUM) – A SymbolicConstant specifying whether to control the permitted absolute step size by the average optimization displacement or minimum optimization displacement. Possible values are MINIMUM and AVERAGE. The default value is MINIMUM.

  • activateDurability (Union[AbaqusBoolean, bool], default: 1) – A boolean specifying whether or not the durability approach of optimization is turned on. The default value is ON.

  • additionalDurabilityFiles (str, default: '') – A String specifying the path of additional files pertaining to durability optimization. Only valid if the activateDurability argument is ON.

  • constrainedLaplacianConvergenceLevel (Literal[AGGRESSIVE, NORMAL, CONSERVATIVE], default: NORMAL) – A SymbolicConstant specifying the constrained Laplacian convergence level. Possible values are NORMAL, CONSERVATIVE, and AGGRESSIVE. The default value is NORMAL.

  • curvatureSmoothingEdgeLength (float, default: 5) – A Float specifying the edge length for the movement vector. The default value is 5.0.

  • durabilityInputfile (str, default: '') – A string specifying the path of the input file. Only valid if the activateDurability argument is ON and is a required argument in that case.

  • durabilitySolver (str, default: FE_SAFE) – A String specifying the type of solver for durability optimization. Possible values are: FE_SAFE, FEMFAT, FLANS, MSC_FATIGUE, FE_FATIGUE, DESIGN_LIFE, CUSTOM, FEMSITE. The default value is FE_SAFE. Only valid if the activateDurability argument is ON.

  • equalityConstraintTolerance (Optional[float], default: None) – A Float specifying the equality constraint tolerance. The default value is 10⁻³.

  • featureRecognitionAngle (float, default: 30) – A Float specifying the mesh smoothing feature recognition angle for edges and corners. The default value is 30.0.

  • filterExponent (float, default: 1) – A Float specifying the weight depending on the radius, used when filterMaxRadius is specified. The default value is 1.0.

  • filterMaxRadius (Optional[float], default: None) – None or a Float specifying the maximum influence radius for equivalent stress. The default value is None.

  • filterRadiusReduction (Optional[float], default: None) – None or a Float specifying the reduction of the radius depending on surface bending, used when filterMaxRadius is specified. The default value is None.

  • firstCycleDeletedVolumeTechnique (Union[Literal[PERCENTAGE, ABSOLUTE], AbaqusBoolean, bool], default: 0) – A SymbolicConstant specifying the method of specifying volume that can be removed immediately in the first design cycle. Possible values are OFF, PERCENTAGE, and ABSOLUTE. The default value is OFF.

  • freezeBoundaryConditionRegions (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to exclude nodes with boundary conditions from the optimization. The default value is OFF.

  • frozenBoundaryConditionRegion (Literal[MODEL], default: MODEL) – The SymbolicConstant MODEL or a Region object specifying the region in which to freeze boundary condition regions, or the SymbolicConstant MODEL, used with freezeBoundaryConditionRegions. The default value is MODEL.

  • geometricRestrictionEvaluationFrequency (Literal[LOW, MEDIUM, HIGH], default: LOW) – A SymbolicConstant specifying the frequency of evaluating geometric restrictions during mesh smoothing. Possible values are LOW, MEDIUM, and HIGH. The default value is LOW.

  • growthScaleFactor (float, default: 1) – A Float specifying the scale factor to apply to optimization displacements for nodes with growth. The default value is 1.0.

  • haltUponViolation (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to halt the optimization if quality criteria are not satisified. The default value is OFF.

  • layerReferenceRegion (Optional[str], default: None) – None or a Region object specifying the region specifying the first node layer for mesh smoothing, used when meshSmoothingRegionMethod is TASK_REGION_LAYERS. The default value is None.

  • meshSmoothingRegionMethod (Literal[NUMBER_OF_LAYERS, REGION, TASK_REGION_LAYERS], default: TASK_REGION_LAYERS) – A SymbolicConstant specifying the method used to determine the mesh smoothing region. The REGION value uses the smoothingRegion. The NUMBER_OF_LAYERS value uses the layerReferenceRegion. The TASK_REGION_LAYERS value will smooth six layers using the task region. Possible values are TASK_REGION_LAYERS, REGION, and NUMBER_OF_LAYERS. The default value is TASK_REGION_LAYERS.

  • meshSmoothingStrategy (Literal[CONSTRAINED_LAPLACIAN, LOCAL_GRADIENT], default: CONSTRAINED_LAPLACIAN) – A SymbolicConstant specifying the method smoothing strategy. Possible values are CONSTRAINED_LAPLACIAN and LOCAL_GRADIENT. The default value is CONSTRAINED_LAPLACIAN.

  • midsideInterpolation (Literal[POSITIONS, OPTIMIZATION_DISPLACEMENT], default: POSITIONS) – A SymbolicConstant specifying the approach used when treating midside node positions during optimization. POSITIONS indicates midside node positions are interpolated linearly by position. OPTIMIZATION_DISPLACEMENT indicates they are interpolated by optimization displacement of corner nodes. Possible values are POSITIONS and OPTIMIZATION_DISPLACEMENT. The default value is POSITIONS.

  • numFreeNodeLayers (Union[Literal[FIX_NONE], int], default: 0) – The SymbolicConstant FIX_NONE or an Int specifying the number of node layers adjoining the task region to remain free during mesh smoothing. A value of 0 indicates that no layers are free and all layers are fixed. The default value is 0.

  • numSmoothedElementLayers (Optional[int], default: None) – None or an Int specifying the number of layers for mesh smoothing when meshSmoothingRegionMethod is NUMBER_OF_LAYERS. The default value is None.

  • presumeFeasibleBCRegionAtStart (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to ignore automatically frozen boundary condition regions in the first design cycle. This is used with freezeBoundaryConditionRegions. The default value is ON.

  • quadMaxAngle (float, default: 160) – A Float specifying the maximum angle for quad elements during mesh smoothing. The default value is 160.0.

  • quadMinAngle (float, default: 20) – A Float specifying the minimum angle for quad elements during mesh smoothing. The default value is 20.0.

  • quadSkew (float, default: 30) – A Float specifying the skew angle for quad elements during mesh smoothing, used with reportQualityViolation. The default value is 30.0.

  • quadTaper (float, default: 0) – A Float specifying the taper for quad elements during mesh smoothing, used with reportQualityViolation. The default value is 0.5.

  • region (Literal[MODEL], default: MODEL) – The SymbolicConstant MODEL or a Region object specifying the region to which the optimization task is applied. The default value is MODEL.

  • reportPoorQualityElements (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to report poor quality elements during mesh smoothing. The default value is OFF.

  • reportQualityViolation (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to report a quality criteria violation during mesh smoothing. The default value is OFF.

  • shrinkScaleFactor (float, default: 1) – A Float specifying the scale factor to apply to optimization displacements for nodes with shrinkage. The default value is 1.0.

  • smoothingRegion (Optional[str], default: None) – None or a Region object specifying the mesh smoothing region, used when meshSmoothingRegionMethod is REGION. The default value is None.

  • targetMeshQuality (Literal[LOW, MEDIUM, NONE, HIGH], default: LOW) – A SymbolicConstant specifying the target mesh quality for mesh smoothing. Possible values are NONE, LOW, MEDIUM, and HIGH. The default value is LOW.

  • tetAspectRatio (float, default: 100) – A Float specifying the tet element aspect ratio during mesh smoothing. The default value is 100.0.

  • tetMaxAspect (float, default: 8) – A Float specifying the maximum tet element aspect ratio during mesh smoothing. The default value is 8.0.

  • tetMinAspect (float, default: 0) – A Float specifying the minimum tet element aspect ratio during mesh smoothing. The default value is 0.222.

  • tetSkew (float, default: 100) – A Float specifying the tet element skew value during mesh smoothing. The default value is 100.0.

  • triMaxAngle (float, default: 140) – A Float specifying the tri element maximum angle during mesh smoothing. The default value is 140.0.

  • triMinAngle (float, default: 20) – A Float specifying the tri element maximum angle during mesh smoothing. The default value is 20.0.

  • updateShapeBasisVectors (Literal[EVERY_CYCLE, FIRST_CYCLE], default: EVERY_CYCLE) – A SymbolicConstant specifying whether to update shape basis vectors in the first design cycle or every design cycle. Possible values are EVERY_CYCLE and FIRST_CYCLE. The default value is EVERY_CYCLE.

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

    A Boolean specifying whether the group in the design response will be evaluated using the existing algorithm or a new algorithm based on Abaqus sensitivities. The default value of False means that the existing algorithm will be used.

    New in version 2022: The groupOperator argument was added.

Returns:

A ShapeTask object.

Return type:

ShapeTask

SizingTask(name, abaqusSensitivities=True, elementThicknessDeltaStopCriteria=0, freezeBoundaryConditionRegions=0, freezeLoadRegions=1, modeTrackingRegion=abaqusConstants.MODEL, numFulfilledStopCriteria=2, numTrackedModes=5, objectiveFunctionDeltaStopCriteria=0, stopCriteriaDesignCycle=4, thicknessMoveLimit=0, thicknessUpdateStrategy=abaqusConstants.NORMAL, groupOperator=0)[source]

This method creates a SizingTask object.

Note

This function can be accessed by:

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

  • abaqusSensitivities (Union[AbaqusBoolean, bool], default: True) –

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

    New in version 2019: The abaqusSensitivities argument was added.

  • elementThicknessDeltaStopCriteria (float, default: 0) – A Float specifying the stop criteria based on the change in element thickness. The default value is 0.5 x 10⁻².

  • freezeBoundaryConditionRegions (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to exclude elements with boundary conditions from the optimization. The default value is OFF.

  • freezeLoadRegions (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to exclude elements with loads and elements with loaded nodes from the optimization. The default value is ON.

  • modeTrackingRegion (str, default: MODEL) – The SymbolicConstatnt MODEL or a Region object specifying the region to use for mode tracking. The default value is MODEL.

  • numFulfilledStopCriteria (int, default: 2) – An Int specifying the number of stop criteria. The default value is 2.

  • numTrackedModes (int, default: 5) – An Int specifying the number of modes included in mode tracking. The default value is 5.

  • objectiveFunctionDeltaStopCriteria (float, default: 0) – A Float specifying the stop criteria based on the change in objective function. The default value is 0.001.

  • stopCriteriaDesignCycle (int, default: 4) – An Int specifying the first design cycle used to evaluate convergence criteria. The default value is 4.

  • thicknessMoveLimit (float, default: 0) – A Float specifying the maximum change in thickness per design cycle. The default value is 0.25.

  • thicknessUpdateStrategy (Literal[AGGRESSIVE, NORMAL, CONSERVATIVE], default: NORMAL) – A SymbolicConstant specifying the strategy for how the thickness is updated in the method of moving asymptotes. Possible values are NORMAL, CONSERVATIVE, and AGGRESSIVE. The default value is NORMAL.

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

    A Boolean specifying whether the group in the design response will be evaluated using the existing algorithm or a new algorithm based on Abaqus sensitivities. The default value of False means that the existing algorithm will be used.

    New in version 2022: The groupOperator argument was added.

Returns:

A SizingTask object.

Return type:

SizingTask

TopologyTask(name, abaqusSensitivities=True, algorithm=abaqusConstants.GENERAL_OPTIMIZATION, densityMoveLimit=0, densityUpdateStrategy=abaqusConstants.NORMAL, elementDensityDeltaStopCriteria=0, filterRadius=None, firstCycleDeletedVolume=5, firstCycleDeletedVolumeTechnique=0, freezeBoundaryConditionRegions=0, freezeLoadRegions=1, frequencySpectrumWeight=6, initialDensity=abaqusConstants.DEFAULT, materialInterpolationPenalty=3, materialInterpolationTechnique=abaqusConstants.DEFAULT, maxDensity=1, minDensity=None, modeTrackingRegion=abaqusConstants.MODEL, numDesignCycles=15, numFulfilledStopCriteria=2, numTrackedModes=5, objectiveFunctionDeltaStopCriteria=None, region=abaqusConstants.MODEL, softDeletionMethod=abaqusConstants.STANDARD, softDeletionRadius=0, softDeletionRegion=None, softDeletionThreshold=None, stepSize=abaqusConstants.MEDIUM, stiffnessMassDamping=abaqusConstants.AVERAGE_EDGE_LENGTH, stopCriteriaDesignCycle=4, structuralMassDamping=None, viscousMassDamping=None, viscousStiffnessDamping=None, groupOperator=0)[source]

This method creates a TopologyTask object.

Note

This function can be accessed by:

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

  • abaqusSensitivities (Union[AbaqusBoolean, bool], default: True) –

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

    New in version 2019: The abaqusSensitivities argument was added.

  • algorithm (Literal[CONDITION_BASED_OPTIMIZATION, GENERAL_OPTIMIZATION], default: GENERAL_OPTIMIZATION) – A SymbolicConstant specifying the optimization task algorithm. Possible values are GENERAL_OPTIMIZATION and CONDITION_BASED_OPTIMIZATION. The default value is GENERAL_OPTIMIZATION.

  • densityMoveLimit (float, default: 0) – A Float specifying the maximum density change per design cycle. The default value is 0.25.

  • densityUpdateStrategy (Literal[AGGRESSIVE, NORMAL, CONSERVATIVE], default: NORMAL) – A SymbolicConstant specifying the strategy for how the densities are updated in the method of moving asymptotes. Possible values are NORMAL, CONSERVATIVE, and AGGRESSIVE. The default value is NORMAL.

  • elementDensityDeltaStopCriteria (float, default: 0) – A Float specifying the stop criteria based upon the change in element densities. The default value is 0.5x10⁻².

  • filterRadius (Optional[float], default: None) – None or a Float specifying the mesh filter radius for mesh independence and minimum size. The default value is None.

  • firstCycleDeletedVolume (float, default: 5) – A Float specifying the volume that can be removed immediately in the first design cycle. The default value is 5.0.

  • firstCycleDeletedVolumeTechnique (Union[Literal[PERCENTAGE, ABSOLUTE], AbaqusBoolean, bool], default: 0) – A SymbolicConstant specifying the method of quantifying volume that can be removed immediately in the first design cycle. Possible values are OFF, PERCENTAGE, and ABSOLUTE. The default value is OFF.

  • freezeBoundaryConditionRegions (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to exclude elements with boundary conditions from the optimization. The default value is OFF.

  • freezeLoadRegions (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to exclude elements with loads and elements with loaded nodes from the optimization. The default value is ON.

  • frequencySpectrumWeight (float, default: 6) – A Float specifying the weighting factor for frequency spectrum peaks. The default value is 6.0.

  • initialDensity (Literal[DEFAULT], default: DEFAULT) – A SymbolicConstant specifying the Optimization product default or a float specifying the initial density. The default value is DEFAULT.

  • materialInterpolationPenalty (float, default: 3) – A Float specifying the penalty factor for the material interpolation technique. The default value is 3.0.

  • materialInterpolationTechnique (Literal[SIMP, DEFAULT, RAMP], default: DEFAULT) – A SymbolicConstant specifying the material interpolation technique: optimization product default, solid isotropic material with penalization, or rational approximation of material properties. Possible values are DEFAULT, SIMP, and RAMP. The default value is DEFAULT.

  • maxDensity (float, default: 1) – A Float specifying the maximum density in the density update. The default value is 1.0.

  • minDensity (Optional[float], default: None) – A Float specifying the minimum density in the density update. The default value is 10⁻³.

  • modeTrackingRegion (Literal[MODEL], default: MODEL) – The SymbolicConstant MODEL or a Region object specifying the region to use for mode tracking. The default value is MODEL.

  • numDesignCycles (int, default: 15) – An Int specifying the number of design cycles permitted when stepSize is DYNAMIC. The default value is 15.

  • numFulfilledStopCriteria (int, default: 2) – An Int specifying the number of stop criteria. The default value is 2.

  • numTrackedModes (int, default: 5) – An Int specifying the number of modes included in mode tracking. The default value is 5.

  • objectiveFunctionDeltaStopCriteria (Optional[float], default: None) – A Float specifying the stop criteria based on the change in objective function. The default value is 10⁻³.

  • region (Literal[MODEL], default: MODEL) – The SymbolicConstant MODEL or a Region object specifying the region to which the optimization task is applied. The default value is MODEL.

  • softDeletionMethod (Literal[STANDARD, VOLUME_COMPRESSION, MAX_SHEAR_STRAIN, AGGRESSIVE, MIN_PRINCIPAL_STRAIN, MAX_ELASTOPLASTIC_STRAIN], default: STANDARD) – A SymbolicConstant specifying the method used when softDeletionRegion is specified. The STANDARD method avoids creating disconnected regions. The AGGRESSIVE method only considers the softDeletionThreshold. The MAX_SHEAR_STRAIN, MAX_ELASTOPLASTIC_STRAIN and VOLUME_COMPRESSION methods do not need the softDeletionRadius. Possible values are STANDARD, AGGRESSIVE, MAX_SHEAR_STRAIN, MIN_PRINCIPAL_STRAIN, MAX_ELASTOPLASTIC_STRAIN and VOLUME_COMPRESSION. The default value is STANDARD.

  • softDeletionRadius (float, default: 0) – A Float specifying the radius to use when considering neighboring soft elements to delete. The default value is 0.0.

  • softDeletionRegion (Optional[str], default: None) – None or a Region object specifying the region in which the soft elements should be deleted during optimization. The default value is None.

  • softDeletionThreshold (Optional[float], default: None) – A Float specifying the relative material density value used to identify soft elements. Those with values below the threshold are considered for removal. For STANDARD and AGGRESSIVE methods positive values are accepted and the default value is 0.05. For MAX_SHEAR_STRAIN and MAX_ELASTOPLASTIC_STRAIN methods positive values are accepted whereas for MIN_PRINCIPAL_STRAIN and VOLUME_COMPRESSION methods negative values are accepted.

  • stepSize (Literal[SMALL, LARGE, MODERATE, VERY_SMALL, DYNAMIC, MEDIUM], default: MEDIUM) – A SymbolicConstant specifying the size of the increment for volume modification. Possible values are DYNAMIC, VERY_SMALL, SMALL, MODERATE, MEDIUM, and LARGE. The default value is MEDIUM.

  • stiffnessMassDamping (Union[Literal[AVERAGE_EDGE_LENGTH], float], default: AVERAGE_EDGE_LENGTH) – The SymbolicConstant AVERAGE_EDGE_LENGTH or a Float specifying the stiffness mass damping for the task region. The default value is AVERAGE_EDGE_LENGTH.

  • stopCriteriaDesignCycle (int, default: 4) – An Int specifying the first design cycle used to evaluate convergence criteria. The default value is 4.

  • structuralMassDamping (Optional[float], default: None) – None or a Float specifying the structural mass damping for the task region. The default value is None.

  • viscousMassDamping (Optional[float], default: None) – None or a Float specifying the viscous mass damping for the task region. The default value is None.

  • viscousStiffnessDamping (Optional[float], default: None) – None or a Float specifying the viscous stiffness damping for the task region. The default value is None.

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

    A Boolean specifying whether the group in the design response will be evaluated using the existing algorithm or a new algorithm based on Abaqus sensitivities. The default value of False means that the existing algorithm will be used.

    New in version 2022: The groupOperator argument was added.

Returns:

A TopologyTask object.

Return type:

TopologyTask

Assign features to optimization tasks

class OptimizationTask[source]

Bases: OptimizationTaskBase

Public Data Attributes:

Inherited from OptimizationTaskBase

name

A String specifying the optimization task repository key.

region

The SymbolicConstant MODEL or a Region object specifying the region to which the optimization task is applied.

designResponses

A repository of DesignResponse objects.

objectiveFunctions

A repository of ObjectiveFunction objects.

optimizationConstraints

A repository of OptimizationConstraint objects.

geometricRestrictions

A repository of GeometricRestriction objects.

stopConditions

A repository of StopCondition objects.

Public Methods:

SingleTermDesignResponse(name,Β identifier[,Β ...])

This method creates a SingleTermDesignResponse object.

ObjectiveFunction(name,Β objectives[,Β target])

This method creates an ObjectiveFunction object.

OptimizationConstraint(name,Β designResponse,Β ...)

This method creates an OptimizationConstraint object.

BeadFilter(name,Β region[,Β radius,Β ...])

This method creates a BeadFilter object.

BeadFixedRegion(name,Β region[,Β csys,Β u1,Β u2,Β u3])

This method creates a BeadFixedRegion object.

BeadGrowth(name,Β region[,Β beadGrowth,Β shrink])

This method creates a BeadGrowth object.

BeadPenetrationCheck(name,Β ...)

This method creates a BeadPenetrationCheck object.

BeadPlanarSymmetry(name,Β region[,Β axis,Β csys])

This method creates a BeadPlanarSymmetry object.

BeadPointSymmetry(name,Β region[,Β csys])

This method creates a BeadPointSymmetry object.

BeadRotationalSymmetry(name,Β angle,Β region)

This method creates a BeadRotationalSymmetry object.

DesignDirection(name,Β region[,Β csys,Β ...])

This method creates a DesignDirection object.

DrillControl(name,Β clientDirection,Β region)

This method creates a DrillControl object.

FixedRegion(name,Β region[,Β csys,Β ...])

This method creates a FixedRegion object.

FrozenArea(name[,Β region])

This method creates a FrozenArea object.

Growth(name,Β region[,Β growth,Β ...])

This method creates a Growth object.

PenetrationCheck(name,Β ...[,Β ...])

This method creates a PenetrationCheck object.

ShapeDemoldControl(name,Β pullDirection,Β region)

This method creates a ShapeDemoldControl object.

ShapeMemberSize(name,Β region[,Β ...])

This method creates a ShapeMemberSize object.

ShapePlanarSymmetry(name,Β clientDirection,Β ...)

This method creates a ShapePlanarSymmetry object.

ShapePointSymmetry(name,Β region[,Β csys,Β ...])

This method creates a ShapePointSymmetry object.

ShapeRotationalSymmetry(name,Β ...[,Β ...])

This method creates a ShapeRotationalSymmetry object.

SizingClusterAreas(name,Β regions)

This method creates a SizingClusterAreas object.

SizingCyclicSymmetry(name,Β region,Β translation)

This method creates a SizingCyclicSymmetry object.

SizingFrozenArea(name,Β region)

This method creates a SizingFrozenArea object.

SizingMemberSize(name,Β region,Β minWidth)

This method creates a SizingMemberSize object.

SizingPlanarSymmetry(name,Β region[,Β axis,Β ...])

This method creates a SizingPlanarSymmetry object.

SizingPointSymmetry(name,Β region[,Β csys,Β ...])

This method creates a SizingPointSymmetry object.

SizingRotationalSymmetry(name,Β angle,Β region)

This method creates a SizingRotationalSymmetry object.

SlideRegionControl(name,Β clientDirection,Β region)

This method creates a SlideRegionControl object.

StampControl(name,Β clientDirection,Β region)

This method creates a StampControl object.

TopologyCyclicSymmetry(name,Β region,Β translation)

This method creates a TopologyCyclicSymmetry object.

TopologyDemoldControl(name,Β region[,Β csys,Β ...])

This method creates a TopologyDemoldControl object.

TopologyMemberSize(name,Β region[,Β ...])

This method creates a TopologyMemberSize object.

TopologyMillingControl(name,Β ...[,Β csys,Β ...])

This method creates a TopologyMillingControl object.

TopologyOverhangControl(name,Β pullDirection,Β ...)

This method creates a TopologyOverhangControl object.

TopologyPlanarSymmetry(name,Β region[,Β axis,Β ...])

This method creates a TopologyPlanarSymmetry object.

TopologyPointSymmetry(name,Β region[,Β csys,Β ...])

This method creates a TopologyPointSymmetry object.

TopologyRibDesign(name,Β ribDirection,Β ...[,Β ...])

This method creates a TopologyRibDesign object.

TopologyRotationalSymmetry(name,Β angle,Β region)

This method creates a TopologyRotationalSymmetry object.

TurnControl(name,Β clientDirection,Β region[,Β ...])

This method creates a TurnControl object.


Member Details:

BeadFilter(name, region, radius=None, filterRadiusBy=abaqusConstants.ABSOLUTE_VALUE, filterCheckRegion=abaqusConstants.FILTER_REGION)[source]

This method creates a BeadFilter object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].BeadFilter

New in version 2023.

The BeadFilter method was added.

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

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied.

  • radius (Optional[float], default: None) – A Float specifying the filter radius. The default value is double the average edge length of the model.

  • filterRadiusBy (Literal[ABSOLUTE_VALUE, RELATIVE], default: ABSOLUTE_VALUE) – The SymbolicConstant defines whether the filter radius is in absolute or relative units. For an absolute radius, the value is ABSOLUTE_VALUE. For a relative radius, the value is RELATIVE. The default value is ABSOLUTE_VALUE.

  • filterCheckRegion (Union[Literal[FILTER_REGION], Region], default: FILTER_REGION) – The SymbolicConstant FILTER_REGION or a Region object specifying the filter check region. If the value is FILTER_REGION, the value of the region is used as both the filter region and the filter check region. The default value is FILTER_REGION.

Returns:

A BeadFilter object.

Return type:

BeadFilter

BeadFixedRegion(name, region, csys=None, u1=0, u2=0, u3=0)[source]

This method creates a BeadFixedRegion object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].BeadFixedRegion
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

  • u1 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to fix the region in the 1-direction. The default value is OFF.

  • u2 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to fix the region in the 2-direction. The default value is OFF.

  • u3 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to fix the region in the 3-direction. The default value is OFF.

Returns:

A BeadFixedRegion object.

Return type:

BeadFixedRegion

BeadGrowth(name, region, beadGrowth=0, shrink=0)[source]

This method creates a BeadGrowth object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].BeadGrowth
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied.

  • beadGrowth (float, default: 0) – A Float specifying the maximum optimization displacement in the growth direction. Either beadGrowth or shrink or both must be specified. The default value is 0.0.

  • shrink (float, default: 0) – A Float specifying the maximum optimization displacement in the shrink direction. Either beadGrowth or shrink or both must be specified The default value is 0.0.

Returns:

A BeadGrowth object.

Return type:

BeadGrowth

BeadPenetrationCheck(name, beadPenetrationCheckRegion, region)[source]

This method creates a BeadPenetrationCheck object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].BeadPenetrationCheck
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • beadPenetrationCheckRegion (Region) – A Region object specifying the penetration check region.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied.

Returns:

A BeadPenetrationCheck object.

Return type:

BeadPenetrationCheck

BeadPlanarSymmetry(name, region, axis=abaqusConstants.AXIS_1, csys=None)[source]

This method creates a BeadPlanarSymmetry object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].BeadPlanarSymmetry
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied.

  • axis (Literal[AXIS_1, AXIS_3, AXIS_2], default: AXIS_1) – A SymbolicConstant specifying the axis of symmetry. Possible values are AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_1.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

Returns:

A BeadPlanarSymmetry object.

Return type:

BeadPlanarSymmetry

BeadPointSymmetry(name, region, csys=None)[source]

This method creates a BeadPointSymmetry object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].BeadPointSymmetry
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the position of the symmetry point defined as the origin of a local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

Returns:

A BeadPointSymmetry object.

Return type:

BeadPointSymmetry

BeadRotationalSymmetry(name, angle, region, axis=abaqusConstants.AXIS_1, csys=None)[source]

This method creates a BeadRotationalSymmetry object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].BeadRotationalSymmetry
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • angle (float) – A Float specifying the repeating segment size, an angle in degrees.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied.

  • axis (Literal[AXIS_1, AXIS_3, AXIS_2], default: AXIS_1) – A SymbolicConstant specifying the axis of symmetry. Possible values are AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_1.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

Returns:

A BeadRotationalSymmetry object.

Return type:

BeadRotationalSymmetry

DesignDirection(name, region, csys=None, mainPoint=None, mainPointDetermination=abaqusConstants.MAXIMUM, movementRestriction=abaqusConstants.VECTOR, presumeFeasibleRegionAtStart=1, u1=1, u2=1, u3=1)[source]

This method creates a DesignDirection object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].DesignDirection
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

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

    None or a Region object specifying the main point used when mainPointDetermination is SPECIFY. The default value is None.

    Changed in version 2022: The argument masterPoint was renamed to mainPoint.

  • mainPointDetermination (Literal[SPECIFY, MINIMUM, MAXIMUM], default: MAXIMUM) –

    A SymbolicConstant specifying the rule for assigning point priority. Possible values are MAXIMUM, MINIMUM, and SPECIFY. The default value is MAXIMUM.

    Changed in version 2022: The argument masterPointDetermination was renamed to mainPointDetermination.

  • movementRestriction (Literal[MAGNITUDE, DIRECTION, VECTOR], default: VECTOR) – A SymbolicConstant specifying whether movement in the region should follow only the direction of the mainPoint, only the magnitude, or both the magnitude of the mainPoint and the directions specified by u1, u2 and u3. Possible values are DIRECTION, MAGNITUDE, and VECTOR. The default value is VECTOR.

  • presumeFeasibleRegionAtStart (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

  • u1 (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether movement in the region should follow the masterPoint in the 1-direction. This is used when movementRestriction is VECTOR. The default value is ON.

  • u2 (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether movement in the region should follow the masterPoint in the 2-direction. This is used when movementRestriction is VECTOR. The default value is ON.

  • u3 (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether movement in the region should follow the masterPoint in the 3-direction. This is used when movementRestriction is VECTOR. The default value is ON.

Returns:

A DesignDirection object.

Return type:

DesignDirection

DrillControl(name, clientDirection, region, csys=None, drawAngle=0, mainPoint=None, mainPointDetermination=abaqusConstants.MAXIMUM, presumeFeasibleRegionAtStart=1, tolerance1=0, tolerance2=0, tolerance3=0, undercutTolerance=0)[source]

This method creates a DrillControl object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].DrillControl
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • clientDirection (tuple) – A VertexArray object of length 2 specifying the direction of the drill axis positioned at the csys origin. Instead of through a ConstrainedSketchVertex, each point may be specified through a tuple of coordinates.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

  • drawAngle (float, default: 0) – A Float specifying the draw angle. The default value is 0.0.

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

    None or a Region object specifying the main point used when mainPointDetermination is SPECIFY. The default value is None.

    Changed in version 2022: The argument masterPoint was renamed to mainPoint.

  • mainPointDetermination (Literal[SPECIFY, MINIMUM, MAXIMUM], default: MAXIMUM) –

    A SymbolicConstant specifying the rule for assigning point priority. Possible values are MAXIMUM, MINIMUM, and SPECIFY. The default value is MAXIMUM.

    Changed in version 2022: The argument masterPointDetermination was renamed to mainPointDetermination.

  • presumeFeasibleRegionAtStart (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

  • tolerance1 (float, default: 0) – A Float specifying the geometric tolerance in the 1-direction. The default value is 0.01.

  • tolerance2 (float, default: 0) – A Float specifying the geometric tolerance in the 2-direction. The default value is 0.01.

  • tolerance3 (float, default: 0) – A Float specifying the geometric tolerance in the 3-direction. The default value is 0.01.

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

Returns:

A DrillControl object.

Return type:

DrillControl

FixedRegion(name, region, csys=None, presumeFeasibleRegionAtStart=1, u1=0, u2=0, u3=0)[source]

This method creates a FixedRegion object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].FixedRegion
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

  • presumeFeasibleRegionAtStart (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

  • u1 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to fix the region in the 1-direction. The default value is OFF.

  • u2 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to fix the region in the 2-direction. The default value is OFF.

  • u3 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to fix the region in the 3-direction. The default value is OFF.

Returns:

A FixedRegion object.

Return type:

FixedRegion

FrozenArea(name, region=<abaqus.Region.Region.Region object>)[source]

This method creates a FrozenArea object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].FrozenArea
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region, default: <abaqus.Region.Region.Region object at 0x7f5b3e85de50>) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

Returns:

A FrozenArea object.

Return type:

FrozenArea

Growth(name, region, growth=0, presumeFeasibleRegionAtStart=1, shrink=0)[source]

This method creates a Growth object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].Growth
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • growth (float, default: 0) – A Float specifying the maximum optimization displacement in the growth direction. Either growth or shrink or both must be specified. The default value is 0.0.

  • presumeFeasibleRegionAtStart (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

  • shrink (float, default: 0) – A Float specifying the maximum optimization displacement in the shrink direction. Either growth or shrink or both must be specified The default value is 0.0.

Returns:

A Growth object.

Return type:

Growth

ObjectiveFunction(name, objectives, target=abaqusConstants.MINIMIZE)[source]

This method creates an ObjectiveFunction object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].ObjectiveFunction
Parameters:
  • name (str) – A String specifying the objective function repository key.

  • objectives (List[OptimizationObjective]) – An OptimizationObjectiveArray object.

  • target (Literal[MINIMIZE_MAXIMUM, MINIMIZE, MAXIMIZE], default: MINIMIZE) – A SymbolicConstant specifying the target of the objective function. Possible values are MINIMIZE, MAXIMIZE, and MINIMIZE_MAXIMUM. The default value is MINIMIZE.

Returns:

An ObjectiveFunction object.

Return type:

ObjectiveFunction

Raises:
  • InvalidNameError –

  • RangeError –

OptimizationConstraint(name, designResponse, restrictionValue, restrictionMethod=abaqusConstants.ABSOLUTE_EQUAL)[source]

This method creates an OptimizationConstraint object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].OptimizationConstraint
Parameters:
  • name (str) – A String specifying the optimization constraint repository key.

  • designResponse (str) – A String specifying the name of the design response to constrain.

  • restrictionValue (float) – A Float specifying the value to which the design response should be constrained.

  • restrictionMethod (Literal[ABSOLUTE_LESS_THAN_EQUAL, RELATIVE_GREATER_THAN_EQUAL, ABSOLUTE_GREATER_THAN_EQUAL, RELATIVE_EQUAL, ABSOLUTE_EQUAL, RELATIVE_LESS_THAN_EQUAL], default: ABSOLUTE_EQUAL) – A SymbolicConstant specifying the method used to constrain the design response. Possible values are ABSOLUTE_EQUAL, ABSOLUTE_GREATER_THAN_EQUAL, ABSOLUTE_LESS_THAN_EQUAL, RELATIVE_EQUAL, RELATIVE_GREATER_THAN_EQUAL, and RELATIVE_LESS_THAN_EQUAL. The default value is ABSOLUTE_EQUAL.

Returns:

An OptimizationConstraint object.

Return type:

OptimizationConstraint

Raises:
  • InvalidNameError –

  • RangeError –

PenetrationCheck(name, penetrationCheckRegion, region, presumeFeasibleRegionAtStart=1)[source]

This method creates a PenetrationCheck object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].PenetrationCheck
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • penetrationCheckRegion (Region) – A Region object specifying the penetration check region.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • presumeFeasibleRegionAtStart (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

Returns:

A PenetrationCheck object.

Return type:

PenetrationCheck

ShapeDemoldControl(name, pullDirection, region, collisionCheckRegion=abaqusConstants.DEMOLD_REGION, csys=None, drawAngle=0, mainPointDetermination=abaqusConstants.MAXIMUM, presumeFeasibleRegionAtStart=1, tolerance1=0, tolerance2=0, tolerance3=0, undercutTolerance=0)[source]

This method creates a ShapeDemoldControl object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].ShapeDemoldControl
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • pullDirection (tuple) – A VertexArray object of length 2 specifying the demold pull direction. Instead of through a ConstrainedSketchVertex, each point might be specified through a tuple of coordinates.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • collisionCheckRegion (Literal[DEMOLD_REGION], default: DEMOLD_REGION) – The SymbolicConstant DEMOLD_REGION or a Region object specifying the collision check region. If the value is DEMOLD_REGION, then the value of region is used as both the demold region and the collision check region. The default value is DEMOLD_REGION.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system of the pullDirection. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int indicating the identifier of the DatumCsys. The default value is None.

  • drawAngle (float, default: 0) – A Float specifying the draw angle. The default value is 0.0.

  • mainPointDetermination (Literal[MINIMUM, MAXIMUM], default: MAXIMUM) –

    A SymbolicConstant specifying the rule for assigning point priority. Possible values are MAXIMUM and MINIMUM. The default value is MAXIMUM.

    Changed in version 2022: The argument masterPointDetermination was renamed to mainPointDetermination.

  • presumeFeasibleRegionAtStart (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

  • tolerance1 (float, default: 0) – A Float specifying the geometric tolerance in the 1-direction. The default value is 0.01.

  • tolerance2 (float, default: 0) – A Float specifying the geometric tolerance in the 2-direction. The default value is 0.01.

  • tolerance3 (float, default: 0) – A Float specifying the geometric tolerance in the 3-direction. The default value is 0.01.

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

Returns:

A ShapeDemoldControl object.

Return type:

ShapeDemoldControl

ShapeMemberSize(name, region, maxThickness=0, minThickness=0, sizeRestriction=abaqusConstants.MINIMUM, assignNodeGroupRegion=0, nodeGroupRegion='')[source]

This method creates a ShapeMemberSize object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].ShapeMemberSize
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • maxThickness (float, default: 0) – A Float specifying the maximum thickness. The default value is 0.0.

  • minThickness (float, default: 0) – A Float specifying the minimum thickness. The default value is 0.0.

  • sizeRestriction (Literal[MINIMUM, MAXIMUM], default: MINIMUM) – A SymbolicConstant specifying whether to restrict the minimum or maximum thickness. Possible values are MAXIMUM and MINIMUM. The default value is MINIMUM.

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

    A bool specifying whether to use the node group region. The default value is OFF.

    New in version 2022: The assignNodeGroupRegion argument was added.

  • nodeGroupRegion (str, default: '') –

    A Node Region object specifying the check node group.

    New in version 2022: The nodeGroupRegion argument was added.

Returns:

A ShapeMemberSize object.

Return type:

ShapeMemberSize

ShapePlanarSymmetry(name, clientDirection, region, allowNonSymmetricMesh=True, csys=None, mainPointDetermination=abaqusConstants.MAXIMUM, presumeFeasibleRegionAtStart=1, tolerance1=0, tolerance2=0, tolerance3=0)[source]

This method creates a ShapePlanarSymmetry object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].ShapePlanarSymmetry
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • clientDirection (tuple) – A VertexArray object of length 2 specifying the vector positioned at the csys origin that is normal to the symmetry plane. Instead of through a ConstrainedSketchVertex, each point may be specified through a tuple of coordinates.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • allowNonSymmetricMesh (Union[AbaqusBoolean, bool], default: True) –

    A Boolean specifying whether to allow a nonsymmetric mesh for this geometric restriction. The default value is TRUE.

    New in version 2021: The alloowNonSymmetricMesh argument was added.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

  • mainPointDetermination (Literal[MINIMUM, MAXIMUM], default: MAXIMUM) –

    A SymbolicConstant specifying the rule for determining the main node. Possible values are MAXIMUM and MINIMUM. The default value is MAXIMUM.

    Changed in version 2022: The argument masterPointDetermination was renamed to mainPointDetermination.

  • presumeFeasibleRegionAtStart (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

  • tolerance1 (float, default: 0) – A Float specifying the geometric tolerance in the 1-direction. The default value is 0.01.

  • tolerance2 (float, default: 0) – A Float specifying the geometric tolerance in the 2-direction. The default value is 0.01.

  • tolerance3 (float, default: 0) – A Float specifying the geometric tolerance in the 3-direction. The default value is 0.01.

Returns:

A ShapePlanarSymmetry object.

Return type:

ShapePlanarSymmetry

ShapePointSymmetry(name, region, csys=None, mainPointDetermination=abaqusConstants.MAXIMUM, presumeFeasibleRegionAtStart=1, tolerance1=0, tolerance2=0, tolerance3=0)[source]

This method creates a ShapePointSymmetry object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].ShapePointSymmetry
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the symmetry point represented as the origin of a local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

  • mainPointDetermination (Literal[MINIMUM, MAXIMUM], default: MAXIMUM) –

    A SymbolicConstant specifying the rule for determining the main node. Possible values are MAXIMUM and MINIMUM. The default value is MAXIMUM.

    Changed in version 2022: The argument masterPointDetermination was renamed to mainPointDetermination.

  • presumeFeasibleRegionAtStart (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

  • tolerance1 (float, default: 0) – A Float specifying the geometric tolerance in the 1-direction. The default value is 0.01.

  • tolerance2 (float, default: 0) – A Float specifying the geometric tolerance in the 2-direction. The default value is 0.01.

  • tolerance3 (float, default: 0) – A Float specifying the geometric tolerance in the 3-direction. The default value is 0.01.

Returns:

A ShapePointSymmetry object.

Return type:

ShapePointSymmetry

ShapeRotationalSymmetry(name, clientDirection, region, allowNonSymmetricMesh=True, angle=0, csys=None, mainPoint=None, mainPointDetermination=abaqusConstants.MAXIMUM, presumeFeasibleRegionAtStart=1, startPoint=None, tolerance1=0, tolerance2=0, tolerance3=0)[source]

This method creates a ShapeRotationalSymmetry object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].ShapeRotationalSymmetry
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • clientDirection (tuple) – A VertexArray object of length 2 specifying the vector positioned at the csys origin, used as the axis of symmetry. Instead of through a ConstrainedSketchVertex, each point might be specified through a tuple of coordinates.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • allowNonSymmetricMesh (Union[AbaqusBoolean, bool], default: True) –

    A Boolean specifying whether to allow a nonsymmetric mesh for this geometric restriction. The default value is TRUE.

    New in version 2021: The alloowNonSymmetricMesh argument was added.

  • angle (float, default: 0) – A Float specifying the segment size of the repeating pattern in degrees. If the angle value is 0, no repeating pattern is created. The default value is 0.0.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

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

    None or a Region object specifying the main point used when mainPointDetermination is SPECIFY. The default value is None.

    Changed in version 2022: The argument masterPoint was renamed to mainPoint.

  • mainPointDetermination (Literal[SPECIFY, MINIMUM, MAXIMUM], default: MAXIMUM) –

    A SymbolicConstant specifying the rule for determining the main node. Possible values are MAXIMUM, MINIMUM, and SPECIFY. The default value is MAXIMUM.

    Changed in version 2022: The argument masterPointDetermination was renamed to mainPointDetermination.

  • presumeFeasibleRegionAtStart (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

  • startPoint (Optional[float], default: None) – A tuple of Floats representing the coordinates of a start point of the rotational symmetry.

  • tolerance1 (float, default: 0) – A Float specifying the geometric tolerance in the 1-direction. The default value is 0.01.

  • tolerance2 (float, default: 0) – A Float specifying the geometric tolerance in the 2-direction. The default value is 0.01.

  • tolerance3 (float, default: 0) – A Float specifying the geometric tolerance in the 3-direction. The default value is 0.01.

Returns:

A ShapeRotationalSymmetry object.

Return type:

ShapeRotationalSymmetry

SingleTermDesignResponse(name, identifier, csys=None, drivingRegion=None, operation=abaqusConstants.SUM, region=abaqusConstants.MODEL, shellLayer=abaqusConstants.MAXIMUM, stepOperation=abaqusConstants.SUM, stepOptions=None)[source]

This method creates a SingleTermDesignResponse object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].SingleTermDesignResponse
Parameters:
  • name (str) – A String specifying the design response repository key.

  • identifier (str) – A String specifying the name of the variable identifier.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

  • drivingRegion (Optional[str], default: None) – None or a sequence of Floats specifying the driving region used when identifier is an internal nodal variable. The default value is None.

  • operation (Literal[SUM, MINIMUM, MAXIMUM], default: SUM) – A SymbolicConstant specifying the operation used on values in the region. Possible values are MAXIMUM, MINIMUM, and SUM. The default value is SUM.

  • region (Literal[MODEL], default: MODEL) – The SymbolicConstant MODEL or a Region object specifying the region of the design response variable. The default value is MODEL.

  • shellLayer (Literal[BOTTOM, TOP, MAXIMUM, MINIMUM, MIDDLE], default: MAXIMUM) – A SymbolicConstant specifying the location used for shell layer values. Possible values are BOTTOM, MAXIMUM, MIDDLE, MINIMUM, and TOP. The default value is MAXIMUM.

  • stepOperation (Literal[SUM, MINIMUM, MAXIMUM], default: SUM) – A SymbolicConstant specifying the operation used on values across steps and load cases. Possible values are MAXIMUM, MINIMUM, and SUM. The default value is SUM.

  • stepOptions (Optional[List[StepOption]], default: None) – A StepOptionArray object.

Returns:

A SingleTermDesignResponse object.

Return type:

SingleTermDesignResponse

SizingClusterAreas(name, regions)[source]

This method creates a SizingClusterAreas object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].SizingClusterAreas
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • regions (tuple) – Tuple of Region objects specifying the regions to which the geometric restriction is applied.

Returns:

A SizingClusterAreas object.

Return type:

SizingClusterAreas

SizingCyclicSymmetry(name, region, translation, axis=abaqusConstants.AXIS_1, csys=None, ignoreFrozenArea=0)[source]

This method creates a SizingCyclicSymmetry object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].SizingCyclicSymmetry
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied.

  • translation (float) – A Float specifying the translation distance.

  • axis (Literal[AXIS_1, AXIS_3, AXIS_2], default: AXIS_1) – A SymbolicConstant specifying the translation direction defined along an axis positioned at the csys origin. Possible values are AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_1.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

  • ignoreFrozenArea (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to ignore frozen areas. The default value is OFF.

Returns:

A SizingCyclicSymmetry object.

Return type:

SizingCyclicSymmetry

SizingFrozenArea(name, region)[source]

This method creates a SizingFrozenArea object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].SizingFrozenArea
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied.

Returns:

A SizingFrozenArea object.

Return type:

SizingFrozenArea

SizingMemberSize(name, region, minWidth)[source]

This method creates a SizingMemberSize object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].SizingMemberSize
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied.

  • minWidth (float) – A Float specifying the min width.

SizingPlanarSymmetry(name, region, axis=abaqusConstants.AXIS_1, csys=None, ignoreFrozenArea=0)[source]

This method creates a SizingPlanarSymmetry object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].SizingPlanarSymmetry
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied.

  • axis (Literal[AXIS_1, AXIS_3, AXIS_2], default: AXIS_1) – A SymbolicConstant specifying the axis of symmetry. Possible values are AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_1.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

  • ignoreFrozenArea (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to ignore frozen areas. The default value is OFF.

Returns:

A SizingPlanarSymmetry object.

Return type:

SizingPlanarSymmetry

SizingPointSymmetry(name, region, csys=None, ignoreFrozenArea=0)[source]

This method creates a SizingPointSymmetry object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].SizingPointSymmetry
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the position of the symmetry point defined as the origin of a local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

  • ignoreFrozenArea (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to ignore frozen areas. The default value is OFF.

Returns:

A SizingPointSymmetry object.

Return type:

SizingPointSymmetry

SizingRotationalSymmetry(name, angle, region, axis=abaqusConstants.AXIS_1, csys=None, ignoreFrozenArea=0)[source]

This method creates a SizingRotationalSymmetry object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].SizingRotationalSymmetry
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • angle (float) – A Float specifying the repeating segment size, an angle in degrees.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied.

  • axis (Literal[AXIS_1, AXIS_3, AXIS_2], default: AXIS_1) – A SymbolicConstant specifying the axis of symmetry. Possible values are AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_1.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

  • ignoreFrozenArea (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to ignore frozen areas. The default value is OFF.

Returns:

A SizingRotationalSymmetry object.

Return type:

SizingRotationalSymmetry

SlideRegionControl(name, clientDirection, region, approach=abaqusConstants.FREE_FORM, csys=None, freeFormRegion=None, presumeFeasibleRegionAtStart=1, revolvedRegion=None, tolerance1=0, tolerance2=0, tolerance3=0)[source]

This method creates a SlideRegionControl object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].SlideRegionControl
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • clientDirection (tuple) – A VertexArray object of length 2 specifying the axis of revolution. Instead of through a ConstrainedSketchVertex, each point may be specified through a tuple of coordinates. This is used when approach is TURN.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • approach (Literal[FREE_FORM, TURN], default: FREE_FORM) – A SymbolicConstant specifying the restriction approach. The SymbolicConstant FREE_FORM indicates a free-form slide region, and the SymbolicConstant TURN indicates that the restriction should conserve a turnable surface. Possible values are FREE_FORM and TURN. The default value is FREE_FORM.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. This is used when approach is TURN. The default value is None.

  • freeFormRegion (Optional[str], default: None) – None or a Region object specifying the free-form region. This is used when approach is FREE_FORM. The default value is None.

  • presumeFeasibleRegionAtStart (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

  • revolvedRegion (Optional[str], default: None) – None or a Region object specifying the region to revolve into a slide region. This is used when approach is TURN. The default value is None.

  • tolerance1 (float, default: 0) – A Float specifying the geometric tolerance in the 1-direction. This is used when approach is TURN. The default value is 0.01.

  • tolerance2 (float, default: 0) – A Float specifying the geometric tolerance in the 2-direction. This is used when approach is TURN. The default value is 0.01.

  • tolerance3 (float, default: 0) – A Float specifying the geometric tolerance in the 3-direction. This is used when approach is TURN. The default value is 0.01.

Returns:

A SlideRegionControl object.

Return type:

SlideRegionControl

StampControl(name, clientDirection, region, csys=None, drawAngle=0, mainPoint=None, mainPointDetermination=abaqusConstants.MAXIMUM, presumeFeasibleRegionAtStart=1, tolerance1=0, tolerance2=0, tolerance3=0, undercutTolerance=0)[source]

This method creates a StampControl object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].StampControl
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • clientDirection (tuple) – A VertexArray object of length 2 specifying the stamping direction. Instead of through a ConstrainedSketchVertex, each point may be specified through a tuple of coordinates.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

  • drawAngle (float, default: 0) – A Float specifying the draw angle. The default value is 0.0.

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

    None or a Region object specifying the main point used when mainPointDetermination is SPECIFY. The default value is None.

    Changed in version 2022: The argument masterPoint was renamed to mainPoint.

  • mainPointDetermination (Literal[SPECIFY, MINIMUM, MAXIMUM], default: MAXIMUM) –

    A SymbolicConstant specifying the rule for assigning point priority. Possible values are MAXIMUM, MINIMUM, and SPECIFY. The default value is MAXIMUM.

    Changed in version 2022: The argument masterPointDetermination was renamed to mainPointDetermination.

  • presumeFeasibleRegionAtStart (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

  • tolerance1 (float, default: 0) – A Float specifying the geometric tolerance in the 1-direction. The default value is 0.01.

  • tolerance2 (float, default: 0) – A Float specifying the geometric tolerance in the 2-direction. The default value is 0.01.

  • tolerance3 (float, default: 0) – A Float specifying the geometric tolerance in the 3-direction. The default value is 0.01.

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

Returns:

A StampControl object.

Return type:

StampControl

TopologyCyclicSymmetry(name, region, translation, axis=abaqusConstants.AXIS_1, csys=None, ignoreFrozenArea=0)[source]

This method creates a TopologyCyclicSymmetry object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].TopologyCyclicSymmetry
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • translation (float) – A Float specifying the translation distance.

  • axis (Literal[AXIS_1, AXIS_3, AXIS_2], default: AXIS_1) – A SymbolicConstant specifying the translation direction defined along an axis positioned at the csys origin. Possible values are AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_1.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

  • ignoreFrozenArea (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to ignore frozen areas. The default value is OFF.

Returns:

A TopologyCyclicSymmetry object.

Return type:

TopologyCyclicSymmetry

TopologyDemoldControl(name, region, csys=None, draftAngle=0, collisionCheckRegion=abaqusConstants.DEMOLD_REGION, pointRegion=None, pullDirection=(), technique=abaqusConstants.AUTO)[source]

This method creates a TopologyDemoldControl object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].TopologyDemoldControl
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system of the pullDirection. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int indicating the identifier of the DatumCsys. The default value is None.

  • draftAngle (float, default: 0) – A Float specifying the draft angle. The default value is 0.0.

  • collisionCheckRegion (Literal[DEMOLD_REGION], default: DEMOLD_REGION) – The SymbolicConstant DEMOLD_REGION or a Region object specifying the collision check region. If the value is DEMOLD_REGION, then the value of region is used as both the demold region and the collision check region. The default value is DEMOLD_REGION.

  • pointRegion (Optional[Region], default: None) – A Region object specifying the point on a plane perpendicular to the pull direction, used to specify the central plane when technique is POINT.

  • pullDirection (tuple, default: ()) – A VertexArray object of length 2 specifying the demold pull direction. Instead of through a ConstrainedSketchVertex, each point may be specified through a tuple of coordinates.

  • technique (Literal[POINT, AUTO_TIGHT, SURFACE, STAMP, AUTO], default: AUTO) – A SymbolicConstant specifying the demold technique. Possible values are AUTO, AUTO_TIGHT, POINT, SURFACE, and STAMP. The default value is AUTO.

Returns:

A TopologyDemoldControl object.

Return type:

TopologyDemoldControl

TopologyMemberSize(name, region, maxThickness=0, minThickness=0, separation=0, sizeRestriction=abaqusConstants.MINIMUM)[source]

This method creates a TopologyMemberSize object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].TopologyMemberSize
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • maxThickness (float, default: 0) – A Float specifying the maximum thickness. The default value is 0.0.

  • minThickness (float, default: 0) – A Float specifying the minimum thickness. The default value is 0.0.

  • separation (float, default: 0) – A Float specifying the minimum gap. The default value is 0.0.

  • sizeRestriction (Literal[ENVELOPE, MINIMUM, MAXIMUM], default: MINIMUM) – A SymbolicConstant specifying whether to restrict the minimum or maximum thickness or an envelope of both. Possible values are ENVELOPE, MAXIMUM, and MINIMUM. The default value is MINIMUM.

Returns:

A TopologyMemberSize object.

Return type:

TopologyMemberSize

TopologyMillingControl(name, millingDirections, region, csys=None, millingCheckRegion=abaqusConstants.MILLING_REGION, radius=None)[source]

This method creates a TopologyMillingControl object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].TopologyMillingControl

New in version 2022: The TopologyMillingControl method was added.

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

  • millingDirections (tuple) – A tuple of VertexArray objects of length 2 specifying the milling directions. Each point can be specified through a tuple of coordinates instead of through a ConstrainedSketchVertex.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system of the millingDirections. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int indicating the identifier of the DatumCsys. The default value is None.

  • millingCheckRegion (Literal[MILLING_REGION], default: MILLING_REGION) – The SymbolicConstant MILLING_REGION or a Region object specifying the milling check region. If the value is MILLING_REGION, the value of region is used as both the milling control region and the milling check region. The default value is MILLING_REGION.

  • radius (Optional[float], default: None) – A Float specifying the radius for the collision check during the removal of the elements for the milling criteria.

Returns:

A TopologyMillingControl object.

Return type:

TopologyMillingControl

TopologyOverhangControl(name, pullDirection, region, csys=None, draftAngle=45, overhangCheckRegion=abaqusConstants.OVERHANG_REGION, pointRegion=<abaqus.Region.Region.Region object>, radius=None, technique=abaqusConstants.AUTO)[source]

This method creates a TopologyOverhangControl object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].TopologyOverhangControl

New in version 2019: The TopologyOverhangControl method was added.

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

  • pullDirection (tuple) – A VertexArray object of length 2 specifying the overhang control print direction. Instead of through a ConstrainedSketchVertex, each point can be specified through a tuple of coordinates.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system of the pullDirection. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int indicating the identifier of the DatumCsys. The default value is None.

  • draftAngle (float, default: 45) – A Float specifying the overhang angle. The default value is 45.0.

  • overhangCheckRegion (Literal[OVERHANG_REGION], default: OVERHANG_REGION) – The SymbolicConstant OVERHANG_REGION or a Region object specifying the overhang check region. If the value is OVERHANG_REGION, the value of region is used as both the overhang control region and the overhang check region. The default value is OVERHANG_REGION.

  • pointRegion (Region, default: <abaqus.Region.Region.Region object at 0x7f5b3e837e50>) – A Region object specifying the point on a plane perpendicular to the pullDirection that is used to specify the base plane when technique is POINT.

  • radius (Optional[float], default: None) – A Float specifying the radius to define the size of the cones that are used in the internal check for the overhang criteria.

  • technique (Literal[POINT, NONE, AUTO], default: AUTO) – A SymbolicConstant specifying the overhang control technique used to define the base plane. Possible values are AUTO, POINT, and NONE. The default value is AUTO.

Returns:

A TopologyOverhangControl object.

TopologyPlanarSymmetry(name, region, axis=abaqusConstants.AXIS_1, csys=None, ignoreFrozenArea=0)[source]

This method creates a TopologyPlanarSymmetry object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].TopologyPlanarSymmetry
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • axis (Literal[AXIS_1, AXIS_3, AXIS_2], default: AXIS_1) – A SymbolicConstant specifying the axis of symmetry. Possible values are AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_1.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

  • ignoreFrozenArea (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to ignore frozen areas. The default value is OFF.

Returns:

A TopologyPlanarSymmetry object.

Return type:

TopologyPlanarSymmetry

TopologyPointSymmetry(name, region, csys=None, ignoreFrozenArea=0)[source]

This method creates a TopologyPointSymmetry object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].TopologyPointSymmetry
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the position of the symmetry point defined as the origin of a local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

  • ignoreFrozenArea (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to ignore frozen areas. The default value is OFF.

Returns:

A TopologyPointSymmetry object.

Return type:

TopologyPointSymmetry

TopologyRibDesign(name, ribDirection, ribThickness, ribDistance, region, csys=None, ribDesignCheckRegion=abaqusConstants.RIBDESIGN_REGION)[source]

This method creates a TopologyRibDesign object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].TopologyRibDesign

New in version 2022: The TopologyRibDesign method was added.

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

  • ribDirection (VertexArray) – A VertexArray object of length 2 specifying the out-of-plane growth direction of the ribs. Instead of through a Vertex, each point can be specified through a tuple of coordinates.

  • ribThickness (float) – A Float specifying the average thickness of the ribs.

  • ribDistance (float) – A Float specifying the average distance between the rib centers. The distance must be larger than twice the average element edge length.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • csys (Optional[DatumCsys], default: None) – None or a DatumCsys object specifying the position of the symmetry point defined as the origin of a local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

  • ribDesignCheckRegion (Union[Literal[RIBDESIGN_REGION], Region], default: RIBDESIGN_REGION) – The SymbolicConstant RIBDESIGN_REGION or a Region object specifying the overhang check region. If the value is OVERHANG_REGION, the value of region is used as both the overhang control region and the overhang check region. The default value is RIBDESIGN_REGION.

Returns:

A TopologyRibDesign object.

Return type:

TopologyRibDesign

TopologyRotationalSymmetry(name, angle, region, axis=abaqusConstants.AXIS_1, csys=None, ignoreFrozenArea=0)[source]

This method creates a TopologyRotationalSymmetry object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].TopologyRotationalSymmetry
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • angle (float) – A Float specifying the repeating segment size, an angle in degrees.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • axis (Literal[AXIS_1, AXIS_3, AXIS_2], default: AXIS_1) – A SymbolicConstant specifying the axis of symmetry. Possible values are AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_1.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

  • ignoreFrozenArea (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to ignore frozen areas. The default value is OFF.

Returns:

A TopologyRotationalSymmetry object.

Return type:

TopologyRotationalSymmetry

TurnControl(name, clientDirection, region, csys=None, mainPoint=None, mainPointDetermination=abaqusConstants.MAXIMUM, presumeFeasibleRegionAtStart=1, tolerance1=0, tolerance2=0, tolerance3=0)[source]

This method creates a TurnControl object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].TurnControl
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • clientDirection (tuple) – A VertexArray object of length 2 specifying the direction of the rotation axis as a vector positioned at the csys origin. Instead of through a ConstrainedSketchVertex, each point might be specified through a tuple of coordinates.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

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

    None or a Region object specifying the main point used when mainPointDetermination is SPECIFY. The default value is None.

    Changed in version 2022: The argument masterPoint was renamed to mainPoint.

  • mainPointDetermination (Literal[SPECIFY, MINIMUM, MAXIMUM], default: MAXIMUM) –

    A SymbolicConstant specifying the rule for assigning point priority. Possible values are MAXIMUM, MINIMUM, and SPECIFY. The default value is MAXIMUM.

    Changed in version 2022: The argument masterPointDetermination was renamed to mainPointDetermination.

  • presumeFeasibleRegionAtStart (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

  • tolerance1 (float, default: 0) – A Float specifying the geometric tolerance in the 1-direction. The default value is 0.01.

  • tolerance2 (float, default: 0) – A Float specifying the geometric tolerance in the 2-direction. The default value is 0.01.

  • tolerance3 (float, default: 0) – A Float specifying the geometric tolerance in the 3-direction. The default value is 0.01.

Returns:

A TurnControl object.

Return type:

TurnControl

Other Classes

class BeadFilter(name, region, radius=None, filterRadiusBy=abaqusConstants.ABSOLUTE_VALUE, filterCheckRegion=abaqusConstants.FILTER_REGION)[source]

Bases: GeometricRestriction

The BeadFilter object defines a growth geometric restriction. The BeadFilter object is derived from the GeometricRestriction object.

Note

This object can be accessed by:

import optimization
mdb.models[name].optimizationTasks[name].geometricRestrictions[name]

New in version 2023: The BeadFilter class was added.

This method creates a BeadFilter object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].BeadFilter
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied.

  • radius (Optional[float], default: None) – A Float specifying the filter radius. The default value is double the average edge length of the model.

  • filterRadiusBy (Literal[ABSOLUTE_VALUE, RELATIVE], default: ABSOLUTE_VALUE) – The SymbolicConstant defines whether the filter radius is in absolute or relative units. For an absolute radius, the value is ABSOLUTE_VALUE. For a relative radius, the value is RELATIVE. The default value is ABSOLUTE_VALUE.

  • filterCheckRegion (Union[Literal[FILTER_REGION], Region], default: FILTER_REGION) – The SymbolicConstant FILTER_REGION or a Region object specifying the filter check region. If the value is FILTER_REGION, the value of the region is used as both the filter region and the filter check region. The default value is FILTER_REGION.

Returns:

A BeadFilter object.

Return type:

BeadFilter

Member Details:

filterCheckRegion: Union[Literal[FILTER_REGION], Region] = 'FILTER_REGION'[source]

The SymbolicConstant FILTER_REGION or a Region object specifying the filter check region. If the value is FILTER_REGION, the value of the region is used as both the filter region and the filter check region. The default value is FILTER_REGION.

filterRadiusBy: Literal[ABSOLUTE_VALUE, RELATIVE] = 'ABSOLUTE_VALUE'[source]

The SymbolicConstant defines whether the filter radius is in absolute or relative units. For an absolute radius, the value is ABSOLUTE_VALUE. For a relative radius, the value is RELATIVE. The default value is ABSOLUTE_VALUE.

radius: float[source]

A Float specifying the filter radius. The default value is double the average edge length of the model.

setValues(region, radius=None, filterRadiusBy=abaqusConstants.ABSOLUTE_VALUE, filterCheckRegion=abaqusConstants.FILTER_REGION)[source]

This method modifies the BeadFilter object.

Parameters:
  • region (Region) – A Region object specifying the region to which the geometric restriction is applied.

  • radius (Optional[float], default: None) – A Float specifying the filter radius. The default value is double the average edge length of the model.

  • filterRadiusBy (Literal[ABSOLUTE_VALUE, RELATIVE], default: ABSOLUTE_VALUE) – The SymbolicConstant defines whether the filter radius is in absolute or relative units. For an absolute radius, the value is ABSOLUTE_VALUE. For a relative radius, the value is RELATIVE. The default value is ABSOLUTE_VALUE.

  • filterCheckRegion (Union[Literal[FILTER_REGION], Region], default: FILTER_REGION) – The SymbolicConstant FILTER_REGION or a Region object specifying the filter check region. If the value is FILTER_REGION, the value of the region is used as both the filter region and the filter check region. The default value is FILTER_REGION.

class GeometricRestriction[source]

Bases: object

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

Note

This object can be accessed by:

import optimization
mdb.models[name].optimizationTasks[name].geometricRestrictions[name]

Member Details:

name: str = ''[source]

A String specifying the geometric restriction repository key.

region: Region = <abaqus.Region.Region.Region object>[source]

A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

class BeadFixedRegion(name, region, csys=None, u1=0, u2=0, u3=0)[source]

Bases: GeometricRestriction

The BeadFixedRegion object defines a fixed region geometric restriction. The BeadFixedRegion object is derived from the GeometricRestriction object.

Note

This object can be accessed by:

import optimization
mdb.models[name].optimizationTasks[name].geometricRestrictions[name]

This method creates a BeadFixedRegion object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].BeadFixedRegion
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

  • u1 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to fix the region in the 1-direction. The default value is OFF.

  • u2 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to fix the region in the 2-direction. The default value is OFF.

  • u3 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to fix the region in the 3-direction. The default value is OFF.

Returns:

A BeadFixedRegion object.

Return type:

BeadFixedRegion

Member Details:

csys: Optional[int] = None[source]

None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

setValues(csys=None, u1=0, u2=0, u3=0)[source]

This method modifies the BeadFixedRegion object.

Parameters:
  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

  • u1 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to fix the region in the 1-direction. The default value is OFF.

  • u2 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to fix the region in the 2-direction. The default value is OFF.

  • u3 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to fix the region in the 3-direction. The default value is OFF.

u1: Union[AbaqusBoolean, bool] = 0[source]

A Boolean specifying whether to fix the region in the 1-direction. The default value is OFF.

u2: Union[AbaqusBoolean, bool] = 0[source]

A Boolean specifying whether to fix the region in the 2-direction. The default value is OFF.

u3: Union[AbaqusBoolean, bool] = 0[source]

A Boolean specifying whether to fix the region in the 3-direction. The default value is OFF.

class BeadGrowth(name, region, beadGrowth=0, shrink=0)[source]

Bases: GeometricRestriction

The BeadGrowth object defines a growth geometric restriction. The BeadGrowth object is derived from the GeometricRestriction object.

Note

This object can be accessed by:

import optimization
mdb.models[name].optimizationTasks[name].geometricRestrictions[name]

This method creates a BeadGrowth object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].BeadGrowth
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied.

  • beadGrowth (float, default: 0) – A Float specifying the maximum optimization displacement in the growth direction. Either beadGrowth or shrink or both must be specified. The default value is 0.0.

  • shrink (float, default: 0) – A Float specifying the maximum optimization displacement in the shrink direction. Either beadGrowth or shrink or both must be specified The default value is 0.0.

Returns:

A BeadGrowth object.

Return type:

BeadGrowth

Member Details:

beadGrowth: float = 0[source]

A Float specifying the maximum optimization displacement in the growth direction. Either beadGrowth or shrink or both must be specified. The default value is 0.0.

setValues(beadGrowth=0, shrink=0)[source]

This method modifies the BeadGrowth object.

Parameters:
  • beadGrowth (float, default: 0) – A Float specifying the maximum optimization displacement in the growth direction. Either beadGrowth or shrink or both must be specified. The default value is 0.0.

  • shrink (float, default: 0) – A Float specifying the maximum optimization displacement in the shrink direction. Either beadGrowth or shrink or both must be specified The default value is 0.0.

shrink: float = 0[source]

A Float specifying the maximum optimization displacement in the shrink direction. Either beadGrowth or shrink or both must be specified The default value is 0.0.

class BeadPenetrationCheck(name, beadPenetrationCheckRegion, region)[source]

Bases: GeometricRestriction

The BeadPenetrationCheck object defines a penetration check geometric restriction. The BeadPenetrationCheck object is derived from the GeometricRestriction object.

Note

This object can be accessed by:

import optimization
mdb.models[name].optimizationTasks[name].geometricRestrictions[name]

This method creates a BeadPenetrationCheck object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].BeadPenetrationCheck
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • beadPenetrationCheckRegion (Region) – A Region object specifying the penetration check region.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied.

Returns:

A BeadPenetrationCheck object.

Return type:

BeadPenetrationCheck

Member Details:

beadPenetrationCheckRegion: Region[source]

A Region object specifying the penetration check region.

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

This method modifies the BeadPenetrationCheck object.

class BeadPlanarSymmetry(name, region, axis=abaqusConstants.AXIS_1, csys=None)[source]

Bases: GeometricRestriction

The BeadPlanarSymmetry object defines a bead planar symmetry geometric restriction. The BeadPlanarSymmetry object is derived from the GeometricRestriction object.

Note

This object can be accessed by:

import optimization
mdb.models[name].optimizationTasks[name].geometricRestrictions[name]

This method creates a BeadPlanarSymmetry object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].BeadPlanarSymmetry
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied.

  • axis (Literal[AXIS_1, AXIS_3, AXIS_2], default: AXIS_1) – A SymbolicConstant specifying the axis of symmetry. Possible values are AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_1.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

Returns:

A BeadPlanarSymmetry object.

Return type:

BeadPlanarSymmetry

Member Details:

axis: SymbolicConstant = 'AXIS_1'[source]

A SymbolicConstant specifying the axis of symmetry. Possible values are AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_1.

csys: Optional[int] = None[source]

None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

setValues(axis=abaqusConstants.AXIS_1, csys=None)[source]

This method modifies the BeadPlanarSymmetry object.

Parameters:
  • axis (Literal[AXIS_1, AXIS_3, AXIS_2], default: AXIS_1) – A SymbolicConstant specifying the axis of symmetry. Possible values are AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_1.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

class BeadPointSymmetry(name, region, csys=None)[source]

Bases: GeometricRestriction

The BeadPointSymmetry object defines a point symmetry geometric restriction. The BeadPointSymmetry object is derived from the GeometricRestriction object.

Note

This object can be accessed by:

import optimization
mdb.models[name].optimizationTasks[name].geometricRestrictions[name]

This method creates a BeadPointSymmetry object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].BeadPointSymmetry
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the position of the symmetry point defined as the origin of a local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

Returns:

A BeadPointSymmetry object.

Return type:

BeadPointSymmetry

Member Details:

csys: Optional[int] = None[source]

None or a DatumCsys object specifying the position of the symmetry point defined as the origin of a local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

setValues(csys=None)[source]

This method modifies the BeadPointSymmetry object.

Parameters:

csys (Optional[int], default: None) – None or a DatumCsys object specifying the position of the symmetry point defined as the origin of a local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

class BeadRotationalSymmetry(name, angle, region, axis=abaqusConstants.AXIS_1, csys=None)[source]

Bases: GeometricRestriction

The BeadRotationalSymmetry object defines a bead rotational symmetry geometric restriction. The BeadRotationalSymmetry object is derived from the GeometricRestriction object.

Note

This object can be accessed by:

import optimization
mdb.models[name].optimizationTasks[name].geometricRestrictions[name]

This method creates a BeadRotationalSymmetry object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].BeadRotationalSymmetry
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • angle (float) – A Float specifying the repeating segment size, an angle in degrees.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied.

  • axis (Literal[AXIS_1, AXIS_3, AXIS_2], default: AXIS_1) – A SymbolicConstant specifying the axis of symmetry. Possible values are AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_1.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

Returns:

A BeadRotationalSymmetry object.

Return type:

BeadRotationalSymmetry

Member Details:

angle: float[source]

A Float specifying the repeating segment size, an angle in degrees.

axis: SymbolicConstant = 'AXIS_1'[source]

A SymbolicConstant specifying the axis of symmetry. Possible values are AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_1.

csys: Optional[int] = None[source]

None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

setValues(axis=abaqusConstants.AXIS_1, csys=None)[source]

This method modifies the BeadRotationalSymmetry object.

Parameters:
  • axis (Literal[AXIS_1, AXIS_3, AXIS_2], default: AXIS_1) – A SymbolicConstant specifying the axis of symmetry. Possible values are AXIS_1, AXIS_2, and AXIS_3. The default value is AXIS_1.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

class BeadTask(name, abaqusSensitivities=True, algorithm=abaqusConstants.GENERAL_OPTIMIZATION, areBCRegionsFrozen=0, beadIter=1, beadMaxMembraneStress=0, beadMinStress=0, beadPerturbation=0, beadWidth=abaqusConstants.DEFAULT, curveSmooth=5, filterRadius=4, filterRadiusBy=abaqusConstants.VALUE, flipNormalDir=0, frozenBoundaryConditionRegion=abaqusConstants.MODEL, isSensCalcOnlyOnDesignNodes=0, modeTrackingRegion=abaqusConstants.MODEL, nodalMoveLimit=0, nodeSmooth=abaqusConstants.DEFAULT, nodeUpdateStrategy=abaqusConstants.CONSERVATIVE, numTrackedModes=5, updateShapeBasisVectors=abaqusConstants.EVERY_CYCLE, groupOperator=0)[source]

Bases: OptimizationTask

The BeadTask object defines a bead task. The BeadTask object is derived from the OptimizationTask object.

Note

This object can be accessed by:

import optimization
mdb.models[name].optimizationTasks[name]

This method creates a BeadTask object.

Note

This function can be accessed by:

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

  • abaqusSensitivities (Union[AbaqusBoolean, bool], default: True) –

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

    New in version 2019: The abaqusSensitivities argument was added.

  • algorithm (Literal[CONDITION_BASED_OPTIMIZATION, GENERAL_OPTIMIZATION], default: GENERAL_OPTIMIZATION) – A SymbolicConstant specifying the optimization task algorithm. Possible values are GENERAL_OPTIMIZATION and CONDITION_BASED_OPTIMIZATION. The default value is GENERAL_OPTIMIZATION.

  • areBCRegionsFrozen (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to exclude elements with boundary conditions from the optimization. The default value is OFF.

  • beadIter (int, default: 1) – An int specifying the step size of the optimization. The default value is 1.

  • beadMaxMembraneStress (float, default: 0) – A float specifying maximum membrane/bending stress. The default value is 0.1.

  • beadMinStress (float, default: 0) – A float specifying minimum stress. The default value is 0.001.

  • beadPerturbation (float, default: 0) – A Sets perturbation size for finite differences. The default value is 0.0001.

  • beadWidth (Literal[DEFAULT], default: DEFAULT) – A SymbolicConstant specifying the Optimization product default or a float specifying the bead width. The default value is DEFAULT.

  • curveSmooth (float, default: 5) – A float specifying relative value to the middle element edge length such that normals in this area do not cross each other. The default value is 5.

  • filterRadius (float, default: 4) – A float specifying the filter radius. The default value is 4.

  • filterRadiusBy (Literal[VALUE, REFERENCE], default: VALUE) – A SymbolicConstant specifying the method used to define filter radius. Possible values are VALUE and REFERENCE. The default is VALUE.

  • flipNormalDir (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether the growth direction is along the normal direction of elements or opposite to the normal direction. The default value is OFF

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

  • isSensCalcOnlyOnDesignNodes (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to calculate the sensitivities only on design nodes or the whole model. The default value is ON

  • modeTrackingRegion (Literal[MODEL], default: MODEL) – The SymbolicConstant MODEL or a Region object specifying the region to use for mode tracking. The default value is MODEL.

  • nodalMoveLimit (float, default: 0) – A Float specifying the maximum change in nodal displacement per design cycle. The default value is 0.1.

  • nodeSmooth (Literal[DEFAULT], default: DEFAULT) – A SymbolicConstant specifying the Optimization product default or a float specifying the node smooth. The default value is DEFAULT.

  • nodeUpdateStrategy (Literal[AGGRESSIVE, NORMAL, CONSERVATIVE], default: CONSERVATIVE) – A SymbolicConstant specifying the strategy for how the nodal displacements are updated in the method of moving asymptotes. Possible values are NORMAL, CONSERVATIVE, and AGGRESSIVE. The default value is CONSERVATIVE.

  • numTrackedModes (int, default: 5) – An Int specifying the number of modes included in mode tracking. The default value is 5.

  • updateShapeBasisVectors (Literal[EVERY_CYCLE, FIRST_CYCLE], default: EVERY_CYCLE) – A SymbolicConstant specifying whether to update shape basis vectors in the first design cycle or every design cycle. Possible values are EVERY_CYCLE and FIRST_CYCLE. The default value is EVERY_CYCLE.

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

    A Boolean specifying whether the group in the design response will be evaluated using the existing algorithm or a new algorithm based on Abaqus sensitivities. The default value of False means that the existing algorithm will be used.

    New in version 2022: The groupOperator argument was added.

Returns:

A BeadTask object.

Return type:

BeadTask

Member Details:

abaqusSensitivities: Boolean = False[source]

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

New in version 2019: The abaqusSensitivities attribute was added.

algorithm: SymbolicConstant = 'GENERAL_OPTIMIZATION'[source]

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

areBCRegionsFrozen: Boolean = 0[source]

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

beadIter: int = 1[source]

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

beadMaxMembraneStress: float = 0[source]

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

beadMinStress: float = 0[source]

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

beadPerturbation: float = 0[source]

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

beadWidth: SymbolicConstant = 'DEFAULT'[source]

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

curveSmooth: float = 5[source]

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

designResponses: dict[str, DesignResponse] = {}[source]

A repository of DesignResponse objects.

filterRadius: float = 4[source]

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

filterRadiusBy: SymbolicConstant = 'VALUE'[source]

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

flipNormalDir: Boolean = 0[source]

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

frozenBoundaryConditionRegion: SymbolicConstant = 'MODEL'[source]

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

geometricRestrictions: dict[str, GeometricRestriction] = {}[source]

A repository of GeometricRestriction objects.

groupOperator: Boolean = 0[source]

A Boolean specifying whether the group in the design response will be evaluated using the existing algorithm or a new algorithm based on Abaqus sensitivities. The default value of False means that the existing algorithm will be used.

New in version 2022: The groupSensitivities attribute was added.

isSensCalcOnlyOnDesignNodes: Boolean = 0[source]

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

modeTrackingRegion: SymbolicConstant = 'MODEL'[source]

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

nodalMoveLimit: float = 0[source]

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

nodeSmooth: SymbolicConstant = 'DEFAULT'[source]

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

nodeUpdateStrategy: SymbolicConstant = 'CONSERVATIVE'[source]

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

numTrackedModes: int = 5[source]

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

objectiveFunctions: dict[str, ObjectiveFunction] = {}[source]

A repository of ObjectiveFunction objects.

optimizationConstraints: dict[str, OptimizationConstraint] = {}[source]

A repository of OptimizationConstraint objects.

setValues(abaqusSensitivities=True, algorithm=abaqusConstants.GENERAL_OPTIMIZATION, areBCRegionsFrozen=0, beadIter=1, beadMaxMembraneStress=0, beadMinStress=0, beadPerturbation=0, beadWidth=abaqusConstants.DEFAULT, curveSmooth=5, filterRadius=4, filterRadiusBy=abaqusConstants.VALUE, flipNormalDir=0, frozenBoundaryConditionRegion=abaqusConstants.MODEL, isSensCalcOnlyOnDesignNodes=0, modeTrackingRegion=abaqusConstants.MODEL, nodalMoveLimit=0, nodeSmooth=abaqusConstants.DEFAULT, nodeUpdateStrategy=abaqusConstants.CONSERVATIVE, numTrackedModes=5, updateShapeBasisVectors=abaqusConstants.EVERY_CYCLE, groupOperator=0)[source]

This method modifies the BeadTask object.

Parameters:
  • abaqusSensitivities (Union[AbaqusBoolean, bool], default: True) –

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

    New in version 2019: The abaqusSensitivities argument was added.

  • algorithm (Literal[CONDITION_BASED_OPTIMIZATION, GENERAL_OPTIMIZATION], default: GENERAL_OPTIMIZATION) – A SymbolicConstant specifying the optimization task algorithm. Possible values are GENERAL_OPTIMIZATION and CONDITION_BASED_OPTIMIZATION. The default value is GENERAL_OPTIMIZATION.

  • areBCRegionsFrozen (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to exclude elements with boundary conditions from the optimization. The default value is OFF.

  • beadIter (int, default: 1) – An int specifying the step size of the optimization. The default value is 1.

  • beadMaxMembraneStress (float, default: 0) – A float specifying maximum membrane/bending stress. The default value is 0.1.

  • beadMinStress (float, default: 0) – A float specifying minimum stress. The default value is 0.001.

  • beadPerturbation (float, default: 0) – A Sets perturbation size for finite differences. The default value is 0.0001.

  • beadWidth (Literal[DEFAULT], default: DEFAULT) – A SymbolicConstant specifying the Optimization product default or a float specifying the bead width. The default value is DEFAULT.

  • curveSmooth (float, default: 5) – A float specifying relative value to the middle element edge length such that normals in this area do not cross each other. The default value is 5.

  • filterRadius (float, default: 4) – A float specifying the filter radius. The default value is 4.

  • filterRadiusBy (Literal[VALUE, REFERENCE], default: VALUE) – A SymbolicConstant specifying the method used to define filter radius. Possible values are VALUE and REFERENCE. The default is VALUE.

  • flipNormalDir (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether the growth direction is along the normal direction of elements or opposite to the normal direction. The default value is OFF

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

  • isSensCalcOnlyOnDesignNodes (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to calculate the sensitivities only on design nodes or the whole model. The default value is ON

  • modeTrackingRegion (Literal[MODEL], default: MODEL) – The SymbolicConstant MODEL or a Region object specifying the region to use for mode tracking. The default value is MODEL.

  • nodalMoveLimit (float, default: 0) – A Float specifying the maximum change in nodal displacement per design cycle. The default value is 0.1.

  • nodeSmooth (Literal[DEFAULT], default: DEFAULT) – A SymbolicConstant specifying the Optimization product default or a float specifying the node smooth. The default value is DEFAULT.

  • nodeUpdateStrategy (Literal[AGGRESSIVE, NORMAL, CONSERVATIVE], default: CONSERVATIVE) – A SymbolicConstant specifying the strategy for how the nodal displacements are updated in the method of moving asymptotes. Possible values are NORMAL, CONSERVATIVE, and AGGRESSIVE. The default value is CONSERVATIVE.

  • numTrackedModes (int, default: 5) – An Int specifying the number of modes included in mode tracking. The default value is 5.

  • updateShapeBasisVectors (Literal[EVERY_CYCLE, FIRST_CYCLE], default: EVERY_CYCLE) – A SymbolicConstant specifying whether to update shape basis vectors in the first design cycle or every design cycle. Possible values are EVERY_CYCLE and FIRST_CYCLE. The default value is EVERY_CYCLE.

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

    A Boolean specifying whether the group in the design response will be evaluated using the existing algorithm or a new algorithm based on Abaqus sensitivities. The default value of False means that the existing algorithm will be used.

    New in version 2022: The groupOperator argument was added.

updateShapeBasisVectors: SymbolicConstant = 'EVERY_CYCLE'[source]

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

class DesignResponse[source]

Bases: object

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

Note

This object can be accessed by:

import optimization
mdb.models[name].optimizationTasks[name].designResponses[name]

Member Details:

name: str = ''[source]

A String specifying the design response repository key.

class ObjectiveFunction(name, objectives, target=abaqusConstants.MINIMIZE)[source]

Bases: object

The ObjectiveFunction object defines the objective of the optimization.

Note

This object can be accessed by:

import optimization
mdb.models[name].optimizationTasks[name].objectiveFunctions[name]

This method creates an ObjectiveFunction object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].ObjectiveFunction
Parameters:
  • name (str) – A String specifying the objective function repository key.

  • objectives (List[OptimizationObjective]) – An OptimizationObjectiveArray object.

  • target (Literal[MINIMIZE_MAXIMUM, MINIMIZE, MAXIMIZE], default: MINIMIZE) – A SymbolicConstant specifying the target of the objective function. Possible values are MINIMIZE, MAXIMIZE, and MINIMIZE_MAXIMUM. The default value is MINIMIZE.

Returns:

An ObjectiveFunction object.

Return type:

ObjectiveFunction

Raises:
  • InvalidNameError –

  • RangeError –

Member Details:

name: str[source]

A String specifying the objective function repository key.

objectives: List[OptimizationObjective] = [][source]

Optimization objectives

setValues(target=abaqusConstants.MINIMIZE)[source]

This method modifies the ObjectiveFunction object.

Parameters:

target (Literal[MINIMIZE_MAXIMUM, MINIMIZE, MAXIMIZE], default: MINIMIZE) – A SymbolicConstant specifying the target of the objective function. Possible values are MINIMIZE, MAXIMIZE, and MINIMIZE_MAXIMUM. The default value is MINIMIZE.

Raises:

RangeError –

target: SymbolicConstant = 'MINIMIZE'[source]

A SymbolicConstant specifying the target of the objective function. Possible values are MINIMIZE, MAXIMIZE, and MINIMIZE_MAXIMUM. The default value is MINIMIZE.

class OptimizationConstraint(name, designResponse, restrictionValue, restrictionMethod=abaqusConstants.ABSOLUTE_EQUAL)[source]

Bases: object

The OptimizationConstraint object constrains an optimization from making changes to the topology of the model.

Note

This object can be accessed by:

import optimization
mdb.models[name].optimizationTasks[name].optimizationConstraints[name]

This method creates an OptimizationConstraint object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].OptimizationConstraint
Parameters:
  • name (str) – A String specifying the optimization constraint repository key.

  • designResponse (str) – A String specifying the name of the design response to constrain.

  • restrictionValue (float) – A Float specifying the value to which the design response should be constrained.

  • restrictionMethod (Literal[ABSOLUTE_LESS_THAN_EQUAL, RELATIVE_GREATER_THAN_EQUAL, ABSOLUTE_GREATER_THAN_EQUAL, RELATIVE_EQUAL, ABSOLUTE_EQUAL, RELATIVE_LESS_THAN_EQUAL], default: ABSOLUTE_EQUAL) – A SymbolicConstant specifying the method used to constrain the design response. Possible values are ABSOLUTE_EQUAL, ABSOLUTE_GREATER_THAN_EQUAL, ABSOLUTE_LESS_THAN_EQUAL, RELATIVE_EQUAL, RELATIVE_GREATER_THAN_EQUAL, and RELATIVE_LESS_THAN_EQUAL. The default value is ABSOLUTE_EQUAL.

Returns:

An OptimizationConstraint object.

Return type:

OptimizationConstraint

Raises:
  • InvalidNameError –

  • RangeError –

Member Details:

designResponse: str[source]

A String specifying the name of the design response to constrain.

name: str[source]

A String specifying the optimization constraint repository key.

restrictionMethod: SymbolicConstant = 'ABSOLUTE_EQUAL'[source]

A SymbolicConstant specifying the method used to constrain the design response. Possible values are ABSOLUTE_EQUAL, ABSOLUTE_GREATER_THAN_EQUAL, ABSOLUTE_LESS_THAN_EQUAL, RELATIVE_EQUAL, RELATIVE_GREATER_THAN_EQUAL, and RELATIVE_LESS_THAN_EQUAL. The default value is ABSOLUTE_EQUAL.

restrictionValue: float[source]

A Float specifying the value to which the design response should be constrained.

setValues(restrictionMethod=abaqusConstants.ABSOLUTE_EQUAL)[source]

This method modifies the OptimizationConstraint object.

Parameters:

restrictionMethod (Literal[ABSOLUTE_LESS_THAN_EQUAL, RELATIVE_GREATER_THAN_EQUAL, ABSOLUTE_GREATER_THAN_EQUAL, RELATIVE_EQUAL, ABSOLUTE_EQUAL, RELATIVE_LESS_THAN_EQUAL], default: ABSOLUTE_EQUAL) – A SymbolicConstant specifying the method used to constrain the design response. Possible values are ABSOLUTE_EQUAL, ABSOLUTE_GREATER_THAN_EQUAL, ABSOLUTE_LESS_THAN_EQUAL, RELATIVE_EQUAL, RELATIVE_GREATER_THAN_EQUAL, and RELATIVE_LESS_THAN_EQUAL. The default value is ABSOLUTE_EQUAL.

Raises:

RangeError –

class CombinedTermDesignResponse(name, terms, filterMaxRadius=None, filterExponent=1, filterRadiusReduction=0, highCutOff=None, lowCutOff=0, method=abaqusConstants.ADD, weights=())[source]

Bases: DesignResponse

The CombinedTermDesignResponse object defines a combined-term design response. The CombinedTermDesignResponse object is derived from the DesignResponse object.

Note

This object can be accessed by:

import optimization
mdb.models[name].optimizationTasks[name].designResponses[name]

This method creates a CombinedTermDesignResponse object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].CombinedTermDesignResponse
Parameters:
  • name (str) – A String specifying the design response repository key.

  • terms (tuple) – A sequence of Strings specifying the names of the design responses to combine.

  • filterMaxRadius (Optional[str], default: None) – None or a sequence of Floats specifying the maximum radius of influence used when method is FILTER. The default value is None.

  • filterExponent (float, default: 1) – A Float specifying the exponent used when method is FILTER. The default value is 1.0.

  • filterRadiusReduction (float, default: 0) – A Float specifying the reduction of the radius depending on surface bending, used when method is FILTER. The default value is 0.2.

  • highCutOff (Optional[str], default: None) – None or a sequence of Floats specifying the upper bound of the vector value used when method is CUT_OFF. All values greater than the highCutOff are set to the highCutOff value. The default value is None.

  • lowCutOff (float, default: 0) – A Float specifying the lower bound of the vector value used when method is CUT_OFF. All values less than the lowCutOff are treated as 0. The default value is 0.0.

  • method (Literal[ABSOLUTE_DIFFERENCE, NORM, NTH_ROOT, ABSOLUTE_VALUE, SQUARE_ROOT, COSINE, DIVIDE, MULTIPLY, EXPONENTIAL, CUT_OFF, SINE, SUBTRACT, SIGN, WEIGHTED_ADD, FILTER, NTH_POWER, LOG, DELTA_OVER_6_ITERATIONS, DELTA_OVER_2_ITERATIONS, TANGENT, DELTA_OVER_3_ITERATIONS, NORM_FIRST, MAXIMUM, NEAREST_INTEGER, INTEGER, DELTA_OVER_4_ITERATIONS, NATURAL_LOG, DELTA_OVER_1_ITERATION, DELTA_OVER_5_ITERATIONS, MINIMUM, ADD], default: ADD) –

    A SymbolicConstant specifying the method used to combine selected design responses. Possible values are:

    • ABSOLUTE_DIFFERENCE

    • ABSOLUTE_VALUE

    • ADD

    • COSINE

    • CUT_OFF

    • DELTA_OVER_1_ITERATION

    • DELTA_OVER_2_ITERATIONS

    • DELTA_OVER_3_ITERATIONS

    • DELTA_OVER_4_ITERATIONS

    • DELTA_OVER_5_ITERATIONS

    • DELTA_OVER_6_ITERATIONS

    • DIVIDE

    • EXPONENTIAL

    • FILTER

    • INTEGER

    • LOG

    • MAXIMUM

    • MINIMUM

    • MULTIPLY

    • NATURAL_LOG

    • NEAREST_INTEGER

    • NORM

    • NORM_FIRST

    • NTH_POWER

    • NTH_ROOT

    • SIGN

    • SINE

    • SQUARE_ROOT

    • SUBTRACT

    • TANGENT

    • WEIGHTED_ADD

    The default value is ADD.

  • weights (tuple, default: ()) – A sequence of Floats specifying the weights to apply to the list of design responses used when method is WEIGHTED_ADD. The default value is an empty sequence.

Returns:

A CombinedTermDesignResponse object.

Return type:

CombinedTermDesignResponse

Member Details:

filterExponent: float = 1[source]

A Float specifying the exponent used when method is FILTER. The default value is 1.0.

filterMaxRadius: Optional[str] = None[source]

None or a sequence of Floats specifying the maximum radius of influence used when method is FILTER. The default value is None.

filterRadiusReduction: float = 0[source]

A Float specifying the reduction of the radius depending on surface bending, used when method is FILTER. The default value is 0.2.

highCutOff: Optional[str] = None[source]

None or a sequence of Floats specifying the upper bound of the vector value used when method is CUT_OFF. All values greater than the highCutOff are set to the highCutOff value. The default value is None.

lowCutOff: float = 0[source]

A Float specifying the lower bound of the vector value used when method is CUT_OFF. All values less than the lowCutOff are treated as 0. The default value is 0.0.

method: SymbolicConstant = 'ADD'[source]
  • ABSOLUTE_DIFFERENCE

  • ABSOLUTE_VALUE

  • ADD

  • COSINE

  • CUT_OFF

  • DELTA_OVER_1_ITERATION

  • DELTA_OVER_2_ITERATIONS

  • DELTA_OVER_3_ITERATIONS

  • DELTA_OVER_4_ITERATIONS

  • DELTA_OVER_5_ITERATIONS

  • DELTA_OVER_6_ITERATIONS

  • DIVIDE

  • EXPONENTIAL

  • FILTER

  • INTEGER

  • LOG

  • MAXIMUM

  • MINIMUM

  • MULTIPLY

  • NATURAL_LOG

  • NEAREST_INTEGER

  • NORM

  • NORM_FIRST

  • NTH_POWER

  • NTH_ROOT

  • SIGN

  • SINE

  • SQUARE_ROOT

  • SUBTRACT

  • TANGENT

  • WEIGHTED_ADD

The default value is ADD.

setValues(filterMaxRadius=None, filterExponent=1, filterRadiusReduction=0, highCutOff=None, lowCutOff=0, method=abaqusConstants.ADD, weights=())[source]

This method modifies the CombinedTermDesignResponse object.

Parameters:
  • filterMaxRadius (Optional[str], default: None) – None or a sequence of Floats specifying the maximum radius of influence used when method is FILTER. The default value is None.

  • filterExponent (float, default: 1) – A Float specifying the exponent used when method is FILTER. The default value is 1.0.

  • filterRadiusReduction (float, default: 0) – A Float specifying the reduction of the radius depending on surface bending, used when method is FILTER. The default value is 0.2.

  • highCutOff (Optional[str], default: None) – None or a sequence of Floats specifying the upper bound of the vector value used when method is CUT_OFF. All values greater than the highCutOff are set to the highCutOff value. The default value is None.

  • lowCutOff (float, default: 0) – A Float specifying the lower bound of the vector value used when method is CUT_OFF. All values less than the lowCutOff are treated as 0. The default value is 0.0.

  • method (Literal[ABSOLUTE_DIFFERENCE, NORM, NTH_ROOT, ABSOLUTE_VALUE, SQUARE_ROOT, COSINE, DIVIDE, MULTIPLY, EXPONENTIAL, CUT_OFF, SINE, SUBTRACT, SIGN, WEIGHTED_ADD, FILTER, NTH_POWER, LOG, DELTA_OVER_6_ITERATIONS, DELTA_OVER_2_ITERATIONS, TANGENT, DELTA_OVER_3_ITERATIONS, NORM_FIRST, MAXIMUM, NEAREST_INTEGER, INTEGER, DELTA_OVER_4_ITERATIONS, NATURAL_LOG, DELTA_OVER_1_ITERATION, DELTA_OVER_5_ITERATIONS, MINIMUM, ADD], default: ADD) –

    A SymbolicConstant specifying the method used to combine selected design responses. Possible values are:

    • ABSOLUTE_DIFFERENCE

    • ABSOLUTE_VALUE

    • ADD

    • COSINE

    • CUT_OFF

    • DELTA_OVER_1_ITERATION

    • DELTA_OVER_2_ITERATIONS

    • DELTA_OVER_3_ITERATIONS

    • DELTA_OVER_4_ITERATIONS

    • DELTA_OVER_5_ITERATIONS

    • DELTA_OVER_6_ITERATIONS

    • DIVIDE

    • EXPONENTIAL

    • FILTER

    • INTEGER

    • LOG

    • MAXIMUM

    • MINIMUM

    • MULTIPLY

    • NATURAL_LOG

    • NEAREST_INTEGER

    • NORM

    • NORM_FIRST

    • NTH_POWER

    • NTH_ROOT

    • SIGN

    • SINE

    • SQUARE_ROOT

    • SUBTRACT

    • TANGENT

    • WEIGHTED_ADD

    The default value is ADD.

  • weights (tuple, default: ()) – A sequence of Floats specifying the weights to apply to the list of design responses used when method is WEIGHTED_ADD. The default value is an empty sequence.

terms: tuple[source]

A sequence of Strings specifying the names of the design responses to combine.

weights: tuple = ()[source]

A sequence of Floats specifying the weights to apply to the list of design responses used when method is WEIGHTED_ADD. The default value is an empty sequence.

class DesignDirection(name, region, csys=None, mainPoint=None, mainPointDetermination=abaqusConstants.MAXIMUM, movementRestriction=abaqusConstants.VECTOR, presumeFeasibleRegionAtStart=1, u1=1, u2=1, u3=1)[source]

Bases: GeometricRestriction

The DesignDirection object defines a design direction geometric restriction. The DesignDirection object is derived from the GeometricRestriction object.

Note

This object can be accessed by:

import optimization
mdb.models[name].optimizationTasks[name].geometricRestrictions[name]

This method creates a DesignDirection object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].DesignDirection
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

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

    None or a Region object specifying the main point used when mainPointDetermination is SPECIFY. The default value is None.

    Changed in version 2022: The argument masterPoint was renamed to mainPoint.

  • mainPointDetermination (Literal[SPECIFY, MINIMUM, MAXIMUM], default: MAXIMUM) –

    A SymbolicConstant specifying the rule for assigning point priority. Possible values are MAXIMUM, MINIMUM, and SPECIFY. The default value is MAXIMUM.

    Changed in version 2022: The argument masterPointDetermination was renamed to mainPointDetermination.

  • movementRestriction (Literal[MAGNITUDE, DIRECTION, VECTOR], default: VECTOR) – A SymbolicConstant specifying whether movement in the region should follow only the direction of the mainPoint, only the magnitude, or both the magnitude of the mainPoint and the directions specified by u1, u2 and u3. Possible values are DIRECTION, MAGNITUDE, and VECTOR. The default value is VECTOR.

  • presumeFeasibleRegionAtStart (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

  • u1 (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether movement in the region should follow the masterPoint in the 1-direction. This is used when movementRestriction is VECTOR. The default value is ON.

  • u2 (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether movement in the region should follow the masterPoint in the 2-direction. This is used when movementRestriction is VECTOR. The default value is ON.

  • u3 (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether movement in the region should follow the masterPoint in the 3-direction. This is used when movementRestriction is VECTOR. The default value is ON.

Returns:

A DesignDirection object.

Return type:

DesignDirection

Member Details:

csys: Optional[int] = None[source]

None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

mainPoint: Optional[str] = None[source]

None or a Region object specifying the main point used when mainPointDetermination is SPECIFY. The default value is None.

Changed in version 2022: The attribute masterPoint was renamed to mainPoint.

mainPointDetermination: SymbolicConstant = 'MAXIMUM'[source]

A SymbolicConstant specifying the rule for assigning point priority. Possible values are MAXIMUM, MINIMUM, and SPECIFY. The default value is MAXIMUM.

Changed in version 2022: The attribute masterPointDetermination was renamed to mainPointDetermination.

movementRestriction: SymbolicConstant = 'VECTOR'[source]

A SymbolicConstant specifying whether movement in the region should follow only the direction of the mainPoint, only the magnitude, or both the magnitude of the mainPoint and the directions specified by u1, u2 and u3. Possible values are DIRECTION, MAGNITUDE, and VECTOR. The default value is VECTOR.

presumeFeasibleRegionAtStart: Union[AbaqusBoolean, bool] = 1[source]

A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

setValues(csys=None, mainPoint=None, mainPointDetermination=abaqusConstants.MAXIMUM, movementRestriction=abaqusConstants.VECTOR, presumeFeasibleRegionAtStart=1, u1=1, u2=1, u3=1)[source]

This method modifies the DesignDirection object.

Parameters:
  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

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

    None or a Region object specifying the main point used when mainPointDetermination is SPECIFY. The default value is None.

    Changed in version 2022: The argument masterPoint was renamed to mainPoint.

  • mainPointDetermination (Literal[SPECIFY, MINIMUM, MAXIMUM], default: MAXIMUM) –

    A SymbolicConstant specifying the rule for assigning point priority. Possible values are MAXIMUM, MINIMUM, and SPECIFY. The default value is MAXIMUM.

    Changed in version 2022: The argument masterPointDetermination was renamed to mainPointDetermination.

  • movementRestriction (Literal[MAGNITUDE, DIRECTION, VECTOR], default: VECTOR) – A SymbolicConstant specifying whether movement in the region should follow only the direction of the mainPoint, only the magnitude, or both the magnitude of the mainPoint and the directions specified by u1, u2 and u3. Possible values are DIRECTION, MAGNITUDE, and VECTOR. The default value is VECTOR.

  • presumeFeasibleRegionAtStart (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

  • u1 (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether movement in the region should follow the masterPoint in the 1-direction. This is used when movementRestriction is VECTOR. The default value is ON.

  • u2 (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether movement in the region should follow the masterPoint in the 2-direction. This is used when movementRestriction is VECTOR. The default value is ON.

  • u3 (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether movement in the region should follow the masterPoint in the 3-direction. This is used when movementRestriction is VECTOR. The default value is ON.

u1: Union[AbaqusBoolean, bool] = 1[source]

A Boolean specifying whether movement in the region should follow the masterPoint in the 1-direction. This is used when movementRestriction is VECTOR. The default value is ON.

u2: Union[AbaqusBoolean, bool] = 1[source]

A Boolean specifying whether movement in the region should follow the masterPoint in the 2-direction. This is used when movementRestriction is VECTOR. The default value is ON.

u3: Union[AbaqusBoolean, bool] = 1[source]

A Boolean specifying whether movement in the region should follow the masterPoint in the 3-direction. This is used when movementRestriction is VECTOR. The default value is ON.

class DrillControl(name, clientDirection, region, csys=None, drawAngle=0, mainPoint=None, mainPointDetermination=abaqusConstants.MAXIMUM, presumeFeasibleRegionAtStart=1, tolerance1=0, tolerance2=0, tolerance3=0, undercutTolerance=0)[source]

Bases: GeometricRestriction

The DrillControl object defines a drill control geometric restriction. The DrillControl object is derived from the GeometricRestriction object.

Note

This object can be accessed by:

import optimization
mdb.models[name].optimizationTasks[name].geometricRestrictions[name]

This method creates a DrillControl object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].DrillControl
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • clientDirection (tuple) – A VertexArray object of length 2 specifying the direction of the drill axis positioned at the csys origin. Instead of through a ConstrainedSketchVertex, each point may be specified through a tuple of coordinates.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

  • drawAngle (float, default: 0) – A Float specifying the draw angle. The default value is 0.0.

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

    None or a Region object specifying the main point used when mainPointDetermination is SPECIFY. The default value is None.

    Changed in version 2022: The argument masterPoint was renamed to mainPoint.

  • mainPointDetermination (Literal[SPECIFY, MINIMUM, MAXIMUM], default: MAXIMUM) –

    A SymbolicConstant specifying the rule for assigning point priority. Possible values are MAXIMUM, MINIMUM, and SPECIFY. The default value is MAXIMUM.

    Changed in version 2022: The argument masterPointDetermination was renamed to mainPointDetermination.

  • presumeFeasibleRegionAtStart (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

  • tolerance1 (float, default: 0) – A Float specifying the geometric tolerance in the 1-direction. The default value is 0.01.

  • tolerance2 (float, default: 0) – A Float specifying the geometric tolerance in the 2-direction. The default value is 0.01.

  • tolerance3 (float, default: 0) – A Float specifying the geometric tolerance in the 3-direction. The default value is 0.01.

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

Returns:

A DrillControl object.

Return type:

DrillControl

Member Details:

clientDirection: tuple[source]

A VertexArray object of length 2 specifying the direction of the drill axis positioned at the csys origin. Instead of through a ConstrainedSketchVertex, each point may be specified through a tuple of coordinates.

csys: Optional[int] = None[source]

None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

drawAngle: float = 0[source]

A Float specifying the draw angle. The default value is 0.0.

mainPoint: Optional[str] = None[source]

None or a Region object specifying the main point used when mainPointDetermination is SPECIFY. The default value is None.

Changed in version 2022: The attribute masterPoint was renamed to mainPoint.

mainPointDetermination: SymbolicConstant = 'MAXIMUM'[source]

A SymbolicConstant specifying the rule for assigning point priority. Possible values are MAXIMUM, MINIMUM, and SPECIFY. The default value is MAXIMUM.

Changed in version 2022: The attribute masterPointDetermination was renamed to mainPointDetermination.

presumeFeasibleRegionAtStart: Union[AbaqusBoolean, bool] = 1[source]

A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

setValues(csys=None, drawAngle=0, mainPoint=None, mainPointDetermination=abaqusConstants.MAXIMUM, presumeFeasibleRegionAtStart=1, tolerance1=0, tolerance2=0, tolerance3=0, undercutTolerance=0)[source]

This method modifies the DrillControl object.

Parameters:
  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

  • drawAngle (float, default: 0) – A Float specifying the draw angle. The default value is 0.0.

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

    None or a Region object specifying the main point used when mainPointDetermination is SPECIFY. The default value is None.

    Changed in version 2022: The argument masterPoint was renamed to mainPoint.

  • mainPointDetermination (Literal[SPECIFY, MINIMUM, MAXIMUM], default: MAXIMUM) –

    A SymbolicConstant specifying the rule for assigning point priority. Possible values are MAXIMUM, MINIMUM, and SPECIFY. The default value is MAXIMUM.

    Changed in version 2022: The argument masterPointDetermination was renamed to mainPointDetermination.

  • presumeFeasibleRegionAtStart (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

  • tolerance1 (float, default: 0) – A Float specifying the geometric tolerance in the 1-direction. The default value is 0.01.

  • tolerance2 (float, default: 0) – A Float specifying the geometric tolerance in the 2-direction. The default value is 0.01.

  • tolerance3 (float, default: 0) – A Float specifying the geometric tolerance in the 3-direction. The default value is 0.01.

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

tolerance1: float = 0[source]

A Float specifying the geometric tolerance in the 1-direction. The default value is 0.01.

tolerance2: float = 0[source]

A Float specifying the geometric tolerance in the 2-direction. The default value is 0.01.

tolerance3: float = 0[source]

A Float specifying the geometric tolerance in the 3-direction. The default value is 0.01.

undercutTolerance: float = 0[source]

A Float specifying the undercut tolerance. The default value is 0.0.

class FixedRegion(name, region, csys=None, presumeFeasibleRegionAtStart=1, u1=0, u2=0, u3=0)[source]

Bases: GeometricRestriction

The FixedRegion object defines a fixed region geometric restriction. The FixedRegion object is derived from the GeometricRestriction object.

Note

This object can be accessed by:

import optimization
mdb.models[name].optimizationTasks[name].geometricRestrictions[name]

This method creates a FixedRegion object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].FixedRegion
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

  • presumeFeasibleRegionAtStart (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

  • u1 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to fix the region in the 1-direction. The default value is OFF.

  • u2 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to fix the region in the 2-direction. The default value is OFF.

  • u3 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to fix the region in the 3-direction. The default value is OFF.

Returns:

A FixedRegion object.

Return type:

FixedRegion

Member Details:

csys: Optional[int] = None[source]

None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

presumeFeasibleRegionAtStart: Union[AbaqusBoolean, bool] = 1[source]

A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

setValues(csys=None, presumeFeasibleRegionAtStart=1, u1=0, u2=0, u3=0)[source]

This method modifies the FixedRegion object.

Parameters:
  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

  • presumeFeasibleRegionAtStart (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

  • u1 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to fix the region in the 1-direction. The default value is OFF.

  • u2 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to fix the region in the 2-direction. The default value is OFF.

  • u3 (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether to fix the region in the 3-direction. The default value is OFF.

u1: Union[AbaqusBoolean, bool] = 0[source]

A Boolean specifying whether to fix the region in the 1-direction. The default value is OFF.

u2: Union[AbaqusBoolean, bool] = 0[source]

A Boolean specifying whether to fix the region in the 2-direction. The default value is OFF.

u3: Union[AbaqusBoolean, bool] = 0[source]

A Boolean specifying whether to fix the region in the 3-direction. The default value is OFF.

class FrozenArea(name, region=<abaqus.Region.Region.Region object>)[source]

Bases: GeometricRestriction

The FrozenArea object defines a frozen area geometric restriction. The FrozenArea object is derived from the GeometricRestriction object.

Note

This object can be accessed by:

import optimization
mdb.models[name].optimizationTasks[name].geometricRestrictions[name]

This method creates a FrozenArea object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].FrozenArea
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region, default: <abaqus.Region.Region.Region object at 0x7f5b3e879b50>) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

Returns:

A FrozenArea object.

Return type:

FrozenArea

Member Details:

region: Region = <abaqus.Region.Region.Region object>[source]

A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

setValues(region=<abaqus.Region.Region.Region object>)[source]

This method modifies the FrozenArea object.

Parameters:

region (Region, default: <abaqus.Region.Region.Region object at 0x7f5b3e87af10>) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

class Growth(name, region, growth=0, presumeFeasibleRegionAtStart=1, shrink=0)[source]

Bases: GeometricRestriction

The Growth object defines a growth geometric restriction. The Growth object is derived from the GeometricRestriction object.

Note

This object can be accessed by:

import optimization
mdb.models[name].optimizationTasks[name].geometricRestrictions[name]

This method creates a Growth object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].Growth
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • growth (float, default: 0) – A Float specifying the maximum optimization displacement in the growth direction. Either growth or shrink or both must be specified. The default value is 0.0.

  • presumeFeasibleRegionAtStart (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

  • shrink (float, default: 0) – A Float specifying the maximum optimization displacement in the shrink direction. Either growth or shrink or both must be specified The default value is 0.0.

Returns:

A Growth object.

Return type:

Growth

Member Details:

growth: float = 0[source]

A Float specifying the maximum optimization displacement in the growth direction. Either growth or shrink or both must be specified. The default value is 0.0.

presumeFeasibleRegionAtStart: Union[AbaqusBoolean, bool] = 1[source]

A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

setValues(growth=0, presumeFeasibleRegionAtStart=1, shrink=0)[source]

This method modifies the Growth object.

Parameters:
  • growth (float, default: 0) – A Float specifying the maximum optimization displacement in the growth direction. Either growth or shrink or both must be specified. The default value is 0.0.

  • presumeFeasibleRegionAtStart (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

  • shrink (float, default: 0) – A Float specifying the maximum optimization displacement in the shrink direction. Either growth or shrink or both must be specified The default value is 0.0.

shrink: float = 0[source]

A Float specifying the maximum optimization displacement in the shrink direction. Either growth or shrink or both must be specified The default value is 0.0.

class LocalStopCondition(name, referenceFactor, comparisonOperation=abaqusConstants.LESS_THAN, identifier=abaqusConstants.MOVEMENT, identifierOperation=abaqusConstants.MAXIMUM, referenceDesignCycle=abaqusConstants.PREVIOUS, referenceOperation=abaqusConstants.ADD, region=abaqusConstants.MODEL)[source]

Bases: StopCondition

The LocalStopCondition object defines a local stop condition. The LocalStopCondition object is derived from the StopCondition object.

Note

This object can be accessed by:

import optimization
mdb.models[name].optimizationTasks[name].stopConditions[name]

This method creates a LocalStopCondition object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].LocalStopCondition
Parameters:
  • name (str) – A String specifying the stop condition repository key.

  • referenceFactor (float) – A Float specifying the factor used to modify the reference value.

  • comparisonOperation (Literal[EQUAL, GREATER_THAN_EQUAL, LESS_THAN_EQUAL, LESS_THAN, GREATER_THAN], default: LESS_THAN) – A SymbolicConstant specifying the operation used to compare the selected value to the reference value. Possible values are LESS_THAN, LESS_THAN_EQUAL, EQUAL, GREATER_THAN_EQUAL, and GREATER_THAN. The default value is LESS_THAN.

  • identifier (Literal[TOTAL_ABSOLUTE_MOVEMENT, GROWTH_MOVEMENT, SURFACE_POINT_EQUIV_STRESS, ABSOLUTE_GROWTH_MOVEMENT, TASK_REGION_EQUIV_STRESS, SHRINK_MOVEMENT, RESTRICTED_TASK_REGION_EQUIV_STRESS, EQUIV_STRESS, MOVEMENT, FREE_TASK_REGION_EQUIV_STRESS, ABSOLUTE_SHRINK_MOVEMENT], default: MOVEMENT) –

    A SymbolicConstant specifying the variable identifier of the compared value. Possible values are: - ABSOLUTE_GROWTH_MOVEMENT - ABSOLUTE_SHRINK_MOVEMENT - GROWTH_MOVEMENT - SHRINK_MOVEMENT - MOVEMENT - TOTAL_ABSOLUTE_MOVEMENT - EQUIV_STRESS - FREE_TASK_REGION_EQUIV_STRESS - RESTRICTED_TASK_REGION_EQUIV_STRESS - SURFACE_POINT_EQUIV_STRESS - TASK_REGION_EQUIV_STRESS

    The default value is MOVEMENT.

  • identifierOperation (Literal[SUM, MINIMUM, MAXIMUM], default: MAXIMUM) – A SymbolicConstant specifying the operation used to evaluate values in the region. Possible values are MAXIMUM, MINIMUM, and SUM. The default value is MAXIMUM.

  • referenceDesignCycle (Literal[PREVIOUS, FIRST], default: PREVIOUS) – A SymbolicConstant specifying the iteration from which a value is compared to the reference value. Possible values are FIRST and PREVIOUS. The default value is PREVIOUS.

  • referenceOperation (Literal[MULTIPLY, DIVIDE, SUBTRACT, ADD], default: ADD) – A SymbolicConstant specifying the operation used to modify the reference value by the reference factor. Possible values are ADD, DIVIDE, MULTIPLY, and SUBTRACT. The default value is ADD.

  • region (Literal[MODEL], default: MODEL) – The SymbolicConstant MODEL or a Region object specifying the region to which the stop condition is applied. The default value is MODEL.

Returns:

A LocalStopCondition object.

Return type:

LocalStopCondition

Member Details:

comparisonOperation: SymbolicConstant = 'LESS_THAN'[source]

A SymbolicConstant specifying the operation used to compare the selected value to the reference value. Possible values are LESS_THAN, LESS_THAN_EQUAL, EQUAL, GREATER_THAN_EQUAL, and GREATER_THAN. The default value is LESS_THAN.

identifier: SymbolicConstant = 'MOVEMENT'[source]

A SymbolicConstant specifying the variable identifier of the compared value. Possible values are:

  • ABSOLUTE_GROWTH_MOVEMENT

  • ABSOLUTE_SHRINK_MOVEMENT

  • GROWTH_MOVEMENT

  • SHRINK_MOVEMENT

  • MOVEMENT

  • TOTAL_ABSOLUTE_MOVEMENT

  • EQUIV_STRESS

  • FREE_TASK_REGION_EQUIV_STRESS

  • RESTRICTED_TASK_REGION_EQUIV_STRESS

  • SURFACE_POINT_EQUIV_STRESS

  • TASK_REGION_EQUIV_STRESS

The default value is MOVEMENT.

identifierOperation: SymbolicConstant = 'MAXIMUM'[source]

A SymbolicConstant specifying the operation used to evaluate values in the region. Possible values are MAXIMUM, MINIMUM, and SUM. The default value is MAXIMUM.

referenceDesignCycle: SymbolicConstant = 'PREVIOUS'[source]

A SymbolicConstant specifying the iteration from which a value is compared to the reference value. Possible values are FIRST and PREVIOUS. The default value is PREVIOUS.

referenceFactor: float[source]

A Float specifying the factor used to modify the reference value.

referenceOperation: SymbolicConstant = 'ADD'[source]

A SymbolicConstant specifying the operation used to modify the reference value by the reference factor. Possible values are ADD, DIVIDE, MULTIPLY, and SUBTRACT. The default value is ADD.

region: SymbolicConstant = 'MODEL'[source]

The SymbolicConstant MODEL or a Region object specifying the region to which the stop condition is applied. The default value is MODEL.

setValues(comparisonOperation=abaqusConstants.LESS_THAN, identifier=abaqusConstants.MOVEMENT, identifierOperation=abaqusConstants.MAXIMUM, referenceDesignCycle=abaqusConstants.PREVIOUS, referenceOperation=abaqusConstants.ADD, region=abaqusConstants.MODEL)[source]

This method modifies the LocalStopCondition object.

Parameters:
  • comparisonOperation (Literal[EQUAL, GREATER_THAN_EQUAL, LESS_THAN_EQUAL, LESS_THAN, GREATER_THAN], default: LESS_THAN) – A SymbolicConstant specifying the operation used to compare the selected value to the reference value. Possible values are LESS_THAN, LESS_THAN_EQUAL, EQUAL, GREATER_THAN_EQUAL, and GREATER_THAN. The default value is LESS_THAN.

  • identifier (Literal[TOTAL_ABSOLUTE_MOVEMENT, GROWTH_MOVEMENT, SURFACE_POINT_EQUIV_STRESS, ABSOLUTE_GROWTH_MOVEMENT, TASK_REGION_EQUIV_STRESS, SHRINK_MOVEMENT, RESTRICTED_TASK_REGION_EQUIV_STRESS, EQUIV_STRESS, MOVEMENT, FREE_TASK_REGION_EQUIV_STRESS, ABSOLUTE_SHRINK_MOVEMENT], default: MOVEMENT) –

    A SymbolicConstant specifying the variable identifier of the compared value. Possible values are: - ABSOLUTE_GROWTH_MOVEMENT - ABSOLUTE_SHRINK_MOVEMENT - GROWTH_MOVEMENT - SHRINK_MOVEMENT - MOVEMENT - TOTAL_ABSOLUTE_MOVEMENT - EQUIV_STRESS - FREE_TASK_REGION_EQUIV_STRESS - RESTRICTED_TASK_REGION_EQUIV_STRESS - SURFACE_POINT_EQUIV_STRESS - TASK_REGION_EQUIV_STRESS

    The default value is MOVEMENT.

  • identifierOperation (Literal[SUM, MINIMUM, MAXIMUM], default: MAXIMUM) – A SymbolicConstant specifying the operation used to evaluate values in the region. Possible values are MAXIMUM, MINIMUM, and SUM. The default value is MAXIMUM.

  • referenceDesignCycle (Literal[PREVIOUS, FIRST], default: PREVIOUS) – A SymbolicConstant specifying the iteration from which a value is compared to the reference value. Possible values are FIRST and PREVIOUS. The default value is PREVIOUS.

  • referenceOperation (Literal[MULTIPLY, DIVIDE, SUBTRACT, ADD], default: ADD) – A SymbolicConstant specifying the operation used to modify the reference value by the reference factor. Possible values are ADD, DIVIDE, MULTIPLY, and SUBTRACT. The default value is ADD.

  • region (Literal[MODEL], default: MODEL) – The SymbolicConstant MODEL or a Region object specifying the region to which the stop condition is applied. The default value is MODEL.

class StopCondition[source]

Bases: object

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

Note

This object can be accessed by:

import optimization
mdb.models[name].optimizationTasks[name].stopConditions[name]

Member Details:

name: str = ''[source]

A String specifying the stop condition repository key.

region: SymbolicConstant = 'MODEL'[source]

The SymbolicConstant MODEL or a Region object specifying the region to which the stop condition is applied. The default value is MODEL.

class OptimizationObjective[source]

Bases: object

An OptimizationObjective is an object used to define objectives in an objective function.

Note

This object can be accessed by:

import optimization
mdb.models[name].optimizationTasks[name].objectiveFunctions[name].objectives[i]

Member Details:

designResponse: str = ''[source]

A String specifying the name of the design response.

referenceValue: Union[SymbolicConstant, float] = 'DEFAULT'[source]

The SymbolicConstant DEFAULT or a Float specifying the reference value used in evaluating a design response. For topology optimization, DEFAULT> indicates the reference value is 0. For shape optimization, DEFAULT indicates the reference value is the nodal average. The default value is DEFAULT.

suppress: Union[AbaqusBoolean, bool] = 0[source]

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

weight: float = 1[source]

A Float specifying the weight applied to the design response value. The default value is 1.0.

class OptimizationTaskBase[source]

Bases: object

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

Note

This object can be accessed by:

import optimization
mdb.models[name].optimizationTasks[name]

Member Details:

designResponses: dict[str, DesignResponse] = {}[source]

A repository of DesignResponse objects.

geometricRestrictions: dict[str, GeometricRestriction] = {}[source]

A repository of GeometricRestriction objects.

name: str = ''[source]

A String specifying the optimization task repository key.

objectiveFunctions: dict[str, ObjectiveFunction] = {}[source]

A repository of ObjectiveFunction objects.

optimizationConstraints: dict[str, OptimizationConstraint] = {}[source]

A repository of OptimizationConstraint objects.

region: SymbolicConstant = 'MODEL'[source]

The SymbolicConstant MODEL or a Region object specifying the region to which the optimization task is applied. The default value is MODEL.

stopConditions: dict[str, StopCondition] = {}[source]

A repository of StopCondition objects.

class PenetrationCheck(name, penetrationCheckRegion, region, presumeFeasibleRegionAtStart=1)[source]

Bases: GeometricRestriction

The PenetrationCheck object defines a penetration check geometric restriction. The PenetrationCheck object is derived from the GeometricRestriction object. This page discusses:

Note

This object can be accessed by:

import optimization
mdb.models[name].optimizationTasks[name].geometricRestrictions[name]

This method creates a PenetrationCheck object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].PenetrationCheck
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • penetrationCheckRegion (Region) – A Region object specifying the penetration check region.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • presumeFeasibleRegionAtStart (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

Returns:

A PenetrationCheck object.

Return type:

PenetrationCheck

Member Details:

penetrationCheckRegion: Region[source]

A Region object specifying the penetration check region.

presumeFeasibleRegionAtStart: Union[AbaqusBoolean, bool] = 1[source]

A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

setValues(presumeFeasibleRegionAtStart=1)[source]

This method modifies the PenetrationCheck object.

Parameters:

presumeFeasibleRegionAtStart (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

class ShapeDemoldControl(name, pullDirection, region, collisionCheckRegion=abaqusConstants.DEMOLD_REGION, csys=None, drawAngle=0, mainPointDetermination=abaqusConstants.MAXIMUM, presumeFeasibleRegionAtStart=1, tolerance1=0, tolerance2=0, tolerance3=0, undercutTolerance=0)[source]

Bases: GeometricRestriction

The ShapeDemoldControl object defines a shape demold control geometric restriction. The ShapeDemoldControl object is derived from the GeometricRestriction object.

Note

This object can be accessed by:

import optimization
mdb.models[name].optimizationTasks[name].geometricRestrictions[name]

This method creates a ShapeDemoldControl object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].ShapeDemoldControl
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • pullDirection (tuple) – A VertexArray object of length 2 specifying the demold pull direction. Instead of through a ConstrainedSketchVertex, each point might be specified through a tuple of coordinates.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • collisionCheckRegion (Literal[DEMOLD_REGION], default: DEMOLD_REGION) – The SymbolicConstant DEMOLD_REGION or a Region object specifying the collision check region. If the value is DEMOLD_REGION, then the value of region is used as both the demold region and the collision check region. The default value is DEMOLD_REGION.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system of the pullDirection. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int indicating the identifier of the DatumCsys. The default value is None.

  • drawAngle (float, default: 0) – A Float specifying the draw angle. The default value is 0.0.

  • mainPointDetermination (Literal[MINIMUM, MAXIMUM], default: MAXIMUM) –

    A SymbolicConstant specifying the rule for assigning point priority. Possible values are MAXIMUM and MINIMUM. The default value is MAXIMUM.

    Changed in version 2022: The argument masterPointDetermination was renamed to mainPointDetermination.

  • presumeFeasibleRegionAtStart (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

  • tolerance1 (float, default: 0) – A Float specifying the geometric tolerance in the 1-direction. The default value is 0.01.

  • tolerance2 (float, default: 0) – A Float specifying the geometric tolerance in the 2-direction. The default value is 0.01.

  • tolerance3 (float, default: 0) – A Float specifying the geometric tolerance in the 3-direction. The default value is 0.01.

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

Returns:

A ShapeDemoldControl object.

Return type:

ShapeDemoldControl

Member Details:

collisionCheckRegion: SymbolicConstant = 'DEMOLD_REGION'[source]

The SymbolicConstant DEMOLD_REGION or a Region object specifying the collision check region. If the value is DEMOLD_REGION, then the value of region is used as both the demold region and the collision check region. The default value is DEMOLD_REGION.

csys: Optional[int] = None[source]

None or a DatumCsys object specifying the local coordinate system of the pullDirection. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int indicating the identifier of the DatumCsys. The default value is None.

drawAngle: float = 0[source]

A Float specifying the draw angle. The default value is 0.0.

mainPointDetermination: SymbolicConstant = 'MAXIMUM'[source]

A SymbolicConstant specifying the rule for assigning point priority. Possible values are MAXIMUM and MINIMUM. The default value is MAXIMUM.

Changed in version 2022: The attribute masterPointDetermination was renamed to mainPointDetermination.

presumeFeasibleRegionAtStart: Union[AbaqusBoolean, bool] = 1[source]

A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

pullDirection: tuple[source]

A VertexArray object of length 2 specifying the demold pull direction. Instead of through a ConstrainedSketchVertex, each point might be specified through a tuple of coordinates.

setValues(collisionCheckRegion=abaqusConstants.DEMOLD_REGION, csys=None, drawAngle=0, mainPointDetermination=abaqusConstants.MAXIMUM, presumeFeasibleRegionAtStart=1, tolerance1=0, tolerance2=0, tolerance3=0, undercutTolerance=0)[source]

This method modifies the ShapeDemoldControl object.

Parameters:
  • collisionCheckRegion (Literal[DEMOLD_REGION], default: DEMOLD_REGION) – The SymbolicConstant DEMOLD_REGION or a Region object specifying the collision check region. If the value is DEMOLD_REGION, then the value of region is used as both the demold region and the collision check region. The default value is DEMOLD_REGION.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system of the pullDirection. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int indicating the identifier of the DatumCsys. The default value is None.

  • drawAngle (float, default: 0) – A Float specifying the draw angle. The default value is 0.0.

  • mainPointDetermination (Literal[MINIMUM, MAXIMUM], default: MAXIMUM) –

    A SymbolicConstant specifying the rule for assigning point priority. Possible values are MAXIMUM and MINIMUM. The default value is MAXIMUM.

    Changed in version 2022: The argument masterPointDetermination was renamed to mainPointDetermination.

  • presumeFeasibleRegionAtStart (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

  • tolerance1 (float, default: 0) – A Float specifying the geometric tolerance in the 1-direction. The default value is 0.01.

  • tolerance2 (float, default: 0) – A Float specifying the geometric tolerance in the 2-direction. The default value is 0.01.

  • tolerance3 (float, default: 0) – A Float specifying the geometric tolerance in the 3-direction. The default value is 0.01.

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

tolerance1: float = 0[source]

A Float specifying the geometric tolerance in the 1-direction. The default value is 0.01.

tolerance2: float = 0[source]

A Float specifying the geometric tolerance in the 2-direction. The default value is 0.01.

tolerance3: float = 0[source]

A Float specifying the geometric tolerance in the 3-direction. The default value is 0.01.

undercutTolerance: float = 0[source]

A Float specifying the undercut tolerance. The default value is 0.0.

class ShapeMemberSize(name, region, maxThickness=0, minThickness=0, sizeRestriction=abaqusConstants.MINIMUM, assignNodeGroupRegion=0, nodeGroupRegion='')[source]

Bases: GeometricRestriction

The ShapeMemberSize object defines a shape member size geometric restriction. The ShapeMemberSize object is derived from the GeometricRestriction object.

Note

This object can be accessed by:

import optimization
mdb.models[name].optimizationTasks[name].geometricRestrictions[name]

This method creates a ShapeMemberSize object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].ShapeMemberSize
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • maxThickness (float, default: 0) – A Float specifying the maximum thickness. The default value is 0.0.

  • minThickness (float, default: 0) – A Float specifying the minimum thickness. The default value is 0.0.

  • sizeRestriction (Literal[MINIMUM, MAXIMUM], default: MINIMUM) – A SymbolicConstant specifying whether to restrict the minimum or maximum thickness. Possible values are MAXIMUM and MINIMUM. The default value is MINIMUM.

  • assignNodeGroupRegion (str, default: 0) –

    A bool specifying whether to use the node group region. The default value is OFF.

    New in version 2022: The assignNodeGroupRegion argument was added.

  • nodeGroupRegion (str, default: '') –

    A Node Region object specifying the check node group.

    New in version 2022: The nodeGroupRegion argument was added.

Returns:

A ShapeMemberSize object.

Return type:

ShapeMemberSize

Member Details:

assignNodeGroupRegion: str = 0[source]

A bool specifying whether to use the node group region. The default value is OFF.

New in version 2022: The assignNodeGroupRegion attribute was added.

maxThickness: float = 0[source]

A Float specifying the maximum thickness. The default value is 0.0.

minThickness: float = 0[source]

A Float specifying the minimum thickness. The default value is 0.0.

nodeGroupRegion: str = ''[source]

A Node Region object specifying the check node group.

New in version 2022: The nodeGroupRegion attribute was added.

setValues(maxThickness=0, minThickness=0, sizeRestriction=abaqusConstants.MINIMUM, assignNodeGroupRegion=0, nodeGroupRegion='')[source]

This method modifies the ShapeMemberSize object.

Parameters:
  • maxThickness (float, default: 0) – A Float specifying the maximum thickness. The default value is 0.0.

  • minThickness (float, default: 0) – A Float specifying the minimum thickness. The default value is 0.0.

  • sizeRestriction (Literal[MINIMUM, MAXIMUM], default: MINIMUM) – A SymbolicConstant specifying whether to restrict the minimum or maximum thickness. Possible values are MAXIMUM and MINIMUM. The default value is MINIMUM.

  • assignNodeGroupRegion (str, default: 0) –

    A bool specifying whether to use the node group region. The default value is OFF.

    New in version 2022: The assignNodeGroupRegion argument was added.

  • nodeGroupRegion (str, default: '') –

    A Node Region object specifying the check node group.

    New in version 2022: The nodeGroupRegion argument was added.

sizeRestriction: SymbolicConstant = 'MINIMUM'[source]

A SymbolicConstant specifying whether to restrict the minimum or maximum thickness. Possible values are MAXIMUM and MINIMUM. The default value is MINIMUM.

class ShapePlanarSymmetry(name, clientDirection, region, allowNonSymmetricMesh=True, csys=None, mainPointDetermination=abaqusConstants.MAXIMUM, presumeFeasibleRegionAtStart=1, tolerance1=0, tolerance2=0, tolerance3=0)[source]

Bases: GeometricRestriction

The ShapePlanarSymmetry object defines a shape planar symmetry geometric restriction. The ShapePlanarSymmetry object is derived from the GeometricRestriction object.

Note

This object can be accessed by:

import optimization
mdb.models[name].optimizationTasks[name].geometricRestrictions[name]

This method creates a ShapePlanarSymmetry object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].ShapePlanarSymmetry
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • clientDirection (tuple) – A VertexArray object of length 2 specifying the vector positioned at the csys origin that is normal to the symmetry plane. Instead of through a ConstrainedSketchVertex, each point may be specified through a tuple of coordinates.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • allowNonSymmetricMesh (Union[AbaqusBoolean, bool], default: True) –

    A Boolean specifying whether to allow a nonsymmetric mesh for this geometric restriction. The default value is TRUE.

    New in version 2021: The alloowNonSymmetricMesh argument was added.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

  • mainPointDetermination (Literal[MINIMUM, MAXIMUM], default: MAXIMUM) – A SymbolicConstant specifying the rule for determining the main node. Possible values are MAXIMUM and MINIMUM. The default value is MAXIMUM.

  • presumeFeasibleRegionAtStart (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

  • tolerance1 (float, default: 0) – A Float specifying the geometric tolerance in the 1-direction. The default value is 0.01.

  • tolerance2 (float, default: 0) – A Float specifying the geometric tolerance in the 2-direction. The default value is 0.01.

  • tolerance3 (float, default: 0) – A Float specifying the geometric tolerance in the 3-direction. The default value is 0.01.

Returns:

A ShapePlanarSymmetry object.

Return type:

ShapePlanarSymmetry

Member Details:

allowNonSymmetricMesh: Union[AbaqusBoolean, bool] = True[source]

A Boolean specifying whether to allow a nonsymmetric mesh for this geometric restriction. The default value is TRUE.

New in version 2021: The allowNonSymmetricMesh attribute was added.

clientDirection: tuple[source]

A VertexArray object of length 2 specifying the vector positioned at the csys origin that is normal to the symmetry plane. Instead of through a ConstrainedSketchVertex, each point may be specified through a tuple of coordinates.

csys: Optional[int] = None[source]

None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

mainPointDetermination: SymbolicConstant = 'MAXIMUM'[source]

A SymbolicConstant specifying the rule for determining the main node. Possible values are MAXIMUM and MINIMUM. The default value is MAXIMUM.

presumeFeasibleRegionAtStart: Union[AbaqusBoolean, bool] = 1[source]

A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

setValues(allowNonSymmetricMesh=True, csys=None, mainPointDetermination=abaqusConstants.MAXIMUM, presumeFeasibleRegionAtStart=1, tolerance1=0, tolerance2=0, tolerance3=0)[source]

This method modifies the ShapePlanarSymmetry object.

Parameters:
  • allowNonSymmetricMesh (Union[AbaqusBoolean, bool], default: True) – A Boolean specifying whether to allow a nonsymmetric mesh for this geometric restriction. The default value is TRUE.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

  • mainPointDetermination (Literal[MINIMUM, MAXIMUM], default: MAXIMUM) – A SymbolicConstant specifying the rule for determining the main node. Possible values are MAXIMUM and MINIMUM. The default value is MAXIMUM.

  • presumeFeasibleRegionAtStart (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

  • tolerance1 (float, default: 0) – A Float specifying the geometric tolerance in the 1-direction. The default value is 0.01.

  • tolerance2 (float, default: 0) – A Float specifying the geometric tolerance in the 2-direction. The default value is 0.01.

  • tolerance3 (float, default: 0) – A Float specifying the geometric tolerance in the 3-direction. The default value is 0.01.

tolerance1: float = 0[source]

A Float specifying the geometric tolerance in the 1-direction. The default value is 0.01.

tolerance2: float = 0[source]

A Float specifying the geometric tolerance in the 2-direction. The default value is 0.01.

tolerance3: float = 0[source]

A Float specifying the geometric tolerance in the 3-direction. The default value is 0.01.

class ShapePointSymmetry(name, region, csys=None, mainPointDetermination=abaqusConstants.MAXIMUM, presumeFeasibleRegionAtStart=1, tolerance1=0, tolerance2=0, tolerance3=0)[source]

Bases: GeometricRestriction

The ShapePointSymmetry object defines a shape point symmetry geometric restriction. The ShapePointSymmetry object is derived from the GeometricRestriction object.

Note

This object can be accessed by:

import optimization
mdb.models[name].optimizationTasks[name].geometricRestrictions[name]

This method creates a ShapePointSymmetry object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].ShapePointSymmetry
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the symmetry point represented as the origin of a local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

  • mainPointDetermination (Literal[MINIMUM, MAXIMUM], default: MAXIMUM) –

    A SymbolicConstant specifying the rule for determining the main node. Possible values are MAXIMUM and MINIMUM. The default value is MAXIMUM.

    Changed in version 2022: The argument masterPointDetermination was renamed to mainPointDetermination.

  • presumeFeasibleRegionAtStart (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

  • tolerance1 (float, default: 0) – A Float specifying the geometric tolerance in the 1-direction. The default value is 0.01.

  • tolerance2 (float, default: 0) – A Float specifying the geometric tolerance in the 2-direction. The default value is 0.01.

  • tolerance3 (float, default: 0) – A Float specifying the geometric tolerance in the 3-direction. The default value is 0.01.

Returns:

A ShapePointSymmetry object.

Return type:

ShapePointSymmetry

Member Details:

csys: Optional[int] = None[source]

None or a DatumCsys object specifying the symmetry point represented as the origin of a local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

mainPointDetermination: SymbolicConstant = 'MAXIMUM'[source]

A SymbolicConstant specifying the rule for determining the main node. Possible values are MAXIMUM and MINIMUM. The default value is MAXIMUM.

Changed in version 2022: The attribute masterPointDetermination was renamed to mainPointDetermination.

presumeFeasibleRegionAtStart: Union[AbaqusBoolean, bool] = 1[source]

A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

setValues(csys=None, mainPointDetermination=abaqusConstants.MAXIMUM, presumeFeasibleRegionAtStart=1, tolerance1=0, tolerance2=0, tolerance3=0)[source]

This method modifies the ShapePointSymmetry object.

Parameters:
  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the symmetry point represented as the origin of a local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

  • mainPointDetermination (Literal[MINIMUM, MAXIMUM], default: MAXIMUM) –

    A SymbolicConstant specifying the rule for determining the main node. Possible values are MAXIMUM and MINIMUM. The default value is MAXIMUM.

    Changed in version 2022: The argument masterPointDetermination was renamed to mainPointDetermination.

  • presumeFeasibleRegionAtStart (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to ignore the geometric restriction in the first design cycle. The default value is ON.

  • tolerance1 (float, default: 0) – A Float specifying the geometric tolerance in the 1-direction. The default value is 0.01.

  • tolerance2 (float, default: 0) – A Float specifying the geometric tolerance in the 2-direction. The default value is 0.01.

  • tolerance3 (float, default: 0) – A Float specifying the geometric tolerance in the 3-direction. The default value is 0.01.

tolerance1: float = 0[source]

A Float specifying the geometric tolerance in the 1-direction. The default value is 0.01.

tolerance2: float = 0[source]

A Float specifying the geometric tolerance in the 2-direction. The default value is 0.01.

tolerance3: float = 0[source]

A Float specifying the geometric tolerance in the 3-direction. The default value is 0.01.

class ShapeRotationalSymmetry(name, clientDirection, region, allowNonSymmetricMesh=True, angle=0, csys=None, mainPoint=None, mainPointDetermination=abaqusConstants.MAXIMUM, presumeFeasibleRegionAtStart=1, startPoint=None, tolerance1=0, tolerance2=0, tolerance3=0)[source]

Bases: GeometricRestriction

The ShapeRotationalSymmetry object defines a shape rotational symmetry geometric restriction. The ShapeRotationalSymmetry object is derived from the GeometricRestriction object.

Note

This object can be accessed by:

import optimization
mdb.models[name].optimizationTasks[name].geometricRestrictions[name]

This method creates a ShapeRotationalSymmetry object.

Note

This function can be accessed by:

mdb.models[name].optimizationTasks[name].ShapeRotationalSymmetry
Parameters:
  • name (str) – A String specifying the geometric restriction repository key.

  • clientDirection (tuple) – A VertexArray object of length 2 specifying the vector positioned at the csys origin, used as the axis of symmetry. Instead of through a ConstrainedSketchVertex, each point might be specified through a tuple of coordinates.

  • region (Region) – A Region object specifying the region to which the geometric restriction is applied. When used with a TopologyTask, there is no default value. When used with a ShapeTask, the default value is MODEL.

  • allowNonSymmetricMesh (Union[AbaqusBoolean, bool], default: True) –

    A Boolean specifying whether to allow a nonsymmetric mesh for this geometric restriction. The default value is TRUE.

    New in version 2021: The alloowNonSymmetricMesh argument was added.

  • angle (float, default: 0) – A Float specifying the segment size of the repeating pattern in degrees. If the angle value is 0, no repeating pattern is created. The default value is 0.0.

  • csys (Optional[int], default: None) – None or a DatumCsys object specifying the local coordinate system. If csys = None, the global coordinate system is used. When this member is queried, it returns an Int. The default value is None.

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

    None or a Region object specifying the main point used when mainPointDetermination is SPECIFY. The default value is None.

    Changed in version 2022: The argument masterPoint was renamed to mainPoint.

  • mainPointDetermination (Literal[