MappedMeshBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# MappedMeshBuilder Class

class `NXOpen.CAE.``MappedMeshBuilder`

  Bases: `NXOpen.Builder`

  Represents a Mapped Mesh Builder.

  Used to create a `NXOpen.CAE.MappedMesh`

  To create a new instance of this class, use `NXOpen.CAE.MeshManager.CreateMappedMeshBuilder()`

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
EccAuto | Returns or sets the ECC automatic mode option
EccName | Returns or sets the ECC name
EdgeMatchOption | Returns or sets the edge match toggle
EdgeMatchTolerance | Returns or sets the edge match tolerance
EdgeMergeAngle | Returns or sets the edge merge angle
ElementSize | Returns or sets the element size
ElementSizeExpression | Returns the element size
ElementType | Returns or sets the elem type name.
FlipDiagonals | Returns or sets the flip diagonals option
FormatMesh | Returns or sets the format mesh option
Jacobian | Returns or sets the jacobian
KeepFreeMeshes | Returns or sets the keep free meshes option
MergeEdges | Returns or sets the merge edges option
MidNodeOption | Returns or sets the mid node opt
ProjectVertices | Returns or sets the project vertices option
QuadOnlyMesh | Returns or sets the quad only mesh option
SelectionFace | Returns the selection face
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
AutoSize | Auto-generated element size
ChangeEdgeDensity | Returns the edge density
ChangeEdgeDensityObject | Returns selected edge densities as one object
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetCornerData | Returns the corner data
GetObject | Returns the object currently being edited by this builder.
PreviewMesh | Previews the mapped mesh for further edit.
SetCornerData | Sets the corner data.
SetCornerDataWithEdges | Sets the corner data using array of edges and int array consists of if user want start of an edge or an end of an edge.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

MappedMeshBuilderMidNodeType Enumeration | Mid-node placement options

# Property Detail

## EccAuto

`MappedMeshBuilder.``EccAuto`

  Returns or sets the ECC automatic mode option

  `-------------------------------------`

  Getter Method

  Signature `EccAuto`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `EccAuto`

  Parameters: | eccAutoOption (bool) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## EccName

`MappedMeshBuilder.``EccName`

  Returns or sets the ECC name

  `-------------------------------------`

  Getter Method

  Signature `EccName`

  Returns: |
  Return type: | str

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `EccName`

  Parameters: | eccName (str) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## EdgeMatchOption

`MappedMeshBuilder.``EdgeMatchOption`

  Returns or sets the edge match toggle

  `-------------------------------------`

  Getter Method

  Signature `EdgeMatchOption`

  Returns: |
  Return type: | bool

  New in version NX7.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `EdgeMatchOption`

  Parameters: | edgeMatchOption (bool) –

  New in version NX7.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## EdgeMatchTolerance

`MappedMeshBuilder.``EdgeMatchTolerance`

  Returns or sets the edge match tolerance

  `-------------------------------------`

  Getter Method

  Signature `EdgeMatchTolerance`

  Returns: |
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `EdgeMatchTolerance`

  Parameters: | edgeMatchTolerance (float) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## EdgeMergeAngle

`MappedMeshBuilder.``EdgeMergeAngle`

  Returns or sets the edge merge angle

  `-------------------------------------`

  Getter Method

  Signature `EdgeMergeAngle`

  Returns: |
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `EdgeMergeAngle`

  Parameters: | edgeMergeAngle (float) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## ElementSize

`MappedMeshBuilder.``ElementSize`

  Returns or sets the element size

  `-------------------------------------`

  Getter Method

  Signature `ElementSize`

  Returns: |
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ElementSize`

  Parameters: | elementSize (float) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## ElementSizeExpression

`MappedMeshBuilder.``ElementSizeExpression`

  Returns the element size

  `-------------------------------------`

  Getter Method

  Signature `ElementSizeExpression`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX10.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## ElementType

`MappedMeshBuilder.``ElementType`

  Returns or sets the elem type name.

  This name is solver environment dependent. These are the same names that show up in the meshing dialogues. Refer to the release specific CAE user documentation to set a specific element name desired for a specific solver environment in a given release, refer to the release specific user manual

  `-------------------------------------`

  Getter Method

  Signature `ElementType`

  Returns: |
  Return type: | str

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

  `-------------------------------------`

  Setter Method

  Signature `ElementType`

  Parameters: | typeOfElement (str) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## FlipDiagonals

`MappedMeshBuilder.``FlipDiagonals`

  Returns or sets the flip diagonals option

  `-------------------------------------`

  Getter Method

  Signature `FlipDiagonals`

  Returns: |
  Return type: | bool

  New in version NX7.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `FlipDiagonals`

  Parameters: | flipDiagonalsOption (bool) –

  New in version NX7.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## FormatMesh

`MappedMeshBuilder.``FormatMesh`

  Returns or sets the format mesh option

  `-------------------------------------`

  Getter Method

  Signature `FormatMesh`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `FormatMesh`

  Parameters: | formatMeshOption (bool) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## Jacobian

`MappedMeshBuilder.``Jacobian`

  Returns or sets the jacobian

  `-------------------------------------`

  Getter Method

  Signature `Jacobian`

  Returns: |
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Jacobian`

  Parameters: | jacobian (float) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## KeepFreeMeshes

