BaseFemPart Class — NXOpen Python API Reference 12.0.0 documentation

# BaseFemPart Class

class `NXOpen.CAE.``BaseFemPart`

  Bases: `NXOpen.CAE.CaePart`

  Represents an NX part of type .afm.

  Use the `NXOpen.PartCollection` class to load or create a part.

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
BaseFEModel | Returns the femodel `NXOpen.CAE.BaseFEModel` associated with the part
ComponentAssembly | Returns the component assembly.
Displayed | Returns true if the part represents a displayed part.
FieldManager | Returns the field main.
FullPath | Returns the full path of the part.
FullPathForAssociatedCadPart | Returns the full pathname of the associated cad part
HasWriteAccess | Returns the write-access status of a part independent of the load state.
IsFullyLoaded | Returns the load status of a part.
IsOccurrence | Returns whether this object is an occurrence or not.
IsReadOnly | Returns the read-only status of a part.
JournalIdentifier | Returns the identifier that would be recorded in a journal for this object.
Leaf | Returns the leaf name of the part.
Name | Returns the custom name of the object.
OwningComponent | Returns the owning component, if this object is an occurrence.
OwningPart | Returns the owning part of this object
PartPreviewMode | Returns or sets the preview mode
PartUnits | Returns the units of the part file.
Prototype | Returns the prototype of this object if it is an occurrence.
SaveDisplayFacets | Returns or sets whether display quality facets are saved in the part file
Tag | Returns the Tag for this object.
UniqueIdentifier | Returns or sets the unique identifier for this part used to determine whether parts can be quietly substituted during part open.
UseCyclicSymmetryCsys | Returns the use cyclic symmetry csys flag
SketchCurves | Returns the Sketch Curves collection belonging to the part

# Methods

