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: str, description: str = '', stefanBoltzmann: float | None = None, absoluteZero: float | None = None, waveFormulation: SymbolicConstantType = 'NOT_SET', modelType: SymbolicConstantType = 'STANDARD_EXPLICIT', universalGas: float | None = None, copyConstraints: BooleanType = 1, copyConnectors: BooleanType = 1, copyInteractions: BooleanType = 1)[source]#

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.

DiscreteField(name: str, defaultValues: tuple, fieldType: SymbolicConstantType, location: SymbolicConstantType = 'NODES', dataWidth: int = 1, data: DataTableArray | None = None, description: str = '', orientationType: SymbolicConstantType = 'CARTESIAN', partLevelOrientation: BooleanType = 0) → DiscreteField[source]#

This method creates a DiscreteField object.

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: A SymbolicConstant or an Int specifying the location of the domain data. Possible values are NODES and ELEMENTS. The default value is NODES.
dataWidth: An Int specifying the width of the supplied data. The default value is 1.
data: A DataTableArray object.
description: A String specifying the description of the field. The default value is an empty string.
orientationType: 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: 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.

Raises:

AbaqusException.

Notes

This function can be accessed by:

mdb.models[name].DiscreteField

ExpressionField(name: str, expression: str, localCsys: str | None = None, description: str = '') → ExpressionField[source]#

This method creates an ExpressionField object.

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

Raises:

TextException.

Notes

This function can be accessed by:

mdb.models[name].ExpressionField

MappedField(name: str, regionType: SymbolicConstantType = 'POINT', partLevelData: BooleanType = 0, pointDataFormat: SymbolicConstantType = 'XYZ', gridPointPlane: SymbolicConstantType = 'XYPLANE', defaultUnMappedValue: float = 0, mappingAlgorithm: SymbolicConstantType = 'SURFACE', searchTolType: SymbolicConstantType = 'RELATIVE', boundarySearchTol: float = 0, neighborhoodSearchTol: float = 1000000, negativeNormalSearchTol: float = 0, positiveNormalSearchTol: float = 0, scaleCoordinates: BooleanType = 0, gridPointData: tuple = (), xyzPointData: tuple = (), coordinateScalingFactors: tuple = (), localCsys: str | None = None, description: str = '') → MappedField[source]#

This method creates an MappedField object.

Parameters:

name: A String specifying the repository key.
regionType: 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: 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: A SymbolicConstant specifying point cloud source data format. Possible values are GRID and XYZ. The default value is XYZ.
gridPointPlane: 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: 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: 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: 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: 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: 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: 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: 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: 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 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.

Raises:

AbaqusException.

Notes

This function can be accessed by:

mdb.models[name].MappedField

Object features#

Field#

class Field[source]#

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.

Notes

This object can be accessed by:

import fields

Attributes:

name: str: A String specifying the repository key.
description: str: A String specifying the description of the field. The default value is an empty string.

AnalyticalField#

class AnalyticalField[source]#

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.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the repository key.
localCsys: DatumCsys: 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: str: A String specifying the description of the field. The default value is an empty string.
odbMeshRegionData: OdbMeshRegionData: An OdbMeshRegionData object.

Methods

OdbMeshRegionData(odbFileName, variableLabel)

This method creates an OdbMeshRegionData object.

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

This method creates an OdbMeshRegionData object.

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: An Int specifying the step index. Possible values are 0 ≤≤ stepIndex ≤≤ (numSteps − 1). The default value is 0.
frameIndex: An Int specifying the frame in the specified step. Valid values are 0 ≤≤ frameIndex ≤≤ (numFramesInStep − 1). The default value is 0.
outputPosition: 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: 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: 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: 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: A Boolean specifying whether to average the element output. The default value is OFF.
useRegionBoundaries: A Boolean specifying whether to use region boundaries when averaging. The default value is OFF.
regionBoundaries: 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: A Boolean specifying whether to include additional averaging boundaries for shells and membranes based on feature edges. The default value is ON.
featureAngle: A Float specifying the feature angle to be used when *includeFeatureBoundaries*=ON. The default value is 20.0.
averageOnlyDisplayed: A Boolean specifying whether to average only values on displayed elements. The default value is OFF.
averagingThreshold: A Float specifying the nodal averaging threshold percentage. 0 ≤≤ averagingThreshold ≤≤100. The default value is 75.0.
computeOrder: 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: 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: 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: 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: 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.

Raises:

TextException.

Notes

This function can be accessed by:

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

DataTable#

class DataTable[source]#

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

Notes

This object can be accessed by:

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

Attributes:

dataWidth: int: An Int specifying the width of the data. Valid widths are 1, 6, 21, corresponding to scalar data, orientations and 4D tensors.
name: str: A String specifying the index.
instanceName: str: A String specifying the instance name.
domain: int: A tuple of Ints specifying the domain node, element or integration point identifiers.
table: float: A tuple of Floats specifying the data within the domain.

DataTableArray#

class DataTableArray(iterable=(), /)[source]#

Methods

findAt

DiscreteField#

