Field¶

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

Create fields¶

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

Bases: ModelBase

Public Data Attributes:

Inherited from ModelBase

`name`	A String specifying the repository key.
`stefanBoltzmann`	None or a Float specifying the Stefan-Boltzmann constant.
`absoluteZero`	None or a Float specifying the absolute zero constant.
`waveFormulation`	A SymbolicConstant specifying the type of incident wave formulation to be used in acoustic problems.
`universalGas`	None or a Float specifying the universal gas constant.
`noPartsInputFile`	A Boolean specifying whether an input file should be written without parts and assemblies.
`endRestartStep`	A Boolean specifying that the step specified by restartStep should be terminated at the increment specified by restartIncrement.
`shellToSolid`	A Boolean specifying that a shell global model drives a solid submodel.
`lastChangedCount`	A Float specifying the time stamp that indicates when the model was last changed.
`description`	A String specifying the purpose and contents of the Model object.
`restartJob`	A String specifying the name of the job that generated the restart data.
`restartStep`	A String specifying the name of the step where the restart analysis will start.
`globalJob`	A String specifying the name of the job that generated the results for the global model.
`copyConstraints`	A boolean specifying the status of constraints created in a model, in the model which instances this model.
`copyConnectors`	A boolean specifying the status of connectors created in a model, in the model which instances this model.
`copyInteractions`	A boolean specifying the status of interactions created in a model, in the model which instances this model.
`keywordBlock`	A KeywordBlock object.
`amplitudes`	A repository of Amplitude objects.
`profiles`	A repository of Profile objects.
`boundaryConditions`	A repository of BoundaryCondition objects.
`constraints`	A repository of ConstrainedSketchConstraint objects.
`analyticalFields`	A repository of AnalyticalField objects.
`discreteFields`	A repository of DiscreteField objects.
`predefinedFields`	A repository of PredefinedField objects.
`interactions`	A repository of Interaction objects.
`interactionProperties`	A repository of InteractionProperty objects.
`contactControls`	A repository of ContactControl objects.
`contactInitializations`	A repository of ContactInitialization objects.
`contactStabilizations`	A repository of ContactStabilization objects.
`linkedInstances`	A tuple of tuples of Strings specifying the linked child PartInstance name in the current model to the corresponding parent PartInstance name in a different model.
`linkedParts`	A tuple of tuples of Strings specifying the linked child Part name in the current model to the corresponding parent Part name in a different model.
`loads`	A repository of Load objects.
`materials`	A repository of Material objects.
`calibrations`	A repository of Calibration objects.
`sections`	A repository of Section objects.
`remeshingRules`	A repository of RemeshingRule objects.
`sketches`	A repository of ConstrainedSketch objects.
`parts`	A repository of Part objects.
`steps`	A repository of Step objects.
`featureOptions`	A FeatureOptions object.
`adaptiveMeshConstraints`	A repository of AdaptiveMeshConstraint objects.
`adaptiveMeshControls`	A repository of AdaptiveMeshControl objects.
`timePoints`	A repository of TimePoint objects.
`filters`	A repository of Filter objects.
`integratedOutputSections`	A repository of IntegratedOutputSection objects.
`fieldOutputRequests`	A repository of FieldOutputRequest objects.
`historyOutputRequests`	A repository of HistoryOutputRequest objects.
`optimizationTasks`	A repository of OptimizationTask objects.
`tableCollections`	A repository of TableCollection objects.
`eventSeriesTypes`	A repository of EventSeriesType objects.
`eventSeriesDatas`	A repository of EventSeriesData objects.
`restartIncrement`	An Int specifying the increment, interval, iteration or cycle where the restart analysis will start.
`rootAssembly`	An Assembly object.

Public Methods:

`DiscreteField`(name, defaultValues, fieldType)	This method creates a DiscreteField object.
`ExpressionField`(name, expression[, ...])	This method creates an ExpressionField object.
`MappedField`(name[, regionType, ...])	This method creates an MappedField 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:

DiscreteField( name, defaultValues, fieldType, location=NODES, dataWidth=1, data=None, description='', orientationType=CARTESIAN, partLevelOrientation=0, )[source]¶

This method creates a DiscreteField object.

Note

This function can be accessed by:

mdb.models[name].DiscreteField

Note

Check DiscreteField on help.3ds.com/2024.

Parameters:¶

name¶: A String specifying the repository key.
defaultValues¶: A sequence of Floats specifying a sequence of floats specifying the default values.
fieldType¶: A SymbolicConstant or an Int specifying the type of data represented by this discrete field. Possible values are SCALAR, ORIENTATION, and PRESCRIBEDCONDITION_DOF.
location=NODES¶: A SymbolicConstant or an Int specifying the location of the domain data. Possible values are NODES and ELEMENTS. The default value is NODES.
dataWidth=1¶: An Int specifying the width of the supplied data. The default value is 1.
data=None¶: A DataTableArray object.
description=''¶: A String specifying the description of the field. The default value is an empty string.
orientationType=CARTESIAN¶: A SymbolicConstant specifying the type of the system being described by a discrete field used for an orientation. Possible values are CARTESIAN, CYLINDRICAL, and SPHERICAL. The default value is CARTESIAN.
partLevelOrientation=0¶: A Boolean specifying whether or not the orientations are described in terms of part level coordinates. The default value is OFF.