Method | Description
--- | ---
AssignPermanentName | Saves a temporary part with the given name.
CanBeDisplayPart | Returns true if the part can be displayed and false if not displayed.
Close | Closes an open part.
CompleteStructure | Make additions necessary to complete the incomplete assembly structure of the input part
CreateAttributeIterator | Create an attribute iterator
CreateConvertToConvergentBodyBuilder | Creates a `NXOpen.CAE.ConvertToConvergentBodyBuilder`
CreateDynamicSectionBuilder | Creates a `NXOpen.Display.DynamicSectionBuilder` The base part must be a displayable part, otherwise an exception will be thrown.
CreateEffectivityConditionBuilder | Creates a `NXOpen.EffectivityConditionBuilder`
CreateFacetSettingsBuilder | Creates a builder for the Facet Settings dialog
CreateGatewayGroupBuilder | Creates a Groups builder
CreateModelDisplayBuilder | Creates a builder for model display controls command
CreatePerspectiveOptionsBuilder | Creates a builder for the Perspective Options dialog
CreateReferenceSet | Creates a `NXOpen.ReferenceSet` object
CreateSolverAppendOption | Returns a solver append option object for importing the solver specific data into an existing `NXOpen.CAE.FemPart` or `NXOpen.CAE.SimPart`.
DeleteAllAttributesByType | Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle | Deletes an attribute by type and title.
DeleteReferenceSet | Deletes a `NXOpen.ReferenceSet` object
DeleteSolverAppendOption | Deletes a solver append option object for importing the solver specific data into an existing `NXOpen.CAE.FemPart` or `NXOpen.CAE.SimPart`.
DeleteUserAttribute | Deletes the first attribute encountered with the given Type, Title.
DeleteUserAttributes | Deletes the attributes on the object, if any, that satisfy the given iterator
ExportJt | Exports JT file
ExportSimulation | Exports the Simulation data for a `NXOpen.CAE.CaePart`.
FindObject | Finds the `NXOpen.NXObject` with the given identifier as recorded in a journal.
GetAbstractionType | Gets axisymmetric abstraction type assoicated with the BaseFem part
GetAllReferenceSets | Get all the `NXOpen.ReferenceSet` objects in this part.
GetApplication | Get the application which corresponds to the specified type.
GetArrangements | Outputs the `NXOpen.Assemblies.Arrangement` objects within the given part.
GetAttributeTitlesByType | Gets all the attribute titles of a specific type.
GetBooleanUserAttribute | Gets a boolean attribute by Title and array Index.
GetCollaborativeContentType | The collaborative content type of this part.
GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index.
GetCsysFlattenedLabel | Gets the resolved label of csys in cae part.
GetCyclicSymmetryCsys | Gets the cyclic symmetry csys associated to the fem
GetDescription | Gets the description assoicated with the Cae part
GetEnableMeshMorph | Gets the enable mesh morphing flag
GetHistoryInformation | Get history of part
GetIncompleteStatus | Inquire whether the provided part is flagged as being incomplete
GetIntegerAttribute | Gets an integer attribute by title.
GetIntegerUserAttribute | Gets an integer attribute by Title and array Index.
GetMakeUniqueName | Gets the Unique name on a part for the Make Unique operation
GetNextUserAttribute | Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetPdmReferenceAttributeValue | Gets the value of PDM Reference attribute for given object.
GetPreviewImage | Get the preview image This will return the graphic preview image of the part (when available).
GetRealAttribute | Gets a real attribute by title.
GetRealUserAttribute | Gets a real attribute by Title and array Index.
GetReferenceAttribute | Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
GetSolverAndAnalysisType | Gets solver and analysis type assoicated with the BaseFem part
GetStringAttribute | Gets a string attribute value by title.
GetStringUserAttribute | Gets a string attribute by Title and array Index.
GetTimeAttribute | Gets a time attribute by title.
GetTimeUserAttribute | Gets a time attribute by Title and array Index.
GetTransientStatus | Inquire whether the provided part is flagged as being transient
GetUserAttribute | Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.
GetUserAttributeAsString | Gets the first attribute encountered on the object, if any, with a given title, type and array index.
GetUserAttributeCount | Gets the count of set attributes on the object, if any, that satisfy the given iterator.
GetUserAttributeLock | Determine the lock of the given attribute.
GetUserAttributeSize | Gets the size of the first attribute encountered on the object, if any, with a given Title and Type.
GetUserAttributeSourceObjects | Returns an array of objects from which this object presents attributes.
GetUserAttributes | Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator.
GetUserAttributesAsStrings | Gets all the attributes that have been set on the given object.
HasUserAttribute | Determines if an attribute exists on the object, that satisfies the given iterator
ImportExistingSimulation | Imports the solver specific data into an existing `NXOpen.CAE.FemPart` or `NXOpen.CAE.SimPart`.
LoadFeatureDataForSelection | Ensure that feature data is loaded for a part.
LoadFully | Ensures that this part is fully loaded.
LoadThisPartFully | Ensures that this part is fully loaded.
LoadThisPartPartially | Ensures that this part is at least partially loaded.
NewBeamSectionOffsetOptions | Creates a `NXOpen.CAE.BeamSectionOffsetOptions`
NewBeamSectionOptions | Creates a `NXOpen.CAE.BeamSectionOptions`
NewBeamSectionOrientationOptions | Creates a `NXOpen.CAE.BeamSectionOrientationOptions`
NewMaterialOptions | Creates a `NXOpen.CAE.MaterialOptions`
Print | Prints a representation of this object to the system log file.
RegenerateDisplayFacets | Regenerates display specific transient cached facets in the part.
ReinstateTransience | Reinstate the transient status to the formerly transient input part
RemoveTransience | Remove the transient status from the input part
Reopen | Reopens a loaded part.
ReopenAs | Reopens a loaded part.
ReverseBlankAll | Reverse blank all the objects in the part.
Save | Saves the part whether it is modified or not.
SaveAs | Creates copy of target part.
SaveBookmark | Saves a bookmark file.
SetAttribute | Creates or modifies an integer attribute.
SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not.
SetCyclicSymmetryCsys | Sets the cyclic symmetry csys associated to the fem
SetDescription | Sets the description assoicated with the Cae part
SetEnableMeshMorph | Sets the enable mesh morphing flag
SetMakeUniqueName | Sets the unique name on part for the Make Unique operation
SetName | Sets the custom name of the object.
SetPdmReferenceAttribute | Sets the value of PDM Reference attribute on the object.
SetReferenceAttribute | Creates or modifies a string attribute which uses a reference string.
SetSolverAndAnalysisType | Sets solver and analysis type assoicated with the BaseFem part.
SetSolverAndAnalysisTypeAndAbstraction | Sets solver and analysis type and axisymmetric abstraction associated with the BaseFem part
SetTimeAttribute | Creates or modifies a time attribute.
SetTimeUserAttribute | Creates or modifies a time attribute with the option to update or not.
SetUseCyclicSymmetryCsys | Sets the use cyclic symmetry csys flag
SetUserAttribute | Creates or modifies an attribute with the option to update or not.
SetUserAttributeLock | Lock or unlock the given attribute.
Undisplay | Undisplays the part, if it is currently a displayed part.