`MappedMeshBuilder.``KeepFreeMeshes`

  Returns or sets the keep free meshes option

  `-------------------------------------`

  Getter Method

  Signature `KeepFreeMeshes`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `KeepFreeMeshes`

  Parameters: | quadOnlyMeshOption (bool) –

  New in version NX6.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## MergeEdges

`MappedMeshBuilder.``MergeEdges`

  Returns or sets the merge edges option

  `-------------------------------------`

  Getter Method

  Signature `MergeEdges`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `MergeEdges`

  Parameters: | mergeEdgesOption (bool) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## MidNodeOption

`MappedMeshBuilder.``MidNodeOption`

  Returns or sets the mid node opt

  `-------------------------------------`

  Getter Method

  Signature `MidNodeOption`

  Returns: |
  Return type: | `NXOpen.CAE.MappedMeshBuilderMidNodeType`

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `MidNodeOption`

  Parameters: | midNodeType (`NXOpen.CAE.MappedMeshBuilderMidNodeType`) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## ProjectVertices

`MappedMeshBuilder.``ProjectVertices`

  Returns or sets the project vertices option

  `-------------------------------------`

  Getter Method

  Signature `ProjectVertices`

  Returns: |
  Return type: | bool

  New in version NX7.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ProjectVertices`

  Parameters: | projectVerticesOption (bool) –

  New in version NX7.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## QuadOnlyMesh

`MappedMeshBuilder.``QuadOnlyMesh`

  Returns or sets the quad only mesh option

  `-------------------------------------`

  Getter Method

  Signature `QuadOnlyMesh`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `QuadOnlyMesh`

  Parameters: | quadOnlyMeshOption (bool) –

  New in version NX6.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## SelectionFace

`MappedMeshBuilder.``SelectionFace`

  Returns the selection face

  `-------------------------------------`

  Getter Method

  Signature `SelectionFace`

  Returns: |
  Return type: | `NXOpen.SelectDisplayableObjectList`

  New in version NX5.0.0.

  License requirements: None.

# Method Detail

## AutoSize

`MappedMeshBuilder.``AutoSize`

  Auto-generated element size

  Signature `AutoSize()`

  Returns: |
  Return type: | float

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## ChangeEdgeDensity

`MappedMeshBuilder.``ChangeEdgeDensity`

  Returns the edge density

  Signature `ChangeEdgeDensity(edge, numberElements)`

  Parameters:

  - edge (`NXOpen.NXObject`) –
  - numberElements (int) –

  New in version NX5.0.0.

  License requirements: None.

## ChangeEdgeDensityObject

`MappedMeshBuilder.``ChangeEdgeDensityObject`

  Returns selected edge densities as one object

  Signature `ChangeEdgeDensityObject(pEdgeTags, numberElements)`

  Parameters:

  - pEdgeTags (list of `NXOpen.NXObject`) –
  - numberElements (int) –

  New in version NX12.0.0.

  License requirements: None.

## GetCornerData

`MappedMeshBuilder.``GetCornerData`

  Returns the corner data

  Signature `GetCornerData()`

  Returns: | a tuple
  Return type: | A tuple consisting of (vertexList, face). vertexList is a list of `NXOpen.NXObject`. face is a `NXOpen.NXObject`.

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## PreviewMesh

`MappedMeshBuilder.``PreviewMesh`

  Previews the mapped mesh for further edit.

  After preview, corner definition is allowed.

  Signature `PreviewMesh()`

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## SetCornerData

`MappedMeshBuilder.``SetCornerData`

  Sets the corner data.

  Signature `SetCornerData(face, vertexList)`

  Parameters:

  - face (`NXOpen.NXObject`) –
  - vertexList (list of `NXOpen.NXObject`) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## SetCornerDataWithEdges

`MappedMeshBuilder.``SetCornerDataWithEdges`

  Sets the corner data using array of edges and int array consists of if user want start of an edge or an end of an edge.

  This start of an edge map to the edge where 1 is start of an edge and 0 is end of an edge

  Signature `SetCornerDataWithEdges(face, start, edge)`

  Parameters:

  - face (`NXOpen.NXObject`) –
  - start (list of int) –
  - edge (list of `NXOpen.NXObject`) –

  New in version NX9.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## Validate

`MappedMeshBuilder.``Validate`

  Validate whether the inputs to the component are sufficient for commit to be called.

  If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.