class DiscreteField(name: str, defaultValues: tuple, fieldType: SymbolicConstantType, location: SymbolicConstantType = 'NODES', dataWidth: int = 1, data: DataTableArray | None = None, description: str = '', orientationType: SymbolicConstantType = 'CARTESIAN', partLevelOrientation: BooleanType = 0)[source]#

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.

Notes

This object can be accessed by:

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

Methods

`DiscreteFieldByVolumeFraction`(name, ...[, ...])	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.
`DiscreteFieldFromAnalytic`(name, location, ...)	This method creates a DiscreteField object from a AnalyticalField object.
`setValues`([location, dataWidth, data, ...])	This method modifies the DiscreteField object.

DiscreteFieldByVolumeFraction(name: str, eulerianInstance: PartInstance, referenceInstance: PartInstance, accuracy: str = 'MEDIUM', materialLocation: str = 'INSIDE', description: str = '', scaleFactor: str = '')[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.

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

Raises:

AbaqusException.

Notes

This function can be accessed by:

mdb.models[name].DiscreteField

DiscreteFieldFromAnalytic(name: str, location: SymbolicConstantType, analyticFieldName: str, region: Region)[source]#

This method creates a DiscreteField object from a AnalyticalField object.

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.

Raises:

AbaqusException.

Notes

This function can be accessed by:

mdb.models[name].DiscreteField

setValues(location: SymbolicConstantType = 'NODES', dataWidth: int = 1, data: DataTableArray | None = None, description: str = '', orientationType: SymbolicConstantType = 'CARTESIAN', partLevelOrientation: BooleanType = 0)[source]#

This method modifies the DiscreteField object.

Parameters:

location: A SymbolicConstant or an Int specifying the location of the domain data. Possible values are NODES and ELEMENTS. The default value is NODES.
dataWidth: An Int specifying the width of the supplied data. The default value is 1.
data: A DataTableArray object.
description: A String specifying the description of the field. The default value is an empty string.
orientationType: 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: A Boolean specifying whether or not the orientations are described in terms of part level coordinates. The default value is OFF.

ExpressionField#

class ExpressionField(name: str, expression: str, localCsys: str | None = None, description: str = '')[source]#

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.

Notes

This object can be accessed by:

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

Methods

setValues([localCsys, description])

This method modifies the ExpressionField object.

setValues(localCsys: str | None = None, description: str = '')[source]#

This method modifies the ExpressionField object.

Parameters:

localCsys: 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.

MappedField#

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

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.

Notes

This object can be accessed by:

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

Attributes:

name: str: A String specifying the repository key.
regionType: SymbolicConstant: 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: Boolean: 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: SymbolicConstant: A SymbolicConstant specifying point cloud source data format. Possible values are GRID and XYZ. The default value is XYZ.
gridPointPlane: SymbolicConstant: 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: float: 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.
mappingAlgorithm: SymbolicConstant: 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: SymbolicConstant: 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: float: 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: float: 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: float: 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: float: 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: Boolean: 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: tuple: A tuple of tuples of Floats specifying the point cloud source data of grid format. The default value is an empty sequence.
xyzPointData: tuple: 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.
odbMeshRegionData: OdbMeshRegionData: An OdbMeshRegionData object specifying the external source data from ODB mesh region.
coordinateScalingFactors: float: 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).
localCsys: str: 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: str: A String specifying the description of the field. The default value is an empty string.

Methods

setValues([regionType, partLevelData, ...])

This method modifies the MappedField object.

localCsys: str = None[source]#

odbMeshRegionData: OdbMeshRegionData = None[source]#

setValues(regionType: SymbolicConstantType = 'POINT', partLevelData: BooleanType = 0, pointDataFormat: SymbolicConstantType = 'XYZ', gridPointPlane: SymbolicConstantType = 'XYPLANE', defaultUnMappedValue: float = 0, mappingAlgorithm: SymbolicConstantType = 'SURFACE', searchTolType: SymbolicConstantType = 'RELATIVE', boundarySearchTol: float = 0, neighborhoodSearchTol: float = 1000000, negativeNormalSearchTol: float = 0, positiveNormalSearchTol: float = 0, scaleCoordinates: BooleanType = 0, gridPointData: tuple = (), xyzPointData: tuple = (), coordinateScalingFactors: tuple = (), localCsys: str | None = None, description: str = '')[source]#

This method modifies the MappedField object.

Parameters:

regionType: 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: 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: A SymbolicConstant specifying point cloud source data format. Possible values are GRID and XYZ. The default value is XYZ.
gridPointPlane: 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: 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: 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: 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: 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: 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: 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: 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: 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 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.

OdbMeshRegionData#

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

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

Notes

This object can be accessed by:

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

Attributes:

stepIndex: int

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

frameIndex: int

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

outputPosition: SymbolicConstant

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.

dataType: SymbolicConstant

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

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

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

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

useRegionBoundaries: Boolean

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

regionBoundaries: SymbolicConstant

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

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

featureAngle: float

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

averageOnlyDisplayed: Boolean

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

averagingThreshold: float

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

computeOrder: SymbolicConstant

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

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

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.

odbFileName: str

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

A String specifying the field output variable.

displayOutputPosition: SymbolicConstant

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

Methods

setValues()

This method modifies the OdbMeshRegionData object.

setValues()[source]#: This method modifies the OdbMeshRegionData object.