# Enumerations

BaseFemPartAxisymAbstractionType Enumeration | Used to specify the axisymmetric abstraction type during Fempart creation .

# Property Detail

## BaseFEModel

`BaseFemPart.``BaseFEModel`

  Returns the femodel `NXOpen.CAE.BaseFEModel` associated with the part

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

  Getter Method

  Signature `BaseFEModel`

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

  New in version NX6.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## FullPathForAssociatedCadPart

`BaseFemPart.``FullPathForAssociatedCadPart`

  Returns the full pathname of the associated cad part

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

  Getter Method

  Signature `FullPathForAssociatedCadPart`

  Returns: |
  Return type: | str

  New in version NX7.5.4.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## IsOccurrence

`BaseFemPart.``IsOccurrence`

  Returns whether this object is an occurrence or not.

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

  Getter Method

  Signature `IsOccurrence`

  Returns: | This object is an occurrence
  Return type: | bool

  New in version NX3.0.0.

  License requirements: None.

## JournalIdentifier

`BaseFemPart.``JournalIdentifier`

  Returns the identifier that would be recorded in a journal for this object.

  This may not be the same across different releases of the software.

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

  Getter Method

  Signature `JournalIdentifier`

  Returns: |
  Return type: | str

  New in version NX3.0.0.

  License requirements: None.

## Name

`BaseFemPart.``Name`

  Returns the custom name of the object.

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

  Getter Method

  Signature `Name`

  Returns: |
  Return type: | str

  New in version NX3.0.0.

  License requirements: None.

## OwningComponent

`BaseFemPart.``OwningComponent`

  Returns the owning component, if this object is an occurrence.

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

  Getter Method

  Signature `OwningComponent`

  Returns: |
  Return type: | `NXOpen.Assemblies.Component`

  New in version NX3.0.0.

  License requirements: None.

## OwningPart

`BaseFemPart.``OwningPart`

  Returns the owning part of this object

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

  Getter Method

  Signature `OwningPart`

  Returns: | The owning part of this object or null if it does not have an owner
  Return type: | `NXOpen.BasePart`

  New in version NX3.0.0.

  License requirements: None.

## Prototype

`BaseFemPart.``Prototype`

  Returns the prototype of this object if it is an occurrence.

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

  Getter Method

  Signature `Prototype`

  Returns: | The prototype of this object or null if this object is not an occurrence
  Return type: | `NXOpen.INXObject`

  New in version NX3.0.0.

  License requirements: None.

## UseCyclicSymmetryCsys

`BaseFemPart.``UseCyclicSymmetryCsys`

  Returns the use cyclic symmetry csys flag

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

  Getter Method

  Signature `UseCyclicSymmetryCsys`

  Returns: | Flag to determine if the cyclic symmetry csys is to be used
  Return type: | bool

  New in version NX11.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## SketchCurves

`BaseFemPart.``SketchCurves`

  Returns the Sketch Curves collection belonging to the part

  Signature `SketchCurves`

  New in version NX7.5.0.

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

# Method Detail

## FindObject

`BaseFemPart.``FindObject`

  Finds the `NXOpen.NXObject` with the given identifier as recorded in a journal.

  An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

  An exception will be thrown if no object can be found with the given journal identifier.

  Signature `FindObject(journalIdentifier)`

  Parameters: | journalIdentifier (str) – Journal identifier of the object
  Returns: |
  Return type: | `NXOpen.INXObject`

  New in version NX3.0.0.

  License requirements: None.

## GetAbstractionType