Returns:¶

A DiscreteField object.

Return type:¶

DiscreteField

Raises:¶

AbaqusException –

ExpressionField(name, expression, localCsys=None, description='')[source]¶

This method creates an ExpressionField object.

Note

This function can be accessed by:

mdb.models[name].ExpressionField

Note

Check ExpressionField on help.3ds.com/2024.

Parameters:¶

name¶: A String specifying the repository key.
expression¶: A String specifying the Python expression to evaluate in space. Variables are X, Y, and Z; R, Th, and Z; or R, Th, and P based on the selected coordinate system.
localCsys=None¶: None or a DatumCsys object specifying the local coordinate system of the field. If localCsys = None, the field is defined in the global coordinate system. The default value is None.
description=''¶: A String specifying the description of the field. The default value is an empty string.

Returns:¶

An ExpressionField object.

Return type:¶

ExpressionField

Raises:¶

TextException –

MappedField( name, regionType=POINT, partLevelData=0, pointDataFormat=XYZ, gridPointPlane=XYPLANE, defaultUnMappedValue=0, mappingAlgorithm=SURFACE, searchTolType=RELATIVE, boundarySearchTol=0, neighborhoodSearchTol=1000000, negativeNormalSearchTol=0, positiveNormalSearchTol=0, scaleCoordinates=0, gridPointData=(), xyzPointData=(), coordinateScalingFactors=(), localCsys=None, description='', )[source]¶

This method creates an MappedField object.

Note

This function can be accessed by:

mdb.models[name].MappedField

Note

Check MappedField on help.3ds.com/2024.

Parameters:¶

name¶: A String specifying the repository key.
regionType=POINT¶: A SymbolicConstant specifying the data source region type. It can be either an ODB mesh or a cloud of points. Possible values are MESH and POINT. The default value is POINT.
partLevelData=0¶: A Boolean specifying whether or not the point cloud source data are described in terms of part level coordinates. If part level coordinates is employed, the local coordinate system defined in localCsys will be ignored. The default value is OFF.
pointDataFormat=XYZ¶: A SymbolicConstant specifying point cloud source data format. Possible values are GRID and XYZ. The default value is XYZ.
gridPointPlane=XYPLANE¶: A SymbolicConstant specifying the plane on which the point cloud source data of grid format are described. Possible values are XYPLANE, YZPLANE, and XZPLANE. The default value is XYPLANE.
defaultUnMappedValue=0¶: A Float specifying the parameter (field) value reported when a value cannot be calculated from the data source. The default value is 0.0.
mappingAlgorithm=SURFACE¶: A SymbolicConstant specifying the mapping algorithm for target surface, or on mesh target model when the parameter value are located at nodes, for example nodal temperatures. Possible values are SURFACE and VOLUMETRIC. The default value is SURFACE.
searchTolType=RELATIVE¶: A SymbolicConstant specifying searching tolerance type in terms of absolute value or a fraction of the average of all element characteristic length in target model region. Possible values are ABSOLUTE and RELATIVE. The default value is RELATIVE.
boundarySearchTol=0¶: A Float specifying the search distance tolerance value on the exterior boundary of target model region. Source points within this distance will be included in computing the parameter value of target region. This tolerance applies to both surface and volumetric mapping. The default value is 0.01.
neighborhoodSearchTol=1000000¶: A Float specifying the search distance tolerance value used for distance weighting algorithm. Source points within this distance will be included in computing the parameter value of target region. This tolerance only applies to surface mapping. The default value is 1000000.0.
negativeNormalSearchTol=0¶: A Float specifying the search distance tolerance value in the negative normal of target surface region. Source points within this distance will be included in computing the parameter value of target region. This tolerance only applies to surface mapping. The default value is 0.15.
positiveNormalSearchTol=0¶: A Float specifying the search distance tolerance value in the positive normal of target surface region. Source points within this distance will be included in computing the parameter value of target region. This tolerance only applies to surface mapping. The default value is 0.05.
scaleCoordinates=0¶: A Boolean specifying whether or not to scale the user-supplied coordinate values from the point cloud or indicated ODB. The default value is OFF.
gridPointData=()¶: A sequence of sequences of Floats specifying the point cloud source data of grid format. The default value is an empty sequence.
xyzPointData=()¶: A sequence of sequences of Floats specifying the point cloud source data of XYZ format. Each data item is defining the XYZ coordinates of a point and its field value. The default value is an empty sequence.
coordinateScalingFactors=()¶: A sequence of Floats specifying the scaling factors for the global 1, 2 and 3 directions. The default value is (1.0, 1.0, 1.0).
localCsys=None¶: None or a DatumCsys object specifying the local coordinate system of the field. If localCsys = None, the field is defined in the global coordinate system. The default value is None.
description=''¶: A String specifying the description of the field. The default value is an empty string.

