TBSSmoothBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# TBSSmoothBuilder Class

class `NXOpen.CAE.Optimization.``TBSSmoothBuilder`

  Bases: `NXOpen.Builder`

  Represents the builder of `NXOpen.CAE.Optimization.TBSSmooth`.

  To create a new instance of this class, use `NXOpen.CAE.Optimization.TBSOptimizationManager.CreateSmoothBuilder()`

  New in version NX8.0.0.

# Properties

Property | Description
--- | ---
Border | Returns or sets the option to save border.
ComponentLimitingSize | Returns the limiting size that defines the minimal allowed relative size of a connected component.
IsoTypeOption | Returns or sets the option that specifies what should be saved to the output files
IsoValue | Returns or sets the iso value that is used to determine the positions on the element edges where the new nodes are created.
MinimumAngle | Returns the minimum angle that defines the minimal angle of the triangles that result from the smoothing and data reduction.
MixedMesh | Returns or sets the choice whether to form quardrilaterals from adjacent triangles
NameDescription | Returns the name description
OriginalSurfaceSmooth | Returns or sets the option of how to smooth the original surface
ReductionAngle | Returns the reduction angle that defines the maximal angle between adjacent faces at a node such that the node may be removed during the data reduction
ReductionRate | Returns or sets the reduction rate that defines the percent of faces that should be removed during the data reduction.
ResultFilteringOption | Returns or sets the result filtering option
SelfIntersectionChecking | Returns or sets the option of self-intersection checking
SliceFormat | Returns or sets the slice format
SliceNormalVector | Returns or sets the slice normal vector
SliceNumber | Returns or sets the slice number
SmoothArea | Returns the area to be smoothed
SmoothCycles | Returns or sets the number of smoothing cycles.
Tag | Returns the Tag for this object.
TargetVolume | Returns or sets the target volume that is to be achieved iteratively by varying the isovalue.
UseAdditionalParameters | Returns or sets the option to use additional parameter.

# Methods

Method | Description
--- | ---
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.
GetFormatOption | The output result format accessor
GetObject | Returns the object currently being edited by this builder.
SetFormatOption | The output result format mutator
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

TBSSmoothBuilderFormat Enumeration | Defines the output file format of surface representation
TBSSmoothBuilderIsoType Enumeration | Specifies the content saved to the output files
TBSSmoothBuilderOriginalSurfaceSmoothingOption Enumeration | Defines if the original surface is to be smoothed or remain unchanged
TBSSmoothBuilderResultFiltering Enumeration | Defines if the element material values are to be filtered before the isocut
TBSSmoothBuilderSelfIntersectionCheckingOption Enumeration | Defines if the self-itersection checks are to be performed during the isocut, smoothing and data reduction
TBSSmoothBuilderSliceFormatOption Enumeration | Defines how to save slices

# Property Detail

## Border

`TBSSmoothBuilder.``Border`

  Returns or sets the option to save border.

  If yes, the border of the shell element model will saved

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

  Getter Method

  Signature `Border`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Border`

  Parameters: | border (bool) –

  New in version NX8.0.0.

  License requirements: cae_opt_topo (“NX Topology Optimization”) OR cae_opt_topobead (“NX Bead Optimization”) OR cae_opt_toposhape (“NX Shape Optimization”)

## ComponentLimitingSize

`TBSSmoothBuilder.``ComponentLimitingSize`

  Returns the limiting size that defines the minimal allowed relative size of a connected component.

  All components with the relative size below this value are removed

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

  Getter Method

  Signature `ComponentLimitingSize`

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

  New in version NX8.0.0.

  License requirements: None.

## IsoTypeOption

`TBSSmoothBuilder.``IsoTypeOption`

  Returns or sets the option that specifies what should be saved to the output files

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

  Getter Method

  Signature `IsoTypeOption`

  Returns: |
  Return type: | `NXOpen.CAE.Optimization.TBSSmoothBuilderIsoType`

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `IsoTypeOption`

  Parameters: | isoTypeOption (`NXOpen.CAE.Optimization.TBSSmoothBuilderIsoType`) –

  New in version NX8.0.0.

  License requirements: cae_opt_topo (“NX Topology Optimization”) OR cae_opt_topobead (“NX Bead Optimization”) OR cae_opt_toposhape (“NX Shape Optimization”)

## IsoValue

`TBSSmoothBuilder.``IsoValue`

  Returns or sets the iso value that is used to determine the positions on the element edges where the new nodes are created.

  Larger value lead to models with smaller volume. Value is between 0 and 1

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

  Getter Method

  Signature `IsoValue`

  Returns: |
  Return type: | float

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `IsoValue`

  Parameters: | isoValue (float) –

  New in version NX8.0.0.

  License requirements: cae_opt_topo (“NX Topology Optimization”) OR cae_opt_topobead (“NX Bead Optimization”) OR cae_opt_toposhape (“NX Shape Optimization”)

## MinimumAngle

`TBSSmoothBuilder.``MinimumAngle`

  Returns the minimum angle that defines the minimal angle of the triangles that result from the smoothing and data reduction.

  Too large value may prevent the smoothing, and too small value may lead to degenerated triangles

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

  Getter Method

  Signature `MinimumAngle`

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

  New in version NX8.0.0.

  License requirements: None.

## MixedMesh

`TBSSmoothBuilder.``MixedMesh`

  Returns or sets the choice whether to form quardrilaterals from adjacent triangles

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

  Getter Method

  Signature `MixedMesh`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MixedMesh`

  Parameters: | mixedMesh (bool) –

  New in version NX8.0.0.

  License requirements: cae_opt_topo (“NX Topology Optimization”) OR cae_opt_topobead (“NX Bead Optimization”) OR cae_opt_toposhape (“NX Shape Optimization”)