`BaseFemPart.``GetAbstractionType`

  Gets axisymmetric abstraction type assoicated with the BaseFem part

  Signature `GetAbstractionType()`

  Returns: | the axisymmetric abstraction type. Refer to NX help for more information
  Return type: | `NXOpen.CAE.BaseFemPartAxisymAbstractionType`

  New in version NX9.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## GetCyclicSymmetryCsys

`BaseFemPart.``GetCyclicSymmetryCsys`

  Gets the cyclic symmetry csys associated to the fem

  Signature `GetCyclicSymmetryCsys()`

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

  New in version NX11.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## GetEnableMeshMorph

`BaseFemPart.``GetEnableMeshMorph`

  Gets the enable mesh morphing flag

  Signature `GetEnableMeshMorph()`

  Returns: | Flag to determine whether the mesh morphing is enabled
  Return type: | bool

  New in version NX10.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## GetSolverAndAnalysisType

`BaseFemPart.``GetSolverAndAnalysisType`

  Gets solver and analysis type assoicated with the BaseFem part

  Signature `GetSolverAndAnalysisType()`

  Returns: | a tuple
  Return type: | A tuple consisting of (solverTypeName, analysisTypeName) solverTypeName is a str. the name of the solver. Refer to NX help for more information analysisTypeName is a str. the name of the analysis type. Refer to NX help for more information

  New in version NX6.0.2.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## Print

`BaseFemPart.``Print`

  Prints a representation of this object to the system log file.

  Signature `Print()`

  New in version NX3.0.0.

  License requirements: None.

## SetCyclicSymmetryCsys

`BaseFemPart.``SetCyclicSymmetryCsys`

  Sets the cyclic symmetry csys associated to the fem

  Signature `SetCyclicSymmetryCsys(cyclicSymmetryCsys)`

  Parameters: | cyclicSymmetryCsys (`NXOpen.CoordinateSystem`) –

  New in version NX11.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## SetEnableMeshMorph

`BaseFemPart.``SetEnableMeshMorph`

  Sets the enable mesh morphing flag

  Signature `SetEnableMeshMorph(isMorphingEnabled)`

  Parameters: | isMorphingEnabled (bool) – Flag to determine whether the mesh morphing is enabled

  New in version NX10.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## SetName

`BaseFemPart.``SetName`

  Sets the custom name of the object.

  NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

  Signature `SetName(name)`

  Parameters: | name (str) –

  New in version NX3.0.0.

  License requirements: None.

## SetSolverAndAnalysisType

`BaseFemPart.``SetSolverAndAnalysisType`

  Sets solver and analysis type assoicated with the BaseFem part.

  Axisymmetric abstraction type is set internally using pre-nx9 techniques using solver name and analysis type.

  Signature `SetSolverAndAnalysisType(solverTypeName, analysisTypeName)`

  Parameters:

  - solverTypeName (str) – the name of the solver. Refer to NX help for more information
  - analysisTypeName (str) – the name of the analysis type. Refer to NX help for more information

  New in version NX6.0.2.

  Deprecated since version NX9.0.0: Use `NXOpen.CAE.BaseFemPart.SetSolverAndAnalysisTypeAndAbstraction()` instead.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## SetSolverAndAnalysisTypeAndAbstraction

`BaseFemPart.``SetSolverAndAnalysisTypeAndAbstraction`

  Sets solver and analysis type and axisymmetric abstraction associated with the BaseFem part

  Signature `SetSolverAndAnalysisTypeAndAbstraction(solverTypeName, analysisTypeName, abstractionType)`

  Parameters:

  - solverTypeName (str) – the name of the solver. Refer to NX help for more information
  - analysisTypeName (str) – the name of the analysis type. Refer to NX help for more information
  - abstractionType (`NXOpen.CAE.BaseFemPartAxisymAbstractionType`) – the axisymmetric abstraction type. Refer to NX help for more information

  New in version NX9.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## SetUseCyclicSymmetryCsys

`BaseFemPart.``SetUseCyclicSymmetryCsys`

  Sets the use cyclic symmetry csys flag

  Signature `SetUseCyclicSymmetryCsys(useCyclicSymmetryCsys)`

  Parameters: | useCyclicSymmetryCsys (bool) – Flag to determine if the cyclic symmetry csys is to be used

  New in version NX11.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)