Returns:¶

A MappedField object.

Return type:¶

MappedField

Raises:¶

AbaqusException –

Other Classes¶

class AnalyticalField[source]¶

Bases: Field

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

Note

This object can be accessed by:

import fields
mdb.models[name].analyticalFields[name]

Note

Check AnalyticalField on help.3ds.com/2024.

Member Details:

OdbMeshRegionData( odbFileName, variableLabel, stepIndex=0, frameIndex=0, outputPosition=UNDEFINED_POSITION, dataType=SCALAR, storageType=FLOAT, quantityToPlot=FIELD_OUTPUT, averageElementOutput=0, useRegionBoundaries=0, regionBoundaries=NONE, includeFeatureBoundaries=1, featureAngle=20, averageOnlyDisplayed=0, averagingThreshold=75, computeOrder=EXTRAPOLATE_COMPUTE_AVERAGE, numericForm=REAL, complexAngle=0, sectionPoint='', refinementType=None, refinementLabel='', displayOutputPosition=None, )[source]¶

This method creates an OdbMeshRegionData object.

Note

This function can be accessed by:

mdb.models[name].analyticalFields[name].OdbMeshRegionData

Note

Check OdbMeshRegionData on help.3ds.com/2024.

Parameters:¶

odbFileName¶

A String specifying the name of the output database file (including the .odb extension) to be read into as the source data. This String can also be the full path to the output database file if it is located in another directory.

variableLabel¶

A String specifying the field output variable.

stepIndex=0¶

An Int specifying the step index. Possible values are 0 ≤ stepIndex ≤ (numSteps − 1). The default value is 0.

frameIndex=0¶

An Int specifying the frame in the specified step. Valid values are 0 ≤ frameIndex ≤ (numFramesInStep − 1). The default value is 0.

outputPosition=UNDEFINED_POSITION¶

A SymbolicConstant specifying the position where the data is written in the output database. Data can be obtained only from the position at which it was written to the output database during the analysis. This position should be aligned with the field output variable. Possible values are:

UNDEFINED_POSITION
NODAL
INTEGRATION_POINT
ELEMENT_FACE
ELEMENT_NODAL
ELEMENT_CENTROID
WHOLE_ELEMENT
WHOLE_REGION
WHOLE_PART_INSTANCE
WHOLE_MODEL
GENERAL_PARTICLE

The default value is UNDEFINED_POSITION.

dataType=SCALAR¶

A SymbolicConstant specifying the data type of the field output variable which should be aligned with the variable. Currently only SCALAR is supported. Possible values are:

ENUMERATION
BOOLEAN
INTEGER
SCALAR
VECTOR
QUATERNION_2D
QUATERNION_3D
TENSOR
TENSOR_3D_FULL
TENSOR_3D_PLANAR
TENSOR_3D_SURFACE
TENSOR_2D_PLANAR
TENSOR_2D_SURFACE

The default value is SCALAR.

storageType=FLOAT¶

A SymbolicConstant specifying the storage type of the field output variable which should be aligned with the variable. Possible values are FLOAT, DOUBLE, INTEGER, and BOOLEAN. The default value is FLOAT.

quantityToPlot=FIELD_OUTPUT¶

A SymbolicConstant specifying the quantity to plot. Currently only FIELD_OUTPUT is supported. Possible values are FIELD_OUTPUT and DISCONTINUITIES. The default value is FIELD_OUTPUT.

averageElementOutput=0¶

A Boolean specifying whether to average the element output. The default value is OFF.

useRegionBoundaries=0¶

A Boolean specifying whether to use region boundaries when averaging. The default value is OFF.

regionBoundaries=NONE¶

A SymbolicConstant specifying the type of averaging region boundaries. Currently only NONE and ODB_REGIONS are supported. Possible values are NONE, ODB_REGIONS, ELEMENT_SET, and DISPLAY_GROUPS. The default value is NONE.

includeFeatureBoundaries=1¶

A Boolean specifying whether to include additional averaging boundaries for shells and membranes based on feature edges. The default value is ON.

featureAngle=20¶

A Float specifying the feature angle to be used when includeFeatureBoundaries = ON. The default value is 20.0.

averageOnlyDisplayed=0¶

A Boolean specifying whether to average only values on displayed elements. The default value is OFF.

averagingThreshold=75¶

A Float specifying the nodal averaging threshold percentage. 0 ≤ averagingThreshold ≤ 100. The default value is 75.0.

computeOrder=EXTRAPOLATE_COMPUTE_AVERAGE¶

A SymbolicConstant specifying the order or the computations to be performed on the interested field output variable. Possible values are EXTRAPOLATE_AVERAGE_COMPUTE, EXTRAPOLATE_COMPUTE_AVERAGE, EXTRAPOLATE_COMPUTE, EXTRAPOLATE_COMPUTE_DISCONTINUITIES, and RAW_DATA. The default value is EXTRAPOLATE_COMPUTE_AVERAGE.

numericForm=REAL¶