## NameDescription

`TBSSmoothBuilder.``NameDescription`

  Returns the name description

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

  Getter Method

  Signature `NameDescription`

  Returns: |
  Return type: | `NXOpen.CAE.Optimization.NameDescription`

  New in version NX8.0.0.

  License requirements: None.

## OriginalSurfaceSmooth

`TBSSmoothBuilder.``OriginalSurfaceSmooth`

  Returns or sets the option of how to smooth the original surface

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

  Getter Method

  Signature `OriginalSurfaceSmooth`

  Returns: |
  Return type: | `NXOpen.CAE.Optimization.TBSSmoothBuilderOriginalSurfaceSmoothingOption`

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OriginalSurfaceSmooth`

  Parameters: | originalSurfaceSmooth (`NXOpen.CAE.Optimization.TBSSmoothBuilderOriginalSurfaceSmoothingOption`) –

  New in version NX8.0.0.

  License requirements: cae_opt_topo (“NX Topology Optimization”) OR cae_opt_topobead (“NX Bead Optimization”) OR cae_opt_toposhape (“NX Shape Optimization”)

## ReductionAngle

`TBSSmoothBuilder.``ReductionAngle`

  Returns the reduction angle that defines the maximal angle between adjacent faces at a node such that the node may be removed during the data reduction

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

  Getter Method

  Signature `ReductionAngle`

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

  New in version NX8.0.0.

  License requirements: None.

## ReductionRate

`TBSSmoothBuilder.``ReductionRate`

  Returns or sets the reduction rate that defines the percent of faces that should be removed during the data reduction.

  if set to 0, no data reduction occurs. If set to 100, the data reduction sopts when no faces could be removed

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

  Getter Method

  Signature `ReductionRate`

  Returns: |
  Return type: | float

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ReductionRate`

  Parameters: | reductionRate (float) –

  New in version NX8.0.0.

  License requirements: cae_opt_topo (“NX Topology Optimization”) OR cae_opt_topobead (“NX Bead Optimization”) OR cae_opt_toposhape (“NX Shape Optimization”)

## ResultFilteringOption

`TBSSmoothBuilder.``ResultFilteringOption`

  Returns or sets the result filtering option

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

  Getter Method

  Signature `ResultFilteringOption`

  Returns: |
  Return type: | `NXOpen.CAE.Optimization.TBSSmoothBuilderResultFiltering`

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ResultFilteringOption`

  Parameters: | resultFilteringOption (`NXOpen.CAE.Optimization.TBSSmoothBuilderResultFiltering`) –

  New in version NX8.0.0.

  License requirements: cae_opt_topo (“NX Topology Optimization”) OR cae_opt_topobead (“NX Bead Optimization”) OR cae_opt_toposhape (“NX Shape Optimization”)

## SelfIntersectionChecking

`TBSSmoothBuilder.``SelfIntersectionChecking`

  Returns or sets the option of self-intersection checking

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

  Getter Method

  Signature `SelfIntersectionChecking`

  Returns: |
  Return type: | `NXOpen.CAE.Optimization.TBSSmoothBuilderSelfIntersectionCheckingOption`

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SelfIntersectionChecking`

  Parameters: | selfIntersectionChecking (`NXOpen.CAE.Optimization.TBSSmoothBuilderSelfIntersectionCheckingOption`) –

  New in version NX8.0.0.

  License requirements: cae_opt_topo (“NX Topology Optimization”) OR cae_opt_topobead (“NX Bead Optimization”) OR cae_opt_toposhape (“NX Shape Optimization”)

## SliceFormat

