## On this page

  

 

 # FeatureSimulation Class Reference

 Last update: 16.07.2025 

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

Inheritance diagram for FeatureSimulation:

 ![](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/class_speos_n_x__2412_1_1_feature_simulation.png)



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

 'None' [Isolate](#a4b07905b79c7ecd38ce5bea55fbb4e33) (self) Isolates the simulation and its results.   
  'None' [Export](#af3a00b7b292d5b559d4724d42ff486ad) (self, path) Exports the simulation to a specified location.   
  'None' [LinkedExport](#ae41856e50d4fccfcbd2570fef9ddea82) (self) Exports the simulation to the Speos isolated folder.   
  'None' [RegenerationSpeosHPC](#aa862db7061f4e2ccbec37501b239eac9) (self) Runs the simulation on the Speos HPC cluster.   
 ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Public Member Functions inherited from [Feature](class_speos_n_x__2412_1_1_feature.xhtml) 'None' **Update** (self) Updates the feature.   
  'None' **Delete** (self) Deletes the feature.   
 ## <a id="pub-static-attribs" name="pub-static-attribs"></a>Static Public Attributes

str [GPUSimulationMode](#a49b58dfb3f31e2d8cc7cff3cfdfd0248) = property(fset=\_\_SetGPUSimulationMode) Sets the simulation mode.   
 str [Results](#a04f67e0bf8dc676a1c09da5845e2a47b) = property(fget=\_\_GetResults) Gets the result collection.   
 ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Static Public Attributes inherited from [Feature](class_speos_n_x__2412_1_1_feature.xhtml)str [Name](class_speos_n_x__2412_1_1_feature.xhtml#a19218d0239b929ca8aecfa629d0185d0) = property(fget=\_\_GetName) Returns the name of the feature.   
 str [Tag](class_speos_n_x__2412_1_1_feature.xhtml#a5e0eaa80d2883166fba579916294593c) = property(fget=\_\_GetTag) Returns the NX tag for this feature.   
 ## <a id="properties" name="properties"></a>Properties

<a id="a50e9fbdd6a13e9e50cfba34656086bb6" name="a50e9fbdd6a13e9e50cfba34656086bb6"></a> **thisown** = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') ![-](/sites/default/files/migrate-content/speos_nx_library_2025_r2_1/closed.png) Properties inherited from [Feature](class_speos_n_x__2412_1_1_feature.xhtml) **thisown** = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag') <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="af3a00b7b292d5b559d4724d42ff486ad" name="af3a00b7b292d5b559d4724d42ff486ad"></a>## [◆ ](#af3a00b7b292d5b559d4724d42ff486ad)Export()

  'None' Export  (  *self*,     *path* )

Exports the simulation to a specified location.

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

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



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

  'None' Isolate  (  *self*) 

Isolates the simulation and its results.

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





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

  'None' LinkedExport  (  *self*) 

Exports the simulation to the Speos isolated folder.

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





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

  'None' RegenerationSpeosHPC  (  *self*) 

Runs the simulation on the Speos HPC cluster.

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





## Member Data Documentation

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

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

Sets the simulation mode.

True: GPU simulation.  
 False: CPU simulation.

**Value type**: Boolean.

The default value is False.





<a id="a04f67e0bf8dc676a1c09da5845e2a47b" name="a04f67e0bf8dc676a1c09da5845e2a47b"></a>## [◆ ](#a04f67e0bf8dc676a1c09da5845e2a47b)Results

 str Results = property(fget=\_\_GetResults)  static 

Gets the result collection.

Returns the <a class="el" href="">ResultCollection</a> belonging to this simulation.

ReturnsThe <a class="el" href="">ResultCollection</a>. 



---

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