Predefined Field๏ƒ

A PredefinedField object stores the non-propagating data of a predefined field as well as a number of instances of the corresponding PredefinedFieldState object. The PredefinedFieldState object stores the propagating data of the predefined field in a single step. A specific type of PredefinedField object and a specific type of PredefinedFieldState object are designed for each type of predefined field. Instances of the PredefinedFieldState object are created and deleted internally by its corresponding PredefinedField object.

Create predefined fields๏ƒ

class PredefinedFieldModel(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:

FluidCavityPressure(name,ย fluidCavity,ย ...)

This method creates a FluidCavityPressure object.

InitialState(name,ย instances,ย fileName[,ย ...])

This method creates an InitialState predefined field object.

KinematicHardening(name,ย region[,ย ...])

This method creates a KinematicHardening object.

MaterialAssignment(name,ย instanceList[,ย ...])

This method creates a MaterialAssignment predefined field object.

PorePressure(name,ย region[,ย ...])

This method creates a PorePressure predefined field object.

Temperature(name,ย createStepName,ย region[,ย ...])

This method creates a Temperature object.

Velocity(name,ย region,ย velocity1,ย velocity2,ย ...)

This method creates a Velocity predefined field object.

Saturation(name,ย region[,ย distributionType,ย ...])

This method creates a Saturation predefined field object.

Stress(name,ย region[,ย distributionType,ย ...])

This method creates a Stress predefined field object.

Field(name,ย createStepName,ย region[,ย ...])

This method creates a Field object.

VoidsRatio(name,ย region[,ย distributionType,ย ...])

This method creates a PorePressure predefined field 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:

Field(name, createStepName, region, outputVariable='', fieldVariableNum=None, distributionType=abaqusConstants.UNIFORM, crossSectionDistribution=abaqusConstants.CONSTANT_THROUGH_THICKNESS, field='', amplitude=abaqusConstants.UNSET, fileName='', beginStep=None, beginIncrement=None, endStep=None, endIncrement=None, interpolate=0, magnitudes='')[source]๏ƒ

This method creates a Field object.

Note

This function can be accessed by:

mdb.models[name].Field

New in version 2018: The Field method was added.

Parameters:
  • name (str) โ€“ A String specifying the repository key.

  • createStepName (str) โ€“ A String specifying the name of the step in which the predefined field is created.

  • region (Region) โ€“ A Region object specifying the region to which the predefined field is applied. Region is ignored if the predefined field has a distributionType member available, and distributionType = FROM_FILE.

  • outputVariable (str, default: '') โ€“ A String specifying the scalar nodal output variable that will be read from an output database and used to initialize a specified predefined field. This argument is a required argument if distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED.

  • fieldVariableNum (Optional[int], default: None) โ€“ An Int specifying the field variable number.

  • distributionType (Literal[FIELD, FROM_FILE, DISCRETE_FIELD, FROM_FILE_AND_USER_DEFINED, UNIFORM, USER_DEFINED], default: UNIFORM) โ€“ A SymbolicConstant specifying how the predefined field varies spatially. Possible values are UNIFORM, USER_DEFINED, FROM_FILE, FIELD, FROM_FILE_AND_USER_DEFINED, and DISCRETE_FIELD. The default value is UNIFORM.

  • crossSectionDistribution (Literal[GRADIENTS_THROUGH_BEAM_CS, POINTS_THROUGH_SECTION, GRADIENTS_THROUGH_SHELL_CS, CONSTANT_THROUGH_THICKNESS], default: CONSTANT_THROUGH_THICKNESS) โ€“

    A SymbolicConstant specifying how the predefined field is distributed over the cross-section of the region. Possible values are

    • CONSTANT_THROUGH_THICKNESS

    • GRADIENTS_THROUGH_SHELL_CS

    • GRADIENTS_THROUGH_BEAM_CS

    • POINTS_THROUGH_SECTION

    The default value is CONSTANT_THROUGH_THICKNESS.

  • field (str, default: '') โ€“ A String specifying the name of the AnalyticalField or DiscreteField object associated with this predefined field. The field argument applies only when distributionType = FIELD or distributionType = DISCRETE_FIELD. The default value is an empty string.

  • amplitude (str, default: UNSET) โ€“

    A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the predefined field has no amplitude reference. The default value is UNSET.

    Note

    amplitude should be given only if it is valid for the specified step.

  • fileName (str, default: '') โ€“ A String specifying the name of the file from which the Field values are to be read when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED.

  • beginStep (Optional[Literal[FROM_FILE, LAST_STEP, FROM_FILE_AND_USER_DEFINED, FIRST_STEP]], default: None) โ€“ An Int specifying the first step from which Field values are to be read or the SymbolicConstant FIRST_STEP or LAST_STEP. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • beginIncrement (Optional[Literal[FROM_FILE, FROM_FILE_AND_USER_DEFINED, STEP_END, STEP_START]], default: None) โ€“ An Int specifying the first increment of the step set in beginStep or the SymbolicConstants STEP_START or STEP_END. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • endStep (Optional[Literal[FROM_FILE, LAST_STEP, FROM_FILE_AND_USER_DEFINED, FIRST_STEP]], default: None) โ€“ An Int specifying the last step from which Field values are to be read or the SymbolicConstants FIRST_STEP and LAST_STEP. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • endIncrement (Optional[Literal[FROM_FILE, FROM_FILE_AND_USER_DEFINED, STEP_END, STEP_START]], default: None) โ€“ An Int specifying the last increment of the step set in endStep or the SymbolicConstants STEP_START and STEP_END. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • interpolate (Union[Literal[MIDSIDE_ONLY], AbaqusBoolean, bool], default: 0) โ€“ A SymbolicConstant specifying whether to interpolate a field read from an output database or results file. Possible values are OFF, ON, or MIDSIDE_ONLY. The default value is OFF.

  • magnitudes (str, default: '') โ€“

    A Sequence of Doubles specifying the Field values when distributionType = UNIFORM or FIELD. The value of the magnitudes argument is a function of the crossSectionDistribution argument, as shown in the following list:

    • If crossSectionDistribution = CONSTANT_THROUGH_THICKNESS, magnitudes is a Double specifying the Field.

    • If crossSectionDistribution = GRADIENTS_THROUGH_SHELL_CS, magnitudes is a sequence of Doubles specifying the mean value and the gradient in the thickness direction.

    • If crossSectionDistribution = GRADIENTS_THROUGH_BEAM_CS, magnitudes is a sequence of Doubles specifying the mean value, the gradient in the N1 direction, and the gradient in the N2 direction.

    • If crossSectionDistribution = POINTS_THROUGH_SECTION, magnitudes is a sequence of Doubles specifying the Field at each point.

Returns:

A Field object.

FluidCavityPressure(name, fluidCavity, fluidPressure)[source]๏ƒ

This method creates a FluidCavityPressure object.

Note

This function can be accessed by:

mdb.models[name].FluidCavityPressure
Parameters:
  • name (str) โ€“ A String specifying the repository key.

  • fluidCavity (str) โ€“ A String specifying the name of a Fluid Cavity Interaction.

  • fluidPressure (float) โ€“ A Float specifying the initial fluid pressure.

Returns:

A FluidCavityPressure object.

Return type:

FluidCavityPressure

InitialState(name, instances, fileName, endStep=abaqusConstants.LAST_STEP, endIncrement=abaqusConstants.STEP_END, updateReferenceConfiguration=0)[source]๏ƒ

This method creates an InitialState predefined field object.

Note

This function can be accessed by:

mdb.models[name].InitialState
Parameters:
  • name (str) โ€“ A String specifying the repository key.

  • instances (List[PartInstance]) โ€“ A PartInstanceArray object specifying the instances to which the predefined field is applied.

  • fileName (str) โ€“ A String specifying the name of the job that generated the initial state data.

  • endStep (Literal[LAST_STEP], default: LAST_STEP) โ€“ The SymbolicConstant LAST_STEP or an Int specifying the step from which the initial state values are to be read or the SymbolicConstant LAST_STEP. The default value is LAST_STEP.

  • endIncrement (Literal[STEP_END], default: STEP_END) โ€“ The SymbolicConstant STEP_END or an Int specifying the increment, interval or iteration of the step set in endStep or the SymbolicConstant STEP_END. The default value is STEP_END.

  • updateReferenceConfiguration (Union[AbaqusBoolean, bool], default: 0) โ€“ A Boolean specifying whether to update the reference configuration based on the import data. The default value is OFF.

Returns:

An InitialState object.

Return type:

InitialState

KinematicHardening(name, region, numBackStress=1, equivPlasticStrain=(), backStress=(), sectPtNum=(), definition=abaqusConstants.KINEMATIC_HARDENING, rebarLayerNames=(), distributionType=abaqusConstants.MAGNITUDE)[source]๏ƒ

This method creates a KinematicHardening object.

Note

This function can be accessed by:

mdb.models[name].KinematicHardening
Parameters:
  • name (str) โ€“ A String specifying the repository key.

  • region (Region) โ€“ A Region object specifying the region to which the predefined field is applied.

  • numBackStress (int, default: 1) โ€“ An Int specifying the number of backstresses. The default value is 1.

  • equivPlasticStrain (tuple, default: ()) โ€“ A sequence of Floats specifying the initial equivalent Plastic strain.

  • backStress (tuple, default: ()) โ€“ A sequence of sequences of Floats specifying the initial backstress tensor for kinematic hardening models. The default value is an empty sequence.

  • sectPtNum (tuple, default: ()) โ€“ A sequence of Ints specifying section point numbers. This argument is valid only when definition = SECTION_PTS.

  • definition (Literal[CRUSHABLE_FOAM, KINEMATIC_HARDENING, REBAR, USER_DEFINED, SECTION_PTS], default: KINEMATIC_HARDENING) โ€“ A SymbolicConstant specifying different types of kinematic hardening. Possible values are KINEMATIC_HARDENING, CRUSHABLE_FOAM, REBAR, SECTION_PTS, and USER_DEFINED. The default value is KINEMATIC_HARDENING.

  • rebarLayerNames (tuple, default: ()) โ€“ A sequence of Strings specifying rebar layer names. This argument is valid only when definition = REBAR.

  • distributionType (Literal[MAGNITUDE, ANALYTICAL_FIELD], default: MAGNITUDE) โ€“ A SymbolicConstant specifying whether the load is uniform. Possible values are MAGNITUDE and ANALYTICAL_FIELD. The default value is MAGNITUDE.

Returns:

A KinematicHardening object.

Return type:

KinematicHardening

MaterialAssignment(name, instanceList, useFields=0, assignmentList=(), fieldList=(), colorList=())[source]๏ƒ

This method creates a MaterialAssignment predefined field object.

Note

This function can be accessed by:

mdb.models[name].MaterialAssignment
Parameters:
  • name (str) โ€“ A String specifying the repository key.

  • instanceList (List[PartInstance]) โ€“ A PartInstanceArray object specifying the part instances to which the predefined field is applied. All instances must be assigned the same Eulerian section.

  • useFields (Union[AbaqusBoolean, bool], default: 0) โ€“ A Boolean specifying whether the volume fraction data will be uniform or defined by discrete fields. The default value is OFF.

  • assignmentList (Sequence[tuple[Region, tuple[float, ...]]], default: ()) โ€“ A sequence of tuples specifying the uniform volume fractions to be assigned. This argument is valid only when useFields = FALSE. Each tuple contains two entries:A Region object.A tuple of Floats specifying the uniform volume fraction values. The length of the tuple must match the number of material instance names specified in the Eulerain section assigned to part instances specified by instanceList.

  • fieldList (Sequence[tuple[Region, tuple[str, ...]]], default: ()) โ€“ A sequence of tuples specifying the discrete volume fractions to be assigned. This argument is valid only when useFields = TRUE. Each tuple contains two entries:A Region object.A tuple of Strings specifying Discrete Field names. The length of the tuple must match the number of material instance names specified in the Eulerain section assigned to part instances specified by instanceList.

  • colorList (Sequence[tuple[int, int, int]], default: ()) โ€“ A sequence of three Ints specifying colors used to display the material instance assignments. This is a sequence of R,G,B colors, where the values are represented by integers between 0 and 255. The default value is an empty sequence.

Returns:

A MaterialAssignment object.

Return type:

MaterialAssignment

PorePressure(name, region, distributionType=abaqusConstants.UNIFORM, porePressure1=0, porePressure2=0, coord1=0, coord2=0, pressure2Distribution=abaqusConstants.MAGNITUDE, pressure2Field='', variation=abaqusConstants.CONSTANT_RATIO, fileName='', increment=abaqusConstants.LAST_INCREMENT, step=abaqusConstants.LAST_STEP, interpolate=0)[source]๏ƒ

This method creates a PorePressure predefined field object.

Note

This function can be accessed by:

mdb.models[name].PorePressure
Parameters:
  • name (str) โ€“ A String specifying the repository key.

  • region (Region) โ€“ A Region object specifying the region to which the predefined field is applied. Region is ignored if the predefined field has distributionType = FROM_FILE.

  • distributionType (Literal[UNIFORM, FROM_FILE, USER_DEFINED], default: UNIFORM) โ€“ A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM, FROM_FILE and USER_DEFINED. The default value is UNIFORM.

  • porePressure1 (float, default: 0) โ€“ The initial pore pressure in the first region in your model.

  • porePressure2 (float, default: 0) โ€“ The pore pressure of the second location in your model

  • coord1 (float, default: 0) โ€“ Vertical position of the first location in your model for which you are specifying initial pore pressure.

  • coord2 (float, default: 0) โ€“ The vertical position of the second location in your model.

  • pressure2Distribution (Literal[MAGNITUDE, ANALYTICAL_FIELD], default: MAGNITUDE) โ€“ A SymbolicConstant specifying either the magnitude of a uniform distribution for pore pressure at the second elevation or an analytical field to define a spatially varying initial pore pressure at the second elevation. Possible values are MAGNITUDE and ANALYTICAL_FIELD.

  • pressure2Field (str, default: '') โ€“ A String specifying the name of the AnalyticalField object associated with this predefined field. The pressure2Field argument applies only when distributionType = ANALYTICAL_FIELD.

  • variation (Literal[CONSTANT_RATIO, VARIABLE_RATIO], default: CONSTANT_RATIO) โ€“ A SymbolicConstant selecting the elevation distribution options, either Linear or Constant. Possible values are CONSTANT_RATIO and VARIABLE_RATIO.

  • fileName (str, default: '') โ€“ A String specifying the name of the file from which the Field values are to be read when distributionType = FROM_FILE.

  • increment (Union[int, Literal[LAST_INCREMENT]], default: LAST_INCREMENT) โ€“ The SymbolicConstant LAST_INCREMENT or an Int specifying the increment, interval or iteration of the step when distributionType = FROM_FILE.

  • step (Union[int, Literal[LAST_STEP]], default: LAST_STEP) โ€“ The SymbolicConstant LAST_STEP or an Int specifying the increment, interval or iteration of the step when distributionType = FROM_FILE.

  • interpolate (Union[AbaqusBoolean, bool], default: 0) โ€“ A Boolean specifying whether to interpolate a field read from an output database or results file.

Returns:

A PorePressure object.

Saturation(name, region, distributionType=abaqusConstants.UNIFORM, field='', value=0)[source]๏ƒ

This method creates a Saturation predefined field object.

Note

This function can be accessed by:

mdb.models[name].Saturation
Parameters:
  • name (str) โ€“ A String specifying the repository key.

  • region (Region) โ€“ A Region object specifying the region to which the predefined field is applied.

  • distributionType (Literal[UNIFORM, FIELD], default: UNIFORM) โ€“ A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM, and FIELD. The default value is UNIFORM.

  • field (str, default: '') โ€“ A String specifying the name of the AnalyticalField object associated with this predefined field. The field argument applies only when distributionType = FIELD. The default value is an empty string.

  • value (float, default: 0) โ€“ A float specifying an initial saturation value for the region between 0.0 (for no saturation) and 1.0 (for full saturation).

Returns:

A Saturation object.

Stress(name, region, distributionType=abaqusConstants.UNIFORM, sigma11=0, sigma22=0, sigma33=0, sigma12=0, sigma13=0, sigma23=0)[source]๏ƒ

This method creates a Stress predefined field object.

Note

This function can be accessed by:

mdb.models[name].Stress

New in version 2017: The Stress method was added.

Parameters:
  • name (str) โ€“ A String specifying the repository key.

  • region (Region) โ€“ A Region object specifying the region to which the predefined field is applied. Region is ignored if the predefined field has distributionType = FROM_FILE.

  • distributionType (Literal[UNIFORM, FROM_FILE], default: UNIFORM) โ€“ A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM and FROM_FILE. The default value is UNIFORM.

  • sigma11 (float, default: 0) โ€“ A Float specifying the first principal component of the stress.

  • sigma22 (float, default: 0) โ€“ A Float specifying the second principal component of the stress.

  • sigma33 (float, default: 0) โ€“ A Float specifying the third principal component of the stress.

  • sigma12 (float, default: 0) โ€“ A Float specifying the first shear component of the stress.

  • sigma13 (float, default: 0) โ€“ A Float specifying the second shear component of the stress.

  • sigma23 (float, default: 0) โ€“ A Float specifying the third shear component of the stress.

Returns:

A Stress object.

Temperature(name, createStepName, region, distributionType=abaqusConstants.UNIFORM, crossSectionDistribution=abaqusConstants.CONSTANT_THROUGH_THICKNESS, field='', amplitude=abaqusConstants.UNSET, fileName='', beginStep=None, beginIncrement=None, endStep=None, endIncrement=None, interpolate=0, magnitudes='', absoluteExteriorTolerance=0, exteriorTolerance=0)[source]๏ƒ

This method creates a Temperature object.

Note

This function can be accessed by:

mdb.models[name].Temperature
Parameters:
  • name (str) โ€“ A String specifying the repository key.

  • createStepName (str) โ€“ A String specifying the name of the step in which the predefined field is created.

  • region (Region) โ€“ A Region object specifying the region to which the predefined field is applied. Region is ignored if the predefined field has a distributionType member available, and distributionType = FROM_FILE .

  • distributionType (Literal[FIELD, FROM_FILE, DISCRETE_FIELD, FROM_FILE_AND_USER_DEFINED, UNIFORM, USER_DEFINED], default: UNIFORM) โ€“ A SymbolicConstant specifying how the predefined field varies spatially. Possible values are UNIFORM, USER_DEFINED, FROM_FILE, FIELD, FROM_FILE_AND_USER_DEFINED, and DISCRETE_FIELD. The default value is UNIFORM.

  • crossSectionDistribution (Literal[GRADIENTS_THROUGH_BEAM_CS, POINTS_THROUGH_SECTION, GRADIENTS_THROUGH_SHELL_CS, CONSTANT_THROUGH_THICKNESS], default: CONSTANT_THROUGH_THICKNESS) โ€“

    A SymbolicConstant specifying how the predefined field is distributed over the cross section of the region. Possible values are

    • CONSTANT_THROUGH_THICKNESS

    • GRADIENTS_THROUGH_SHELL_CS

    • GRADIENTS_THROUGH_BEAM_CS

    • POINTS_THROUGH_SECTION

    The default value is CONSTANT_THROUGH_THICKNESS.

  • field (str, default: '') โ€“ A String specifying the name of the AnalyticalField or DiscreteField object associated with this predefined field. The field argument applies only when distributionType = FIELD or distributionType = DISCRETE_FIELD. The default value is an empty string.

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

  • fileName (str, default: '') โ€“ A String specifying the name of the file from which the temperature values are to be read when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED.

  • beginStep (Optional[Literal[FROM_FILE, LAST_STEP, FROM_FILE_AND_USER_DEFINED, FIRST_STEP]], default: None) โ€“ An Int specifying the first step from which temperature values are to be read or the SymbolicConstant FIRST_STEP or LAST_STEP. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • beginIncrement (Optional[Literal[FROM_FILE, FROM_FILE_AND_USER_DEFINED, STEP_END, STEP_START]], default: None) โ€“ An Int specifying the first increment of the step set in beginStep or the SymbolicConstants STEP_START or STEP_END. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • endStep (Optional[Literal[FROM_FILE, LAST_STEP, FROM_FILE_AND_USER_DEFINED, FIRST_STEP]], default: None) โ€“ An Int specifying the last step from which temperature values are to be read or the SymbolicConstants FIRST_STEP and LAST_STEP. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • endIncrement (Optional[Literal[FROM_FILE, FROM_FILE_AND_USER_DEFINED, STEP_END, STEP_START]], default: None) โ€“ An Int specifying the last increment of the step set in endStep or the SymbolicConstants STEP_START and STEP_END. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • interpolate (Union[Literal[MIDSIDE_ONLY], AbaqusBoolean, bool], default: 0) โ€“ A SymbolicConstant specifying whether to interpolate a field read from an output database or results file. Possible values are OFF, ON or MIDSIDE_ONLY. The default value is OFF.

  • magnitudes (str, default: '') โ€“

    A Sequence of Doubles specifying the temperature values when distributionType = UNIFORM or FIELD. The value of the magnitudes argument is a function of the crossSectionDistribution argument, as shown in the following list:

    • If crossSectionDistribution = CONSTANT_THROUGH_THICKNESS then magnitudes is a Double specifying the temperature.

    • If crossSectionDistribution = GRADIENTS_THROUGH_SHELL_CS then magnitudes is a sequence of Doubles specifying the mean value and the gradient in the thickness direction.

    • If crossSectionDistribution = GRADIENTS_THROUGH_BEAM_CS then magnitudes is a sequence of Doubles specifying the mean value, the gradient in the N1 direction, and the gradient in the N2 direction.

    • If crossSectionDistribution = POINTS_THROUGH_SECTION then magnitudes is a sequence of Doubles specifying the temperature at each point.

  • absoluteExteriorTolerance (float, default: 0) โ€“ A Float specifying the absolute value by which a driven node of the field can lie outside the region of the elements of the global model. The default value is 0.0. This argument cannot be used with midside.

  • exteriorTolerance (float, default: 0) โ€“ A Float specifying the fraction of the average element size in the global model by which a driven node of the field can lie outside the region of the elements of the global model. The default value is 0.0. This argument cannot be used with midside.

Returns:

A Temperature object.

Return type:

Temperature

Velocity(name, region, velocity1, velocity2, velocity3, omega, axisBegin, axisEnd, field='', distributionType=abaqusConstants.MAGNITUDE)[source]๏ƒ

This method creates a Velocity predefined field object.

Note

This function can be accessed by:

mdb.models[name].Velocity
Parameters:
  • name (str) โ€“ A String specifying the repository key.

  • region (Region) โ€“ A Region object specifying the region to which the predefined field is applied.

  • velocity1 (float) โ€“ A Float specifying the first component of the velocity.

  • velocity2 (float) โ€“ A Float specifying the second component of the velocity.

  • velocity3 (float) โ€“ A Float specifying the third component of the velocity.

  • omega (float) โ€“ A Float specifying the angular velocity.

  • axisBegin (tuple) โ€“ A sequence of Floats specifying the X-, Y-, and Z coordinates of the starting point of the axis about which omega is defined.

  • axisEnd (tuple) โ€“ A sequence of Floats specifying the X-, Y-, and Z coordinates of the end point of the axis about which omega is defined.

  • field (str, default: '') โ€“ A String specifying the name of the AnalyticalField object associated with this predefined field. The field argument applies only when distributionType = FIELD_ANALYTICAL. The default value is an empty string.

  • distributionType (Literal[MAGNITUDE, FIELD_ANALYTICAL], default: MAGNITUDE) โ€“ A SymbolicConstant specifying whether the load is uniform. Possible values are MAGNITUDE and FIELD_ANALYTICAL. The default value is MAGNITUDE.

Returns:

A Velocity object.

Return type:

Velocity

VoidsRatio(name, region, distributionType=abaqusConstants.UNIFORM, voidsRatio1=0, voidsRatio2=0, coord1=0, coord2=0, ratio2Distribution=abaqusConstants.MAGNITUDE, ratio2Field='', variation=abaqusConstants.CONSTANT_RATIO, fileName='', increment=abaqusConstants.LAST_INCREMENT, step=abaqusConstants.LAST_STEP, interpolate=0)[source]๏ƒ

This method creates a PorePressure predefined field object.

Note

This function can be accessed by:

mdb.models[name].PorePressure
Parameters:
  • name (str) โ€“ A String specifying the repository key.

  • region (Region) โ€“ A Region object specifying the region to which the predefined field is applied. Region is ignored if the predefined field has distributionType = FROM_FILE.

  • distributionType (Literal[UNIFORM, FROM_FILE, USER_DEFINED], default: UNIFORM) โ€“ A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM, FROM_FILE and USER_DEFINED. The default value is UNIFORM.

  • voidsRatio1 (float, default: 0) โ€“ The initial void ratio in the first region in your model.

  • voidsRatio2 (float, default: 0) โ€“ The void ratio of the second location in your model

  • coord1 (float, default: 0) โ€“ Vertical position of the first location in your model for which you are specifying initial void ratio.

  • coord2 (float, default: 0) โ€“ The vertical position of the second location in your model

  • ratio2Distribution (Literal[MAGNITUDE, ANALYTICAL_FIELD], default: MAGNITUDE) โ€“ A SymbolicConstant specifying either the magnitude of a uniform distribution for void ratio at the second elevation or an analytical field to define a spatially varying initial void ratio at the second elevation. Possible values are MAGNITUDE and ANALYTICAL_FIELD.

  • ratio2Field (str, default: '') โ€“ A String specifying the name of the AnalyticalField object associated with this predefined field. The ratio2Field argument applies only when distributionType = ANALYTICAL_FIELD.

  • variation (Literal[CONSTANT_RATIO, VARIABLE_RATIO], default: CONSTANT_RATIO) โ€“ A SymbolicConstant selecting the elevation distribution options, either Linear or Constant. Possible values are CONSTANT_RATIO and VARIABLE_RATIO.

  • fileName (str, default: '') โ€“ A String specifying the name of the file from which the Field values are to be read when distributionType = FROM_FILE.

  • increment (Union[int, Literal[LAST_INCREMENT]], default: LAST_INCREMENT) โ€“ The SymbolicConstant LAST_INCREMENT or an Int specifying the increment, interval or iteration of the step when distributionType = FROM_FILE.

  • step (Union[int, Literal[LAST_STEP]], default: LAST_STEP) โ€“ The SymbolicConstant LAST_STEP or an Int specifying the increment, interval or iteration of the step when distributionType = FROM_FILE.

  • interpolate (Union[AbaqusBoolean, bool], default: 0) โ€“ A Boolean specifying whether to interpolate a field read from an output database or results file.

Returns:

A VoidsRatio object.

Other Classes๏ƒ

class Field(name, createStepName, region, outputVariable='', fieldVariableNum=None, distributionType=abaqusConstants.UNIFORM, crossSectionDistribution=abaqusConstants.CONSTANT_THROUGH_THICKNESS, field='', amplitude=abaqusConstants.UNSET, fileName='', beginStep=None, beginIncrement=None, endStep=None, endIncrement=None, interpolate=0, magnitudes='')[source]๏ƒ

Bases: PredefinedField

The Field object stores the data for field predefined fields. The Field object is derived from the PredefinedField object. distributionType=FROM_FILE or FROM_FILE_AND_USER_DEFINED.

Note

This object can be accessed by:

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

The corresponding analysis keywords are:

  • INITIAL CONDITIONS

  • FIELD

New in version 2018: The Field class was added.

This method creates a Field object.

Note

This function can be accessed by:

mdb.models[name].Field
Parameters:
  • name (str) โ€“ A String specifying the repository key.

  • createStepName (str) โ€“ A String specifying the name of the step in which the predefined field is created.

  • region (Region) โ€“ A Region object specifying the region to which the predefined field is applied. Region is ignored if the predefined field has a distributionType member available, and distributionType = FROM_FILE.

  • outputVariable (str, default: '') โ€“ A String specifying the scalar nodal output variable that will be read from an output database and used to initialize a specified predefined field. This argument is a required argument if distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED.

  • fieldVariableNum (Optional[int], default: None) โ€“ An Int specifying the field variable number.

  • distributionType (Literal[FIELD, FROM_FILE, DISCRETE_FIELD, FROM_FILE_AND_USER_DEFINED, UNIFORM, USER_DEFINED], default: UNIFORM) โ€“ A SymbolicConstant specifying how the predefined field varies spatially. Possible values are UNIFORM, USER_DEFINED, FROM_FILE, FIELD, FROM_FILE_AND_USER_DEFINED, and DISCRETE_FIELD. The default value is UNIFORM.

  • crossSectionDistribution (Literal[GRADIENTS_THROUGH_BEAM_CS, POINTS_THROUGH_SECTION, GRADIENTS_THROUGH_SHELL_CS, CONSTANT_THROUGH_THICKNESS], default: CONSTANT_THROUGH_THICKNESS) โ€“

    A SymbolicConstant specifying how the predefined field is distributed over the cross-section of the region. Possible values are

    • CONSTANT_THROUGH_THICKNESS

    • GRADIENTS_THROUGH_SHELL_CS

    • GRADIENTS_THROUGH_BEAM_CS

    • POINTS_THROUGH_SECTION

    The default value is CONSTANT_THROUGH_THICKNESS.

  • field (str, default: '') โ€“ A String specifying the name of the AnalyticalField or DiscreteField object associated with this predefined field. The field argument applies only when distributionType = FIELD or distributionType = DISCRETE_FIELD. The default value is an empty string.

  • amplitude (str, default: UNSET) โ€“

    A String or the SymbolicConstant UNSET specifying the name of the amplitude reference. UNSET should be used if the predefined field has no amplitude reference. The default value is UNSET.

    Note

    amplitude should be given only if it is valid for the specified step.

  • fileName (str, default: '') โ€“ A String specifying the name of the file from which the Field values are to be read when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED.

  • beginStep (Optional[Literal[FROM_FILE, LAST_STEP, FROM_FILE_AND_USER_DEFINED, FIRST_STEP]], default: None) โ€“ An Int specifying the first step from which Field values are to be read or the SymbolicConstant FIRST_STEP or LAST_STEP. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • beginIncrement (Optional[Literal[FROM_FILE, FROM_FILE_AND_USER_DEFINED, STEP_END, STEP_START]], default: None) โ€“ An Int specifying the first increment of the step set in beginStep or the SymbolicConstants STEP_START or STEP_END. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • endStep (Optional[Literal[FROM_FILE, LAST_STEP, FROM_FILE_AND_USER_DEFINED, FIRST_STEP]], default: None) โ€“ An Int specifying the last step from which Field values are to be read or the SymbolicConstants FIRST_STEP and LAST_STEP. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • endIncrement (Optional[Literal[FROM_FILE, FROM_FILE_AND_USER_DEFINED, STEP_END, STEP_START]], default: None) โ€“ An Int specifying the last increment of the step set in endStep or the SymbolicConstants STEP_START and STEP_END. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • interpolate (Union[Literal[MIDSIDE_ONLY], AbaqusBoolean, bool], default: 0) โ€“ A SymbolicConstant specifying whether to interpolate a field read from an output database or results file. Possible values are OFF, ON, or MIDSIDE_ONLY. The default value is OFF.

  • magnitudes (str, default: '') โ€“

    A Sequence of Doubles specifying the Field values when distributionType = UNIFORM or FIELD. The value of the magnitudes argument is a function of the crossSectionDistribution argument, as shown in the following list:

    • If crossSectionDistribution = CONSTANT_THROUGH_THICKNESS, magnitudes is a Double specifying the Field.

    • If crossSectionDistribution = GRADIENTS_THROUGH_SHELL_CS, magnitudes is a sequence of Doubles specifying the mean value and the gradient in the thickness direction.

    • If crossSectionDistribution = GRADIENTS_THROUGH_BEAM_CS, magnitudes is a sequence of Doubles specifying the mean value, the gradient in the N1 direction, and the gradient in the N2 direction.

    • If crossSectionDistribution = POINTS_THROUGH_SECTION, magnitudes is a sequence of Doubles specifying the Field at each point.

Return type:

A Field object.

Member Details:

distributionType: SymbolicConstant = 'UNIFORM'[source]๏ƒ

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

field: str = ''[source]๏ƒ

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

move(fromStepName, toStepName)[source]๏ƒ

This method moves the FieldState object from one step to a different step.

Parameters:
  • fromStepName (str) โ€“ A String specifying the name of the step from which the PredefinedFieldState is moved.

  • toStepName (str) โ€“ A String specifying the name of the step to which the PredefinedFieldState is moved.

Raises:

TextError โ€“

name: str = ''[source]๏ƒ

A String specifying the repository key.

region: Region = <abaqus.Region.Region.Region object>[source]๏ƒ

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

setValues(outputVariable='', fieldVariableNum=None, distributionType=abaqusConstants.UNIFORM, crossSectionDistribution=abaqusConstants.CONSTANT_THROUGH_THICKNESS, field='', amplitude=abaqusConstants.UNSET, fileName='', beginStep=None, beginIncrement=None, endStep=None, endIncrement=None, interpolate=0, magnitudes='')[source]๏ƒ

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

Parameters:
  • outputVariable (str, default: '') โ€“ A String specifying the scalar nodal output variable that will be read from an output database and used to initialize a specified predefined field. This argument is a required argument if distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED.

  • fieldVariableNum (Optional[int], default: None) โ€“ An Int specifying the field variable number.

  • distributionType (Literal[FIELD, FROM_FILE, DISCRETE_FIELD, FROM_FILE_AND_USER_DEFINED, UNIFORM, USER_DEFINED], default: UNIFORM) โ€“ A SymbolicConstant specifying how the predefined field varies spatially. Possible values are UNIFORM, USER_DEFINED, FROM_FILE, FIELD, FROM_FILE_AND_USER_DEFINED, and DISCRETE_FIELD. The default value is UNIFORM.

  • crossSectionDistribution (Literal[GRADIENTS_THROUGH_BEAM_CS, POINTS_THROUGH_SECTION, GRADIENTS_THROUGH_SHELL_CS, CONSTANT_THROUGH_THICKNESS], default: CONSTANT_THROUGH_THICKNESS) โ€“

    A SymbolicConstant specifying how the predefined field is distributed over the cross-section of the region. Possible values are

    • CONSTANT_THROUGH_THICKNESS

    • GRADIENTS_THROUGH_SHELL_CS

    • GRADIENTS_THROUGH_BEAM_CS

    • POINTS_THROUGH_SECTION

    The default value is CONSTANT_THROUGH_THICKNESS.

  • field (str, default: '') โ€“ A String specifying the name of the AnalyticalField or DiscreteField object associated with this predefined field. The field argument applies only when distributionType = FIELD or distributionType = DISCRETE_FIELD. The default value is an empty string.

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

  • fileName (str, default: '') โ€“ A String specifying the name of the file from which the Field values are to be read when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED.

  • beginStep (Optional[Literal[FROM_FILE, LAST_STEP, FROM_FILE_AND_USER_DEFINED, FIRST_STEP]], default: None) โ€“ An Int specifying the first step from which Field values are to be read or the SymbolicConstant FIRST_STEP or LAST_STEP. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • beginIncrement (Optional[Literal[FROM_FILE, FROM_FILE_AND_USER_DEFINED, STEP_END, STEP_START]], default: None) โ€“ An Int specifying the first increment of the step set in beginStep or the SymbolicConstants STEP_START or STEP_END. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • endStep (Optional[Literal[FROM_FILE, LAST_STEP, FROM_FILE_AND_USER_DEFINED, FIRST_STEP]], default: None) โ€“ An Int specifying the last step from which Field values are to be read or the SymbolicConstants FIRST_STEP and LAST_STEP. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • endIncrement (Optional[Literal[FROM_FILE, FROM_FILE_AND_USER_DEFINED, STEP_END, STEP_START]], default: None) โ€“ An Int specifying the last increment of the step set in endStep or the SymbolicConstants STEP_START and STEP_END. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • interpolate (Union[Literal[MIDSIDE_ONLY], AbaqusBoolean, bool], default: 0) โ€“ A SymbolicConstant specifying whether to interpolate a field read from an output database or results file. Possible values are OFF, ON, or MIDSIDE_ONLY. The default value is OFF.

  • magnitudes (str, default: '') โ€“

    A Sequence of Doubles specifying the Field values when distributionType = UNIFORM or FIELD. The value of the magnitudes argument is a function of the crossSectionDistribution argument, as shown in the following list:

    • If crossSectionDistribution = CONSTANT_THROUGH_THICKNESS, magnitudes is a Double specifying the Field.

    • If crossSectionDistribution = GRADIENTS_THROUGH_SHELL_CS, magnitudes is a sequence of Doubles specifying the mean value and the gradient in the thickness direction.

    • If crossSectionDistribution = GRADIENTS_THROUGH_BEAM_CS, magnitudes is a sequence of Doubles specifying the mean value, the gradient in the N1 direction, and the gradient in the N2 direction.

    • If crossSectionDistribution = POINTS_THROUGH_SECTION, magnitudes is a sequence of Doubles specifying the Field at each point.

setValuesInStep(stepName, outputVariable='', fieldVariableNum=None, field='', amplitude=abaqusConstants.UNSET, fileName='', beginStep=None, beginIncrement=None, endStep=None, endIncrement=None, interpolate=0, magnitudes='')[source]๏ƒ

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

Parameters:
  • stepName (str) โ€“ A String specifying the name of the step in which the predefined field is modified.

  • outputVariable (str, default: '') โ€“ A String specifying the scalar nodal output variable that will be read from an output database and used to initialize a specified predefined field. This argument is a required argument if distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED.

  • fieldVariableNum (Optional[int], default: None) โ€“ An Int specifying the field variable number.

  • field (str, default: '') โ€“ A String specifying the name of the AnalyticalField or DiscreteField object associated with this predefined field. The field argument applies only when distributionType = FIELD or distributionType = DISCRETE_FIELD. The default value is an empty string.

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

  • fileName (str, default: '') โ€“ A String specifying the name of the file from which the Field values are to be read when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED.

  • beginStep (Optional[Literal[FROM_FILE, LAST_STEP, FROM_FILE_AND_USER_DEFINED, FIRST_STEP]], default: None) โ€“ An Int specifying the first step from which Field values are to be read or the SymbolicConstant FIRST_STEP or LAST_STEP. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • beginIncrement (Optional[Literal[FROM_FILE, FROM_FILE_AND_USER_DEFINED, STEP_END, STEP_START]], default: None) โ€“ An Int specifying the first increment of the step set in beginStep or the SymbolicConstants STEP_START or STEP_END. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • endStep (Optional[Literal[FROM_FILE, LAST_STEP, FROM_FILE_AND_USER_DEFINED, FIRST_STEP]], default: None) โ€“ An Int specifying the last step from which Field values are to be read or the SymbolicConstants FIRST_STEP and LAST_STEP. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • endIncrement (Optional[Literal[FROM_FILE, FROM_FILE_AND_USER_DEFINED, STEP_END, STEP_START]], default: None) โ€“ An Int specifying the last increment of the step set in endStep or the SymbolicConstants STEP_START and STEP_END. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • interpolate (Union[Literal[MIDSIDE_ONLY], AbaqusBoolean, bool], default: 0) โ€“ A SymbolicConstant specifying whether to interpolate a field read from an output database or results file. Possible values are OFF, ON, or MIDSIDE_ONLY. The default value is OFF.

  • magnitudes (str, default: '') โ€“

    A Sequence of Doubles specifying the Field values when distributionType = UNIFORM or FIELD. The value of the magnitudes argument is a function of the crossSectionDistribution argument, as shown in the following list:

    • If crossSectionDistribution = CONSTANT_THROUGH_THICKNESS, magnitudes is a Double specifying the Field.

    • If crossSectionDistribution = GRADIENTS_THROUGH_SHELL_CS, magnitudes is a sequence of Doubles specifying the mean value and the gradient in the thickness direction.

    • If crossSectionDistribution = GRADIENTS_THROUGH_BEAM_CS, magnitudes is a sequence of Doubles specifying the mean value, the gradient in the N1 direction, and the gradient in the N2 direction.

    • If crossSectionDistribution = POINTS_THROUGH_SECTION, magnitudes is a sequence of Doubles specifying the Field at each point.

class PredefinedField[source]๏ƒ

Bases: object

The PredefinedField object is the base object for the objects in the predefined field repository. The methods and members of the PredefinedField object are common to all objects derived from PredefinedField. An instance of any PredefinedField object can be obtained through the predefined field repository of the Model object. An instance of any PredefinedFieldState object can be obtained through the predefined field repository of the Step object.

Note

This object can be accessed by:

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

Member Details:

delete(indices)[source]๏ƒ

This method allows you to delete existing fields.

Parameters:

indices (tuple) โ€“ A sequence of Ints specifying the index of each field to delete.

fieldList: IMAField = <abaqus.PredefinedField.IMAField.IMAField object>[source]๏ƒ

An IMAField for MaterialAssignment predefined fieldใ€‚

move(fromStepName, toStepName)[source]๏ƒ

This method moves a specific PredefinedFieldState object from one step to a different step.

Parameters:
  • fromStepName (str) โ€“ A String specifying the name of the step from which the PredefinedFieldState object is moved.

  • toStepName (str) โ€“ A String specifying the name of the step to which the PredefinedFieldState object is moved.

Raises:

TextError โ€“

name: str = ''[source]๏ƒ

A String specifying the repository key.

region: Region = <abaqus.Region.Region.Region object>[source]๏ƒ

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

resume()[source]๏ƒ

This method resumes the predefined field that was previously suppressed.

suppress()[source]๏ƒ

This method suppresses the predefined field.

class FieldState[source]๏ƒ

Bases: PredefinedFieldState

The FieldState object stores the propagating data of a field in a step. One instance of this object is created internally by the Field object for each step. The FieldState object has no constructor or methods. The FieldState object is derived from the PredefinedFieldState object.

Note

This object can be accessed by:

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

New in version 2018: The FieldState class was added.

Member Details:

amplitude: SymbolicConstant = 'UNSET'[source]๏ƒ

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

amplitudeState: SymbolicConstant[source]๏ƒ

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

beginIncrement: SymbolicConstant[source]๏ƒ

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

beginIncrementState: SymbolicConstant[source]๏ƒ

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

beginStep: SymbolicConstant = 'NONE'[source]๏ƒ

A SymbolicConstant or an Int specifying the first step from which field values are to be read. This argument is valid only when distribution = FROM_FILE or distribution = FROM_FILE_AND_USER_DEFINED. Possible values are FIRST_STEP, LAST_STEP, and NONE. The default value is NONE.

beginStepState: SymbolicConstant[source]๏ƒ

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

endIncrement: SymbolicConstant[source]๏ƒ

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

endIncrementState: SymbolicConstant[source]๏ƒ

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

endStep: SymbolicConstant[source]๏ƒ

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

endStepState: SymbolicConstant[source]๏ƒ

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

fileName: str = ''[source]๏ƒ

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

fileNameState: SymbolicConstant[source]๏ƒ

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

magnitudes: tuple = ()[source]๏ƒ

A tuple of Floats specifying the field values when distributionType = UNIFORM or distributionType = FIELD. The value of the magnitudes argument is a function of the crossSectionDistribution argument, as shown in the following list:

  • If crossSectionDistribution = CONSTANT_THROUGH_THICKNESS, magnitudes is a Double specifying the field.

  • If crossSectionDistribution = GRADIENTS_THROUGH_SHELL_CS, magnitudes is a sequence of Doubles specifying the mean value and the gradient in the thickness direction.

  • If crossSectionDistribution = GRADIENTS_THROUGH_BEAM_CS, magnitudes is a sequence of Doubles specifying the mean value, the gradient in the N1 direction, and the gradient in the N2 direction.

  • If crossSectionDistribution = POINTS_THROUGH_SECTION, magnitudes is a sequence of Doubles specifying the field at each point.

magnitudesState: SymbolicConstant[source]๏ƒ

A tuple of SymbolicConstants specifying the propagation state of each item of the magnitudes member. Possible values are UNSET, SET, and UNCHANGED.

outputVariable: str = ''[source]๏ƒ

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

status: SymbolicConstant[source]๏ƒ

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

  • NOT_YET_ACTIVE

  • CREATED

  • PROPAGATED

  • MODIFIED

  • DEACTIVATED

  • DEACTIVATED_TO_INITIAL

  • NO_LONGER_ACTIVE

  • RESET_TO_INITIAL

  • TO_BE_COMPUTED

  • PROPAGATED_FROM_COMPUTED

  • BUILT_INTO_BASE_STATE

  • TYPE_NOT_APPLICABLE

  • INSTANCE_NOT_APPLICABLE

This member exists in all PredefinedFieldState objects, but different predefined fields use different subsets of the entire list of possible values depending on propagation rules.

class PredefinedFieldState[source]๏ƒ

Bases: object

The PredefinedFieldState object is the base object for the objects in the predefinedFieldState repository of the Step object. The members of the PredefinedFieldState object are common to all objects derived from PredefinedFieldState. The PredefinedFieldState object has no constructor or methods.

Note

This object can be accessed by:

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

Member Details:

status: SymbolicConstant[source]๏ƒ

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

  • NOT_YET_ACTIVE

  • CREATED

  • PROPAGATED

  • MODIFIED

  • DEACTIVATED

  • DEACTIVATED_TO_INITIAL

  • NO_LONGER_ACTIVE

  • RESET_TO_INITIAL

  • TO_BE_COMPUTED

  • PROPAGATED_FROM_COMPUTED

  • BUILT_INTO_BASE_STATE

  • TYPE_NOT_APPLICABLE

  • INSTANCE_NOT_APPLICABLE

This member exists in all PredefinedFieldState objects, but different predefined fields use different subsets of the entire list of possible values depending on propagation rules.

class FluidCavityPressure(name, fluidCavity, fluidPressure)[source]๏ƒ

Bases: PredefinedField

The FluidCavityPressure object stores the data for initial fluid cavity pressures. The base class region argument can not be specifed with this object. The FluidCavityPressure object is derived from the PredefinedField object.

Note

This object can be accessed by:

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

The corresponding analysis keywords are:

  • INITIAL CONDITIONS

This method creates a FluidCavityPressure object.

Note

This function can be accessed by:

mdb.models[name].FluidCavityPressure
Parameters:
  • name (str) โ€“ A String specifying the repository key.

  • fluidCavity (str) โ€“ A String specifying the name of a Fluid Cavity Interaction.

  • fluidPressure (float) โ€“ A Float specifying the initial fluid pressure.

Returns:

A FluidCavityPressure object.

Return type:

FluidCavityPressure

Member Details:

fluidCavity: str[source]๏ƒ

A String specifying the name of a Fluid Cavity Interaction.

fluidPressure: float[source]๏ƒ

A Float specifying the initial fluid pressure.

region: Region = <abaqus.Region.Region.Region object>[source]๏ƒ

A Region object on which the fluidCavity interaction is specified.

setValues(*args, **kwargs)[source]๏ƒ

This method modifies the FluidCavityPressure object.

class IMAField[source]๏ƒ

Bases: object

A IMAField is an object used to define material instance name volume fractions for the MaterialAssignment predefined field.

Note

This object can be accessed by:

import load
mdb.models[name].predefinedFields[name].fieldList

Member Details:

discfieldList: tuple[str, ...] = ()[source]๏ƒ

A tuple of Strings specifying the name of the discrete fields that contain the volume fraction data. The length of the tuple corresponds to the number of material instance names, as established by the assigned Eulerian section.

region: Region = <abaqus.Region.Region.Region object>[source]๏ƒ

A Region object specifying the sub-region of the selected part instance to which the volume fractions will be applied.

class IMARegion[source]๏ƒ

Bases: object

A IMARegion is an object used to define material instance name volume fractions for the MaterialAssignment predefined field.

Note

This object can be accessed by:

import load
mdb.models[name].predefinedFields[name].assignmentList

Member Details:

fractionList: Optional[float] = None[source]๏ƒ

A tuple of Floats specifying the volume fractions, per material instance name. The length of the tuple corresponds to the number of material instance names, as established by the assigned Eulerian section.

region: Region = <abaqus.Region.Region.Region object>[source]๏ƒ

A Region object specifying the sub-region of the selected part instance to which the volume fractions will be applied.

class InitialState(name, instances, fileName, endStep=abaqusConstants.LAST_STEP, endIncrement=abaqusConstants.STEP_END, updateReferenceConfiguration=0)[source]๏ƒ

Bases: PredefinedField

The InitialState object stores the data for an initial state predefined field. The InitialState object is derived from the PredefinedField object.

Note

This object can be accessed by:

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

The corresponding analysis keywords are:

  • INSTANCE

This method creates an InitialState predefined field object.

Note

This function can be accessed by:

mdb.models[name].InitialState
Parameters:
  • name (str) โ€“ A String specifying the repository key.

  • instances (List[PartInstance]) โ€“ A PartInstanceArray object specifying the instances to which the predefined field is applied.

  • fileName (str) โ€“ A String specifying the name of the job that generated the initial state data.

  • endStep (Literal[LAST_STEP], default: LAST_STEP) โ€“ The SymbolicConstant LAST_STEP or an Int specifying the step from which the initial state values are to be read or the SymbolicConstant LAST_STEP. The default value is LAST_STEP.

  • endIncrement (Literal[STEP_END], default: STEP_END) โ€“ The SymbolicConstant STEP_END or an Int specifying the increment, interval or iteration of the step set in endStep or the SymbolicConstant STEP_END. The default value is STEP_END.

  • updateReferenceConfiguration (Union[AbaqusBoolean, bool], default: 0) โ€“ A Boolean specifying whether to update the reference configuration based on the import data. The default value is OFF.

Returns:

An InitialState object.

Return type:

InitialState

Member Details:

endIncrement: SymbolicConstant = 'STEP_END'[source]๏ƒ

The SymbolicConstant STEP_END or an Int specifying the increment, interval or iteration of the step set in endStep or the SymbolicConstant STEP_END. The default value is STEP_END.

endStep: SymbolicConstant = 'LAST_STEP'[source]๏ƒ

The SymbolicConstant LAST_STEP or an Int specifying the step from which the initial state values are to be read or the SymbolicConstant LAST_STEP. The default value is LAST_STEP.

fileName: str[source]๏ƒ

A String specifying the name of the job that generated the initial state data.

instances: List[PartInstance][source]๏ƒ

A PartInstanceArray object specifying the instances to which the predefined field is applied.

setValues(endStep=abaqusConstants.LAST_STEP, endIncrement=abaqusConstants.STEP_END, updateReferenceConfiguration=0)[source]๏ƒ

This method modifies the InitialState object.

Parameters:
  • endStep (Literal[LAST_STEP], default: LAST_STEP) โ€“ The SymbolicConstant LAST_STEP or an Int specifying the step from which the initial state values are to be read or the SymbolicConstant LAST_STEP. The default value is LAST_STEP.

  • endIncrement (Literal[STEP_END], default: STEP_END) โ€“ The SymbolicConstant STEP_END or an Int specifying the increment, interval or iteration of the step set in endStep or the SymbolicConstant STEP_END. The default value is STEP_END.

  • updateReferenceConfiguration (Union[AbaqusBoolean, bool], default: 0) โ€“ A Boolean specifying whether to update the reference configuration based on the import data. The default value is OFF.

updateReferenceConfiguration: Union[AbaqusBoolean, bool] = 0[source]๏ƒ

A Boolean specifying whether to update the reference configuration based on the import data. The default value is OFF.

class KinematicHardening(name, region, numBackStress=1, equivPlasticStrain=(), backStress=(), sectPtNum=(), definition=abaqusConstants.KINEMATIC_HARDENING, rebarLayerNames=(), distributionType=abaqusConstants.MAGNITUDE)[source]๏ƒ

Bases: PredefinedField

The KinematicHardening object stores the data for initial equivalent Plastic strains and, if relevant, the initial backstress tensor. The KinematicHardening object is derived from the PredefinedField object.

Note

This object can be accessed by:

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

The corresponding analysis keywords are:

  • INITIAL CONDITIONS

This method creates a KinematicHardening object.

Note

This function can be accessed by:

mdb.models[name].KinematicHardening
Parameters:
  • name (str) โ€“ A String specifying the repository key.

  • region (Region) โ€“ A Region object specifying the region to which the predefined field is applied.

  • numBackStress (int, default: 1) โ€“ An Int specifying the number of backstresses. The default value is 1.

  • equivPlasticStrain (tuple, default: ()) โ€“ A sequence of Floats specifying the initial equivalent Plastic strain.

  • backStress (tuple, default: ()) โ€“ A sequence of sequences of Floats specifying the initial backstress tensor for kinematic hardening models. The default value is an empty sequence.

  • sectPtNum (tuple, default: ()) โ€“ A sequence of Ints specifying section point numbers. This argument is valid only when definition = SECTION_PTS.

  • definition (Literal[CRUSHABLE_FOAM, KINEMATIC_HARDENING, REBAR, USER_DEFINED, SECTION_PTS], default: KINEMATIC_HARDENING) โ€“ A SymbolicConstant specifying different types of kinematic hardening. Possible values are KINEMATIC_HARDENING, CRUSHABLE_FOAM, REBAR, SECTION_PTS, and USER_DEFINED. The default value is KINEMATIC_HARDENING.

  • rebarLayerNames (tuple, default: ()) โ€“ A sequence of Strings specifying rebar layer names. This argument is valid only when definition = REBAR.

  • distributionType (Literal[MAGNITUDE, ANALYTICAL_FIELD], default: MAGNITUDE) โ€“ A SymbolicConstant specifying whether the load is uniform. Possible values are MAGNITUDE and ANALYTICAL_FIELD. The default value is MAGNITUDE.

Returns:

A KinematicHardening object.

Return type:

KinematicHardening

Member Details:

backStress: tuple = ()[source]๏ƒ

A sequence of sequences of Floats specifying the initial backstress tensor for kinematic hardening models. The default value is an empty sequence.

definition: SymbolicConstant = 'KINEMATIC_HARDENING'[source]๏ƒ

A SymbolicConstant specifying different types of kinematic hardening. Possible values are KINEMATIC_HARDENING, CRUSHABLE_FOAM, REBAR, SECTION_PTS, and USER_DEFINED. The default value is KINEMATIC_HARDENING.

distributionType: SymbolicConstant = 'MAGNITUDE'[source]๏ƒ

A SymbolicConstant specifying whether the load is uniform. Possible values are MAGNITUDE and ANALYTICAL_FIELD. The default value is MAGNITUDE.

equivPlasticStrain: tuple = ()[source]๏ƒ

A sequence of Floats specifying the initial equivalent Plastic strain.

field: str = ''[source]๏ƒ

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

numBackStress: int = 1[source]๏ƒ

An Int specifying the number of backstresses. The default value is 1.

rebarLayerNames: tuple = ()[source]๏ƒ

A sequence of Strings specifying rebar layer names. This argument is valid only when definition = REBAR.

sectPtNum: tuple = ()[source]๏ƒ

A sequence of Ints specifying section point numbers. This argument is valid only when definition = SECTION_PTS.

setValues(numBackStress=1, equivPlasticStrain=(), backStress=(), sectPtNum=(), definition=abaqusConstants.KINEMATIC_HARDENING, rebarLayerNames=(), distributionType=abaqusConstants.MAGNITUDE)[source]๏ƒ

This method modifies the KinematicHardening object.

Parameters:
  • numBackStress (int, default: 1) โ€“ An Int specifying the number of backstresses. The default value is 1.

  • equivPlasticStrain (tuple, default: ()) โ€“ A sequence of Floats specifying the initial equivalent Plastic strain.

  • backStress (tuple, default: ()) โ€“ A sequence of sequences of Floats specifying the initial backstress tensor for kinematic hardening models. The default value is an empty sequence.

  • sectPtNum (tuple, default: ()) โ€“ A sequence of Ints specifying section point numbers. This argument is valid only when definition = SECTION_PTS.

  • definition (Literal[CRUSHABLE_FOAM, KINEMATIC_HARDENING, REBAR, USER_DEFINED, SECTION_PTS], default: KINEMATIC_HARDENING) โ€“ A SymbolicConstant specifying different types of kinematic hardening. Possible values are KINEMATIC_HARDENING, CRUSHABLE_FOAM, REBAR, SECTION_PTS, and USER_DEFINED. The default value is KINEMATIC_HARDENING.

  • rebarLayerNames (tuple, default: ()) โ€“ A sequence of Strings specifying rebar layer names. This argument is valid only when definition = REBAR.

  • distributionType (Literal[MAGNITUDE, ANALYTICAL_FIELD], default: MAGNITUDE) โ€“ A SymbolicConstant specifying whether the load is uniform. Possible values are MAGNITUDE and ANALYTICAL_FIELD. The default value is MAGNITUDE.

class MaterialAssignment(name, instanceList, useFields=0, assignmentList=(), fieldList=(), colorList=())[source]๏ƒ

Bases: PredefinedField

The MaterialAssignment object stores the data for an initial material assignment predefined field, for use with an Eulerian analysis. The MaterialAssignment object is derived from the PredefinedField object.

Note

This object can be accessed by:

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

The corresponding analysis keywords are:

  • INITIAL CONDITIONS

This method creates a MaterialAssignment predefined field object.

Note

This function can be accessed by:

mdb.models[name].MaterialAssignment
Parameters:
  • name (str) โ€“ A String specifying the repository key.

  • instanceList (List[PartInstance]) โ€“ A PartInstanceArray object specifying the part instances to which the predefined field is applied. All instances must be assigned the same Eulerian section.

  • useFields (Union[AbaqusBoolean, bool], default: 0) โ€“ A Boolean specifying whether the volume fraction data will be uniform or defined by discrete fields. The default value is OFF.

  • assignmentList (Sequence[tuple[Region, tuple[float, ...]]], default: ()) โ€“ A sequence of tuples specifying the uniform volume fractions to be assigned. This argument is valid only when useFields = FALSE. Each tuple contains two entries:A Region object.A tuple of Floats specifying the uniform volume fraction values. The length of the tuple must match the number of material instance names specified in the Eulerain section assigned to part instances specified by instanceList.

  • fieldList (Sequence[tuple[Region, tuple[str, ...]]], default: ()) โ€“ A sequence of tuples specifying the discrete volume fractions to be assigned. This argument is valid only when useFields = TRUE. Each tuple contains two entries:A Region object.A tuple of Strings specifying Discrete Field names. The length of the tuple must match the number of material instance names specified in the Eulerain section assigned to part instances specified by instanceList.

  • colorList (Sequence[tuple[int, int, int]], default: ()) โ€“ A sequence of three Ints specifying colors used to display the material instance assignments. This is a sequence of R,G,B colors, where the values are represented by integers between 0 and 255. The default value is an empty sequence.

Returns:

A MaterialAssignment object.

Return type:

MaterialAssignment

Member Details:

assignmentList: Sequence[tuple[Region, tuple[float, ...]]] = ()[source]๏ƒ

A sequence of tuples specifying the uniform volume fractions to be assigned. This argument is valid only when useFields = FALSE. Each tuple contains two entries:A Region object.A tuple of Floats specifying the uniform volume fraction values. The length of the tuple must match the number of material instance names specified in the Eulerain section assigned to part instances specified by instanceList.

colorList: Sequence[tuple[int, int, int]] = ()[source]๏ƒ

A sequence of three Ints specifying colors used to display the material instance assignments. This is a sequence of R,G,B colors, where the values are represented by integers between 0 and 255. The default value is an empty sequence.

fieldList: Sequence[tuple[Region, tuple[str, ...]]] = ()[source]๏ƒ

A sequence of tuples specifying the discrete volume fractions to be assigned. This argument is valid only when useFields = TRUE. Each tuple contains two entries:A Region object.A tuple of Strings specifying Discrete Field names. The length of the tuple must match the number of material instance names specified in the Eulerain section assigned to part instances specified by instanceList.

instanceList: List[PartInstance][source]๏ƒ

A PartInstanceArray object specifying the part instances to which the predefined field is applied. All instances must be assigned the same Eulerian section.

region: Region = <abaqus.Region.Region.Region object>[source]๏ƒ

A Region object specifying the region to which the predefined field is applied.

setValues(useFields=0, assignmentList=(), fieldList=(), colorList=())[source]๏ƒ

This method modifies the MaterialAssignment object.

Parameters:
  • useFields (Union[AbaqusBoolean, bool], default: 0) โ€“ A Boolean specifying whether the volume fraction data will be uniform or defined by discrete fields. The default value is OFF.

  • assignmentList (Sequence[tuple[Region, tuple[float, ...]]], default: ()) โ€“ A sequence of tuples specifying the uniform volume fractions to be assigned. This argument is valid only when useFields = FALSE. Each tuple contains two entries:A Region object.A tuple of Floats specifying the uniform volume fraction values. The length of the tuple must match the number of material instance names specified in the Eulerain section assigned to part instances specified by instanceList.

  • fieldList (Sequence[tuple[Region, tuple[str, ...]]], default: ()) โ€“ A sequence of tuples specifying the discrete volume fractions to be assigned. This argument is valid only when useFields = TRUE. Each tuple contains two entries:A Region object.A tuple of Strings specifying Discrete Field names. The length of the tuple must match the number of material instance names specified in the Eulerain section assigned to part instances specified by instanceList.

  • colorList (Sequence[tuple[int, int, int]], default: ()) โ€“ A sequence of three Ints specifying colors used to display the material instance assignments. This is a sequence of R,G,B colors, where the values are represented by integers between 0 and 255. The default value is an empty sequence.

useFields: Union[AbaqusBoolean, bool] = 0[source]๏ƒ

A Boolean specifying whether the volume fraction data will be uniform or defined by discrete fields. The default value is OFF.

class PorePressure(name, region, distributionType=abaqusConstants.UNIFORM, porePressure1=0, porePressure2=0, coord1=0, coord2=0, pressure2Distribution=abaqusConstants.MAGNITUDE, pressure2Field='', variation=abaqusConstants.CONSTANT_RATIO, fileName='', increment=abaqusConstants.LAST_INCREMENT, step=abaqusConstants.LAST_STEP, interpolate=0)[source]๏ƒ

Bases: PredefinedField

The PorePressure object stores the data for an initial pore pressure predefined field. The PorePressure object is derived from the PredefinedField object.

Note

This object can be accessed by:

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

The corresponding analysis keywords are:

  • INITIAL CONDITIONS

This method creates a PorePressure predefined field object.

Note

This function can be accessed by:

mdb.models[name].PorePressure
Parameters:
  • name (str) โ€“ A String specifying the repository key.

  • region (Region) โ€“ A Region object specifying the region to which the predefined field is applied. Region is ignored if the predefined field has distributionType = FROM_FILE.

  • distributionType (Literal[UNIFORM, FROM_FILE, USER_DEFINED], default: UNIFORM) โ€“ A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM, FROM_FILE and USER_DEFINED. The default value is UNIFORM.

  • porePressure1 (float, default: 0) โ€“ The initial pore pressure in the first region in your model.

  • porePressure2 (float, default: 0) โ€“ The pore pressure of the second location in your model

  • coord1 (float, default: 0) โ€“ Vertical position of the first location in your model for which you are specifying initial pore pressure.

  • coord2 (float, default: 0) โ€“ The vertical position of the second location in your model.

  • pressure2Distribution (Literal[MAGNITUDE, ANALYTICAL_FIELD], default: MAGNITUDE) โ€“ A SymbolicConstant specifying either the magnitude of a uniform distribution for pore pressure at the second elevation or an analytical field to define a spatially varying initial pore pressure at the second elevation. Possible values are MAGNITUDE and ANALYTICAL_FIELD.

  • pressure2Field (str, default: '') โ€“ A String specifying the name of the AnalyticalField object associated with this predefined field. The pressure2Field argument applies only when distributionType = ANALYTICAL_FIELD.

  • variation (Literal[CONSTANT_RATIO, VARIABLE_RATIO], default: CONSTANT_RATIO) โ€“ A SymbolicConstant selecting the elevation distribution options, either Linear or Constant. Possible values are CONSTANT_RATIO and VARIABLE_RATIO.

  • fileName (str, default: '') โ€“ A String specifying the name of the file from which the Field values are to be read when distributionType = FROM_FILE.

  • increment (Union[int, Literal[LAST_INCREMENT]], default: LAST_INCREMENT) โ€“ The SymbolicConstant LAST_INCREMENT or an Int specifying the increment, interval or iteration of the step when distributionType = FROM_FILE.

  • step (Union[int, Literal[LAST_STEP]], default: LAST_STEP) โ€“ The SymbolicConstant LAST_STEP or an Int specifying the increment, interval or iteration of the step when distributionType = FROM_FILE.

  • interpolate (Union[AbaqusBoolean, bool], default: 0) โ€“ A Boolean specifying whether to interpolate a field read from an output database or results file.

Return type:

A PorePressure object.

Member Details:

setValues(distributionType=abaqusConstants.UNIFORM, porePressure1=0, porePressure2=0, coord1=0, coord2=0, pressure2Distribution=abaqusConstants.MAGNITUDE, pressure2Field=Ellipsis, variation=abaqusConstants.CONSTANT_RATIO, fileName=Ellipsis, increment=Ellipsis, step=Ellipsis, interpolate=Ellipsis)[source]๏ƒ

This method modifies the PorePressure object.

Parameters:
  • distributionType (Literal[UNIFORM, FROM_FILE, USER_DEFINED], default: UNIFORM) โ€“ A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM, FROM_FILE and USER_DEFINED. The default value is UNIFORM.

  • porePressure1 (float, default: 0) โ€“ The initial pore pressure in the first region in your model.

  • porePressure2 (float, default: 0) โ€“ The pore pressure of the second location in your model

  • coord1 (float, default: 0) โ€“ Vertical position of the first location in your model for which you are specifying initial pore pressure.

  • coord2 (float, default: 0) โ€“ The vertical position of the second location in your model.

  • pressure2Distribution (Literal[MAGNITUDE, ANALYTICAL_FIELD], default: MAGNITUDE) โ€“ A SymbolicConstant specifying either the magnitude of a uniform distribution for pore pressure at the second elevation or an analytical field to define a spatially varying initial pore pressure at the second elevation. Possible values are MAGNITUDE and ANALYTICAL_FIELD.

  • pressure2Field (str, default: Ellipsis) โ€“ A String specifying the name of the AnalyticalField object associated with this predefined field. The pressure2Field argument applies only when distributionType = ANALYTICAL_FIELD.

  • variation (Literal[CONSTANT_RATIO, VARIABLE_RATIO], default: CONSTANT_RATIO) โ€“ A SymbolicConstant selecting the elevation distribution options, either Linear or Constant. Possible values are CONSTANT_RATIO and VARIABLE_RATIO.

  • fileName (str, default: Ellipsis) โ€“ A String specifying the name of the file from which the Field values are to be read when distributionType = FROM_FILE.

  • increment (Union[int, Literal[LAST_INCREMENT]], default: Ellipsis) โ€“ The SymbolicConstant LAST_INCREMENT or an Int specifying the increment, interval or iteration of the step when distributionType = FROM_FILE.

  • step (Union[int, Literal[LAST_STEP]], default: Ellipsis) โ€“ The SymbolicConstant LAST_STEP or an Int specifying the increment, interval or iteration of the step when distributionType = FROM_FILE.

  • interpolate (bool, default: Ellipsis) โ€“ A Boolean specifying whether to interpolate a field read from an output database or results file.

Returns:

None

class Saturation(name, region, distributionType=abaqusConstants.UNIFORM, field='', value=0)[source]๏ƒ

Bases: PredefinedField

The Saturation object stores the data for a saturation predefined field. The Saturation object is derived from the PredefinedField object.

Note

This object can be accessed by:

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

The corresponding analysis keywords are:

  • INITIAL CONDITIONS

This method creates a Saturation predefined field object.

Note

This function can be accessed by:

mdb.models[name].Saturation
Parameters:
  • name (str) โ€“ A String specifying the repository key.

  • region (Region) โ€“ A Region object specifying the region to which the predefined field is applied.

  • distributionType (Literal[UNIFORM, FIELD], default: UNIFORM) โ€“ A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM, and FIELD. The default value is UNIFORM.

  • field (str, default: '') โ€“ A String specifying the name of the AnalyticalField object associated with this predefined field. The field argument applies only when distributionType = FIELD. The default value is an empty string.

  • value (float, default: 0) โ€“ A float specifying an initial saturation value for the region between 0.0 (for no saturation) and 1.0 (for full saturation).

Return type:

A Saturation object.

Member Details:

setValues(name, region, distributionType=abaqusConstants.UNIFORM, field='', value=0)[source]๏ƒ

This method modifies the Saturation object.

Parameters:
  • name (str) โ€“ A String specifying the repository key.

  • region (Region) โ€“ A Region object specifying the region to which the predefined field is applied.

  • distributionType (Literal[UNIFORM, FIELD], default: UNIFORM) โ€“ A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM, and FIELD. The default value is UNIFORM.

  • field (str, default: '') โ€“ A String specifying the name of the AnalyticalField object associated with this predefined field. The field argument applies only when distributionType = FIELD. The default value is an empty string.

  • value (float, default: 0) โ€“ A float specifying an initial saturation value for the region between 0.0 (for no saturation) and 1.0 (for full saturation).

Returns:

None

class Stress(name, region, distributionType=abaqusConstants.UNIFORM, sigma11=0, sigma22=0, sigma33=0, sigma12=0, sigma13=0, sigma23=0)[source]๏ƒ

Bases: PredefinedField

The Stress object stores the data for an initial stress predefined field. The Stress object is derived from the PredefinedField object.

Note

This object can be accessed by:

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

The corresponding analysis keywords are:

  • INITIAL CONDITIONS

New in version 2017: The Stress class was added.

This method creates a Stress predefined field object.

Note

This function can be accessed by:

mdb.models[name].Stress
Parameters:
  • name (str) โ€“ A String specifying the repository key.

  • region (Region) โ€“ A Region object specifying the region to which the predefined field is applied. Region is ignored if the predefined field has distributionType = FROM_FILE.

  • distributionType (Literal[UNIFORM, FROM_FILE], default: UNIFORM) โ€“ A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM and FROM_FILE. The default value is UNIFORM.

  • sigma11 (float, default: 0) โ€“ A Float specifying the first principal component of the stress.

  • sigma22 (float, default: 0) โ€“ A Float specifying the second principal component of the stress.

  • sigma33 (float, default: 0) โ€“ A Float specifying the third principal component of the stress.

  • sigma12 (float, default: 0) โ€“ A Float specifying the first shear component of the stress.

  • sigma13 (float, default: 0) โ€“ A Float specifying the second shear component of the stress.

  • sigma23 (float, default: 0) โ€“ A Float specifying the third shear component of the stress.

Return type:

A Stress object.

Member Details:

setValues(distributionType=abaqusConstants.UNIFORM, sigma11=0, sigma22=0, sigma33=0, sigma12=0, sigma13=0, sigma23=0)[source]๏ƒ

This method modifies the Stress object.

Parameters:
  • distributionType (Literal[UNIFORM, FROM_FILE], default: UNIFORM) โ€“ A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM and FROM_FILE. The default value is UNIFORM.

  • sigma11 (float, default: 0) โ€“ A Float specifying the first principal component of the stress.

  • sigma22 (float, default: 0) โ€“ A Float specifying the second principal component of the stress.

  • sigma33 (float, default: 0) โ€“ A Float specifying the third principal component of the stress.

  • sigma12 (float, default: 0) โ€“ A Float specifying the first shear component of the stress.

  • sigma13 (float, default: 0) โ€“ A Float specifying the second shear component of the stress.

  • sigma23 (float, default: 0) โ€“ A Float specifying the third shear component of the stress.

Return type:

None

class Temperature(name, createStepName, region, distributionType=abaqusConstants.UNIFORM, crossSectionDistribution=abaqusConstants.CONSTANT_THROUGH_THICKNESS, field='', amplitude=abaqusConstants.UNSET, fileName='', beginStep=None, beginIncrement=None, endStep=None, endIncrement=None, interpolate=0, magnitudes='', absoluteExteriorTolerance=0, exteriorTolerance=0)[source]๏ƒ

Bases: PredefinedField

The Temperature object stores the data for temperature predefined fields. The Temperature object is derived from the PredefinedField object.

Note

This object can be accessed by:

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

The corresponding analysis keywords are:

  • INITIAL CONDITIONS

  • TEMPERATURE

This method creates a Temperature object.

Note

This function can be accessed by:

mdb.models[name].Temperature
Parameters:
  • name (str) โ€“ A String specifying the repository key.

  • createStepName (str) โ€“ A String specifying the name of the step in which the predefined field is created.

  • region (Region) โ€“ A Region object specifying the region to which the predefined field is applied. Region is ignored if the predefined field has a distributionType member available, and distributionType = FROM_FILE .

  • distributionType (Literal[FIELD, FROM_FILE, DISCRETE_FIELD, FROM_FILE_AND_USER_DEFINED, UNIFORM, USER_DEFINED], default: UNIFORM) โ€“ A SymbolicConstant specifying how the predefined field varies spatially. Possible values are UNIFORM, USER_DEFINED, FROM_FILE, FIELD, FROM_FILE_AND_USER_DEFINED, and DISCRETE_FIELD. The default value is UNIFORM.

  • crossSectionDistribution (Literal[GRADIENTS_THROUGH_BEAM_CS, POINTS_THROUGH_SECTION, GRADIENTS_THROUGH_SHELL_CS, CONSTANT_THROUGH_THICKNESS], default: CONSTANT_THROUGH_THICKNESS) โ€“

    A SymbolicConstant specifying how the predefined field is distributed over the cross section of the region. Possible values are

    • CONSTANT_THROUGH_THICKNESS

    • GRADIENTS_THROUGH_SHELL_CS

    • GRADIENTS_THROUGH_BEAM_CS

    • POINTS_THROUGH_SECTION

    The default value is CONSTANT_THROUGH_THICKNESS.

  • field (str, default: '') โ€“ A String specifying the name of the AnalyticalField or DiscreteField object associated with this predefined field. The field argument applies only when distributionType = FIELD or distributionType = DISCRETE_FIELD. The default value is an empty string.

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

  • fileName (str, default: '') โ€“ A String specifying the name of the file from which the temperature values are to be read when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED.

  • beginStep (Optional[Literal[FROM_FILE, LAST_STEP, FROM_FILE_AND_USER_DEFINED, FIRST_STEP]], default: None) โ€“ An Int specifying the first step from which temperature values are to be read or the SymbolicConstant FIRST_STEP or LAST_STEP. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • beginIncrement (Optional[Literal[FROM_FILE, FROM_FILE_AND_USER_DEFINED, STEP_END, STEP_START]], default: None) โ€“ An Int specifying the first increment of the step set in beginStep or the SymbolicConstants STEP_START or STEP_END. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • endStep (Optional[Literal[FROM_FILE, LAST_STEP, FROM_FILE_AND_USER_DEFINED, FIRST_STEP]], default: None) โ€“ An Int specifying the last step from which temperature values are to be read or the SymbolicConstants FIRST_STEP and LAST_STEP. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • endIncrement (Optional[Literal[FROM_FILE, FROM_FILE_AND_USER_DEFINED, STEP_END, STEP_START]], default: None) โ€“ An Int specifying the last increment of the step set in endStep or the SymbolicConstants STEP_START and STEP_END. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • interpolate (Union[Literal[MIDSIDE_ONLY], AbaqusBoolean, bool], default: 0) โ€“ A SymbolicConstant specifying whether to interpolate a field read from an output database or results file. Possible values are OFF, ON or MIDSIDE_ONLY. The default value is OFF.

  • magnitudes (str, default: '') โ€“

    A Sequence of Doubles specifying the temperature values when distributionType = UNIFORM or FIELD. The value of the magnitudes argument is a function of the crossSectionDistribution argument, as shown in the following list:

    • If crossSectionDistribution = CONSTANT_THROUGH_THICKNESS then magnitudes is a Double specifying the temperature.

    • If crossSectionDistribution = GRADIENTS_THROUGH_SHELL_CS then magnitudes is a sequence of Doubles specifying the mean value and the gradient in the thickness direction.

    • If crossSectionDistribution = GRADIENTS_THROUGH_BEAM_CS then magnitudes is a sequence of Doubles specifying the mean value, the gradient in the N1 direction, and the gradient in the N2 direction.

    • If crossSectionDistribution = POINTS_THROUGH_SECTION then magnitudes is a sequence of Doubles specifying the temperature at each point.

  • absoluteExteriorTolerance (float, default: 0) โ€“ A Float specifying the absolute value by which a driven node of the field can lie outside the region of the elements of the global model. The default value is 0.0. This argument cannot be used with midside.

  • exteriorTolerance (float, default: 0) โ€“ A Float specifying the fraction of the average element size in the global model by which a driven node of the field can lie outside the region of the elements of the global model. The default value is 0.0. This argument cannot be used with midside.

Returns:

A Temperature object.

Return type:

Temperature

Member Details:

distributionType: SymbolicConstant = 'UNIFORM'[source]๏ƒ

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

field: str = ''[source]๏ƒ

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

move(fromStepName, toStepName)[source]๏ƒ

This method moves the TemperatureState object from one step to a different step.

Parameters:
  • fromStepName (str) โ€“ A String specifying the name of the step from which the PredefinedFieldState is moved.

  • toStepName (str) โ€“ A String specifying the name of the step to which the PredefinedFieldState is moved.

Raises:

TextError โ€“

name: str = ''[source]๏ƒ

A String specifying the repository key.

region: Region = <abaqus.Region.Region.Region object>[source]๏ƒ

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

setValues(distributionType=abaqusConstants.UNIFORM, crossSectionDistribution=abaqusConstants.CONSTANT_THROUGH_THICKNESS, field='', amplitude=abaqusConstants.UNSET, fileName='', beginStep=None, beginIncrement=None, endStep=None, endIncrement=None, interpolate=0, magnitudes='', absoluteExteriorTolerance=0, exteriorTolerance=0)[source]๏ƒ

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

Parameters:
  • distributionType (Literal[FIELD, FROM_FILE, DISCRETE_FIELD, FROM_FILE_AND_USER_DEFINED, UNIFORM, USER_DEFINED], default: UNIFORM) โ€“ A SymbolicConstant specifying how the predefined field varies spatially. Possible values are UNIFORM, USER_DEFINED, FROM_FILE, FIELD, FROM_FILE_AND_USER_DEFINED, and DISCRETE_FIELD. The default value is UNIFORM.

  • crossSectionDistribution (Literal[GRADIENTS_THROUGH_BEAM_CS, POINTS_THROUGH_SECTION, GRADIENTS_THROUGH_SHELL_CS, CONSTANT_THROUGH_THICKNESS], default: CONSTANT_THROUGH_THICKNESS) โ€“

    A SymbolicConstant specifying how the predefined field is distributed over the cross section of the region. Possible values are

    • CONSTANT_THROUGH_THICKNESS

    • GRADIENTS_THROUGH_SHELL_CS

    • GRADIENTS_THROUGH_BEAM_CS

    • POINTS_THROUGH_SECTION

    The default value is CONSTANT_THROUGH_THICKNESS.

  • field (str, default: '') โ€“ A String specifying the name of the AnalyticalField or DiscreteField object associated with this predefined field. The field argument applies only when distributionType = FIELD or distributionType = DISCRETE_FIELD. The default value is an empty string.

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

  • fileName (str, default: '') โ€“ A String specifying the name of the file from which the temperature values are to be read when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED.

  • beginStep (Optional[Literal[FROM_FILE, LAST_STEP, FROM_FILE_AND_USER_DEFINED, FIRST_STEP]], default: None) โ€“ An Int specifying the first step from which temperature values are to be read or the SymbolicConstant FIRST_STEP or LAST_STEP. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • beginIncrement (Optional[Literal[FROM_FILE, FROM_FILE_AND_USER_DEFINED, STEP_END, STEP_START]], default: None) โ€“ An Int specifying the first increment of the step set in beginStep or the SymbolicConstants STEP_START or STEP_END. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • endStep (Optional[Literal[FROM_FILE, LAST_STEP, FROM_FILE_AND_USER_DEFINED, FIRST_STEP]], default: None) โ€“ An Int specifying the last step from which temperature values are to be read or the SymbolicConstants FIRST_STEP and LAST_STEP. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • endIncrement (Optional[Literal[FROM_FILE, FROM_FILE_AND_USER_DEFINED, STEP_END, STEP_START]], default: None) โ€“ An Int specifying the last increment of the step set in endStep or the SymbolicConstants STEP_START and STEP_END. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • interpolate (Union[Literal[MIDSIDE_ONLY], AbaqusBoolean, bool], default: 0) โ€“ A SymbolicConstant specifying whether to interpolate a field read from an output database or results file. Possible values are OFF, ON or MIDSIDE_ONLY. The default value is OFF.

  • magnitudes (str, default: '') โ€“

    A Sequence of Doubles specifying the temperature values when distributionType = UNIFORM or FIELD. The value of the magnitudes argument is a function of the crossSectionDistribution argument, as shown in the following list:

    • If crossSectionDistribution = CONSTANT_THROUGH_THICKNESS then magnitudes is a Double specifying the temperature.

    • If crossSectionDistribution = GRADIENTS_THROUGH_SHELL_CS then magnitudes is a sequence of Doubles specifying the mean value and the gradient in the thickness direction.

    • If crossSectionDistribution = GRADIENTS_THROUGH_BEAM_CS then magnitudes is a sequence of Doubles specifying the mean value, the gradient in the N1 direction, and the gradient in the N2 direction.

    • If crossSectionDistribution = POINTS_THROUGH_SECTION then magnitudes is a sequence of Doubles specifying the temperature at each point.

  • absoluteExteriorTolerance (float, default: 0) โ€“ A Float specifying the absolute value by which a driven node of the field can lie outside the region of the elements of the global model. The default value is 0.0. This argument cannot be used with midside.

  • exteriorTolerance (float, default: 0) โ€“ A Float specifying the fraction of the average element size in the global model by which a driven node of the field can lie outside the region of the elements of the global model. The default value is 0.0. This argument cannot be used with midside.

setValuesInStep(stepName, field='', amplitude=abaqusConstants.UNSET, fileName='', beginStep=None, beginIncrement=None, endStep=None, endIncrement=None, interpolate=0, magnitudes='', absoluteExteriorTolerance=0, exteriorTolerance=0)[source]๏ƒ

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

Parameters:
  • stepName (str) โ€“ A String specifying the name of the step in which the predefined field is modified.

  • field (str, default: '') โ€“ A String specifying the name of the AnalyticalField or DiscreteField object associated with this predefined field. The field argument applies only when distributionType = FIELD or distributionType = DISCRETE_FIELD. The default value is an empty string.

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

  • fileName (str, default: '') โ€“ A String specifying the name of the file from which the temperature values are to be read when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED.

  • beginStep (Optional[Literal[FROM_FILE, LAST_STEP, FROM_FILE_AND_USER_DEFINED, FIRST_STEP]], default: None) โ€“ An Int specifying the first step from which temperature values are to be read or the SymbolicConstant FIRST_STEP or LAST_STEP. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • beginIncrement (Optional[Literal[FROM_FILE, FROM_FILE_AND_USER_DEFINED, STEP_END, STEP_START]], default: None) โ€“ An Int specifying the first increment of the step set in beginStep or the SymbolicConstants STEP_START or STEP_END. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • endStep (Optional[Literal[FROM_FILE, LAST_STEP, FROM_FILE_AND_USER_DEFINED, FIRST_STEP]], default: None) โ€“ An Int specifying the last step from which temperature values are to be read or the SymbolicConstants FIRST_STEP and LAST_STEP. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • endIncrement (Optional[Literal[FROM_FILE, FROM_FILE_AND_USER_DEFINED, STEP_END, STEP_START]], default: None) โ€“ An Int specifying the last increment of the step set in endStep or the SymbolicConstants STEP_START and STEP_END. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED. The default value is None.

  • interpolate (Union[Literal[MIDSIDE_ONLY], AbaqusBoolean, bool], default: 0) โ€“ A SymbolicConstant specifying whether to interpolate a field read from an output database or results file. Possible values are OFF, ON or MIDSIDE_ONLY. The default value is OFF.

  • magnitudes (str, default: '') โ€“

    A Sequence of Doubles specifying the temperature values when distributionType = UNIFORM or FIELD. The value of the magnitudes argument is a function of the crossSectionDistribution argument, as shown in the following list:

    • If crossSectionDistribution = CONSTANT_THROUGH_THICKNESS then magnitudes is a Double specifying the temperature.

    • If crossSectionDistribution = GRADIENTS_THROUGH_SHELL_CS then magnitudes is a sequence of Doubles specifying the mean value and the gradient in the thickness direction.

    • If crossSectionDistribution = GRADIENTS_THROUGH_BEAM_CS then magnitudes is a sequence of Doubles specifying the mean value, the gradient in the N1 direction, and the gradient in the N2 direction.

    • If crossSectionDistribution = POINTS_THROUGH_SECTION then magnitudes is a sequence of Doubles specifying the temperature at each point.

  • absoluteExteriorTolerance (float, default: 0) โ€“ A Float specifying the absolute value by which a driven node of the field can lie outside the region of the elements of the global model. The default value is 0.0. This argument cannot be used with midside.

  • exteriorTolerance (float, default: 0) โ€“ A Float specifying the fraction of the average element size in the global model by which a driven node of the field can lie outside the region of the elements of the global model. The default value is 0.0. This argument cannot be used with midside.

class Velocity(name, region, velocity1, velocity2, velocity3, omega, axisBegin, axisEnd, field='', distributionType=abaqusConstants.MAGNITUDE)[source]๏ƒ

Bases: PredefinedField

The Velocity object stores the data for an initial velocity predefined field. The Velocity object is derived from the PredefinedField object.

Note

This object can be accessed by:

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

The corresponding analysis keywords are:

  • INITIAL CONDITIONS

This method creates a Velocity predefined field object.

Note

This function can be accessed by:

mdb.models[name].Velocity
Parameters:
  • name (str) โ€“ A String specifying the repository key.

  • region (Region) โ€“ A Region object specifying the region to which the predefined field is applied.

  • velocity1 (float) โ€“ A Float specifying the first component of the velocity.

  • velocity2 (float) โ€“ A Float specifying the second component of the velocity.

  • velocity3 (float) โ€“ A Float specifying the third component of the velocity.

  • omega (float) โ€“ A Float specifying the angular velocity.

  • axisBegin (tuple) โ€“ A sequence of Floats specifying the X-, Y-, and Z coordinates of the starting point of the axis about which omega is defined.

  • axisEnd (tuple) โ€“ A sequence of Floats specifying the X-, Y-, and Z coordinates of the end point of the axis about which omega is defined.

  • field (str, default: '') โ€“ A String specifying the name of the AnalyticalField object associated with this predefined field. The field argument applies only when distributionType = FIELD_ANALYTICAL. The default value is an empty string.

  • distributionType (Literal[MAGNITUDE, FIELD_ANALYTICAL], default: MAGNITUDE) โ€“ A SymbolicConstant specifying whether the load is uniform. Possible values are MAGNITUDE and FIELD_ANALYTICAL. The default value is MAGNITUDE.

Returns:

A Velocity object.

Return type:

Velocity

Member Details:

axisBegin: tuple[source]๏ƒ

A sequence of Floats specifying the X-, Y-, and Z coordinates of the starting point of the axis about which omega is defined.

axisEnd: tuple[source]๏ƒ

A sequence of Floats specifying the X-, Y-, and Z coordinates of the end point of the axis about which omega is defined.

distributionType: SymbolicConstant = 'MAGNITUDE'[source]๏ƒ

A SymbolicConstant specifying whether the load is uniform. Possible values are MAGNITUDE and FIELD_ANALYTICAL. The default value is MAGNITUDE.

field: str = ''[source]๏ƒ

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

omega: float[source]๏ƒ

A Float specifying the angular velocity.

setValues(field='', distributionType=abaqusConstants.MAGNITUDE)[source]๏ƒ

This method modifies the Velocity object.

Parameters:
  • field (str, default: '') โ€“ A String specifying the name of the AnalyticalField object associated with this predefined field. The field argument applies only when distributionType = FIELD_ANALYTICAL. The default value is an empty string.

  • distributionType (Literal[MAGNITUDE, FIELD_ANALYTICAL], default: MAGNITUDE) โ€“ A SymbolicConstant specifying whether the load is uniform. Possible values are MAGNITUDE and FIELD_ANALYTICAL. The default value is MAGNITUDE.

velocity1: float[source]๏ƒ

A Float specifying the first component of the velocity.

velocity2: float[source]๏ƒ

A Float specifying the second component of the velocity.

velocity3: float[source]๏ƒ

A Float specifying the third component of the velocity.

class VoidsRatio(name, region, distributionType=abaqusConstants.UNIFORM, voidsRatio1=0, voidsRatio2=0, coord1=0, coord2=0, ratio2Distribution=abaqusConstants.MAGNITUDE, ratio2Field='', variation=abaqusConstants.CONSTANT_RATIO, fileName='', increment=abaqusConstants.LAST_INCREMENT, step=abaqusConstants.LAST_STEP, interpolate=0)[source]๏ƒ

Bases: PredefinedField

The VoidsRatio object stores the data for an initial void ratio predefined field. The VoidsRatio object is derived from the PredefinedField object.

Note

This object can be accessed by:

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

The corresponding analysis keywords are:

  • INITIAL CONDITIONS

This method creates a PorePressure predefined field object.

Note

This function can be accessed by:

mdb.models[name].VoidsRatio
Parameters:
  • name (str) โ€“ A String specifying the repository key.

  • region (Region) โ€“ A Region object specifying the region to which the predefined field is applied. Region is ignored if the predefined field has distributionType = FROM_FILE.

  • distributionType (Literal[UNIFORM, FROM_FILE, USER_DEFINED], default: UNIFORM) โ€“ A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM, FROM_FILE and USER_DEFINED. The default value is UNIFORM.

  • voidsRatio1 (float, default: 0) โ€“ The initial void ratio in the first region in your model.

  • voidsRatio2 (float, default: 0) โ€“ The void ratio of the second location in your model

  • coord1 (float, default: 0) โ€“ Vertical position of the first location in your model for which you are specifying initial void ratio.

  • coord2 (float, default: 0) โ€“ The vertical position of the second location in your model

  • ratio2Distribution (Literal[MAGNITUDE, ANALYTICAL_FIELD], default: MAGNITUDE) โ€“ A SymbolicConstant specifying either the magnitude of a uniform distribution for void ratio at the second elevation or an analytical field to define a spatially varying initial void ratio at the second elevation. Possible values are MAGNITUDE and ANALYTICAL_FIELD.

  • ratio2Field (str, default: '') โ€“ A String specifying the name of the AnalyticalField object associated with this predefined field. The ratio2Field argument applies only when distributionType = ANALYTICAL_FIELD.

  • variation (Literal[CONSTANT_RATIO, VARIABLE_RATIO], default: CONSTANT_RATIO) โ€“ A SymbolicConstant selecting the elevation distribution options, either Linear or Constant. Possible values are CONSTANT_RATIO and VARIABLE_RATIO.

  • fileName (str, default: '') โ€“ A String specifying the name of the file from which the Field values are to be read when distributionType = FROM_FILE.

  • increment (Union[int, Literal[LAST_INCREMENT]], default: LAST_INCREMENT) โ€“ The SymbolicConstant LAST_INCREMENT or an Int specifying the increment, interval or iteration of the step when distributionType = FROM_FILE.

  • step (Union[int, Literal[LAST_STEP]], default: LAST_STEP) โ€“ The SymbolicConstant LAST_STEP or an Int specifying the increment, interval or iteration of the step when distributionType = FROM_FILE.

  • interpolate (Union[AbaqusBoolean, bool], default: 0) โ€“ A Boolean specifying whether to interpolate a field read from an output database or results file.

Return type:

A VoidsRatio object.

Member Details:

setValues(distributionType=abaqusConstants.UNIFORM, voidsRatio1=0, voidsRatio2=0, coord1=0, coord2=0, ratio2Distribution=abaqusConstants.MAGNITUDE, ratio2Field=Ellipsis, variation=abaqusConstants.CONSTANT_RATIO, fileName=Ellipsis, increment=Ellipsis, step=Ellipsis, interpolate=Ellipsis)[source]๏ƒ

This method modifies the VoidsRatio object.

Parameters:
  • distributionType (Literal[UNIFORM, FROM_FILE, USER_DEFINED], default: UNIFORM) โ€“ A SymbolicConstant specifying whether the load is uniform. Possible values are UNIFORM, FROM_FILE and USER_DEFINED. The default value is UNIFORM.

  • voidsRatio1 (float, default: 0) โ€“ The initial void ratio in the first region in your model.

  • voidsRatio2 (float, default: 0) โ€“ The void ratio of the second location in your model

  • coord1 (float, default: 0) โ€“ Vertical position of the first location in your model for which you are specifying initial void ratio.

  • coord2 (float, default: 0) โ€“ The vertical position of the second location in your model

  • ratio2Distribution (Literal[MAGNITUDE, ANALYTICAL_FIELD], default: MAGNITUDE) โ€“ A SymbolicConstant specifying either the magnitude of a uniform distribution for void ratio at the second elevation or an analytical field to define a spatially varying initial void ratio at the second elevation. Possible values are MAGNITUDE and ANALYTICAL_FIELD.

  • ratio2Field (str, default: Ellipsis) โ€“ A String specifying the name of the AnalyticalField object associated with this predefined field. The ratio2Field argument applies only when distributionType = ANALYTICAL_FIELD.

  • variation (Literal[CONSTANT_RATIO, VARIABLE_RATIO], default: CONSTANT_RATIO) โ€“ A SymbolicConstant selecting the elevation distribution options, either Linear or Constant. Possible values are CONSTANT_RATIO and VARIABLE_RATIO.

  • fileName (str, default: Ellipsis) โ€“ A String specifying the name of the file from which the Field values are to be read when distributionType = FROM_FILE.

  • increment (Union[int, Literal[LAST_INCREMENT]], default: Ellipsis) โ€“ The SymbolicConstant LAST_INCREMENT or an Int specifying the increment, interval or iteration of the step when distributionType = FROM_FILE.

  • step (Union[int, Literal[LAST_STEP]], default: Ellipsis) โ€“ The SymbolicConstant LAST_STEP or an Int specifying the increment, interval or iteration of the step when distributionType = FROM_FILE.

  • interpolate (bool, default: Ellipsis) โ€“ A Boolean specifying whether to interpolate a field read from an output database or results file.

Returns:

None

class TemperatureState[source]๏ƒ

Bases: PredefinedFieldState

The TemperatureState object stores the propagating data of a temperature in a step. One instance of this object is created internally by the Temperature object for each step. The TemperatureState object has no constructor or methods. The TemperatureState object is derived from the PredefinedFieldState object.

Note

This object can be accessed by:

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

Member Details:

amplitude: SymbolicConstant = 'UNSET'[source]๏ƒ

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

amplitudeState: SymbolicConstant[source]๏ƒ

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

beginIncrement: SymbolicConstant[source]๏ƒ

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

beginIncrementState: SymbolicConstant[source]๏ƒ

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

beginStep: SymbolicConstant = 'NONE'[source]๏ƒ

A SymbolicConstant or an Int specifying the first step from which temperature values are to be read. This argument is valid only when distribution = FROM_FILE or distribution = FROM_FILE_AND_USER_DEFINED. Possible values are FIRST_STEP, LAST_STEP, and NONE. The default value is NONE.

beginStepState: SymbolicConstant[source]๏ƒ

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

endIncrement: SymbolicConstant[source]๏ƒ

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

endIncrementState: SymbolicConstant[source]๏ƒ

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

endStep: SymbolicConstant[source]๏ƒ

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

endStepState: SymbolicConstant[source]๏ƒ

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

fileName: str = ''[source]๏ƒ

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

fileNameState: SymbolicConstant[source]๏ƒ

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

magnitudes: tuple = ()[source]๏ƒ

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

magnitudesState: SymbolicConstant[source]๏ƒ

A tuple of SymbolicConstants specifying the propagation state of each item of the magnitudes member. Possible values are UNSET, SET, and UNCHANGED.

midside: Union[AbaqusBoolean, bool] = 0[source]๏ƒ

A Boolean specifying that temperatures in second-order elements are to be interpolated from corner node temperatures. This argument is valid only when distributionType = FROM_FILE or distributionType = FROM_FILE_AND_USER_DEFINED.

midsideState: SymbolicConstant[source]๏ƒ

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

status: SymbolicConstant[source]๏ƒ

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

  • NOT_YET_ACTIVE

  • CREATED

  • PROPAGATED

  • MODIFIED

  • DEACTIVATED

  • DEACTIVATED_TO_INITIAL

  • NO_LONGER_ACTIVE

  • RESET_TO_INITIAL

  • TO_BE_COMPUTED

  • PROPAGATED_FROM_COMPUTED

  • BUILT_INTO_BASE_STATE

  • TYPE_NOT_APPLICABLE

  • INSTANCE_NOT_APPLICABLE

This member exists in all PredefinedFieldState objects, but different predefined fields use different subsets of the entire list of possible values depending on propagation rules.

class TiffOptions[source]๏ƒ

Bases: object

The TiffOptions object stores the settings that Abaqus uses when printing in TIFF format. The TiffOptions object has no constructor. Abaqus creates the tiffOptions member when a session is started.

Note

This object can be accessed by:

session.tiffOptions

Member Details:

setValues(imageSize=abaqusConstants.SIZE_ON_SCREEN)[source]๏ƒ

This method modifies the TiffOptions object.

Parameters:

imageSize (Literal[SIZE_ON_SCREEN], default: SIZE_ON_SCREEN) โ€“ The SymbolicConstant SIZE_ON_SCREEN or a pair of Ints specifying the width and height of the image in pixels. Possible values are (minWidth, minHeight) โ‰ค imageSize โ‰ค (maxWidth and maxHeight). The default value is SIZE_ON_SCREEN. Note:The minimum value of width and height (minWidth and minHeight ) is the number of pixels that occupy 10 mm at the current screen resolution. The value is typically around 50 pixels and may be different for width and height. The maximum value of width and height (maxWidth and maxHeight ) is the largest number of pixels supported by the system graphics and will be at least as large as the screen dimensions.

Raises:
  • RangeError โ€“ If either the width or height arguments of imageSize are out of range (where minWidth and minHeight are the number of pixels corresponding to approximately 10 mm for a given display and maxWidth and maxHeight are the largest allowable number of pixels supported by the system graphics).

  • RangeError โ€“ imageSize must be SIZE_ON_SCREEN or a sequence of 2 Ints in the range, (minWidth, minHeight) <= (width, height) <= (maxWidth, maxHeight).