`TBSSmoothBuilder.``SliceFormat`

  Returns or sets the slice format

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

  Getter Method

  Signature `SliceFormat`

  Returns: |
  Return type: | `NXOpen.CAE.Optimization.TBSSmoothBuilderSliceFormatOption`

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SliceFormat`

  Parameters: | sliceFormat (`NXOpen.CAE.Optimization.TBSSmoothBuilderSliceFormatOption`) –

  New in version NX8.0.0.

  License requirements: cae_opt_topo (“NX Topology Optimization”) OR cae_opt_topobead (“NX Bead Optimization”) OR cae_opt_toposhape (“NX Shape Optimization”)

## SliceNormalVector

`TBSSmoothBuilder.``SliceNormalVector`

  Returns or sets the slice normal vector

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

  Getter Method

  Signature `SliceNormalVector`

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

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SliceNormalVector`

  Parameters: | sliceNormalVector (`NXOpen.Direction`) –

  New in version NX8.0.0.

  License requirements: cae_opt_topo (“NX Topology Optimization”) OR cae_opt_topobead (“NX Bead Optimization”) OR cae_opt_toposhape (“NX Shape Optimization”)

## SliceNumber

`TBSSmoothBuilder.``SliceNumber`

  Returns or sets the slice number

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

  Getter Method

  Signature `SliceNumber`

  Returns: |
  Return type: | int

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SliceNumber`

  Parameters: | sliceNumber (int) –

  New in version NX8.0.0.

  License requirements: cae_opt_topo (“NX Topology Optimization”) OR cae_opt_topobead (“NX Bead Optimization”) OR cae_opt_toposhape (“NX Shape Optimization”)

## SmoothArea

`TBSSmoothBuilder.``SmoothArea`

  Returns the area to be smoothed

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

  Getter Method

  Signature `SmoothArea`

  Returns: |
  Return type: | `NXOpen.CAE.Optimization.TBSGroupDefinition`

  New in version NX8.0.0.

  License requirements: None.

## SmoothCycles

`TBSSmoothBuilder.``SmoothCycles`

  Returns or sets the number of smoothing cycles.

  If set to 0, no smoothing is performed. Larger value leads to smoother models, but may cause the narrowing of thin components

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

  Getter Method

  Signature `SmoothCycles`

  Returns: |
  Return type: | int

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SmoothCycles`

  Parameters: | smoothCycles (int) –

  New in version NX8.0.0.

  License requirements: cae_opt_topo (“NX Topology Optimization”) OR cae_opt_topobead (“NX Bead Optimization”) OR cae_opt_toposhape (“NX Shape Optimization”)

## TargetVolume

`TBSSmoothBuilder.``TargetVolume`

  Returns or sets the target volume that is to be achieved iteratively by varying the isovalue.

  If set to 0, the given `NXOpen.CAE.Optimization.TBSSmoothBuilder.IsoValue`()` is usedfor the generation of the isosurface

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

  Getter Method

  Signature `TargetVolume`

  Returns: |
  Return type: | float

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `TargetVolume`

  Parameters: | targetVolume (float) –

  New in version NX8.0.0.

  License requirements: cae_opt_topo (“NX Topology Optimization”) OR cae_opt_topobead (“NX Bead Optimization”) OR cae_opt_toposhape (“NX Shape Optimization”)

## UseAdditionalParameters

`TBSSmoothBuilder.``UseAdditionalParameters`

  Returns or sets the option to use additional parameter.

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

  Getter Method

  Signature `UseAdditionalParameters`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: None.

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

  Setter Method

  Signature `UseAdditionalParameters`

  Parameters: | useAdditionalParameters (bool) –

  New in version NX8.0.0.

  License requirements: cae_opt_topo (“NX Topology Optimization”) OR cae_opt_topobead (“NX Bead Optimization”) OR cae_opt_toposhape (“NX Shape Optimization”)

# Method Detail

## GetFormatOption

`TBSSmoothBuilder.``GetFormatOption`

  The output result format accessor

  Signature `GetFormatOption()`

  Returns: |
  Return type: | list of `NXOpen.CAE.Optimization.TBSSmoothBuilderFormat`

  New in version NX8.0.0.

  License requirements: None.

## SetFormatOption

`TBSSmoothBuilder.``SetFormatOption`

  The output result format mutator

  Signature `SetFormatOption(formatOption)`

  Parameters: | formatOption (list of `NXOpen.CAE.Optimization.TBSSmoothBuilderFormat`) –

  New in version NX8.0.0.

  License requirements: cae_opt_topo (“NX Topology Optimization”) OR cae_opt_topobead (“NX Bead Optimization”) OR cae_opt_toposhape (“NX Shape Optimization”)

## Validate

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