A SymbolicConstant specifying the numeric form in which to display results that contain complex numbers. Possible values are COMPLEX_MAGNITUDE, COMPLEX_PHASE, REAL, IMAGINARY, and COMPLEX_MAG_AT_ANGLE. The default value is REAL.

complexAngle=0¶

A Float specifying the angle (in degrees) at which to display results that contain complex numbers when numericForm = COMPLEX_MAG_AT_ANGLE = COMPLEX_MAG_AT_ANGLE. The default value is 0.0.

sectionPoint=''¶

A Dictionary with String keys and String values. Each key specifies a region in the model; the corresponding value specifies a section point within that region. For example:

sectionPoint = {
    'shell < MAT > < 7 section points >': 'SPOS, (fraction = 1.0)',
    'shell < MAT > < 5 section points >': 'SPOS, (fraction = 1.0)',
}

refinementType=None¶

A SymbolicConstant specifying the type of the FieldOutput object. Possible values for the SymbolicConstant are NO_REFINEMENT, INVARIANT and COMPONENT. Default argument is NO_REFINEMENT. refinementType is mandetory if variableLabel has an INVARIANT or a COMPONENT.

refinementLabel=''¶

A String specifying the Label of FieldOutput object. This is required only if the refinementType is INVARIANT or COMPONENT.

displayOutputPosition=None¶

A SymbolicConstant specifying the position from which to obtain the data. Possible values are NODAL, INTEGRATION_POINT, ELEMENT_FACE, ELEMENT_NODAL, ELEMENT_CENTROID, WHOLE_ELEMENT, WHOLE_REGION, WHOLE_PART_INSTANCE, WHOLE_MODEL, and GENERAL_PARTICLE.

Returns:¶

An OdbMeshRegionData object.

Return type:¶

OdbMeshRegionData

Raises:¶

TextException –

description : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the description of the field. The default value is an empty string.

localCsys : --is-rst--:py:class:`~abaqus.Datum.DatumCsys.DatumCsys` | :py:obj:`None` = <abaqus.Datum.DatumCsys.DatumCsys object>[source]¶: None or a DatumCsys object specifying the local coordinate system of the field. If localCsys = None, the field is defined in the global coordinate system. The default value is None.

name : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the repository key.

odbMeshRegionData : --is-rst--:py:class:`~abaqus.Field.OdbMeshRegionData.OdbMeshRegionData` = <abaqus.Field.OdbMeshRegionData.OdbMeshRegionData object>[source]¶: An OdbMeshRegionData object.

class Field[source]¶

Bases: object

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

Note

This object can be accessed by:

import fields

Note

Check Field on help.3ds.com/2024.

Member Details:

description : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the description of the field. The default value is an empty string.

name : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the repository key.

class OdbMeshRegionData( odbFileName, variableLabel, stepIndex=0, frameIndex=0, outputPosition=UNDEFINED_POSITION, dataType=SCALAR, storageType=FLOAT, quantityToPlot=FIELD_OUTPUT, averageElementOutput=0, useRegionBoundaries=0, regionBoundaries=NONE, includeFeatureBoundaries=1, featureAngle=20, averageOnlyDisplayed=0, averagingThreshold=75, computeOrder=EXTRAPOLATE_COMPUTE_AVERAGE, numericForm=REAL, complexAngle=0, sectionPoint='', refinementType=None, refinementLabel='', displayOutputPosition=None, )[source]¶

Bases: object

The OdbMeshRegionData object defines the external source data of MappedField from an ODB file.

Note

This object can be accessed by:

import field
mdb.models[name].analyticalFields[name].odbMeshRegionData

Changed in version 2017: The transformationType attribute was moved.

Note

Check OdbMeshRegionData on help.3ds.com/2024.

Member Details:

averageElementOutput : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]¶: A Boolean specifying whether to average the element output. The default value is OFF.

averageOnlyDisplayed : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]¶: A Boolean specifying whether to average only values on displayed elements. The default value is OFF.

averagingThreshold : --is-rst--:py:class:`float` = 75[source]¶: A Float specifying the nodal averaging threshold percentage. 0 ≤ averagingThreshold ≤100. The default value is 75.0.

complexAngle : --is-rst--:py:class:`float` = 0[source]¶: A Float specifying the angle (in degrees) at which to display results that contain complex numbers when numericForm=COMPLEX_MAG_AT_ANGLE = COMPLEX_MAG_AT_ANGLE. The default value is 0.0.

computeOrder : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'EXTRAPOLATE_COMPUTE_AVERAGE'[source]¶: A SymbolicConstant specifying the order or the computations to be performed on the interested field output variable. Possible values are EXTRAPOLATE_AVERAGE_COMPUTE, EXTRAPOLATE_COMPUTE_AVERAGE, EXTRAPOLATE_COMPUTE, EXTRAPOLATE_COMPUTE_DISCONTINUITIES, and RAW_DATA. The default value is EXTRAPOLATE_COMPUTE_AVERAGE.

dataType : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'SCALAR'[source]¶

A SymbolicConstant specifying the data type of the field output variable which should be aligned with the variable. Currently only SCALAR is supported. Possible values are:

ENUMERATION
BOOLEAN
INTEGER
SCALAR
VECTOR
QUATERNION_2D
QUATERNION_3D
TENSOR
TENSOR_3D_FULL
TENSOR_3D_PLANAR
TENSOR_3D_SURFACE
TENSOR_2D_PLANAR
TENSOR_2D_SURFACE

The default value is SCALAR.

displayOutputPosition : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'UNDEFINED_POSITION'[source]¶

A SymbolicConstant specifying the position where the output is displayed in the viewport. Possible values are:

UNDEFINED_POSITION
NODAL
INTEGRATION_POINT
ELEMENT_FACE
ELEMENT_NODAL
ELEMENT_CENTROID
WHOLE_ELEMENT
WHOLE_REGION
WHOLE_PART_INSTANCE
WHOLE_MODEL
GENERAL_PARTICLE

The default value is UNDEFINED_POSITION.

featureAngle : --is-rst--:py:class:`float` = 20[source]¶: A Float specifying the feature angle to be used when includeFeatureBoundaries = ON. The default value is 20.0.

frameIndex : --is-rst--:py:class:`int` = 0[source]¶: An Int specifying the frame in the specified step. Valid values are 0 ≤ frameIndex ≤ (numFramesInStep − 1). The default value is 0.

includeFeatureBoundaries : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 1[source]¶: A Boolean specifying whether to include additional averaging boundaries for shells and membranes based on feature edges. The default value is ON.

numericForm : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'REAL'[source]¶: A SymbolicConstant specifying the numeric form in which to display results that contain complex numbers. Possible values are COMPLEX_MAGNITUDE, COMPLEX_PHASE, REAL, IMAGINARY, and COMPLEX_MAG_AT_ANGLE. The default value is REAL.

odbFileName : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the name of the output database file (including the .odb extension) to be read into as the source data. This String can also be the full path to the output database file if it is located in another directory.

outputPosition : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'UNDEFINED_POSITION'[source]¶

A SymbolicConstant specifying the position from which to obtain data. Data can be obtained only from the position at which they were written to the output database during the analysis. This position should be aligned with the field output variable. Possible values are:

UNDEFINED_POSITION
NODAL
INTEGRATION_POINT
ELEMENT_FACE
ELEMENT_NODAL
ELEMENT_CENTROID
WHOLE_ELEMENT
WHOLE_REGION
WHOLE_PART_INSTANCE
WHOLE_MODEL
GENERAL_PARTICLE

The default value is UNDEFINED_POSITION.

quantityToPlot : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'FIELD_OUTPUT'[source]¶: A SymbolicConstant specifying the quantity to plot. Currently only FIELD_OUTPUT is supported. Possible values are FIELD_OUTPUT and DISCONTINUITIES. The default value is FIELD_OUTPUT.

regionBoundaries : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'NONE'[source]¶: A SymbolicConstant specifying the type of averaging region boundaries. Currently only NONE and ODB_REGIONS are supported. Possible values are NONE, ODB_REGIONS, ELEMENT_SET, and DISPLAY_GROUPS. The default value is NONE.

setValues(*args, **kwargs)[source]¶: This method modifies the OdbMeshRegionData object.

stepIndex : --is-rst--:py:class:`int` = 0[source]¶: An Int specifying the step index. Possible values are 0 ≤ stepIndex ≤ (numSteps − 1). The default value is 0.

storageType : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'FLOAT'[source]¶: A SymbolicConstant specifying the storage type of the field output variable which should be aligned with the variable. Possible values are FLOAT, DOUBLE, INTEGER, and BOOLEAN. The default value is FLOAT.

useRegionBoundaries : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]¶: A Boolean specifying whether to use region boundaries when averaging. The default value is OFF.

variableLabel : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the field output variable.

class DataTable[source]¶

Bases: object

A DataTable is an object used to define the domain and data for a DiscreteField.

Note

This object can be accessed by:

import field
mdb.models[name].discreteFields[name].data[i]

Note

Check DataTable on help.3ds.com/2024.

Member Details:

dataWidth : --is-rst--:py:class:`int` | :py:obj:`None` = None[source]¶: An Int specifying the width of the data. Valid widths are 1, 6, 21, corresponding to scalar data, orientations and 4D tensors.

domain : --is-rst--:py:class:`tuple`\ \[:py:class:`int`, :py:data:`...<Ellipsis>`] = ()[source]¶: A tuple of Ints specifying the domain node, element or integration point identifiers.

instanceName : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the instance name.

name : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the index.

table : --is-rst--:py:class:`tuple`\ \[:py:class:`float`, :py:data:`...<Ellipsis>`] = ()[source]¶: A tuple of Floats specifying the data within the domain.

class DiscreteField( name, defaultValues, fieldType, location=NODES, dataWidth=1, data=None, description='', orientationType=CARTESIAN, partLevelOrientation=0, )[source]¶

Bases: Field

The DiscreteField object defines a varying field whose values correspond to distinct points within a domain. The DiscreteField object is derived from the Field object.

Note

This object can be accessed by:

import fields
mdb.models[name].discreteFields[name]

