## On this page

  

 

 # FeatureSimulation Class Reference

 Last update: 17.07.2025 

Represents a Speos simulation feature. [More...](#details)

Inheritance diagram for FeatureSimulation:

 ![](/sites/default/files/migrate-content/speos_nx_2024_r2/class_speos_n_x_1_1_feature_simulation.png)



## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

 [Isolate](#aeecae54d8c7f16c4bcedf21d93da3067) (self) Isolates the simulation and its results.   
  [Export](#a31a18dd95ce0573d79b59ca4057d8591) (self, path) Exports the simulation to a specified location.   
  [LinkedExport](#a23529de1cab39154aa23c7133327ca82) (self) Exports the simulation to the Speos isolated folder.   
  [RegenerationSpeosHPC](#ae189424d69f8854b544ae310082c1a48) (self) Runs the simulation on the Speos HPC cluster.   
 ![-](/sites/default/files/migrate-content/speos_nx_2024_r2/closed.png) Public Member Functions inherited from [Feature](class_speos_n_x_1_1_feature.xhtml) **Update** (self) Updates the feature.   
  **Delete** (self) Deletes the feature.   
 ## <a id="properties" name="properties"></a>Properties

 [GPUSimulationMode](#a21f68ec2beda4bb03b75580244fbcaae) = property(fset = \_\_SetGPUSimulationMode) Sets the simulation mode.   
 ![-](/sites/default/files/migrate-content/speos_nx_2024_r2/closed.png) Properties inherited from [Feature](class_speos_n_x_1_1_feature.xhtml) [Name](class_speos_n_x_1_1_feature.xhtml#aa5998168cabfb2b2e41151349077812c) = property(fget = \_\_GetName) Returns the name of the feature.   
  [Tag](class_speos_n_x_1_1_feature.xhtml#a305263dd89ad9fde1863aece00907351) = property(fget = \_\_GetTag) Returns the NX tag for this feature.   
 <a id="details" name="details"></a>## Detailed Description

Represents a Speos simulation feature.

A base class for all Speos simulation features.

This is an abstract class that provides the basic functionality common to all simulation features.  
 This is an abstract class, and cannot be instantiated.  
 To obtain an instance of this class, refer to the simulation builders.



## Member Function Documentation

<a id="a31a18dd95ce0573d79b59ca4057d8591" name="a31a18dd95ce0573d79b59ca4057d8591"></a>## [◆ ](#a31a18dd95ce0573d79b59ca4057d8591)Export()

 Export  (  *self*,     *path* )

Exports the simulation to a specified location.

**Prerequisite**: The simulation must be updated.

Parameters \[in\]path: The output folder. 



<a id="aeecae54d8c7f16c4bcedf21d93da3067" name="aeecae54d8c7f16c4bcedf21d93da3067"></a>## [◆ ](#aeecae54d8c7f16c4bcedf21d93da3067)Isolate()

 Isolate  (  *self*) 

Isolates the simulation and its results.

**Prerequisite**: The simulation must be updated.





<a id="a23529de1cab39154aa23c7133327ca82" name="a23529de1cab39154aa23c7133327ca82"></a>## [◆ ](#a23529de1cab39154aa23c7133327ca82)LinkedExport()

 LinkedExport  (  *self*) 

Exports the simulation to the Speos isolated folder.

Exports the simulation to the folder "./Speos isolated folder/"





<a id="ae189424d69f8854b544ae310082c1a48" name="ae189424d69f8854b544ae310082c1a48"></a>## [◆ ](#ae189424d69f8854b544ae310082c1a48)RegenerationSpeosHPC()

 RegenerationSpeosHPC  (  *self*) 

Runs the simulation on the Speos HPC cluster.

**Prerequisite**: The Speos HPC cluster must be configured.





## Property Documentation

<a id="a21f68ec2beda4bb03b75580244fbcaae" name="a21f68ec2beda4bb03b75580244fbcaae"></a>## [◆ ](#a21f68ec2beda4bb03b75580244fbcaae)GPUSimulationMode

 GPUSimulationMode = property(fset = \_\_SetGPUSimulationMode)  static 

Sets the simulation mode.

True: GPU simulation.  
 False: CPU simulation.

**Value type**: Boolean.

The default value is False.





---

The documentation for this class was generated from the following file:- **SpeosNX.py**