SimSolutionStep Class

class NXOpen.CAE.SimSolutionStep

Bases: NXOpen.CAE.SimGroupContainer

Represents a subcase/step in a solution.

For more information, refer to the Solver language documentation in the SolverLanguageDocumentation.

To create a new instance of this class, use NXOpen.CAE.SimSimulation.CreateSolutionStep()

New in version NX4.0.0.

Properties

Property	Description
IsConstraintGroupAllowed	Returns a value indicating whether a constraint group is allowed for this group container
IsLoadGroupAllowed	Returns a value indicating whether a load group is allowed for this group container
IsOccurrence	Returns whether this object is an occurrence or not.
IsSimulationObjectGroupAllowed	Returns a value indicating whether a simulation object group is allowed for this group container
JournalIdentifier	Returns the identifier that would be recorded in a journal for this object.
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
PropertyTable	Returns the property table associated with the step
Prototype	Returns the prototype of this object if it is an occurrence.
Solution	Returns the solution to which the step belongs
StepType	Returns the step type
Tag	Returns the Tag for this object.

Methods

Method	Description
AddBc	Add the bc to the step Only the BC that not under the folder can be added to solution
AddFolder	Add the folder to the solution Only the folder not under other folder can be added to solution.
CloneStep	Clone the solution step
CreateAttributeIterator	Create an attribute iterator
CreateConstraintGroup	Creates a constraint group for a solution or solution step
CreateLoadGroup	Creates a load group for a solution or solution step
CreateSimulationObjectGroup	Creates a simulation object group for a solution or solution step
DeleteAllAttributesByType	Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle	Deletes an attribute by type and title.
DeleteGroup	Deletes a BC group from this group container
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
Find	Returns the children of the Solution Step of the given Identifier
FindObject	Finds the NXOpen.NXObject with the given identifier as recorded in a journal.
GetAttributeTitlesByType	Gets all the attribute titles of a specific type.
GetBcs	Gets all the BCs in this solution step
GetBooleanUserAttribute	Gets a boolean attribute by Title and array Index.
GetComputationalTimeUserAttribute	Gets a time attribute by Title and array Index.
GetFolders	Gets all the root folders in this solution step
GetGroupCount	Returns the number of groups in this container
GetGroups	Gets the BC groups in this group container
GetIntegerAttribute	Gets an integer attribute by title.
GetIntegerUserAttribute	Gets an integer attribute by Title and array Index.
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.
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.
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.
GetUnfolderedBcs	Gets all the unfoldered BCs in this solution
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
Print	Prints a representation of this object to the system log file.
RemoveAllConstraints	Remove all constraints from the step
RemoveAllLoads	Remove all loads from the step
RemoveAllSimulationObjects	Remove all simulation objects from the step
RemoveBc	Remove the bc from the step Only the BC that not under the folder can be removed from solution
RemoveFolder	Remove the folder from the solution Only the folder not under other folder can be removed from solution.
SetAttribute	Creates or modifies an integer attribute.
SetBooleanUserAttribute	Creates or modifies a boolean attribute with the option to update or not.
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.
SetTimeAttribute	Creates or modifies a time attribute.
SetTimeUserAttribute	Creates or modifies a time attribute with the option to update or not.
SetUserAttribute	Creates or modifies an attribute with the option to update or not.
SetUserAttributeLock	Lock or unlock the given attribute.

Property Detail

IsOccurrence

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

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

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

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

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

PropertyTable

SimSolutionStep.PropertyTable

Returns the property table associated with the step

-------------------------------------

Getter Method

Signature PropertyTable

Returns:property table Return type:NXOpen.CAE.PropertyTable

New in version NX4.0.0.

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

Prototype

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

Solution

SimSolutionStep.Solution

Returns the solution to which the step belongs

-------------------------------------

Getter Method

Signature Solution

Returns:the solution to which the step belongs Return type:NXOpen.CAE.SimSolution

New in version NX4.0.0.

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

StepType

SimSolutionStep.StepType

Returns the step type

-------------------------------------

Getter Method

Signature StepType

Returns:step type Return type:int

New in version NX4.0.0.

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

Method Detail

AddBc

SimSolutionStep.AddBc

Add the bc to the step Only the BC that not under the folder can be added to solution

Signature AddBc(bc)

Parameters:bc (NXOpen.CAE.SimBC) – the bc to be added

New in version NX4.0.0.

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

AddFolder

SimSolutionStep.AddFolder

Add the folder to the solution Only the folder not under other folder can be added to solution.

Signature AddFolder(folder)

Parameters:folder (NXOpen.CAE.SimLbcFolder) – the folder to be added

New in version NX9.0.0.

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

CloneStep

SimSolutionStep.CloneStep

Clone the solution step

Signature CloneStep(suggestedName)

Parameters:suggestedName (str) – name to use instead of default name (may be None) Returns:the newly created NXOpen.CAE.SimSolutionStep Return type:NXOpen.CAE.SimSolutionStep

New in version NX10.0.0.

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

Find

SimSolutionStep.Find

Returns the children of the Solution Step of the given Identifier

Signature Find(journalIdentifier)

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

New in version NX10.0.0.

License requirements: None.

FindObject

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

GetBcs

SimSolutionStep.GetBcs

Gets all the BCs in this solution step

Signature GetBcs()

Returns:Resultant bcs Return type:list of NXOpen.CAE.SimBC

New in version NX8.5.0.

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

GetFolders

SimSolutionStep.GetFolders

Gets all the root folders in this solution step

Signature GetFolders()

Returns:Resultant bcs Return type:list of NXOpen.CAE.SimLbcFolder

New in version NX8.5.0.

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

GetUnfolderedBcs

SimSolutionStep.GetUnfolderedBcs

Gets all the unfoldered BCs in this solution

Signature GetUnfolderedBcs()

Returns:Resultant bcs Return type:list of NXOpen.CAE.SimBC

New in version NX8.5.0.

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

Print

SimSolutionStep.Print

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

Signature Print()

New in version NX3.0.0.

License requirements: None.

RemoveAllConstraints

SimSolutionStep.RemoveAllConstraints

Remove all constraints from the step

Signature RemoveAllConstraints()

New in version NX8.5.0.

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

RemoveAllLoads

SimSolutionStep.RemoveAllLoads

Remove all loads from the step

Signature RemoveAllLoads()

New in version NX8.5.0.

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

RemoveAllSimulationObjects

SimSolutionStep.RemoveAllSimulationObjects

Remove all simulation objects from the step

Signature RemoveAllSimulationObjects()

New in version NX8.5.0.

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

RemoveBc

SimSolutionStep.RemoveBc

Remove the bc from the step Only the BC that not under the folder can be removed from solution

Signature RemoveBc(bc)

Parameters:bc (NXOpen.CAE.SimBC) – the bc to be remove

New in version NX4.0.0.

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

RemoveFolder

SimSolutionStep.RemoveFolder

Remove the folder from the solution Only the folder not under other folder can be removed from solution.

Signature RemoveFolder(folder)

Parameters:folder (NXOpen.CAE.SimLbcFolder) – the folder to be removed

New in version NX9.0.0.

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

SetName

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