Note

Check DiscreteField on help.3ds.com/2024.

Member Details:

DiscreteFieldByVolumeFraction( name, eulerianInstance, referenceInstance, accuracy=MEDIUM, materialLocation=INSIDE, description='', scaleFactor='', )[source]¶

This method creates a DiscreteField object that represents the volume fraction of each element of an Eulerian Instance that is occupied by a reference instance.

Note

This function can be accessed by:

mdb.models[name].DiscreteField

Note

Check DiscreteFieldByVolumeFraction on help.3ds.com/2024.

Parameters:¶

name¶: A String specifying the repository key.
eulerianInstance¶: A PartInstance object specifying the elements for which volume fraction values will be computed.
referenceInstance¶: A PartInstance object specifying the region that either contains material or is empty of material.
accuracy=MEDIUM¶: A Symbolic Constant specifying the level of accuracy that will be used in computing volume fractions. Possible values are LOW, MEDIUM, or HIGH. The default value is MEDIUM.
materialLocation=INSIDE¶: A Symbolic Constant indicating whether the material is inside or outside the referenceInstance. Possible values are INSIDE or OUTSIDE. The default value is INSIDE.
description=''¶: A String specifying the description of the field. The default value is an empty string.
scaleFactor=''¶: A float specifying the fraction of the volume that is occupied by the referenceInstance. Valid values are between 0 and 1.

Returns:¶

A DiscreteField object.

Return type:¶

DiscreteField

Raises:¶

AbaqusException –

DiscreteFieldFromAnalytic(name, location, analyticFieldName, region)[source]¶

This method creates a DiscreteField object from a AnalyticalField object.

Note

This function can be accessed by:

mdb.models[name].DiscreteField

Note

Check DiscreteFieldFromAnalytic on help.3ds.com/2024.

Parameters:¶

name¶: A String specifying the repository key.
location¶: A SymbolicConstant or an Int specifying the location of the domain data. Possible values are NODES and ELEMENTS. The default value is NODES.
analyticFieldName¶: A String specifying the name of the AnalyticalField containing the source data.
region¶: A Region object for the field.

Returns:¶

A DiscreteField object.

Return type:¶

DiscreteField

Raises:¶

AbaqusException –

data : --is-rst--:py:data:`~typing.Optional`\ \[:py:class:`~typing.List`\ \[:py:class:`~abaqus.Field.DataTable.DataTable`]] = None[source]¶: A DataTableArray object.

dataWidth : --is-rst--:py:class:`int` = 1[source]¶: An Int specifying the width of the supplied data. The default value is 1.

defaultValues : --is-rst--:py:class:`tuple`\ \[:py:class:`float`, :py:data:`...<Ellipsis>`] = ()[source]¶: A sequence of Floats specifying a sequence of floats specifying the default values.

description : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the description of the field. The default value is an empty string.

fieldType : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`[source]¶: A SymbolicConstant or an Int specifying the type of data represented by this discrete field. Possible values are SCALAR, ORIENTATION, and PRESCRIBEDCONDITION_DOF.

location : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'NODES'[source]¶: A SymbolicConstant or an Int specifying the location of the domain data. Possible values are NODES and ELEMENTS. The default value is NODES.

orientationType : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'CARTESIAN'[source]¶: A SymbolicConstant specifying the type of the system being described by a discrete field used for an orientation. Possible values are CARTESIAN, CYLINDRICAL, and SPHERICAL. The default value is CARTESIAN.

partLevelOrientation : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]¶: A Boolean specifying whether or not the orientations are described in terms of part level coordinates. The default value is OFF.

setValues( location=NODES, dataWidth=1, data=None, description='', orientationType=CARTESIAN, partLevelOrientation=0, )[source]¶

This method modifies the DiscreteField object.

Note

Check DiscreteField.setValues on help.3ds.com/2024.

Parameters:¶

location=NODES¶: A SymbolicConstant or an Int specifying the location of the domain data. Possible values are NODES and ELEMENTS. The default value is NODES.
dataWidth=1¶: An Int specifying the width of the supplied data. The default value is 1.
data=None¶: A DataTableArray object.
description=''¶: A String specifying the description of the field. The default value is an empty string.
orientationType=CARTESIAN¶: A SymbolicConstant specifying the type of the system being described by a discrete field used for an orientation. Possible values are CARTESIAN, CYLINDRICAL, and SPHERICAL. The default value is CARTESIAN.
partLevelOrientation=0¶: A Boolean specifying whether or not the orientations are described in terms of part level coordinates. The default value is OFF.

class ExpressionField(name, expression, localCsys=None, description='')[source]¶

Bases: AnalyticalField

The ExpressionField object defines a spatially varying field whose value is calculated from a user- supplied mathematical expression. The ExpressionField object is derived from the AnalyticalField object.

Note

This object can be accessed by:

import fields
mdb.models[name].analyticalFields[name]

Note

Check ExpressionField on help.3ds.com/2024.

Member Details:

description : --is-rst--str = ''[source]¶: A String specifying the description of the field. The default value is an empty string.

expression : --is-rst--str[source]¶: A String specifying the Python expression to evaluate in space. Variables are X, Y, and Z; R, Th, and Z; or R, Th, and P based on the selected coordinate system.

localCsys : --is-rst--DatumCsys | None = None[source]¶: None or a DatumCsys object specifying the local coordinate system of the field. If localCsys = None, the field is defined in the global coordinate system. The default value is None.

setValues(localCsys=None, description='')[source]¶

This method modifies the ExpressionField object.

Note

Check ExpressionField.setValues on help.3ds.com/2024.

Parameters:¶

localCsys=None¶: None or a DatumCsys object specifying the local coordinate system of the field. If localCsys = None, the field is defined in the global coordinate system. The default value is None.
description=''¶: A String specifying the description of the field. The default value is an empty string.

class MappedField( name, regionType=POINT, partLevelData=0, pointDataFormat=XYZ, gridPointPlane=XYPLANE, defaultUnMappedValue=0, mappingAlgorithm=SURFACE, searchTolType=RELATIVE, boundarySearchTol=0, neighborhoodSearchTol=1000000, negativeNormalSearchTol=0, positiveNormalSearchTol=0, scaleCoordinates=0, gridPointData=(), xyzPointData=(), coordinateScalingFactors=(), localCsys=None, description='', )[source]¶

Bases: AnalyticalField

The MappedField object defines a spatially varying field whose value is calculated from an external source data. The MappedField object is derived from the AnalyticalField object.

Note

This object can be accessed by:

import fields
mdb.models[name].analyticalFields[name]

Note

Check MappedField on help.3ds.com/2024.

Member Details:

boundarySearchTol : --is-rst--:py:class:`float` = 0[source]¶: A Float specifying the search distance tolerance value on the exterior boundary of target model region. Source points within this distance will be included in computing the parameter value of target region. This tolerance applies to both surface and volumetric mapping. The default value is 0.01.

coordinateScalingFactors : --is-rst--:py:class:`tuple`\ \[:py:class:`float`, :py:class:`float`, :py:class:`float`] = (1.0, 1.0, 1.0)[source]¶: A tuple of Floats specifying the scaling factors for the global 1, 2 and 3 directions. The default value is (1.0, 1.0, 1.0).

defaultUnMappedValue : --is-rst--:py:class:`float` = 0[source]¶: A Float specifying default parameter (field) value of target model region while its value cannot be calculated from the data source. The default value is 0.0.

description : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the description of the field. The default value is an empty string.

gridPointData : --is-rst--:py:class:`tuple`\ \[:py:class:`tuple`\ \[:py:class:`float`, :py:data:`...<Ellipsis>`], :py:data:`...<Ellipsis>`] = ()[source]¶: A tuple of tuples of Floats specifying the point cloud source data of grid format. The default value is an empty sequence.

gridPointPlane : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'XYPLANE'[source]¶: A SymbolicConstant specifying the plane on which the point cloud source data of grid format are described. Possible values are XYPLANE, YZPLANE, and XZPLANE. The default value is XYPLANE.

localCsys : --is-rst--:py:class:`~abaqus.Datum.DatumCsys.DatumCsys` | :py:obj:`None` = None[source]¶: None or a DatumCsys object specifying the local coordinate system of the field. If localCsys = None, the field is defined in the global coordinate system. The default value is None.

mappingAlgorithm : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'SURFACE'[source]¶: A SymbolicConstant specifying the mapping algorithm for target surface, or on mesh target model when the parameter value are located at nodes, for example nodal temperatures. Possible values are SURFACE and VOLUMETRIC. The default value is SURFACE.

name : --is-rst--:py:class:`str` = ''[source]¶: A String specifying the repository key.

negativeNormalSearchTol : --is-rst--:py:class:`float` = 0[source]¶: A Float specifying the search distance tolerance value in the negative normal of target surface region. Source points within this distance will be included in computing the parameter value of target region. This tolerance only applies to surface mapping. The default value is 0.15.

neighborhoodSearchTol : --is-rst--:py:class:`float` = 1000000[source]¶: A Float specifying the search distance tolerance value used for distance weighting algorithm. Source points within this distance will be included in computing the parameter value of target region. This tolerance only applies to surface mapping. The default value is 1000000.0.

odbMeshRegionData : --is-rst--:py:class:`~abaqus.Field.OdbMeshRegionData.OdbMeshRegionData` = <abaqus.Field.OdbMeshRegionData.OdbMeshRegionData object>[source]¶: An OdbMeshRegionData object specifying the external source data from ODB mesh region.

partLevelData : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]¶: A Boolean specifying whether or not the point cloud source data are described in terms of part level coordinates. If part level coordinates is employed, the local coordinate system defined in localCsys will be ignored. The default value is OFF.

pointDataFormat : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'XYZ'[source]¶: A SymbolicConstant specifying point cloud source data format. Possible values are GRID and XYZ. The default value is XYZ.

positiveNormalSearchTol : --is-rst--:py:class:`float` = 0[source]¶: A Float specifying the search distance tolerance value in the positive normal of target surface region. Source points within this distance will be included in computing the parameter value of target region. This tolerance only applies to surface mapping. The default value is 0.05.

regionType : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'POINT'[source]¶: A SymbolicConstant specifying the data source region type. It can be either an ODB mesh or a cloud of points. Possible values are MESH and POINT. The default value is POINT.

scaleCoordinates : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[source]¶: A Boolean specifying whether or not to scale the user-supplied coordinate values from the point cloud or indicated ODB. The default value is OFF.

searchTolType : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'RELATIVE'[source]¶: A SymbolicConstant specifying searching tolerance type in terms of absolute value or a fraction of the average of all element characteristic length in target model region. Possible values are ABSOLUTE and RELATIVE. The default value is RELATIVE.

setValues( regionType=POINT, partLevelData=0, pointDataFormat=XYZ, gridPointPlane=XYPLANE, defaultUnMappedValue=0, mappingAlgorithm=SURFACE, searchTolType=RELATIVE, boundarySearchTol=0, neighborhoodSearchTol=1000000, negativeNormalSearchTol=0, positiveNormalSearchTol=0, scaleCoordinates=0, gridPointData=(), xyzPointData=(), coordinateScalingFactors=(), localCsys=None, description='', )[source]¶

This method modifies the MappedField object.

Note

Check MappedField.setValues on help.3ds.com/2024.

Parameters:¶

regionType=POINT¶: A SymbolicConstant specifying the data source region type. It can be either an ODB mesh or a cloud of points. Possible values are MESH and POINT. The default value is POINT.
partLevelData=0¶: A Boolean specifying whether or not the point cloud source data are described in terms of part level coordinates. If part level coordinates is employed, the local coordinate system defined in localCsys will be ignored. The default value is OFF.
pointDataFormat=XYZ¶: A SymbolicConstant specifying point cloud source data format. Possible values are GRID and XYZ. The default value is XYZ.
gridPointPlane=XYPLANE¶: A SymbolicConstant specifying the plane on which the point cloud source data of grid format are described. Possible values are XYPLANE, YZPLANE, and XZPLANE. The default value is XYPLANE.
defaultUnMappedValue=0¶: A Float specifying the parameter (field) value reported when a value cannot be calculated from the data source. The default value is 0.0.
mappingAlgorithm=SURFACE¶: A SymbolicConstant specifying the mapping algorithm for target surface, or on mesh target model when the parameter value are located at nodes, for example nodal temperatures. Possible values are SURFACE and VOLUMETRIC. The default value is SURFACE.
searchTolType=RELATIVE¶: A SymbolicConstant specifying searching tolerance type in terms of absolute value or a fraction of the average of all element characteristic length in target model region. Possible values are ABSOLUTE and RELATIVE. The default value is RELATIVE.
boundarySearchTol=0¶: A Float specifying the search distance tolerance value on the exterior boundary of target model region. Source points within this distance will be included in computing the parameter value of target region. This tolerance applies to both surface and volumetric mapping. The default value is 0.01.
neighborhoodSearchTol=1000000¶: A Float specifying the search distance tolerance value used for distance weighting algorithm. Source points within this distance will be included in computing the parameter value of target region. This tolerance only applies to surface mapping. The default value is 1000000.0.
negativeNormalSearchTol=0¶: A Float specifying the search distance tolerance value in the negative normal of target surface region. Source points within this distance will be included in computing the parameter value of target region. This tolerance only applies to surface mapping. The default value is 0.15.
positiveNormalSearchTol=0¶: A Float specifying the search distance tolerance value in the positive normal of target surface region. Source points within this distance will be included in computing the parameter value of target region. This tolerance only applies to surface mapping. The default value is 0.05.
scaleCoordinates=0¶: A Boolean specifying whether or not to scale the user-supplied coordinate values from the point cloud or indicated ODB. The default value is OFF.
gridPointData=()¶: A sequence of sequences of Floats specifying the point cloud source data of grid format. The default value is an empty sequence.
xyzPointData=()¶: A sequence of sequences of Floats specifying the point cloud source data of XYZ format. Each data item is defining the XYZ coordinates of a point and its field value. The default value is an empty sequence.
coordinateScalingFactors=()¶: A sequence of Floats specifying the scaling factors for the global 1, 2 and 3 directions. The default value is (1.0, 1.0, 1.0).
localCsys=None¶: None or a DatumCsys object specifying the local coordinate system of the field. If localCsys = None, the field is defined in the global coordinate system. The default value is None.
description=''¶: A String specifying the description of the field. The default value is an empty string.

xyzPointData : --is-rst--:py:class:`tuple`\ \[:py:class:`tuple`\ \[:py:class:`float`, :py:data:`...<Ellipsis>`], :py:data:`...<Ellipsis>`] = ()[source]¶: A tuple of tuples of Floats specifying the point cloud source data of XYZ format. Each data item is defining the XYZ coordinates of a point and its field value. The default value is an empty sequence.

class FieldOdb(name, analysisTitle='', description='', path='')[source]¶

Bases: OdbBase

Member Details: