Represents a Speos simulation feature. More...

Inheritance diagram for FeatureSimulation:

Public Member Functions
'None'	Isolate (self)
	Isolates the simulation and its results.

'None'	Export (self, path)
	Exports the simulation to a specified location.

'None'	LinkedExport (self)
	Exports the simulation to the Speos isolated folder.

'None'	RegenerationSpeosHPC (self)
	Runs the simulation on the Speos HPC cluster.

Public Member Functions inherited from Feature
'None'	Update (self)
	Updates the feature.

'None'	Delete (self)
	Deletes the feature.

Static Public Attributes
str	GPUSimulationMode = property(fset=__SetGPUSimulationMode)
	Sets the simulation mode.

str	Results = property(fget=__GetResults)
	Gets the result collection.

Static Public Attributes inherited from Feature
str	Name = property(fget=__GetName)
	Returns the name of the feature.

str	Tag = property(fget=__GetTag)
	Returns the NX tag for this feature.

Properties
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')

Properties inherited from Feature
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')

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

◆ Export()

'None' Export	(		self,
			path )

Exports the simulation to a specified location.

Prerequisite: The simulation must be updated.

Parameters

[in] path : The output folder.

◆ Isolate()

'None' Isolate ( self )

Isolates the simulation and its results.

Prerequisite: The simulation must be updated.

◆ LinkedExport()

'None' LinkedExport ( self )

Exports the simulation to the Speos isolated folder.

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

◆ RegenerationSpeosHPC()

'None' RegenerationSpeosHPC ( self )

Runs the simulation on the Speos HPC cluster.

Prerequisite: The Speos HPC cluster must be configured.

Member Data Documentation

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

◆ Results

str Results = property(fget=__GetResults)

static

Gets the result collection.

Returns the ResultCollection belonging to this simulation.

Returns: The ResultCollection.

The documentation for this class was generated from the following file:

SpeosNX_2412.py

Speos NX library 2025 R2

FeatureSimulation Class Reference

Public Member Functions

Static Public Attributes

Properties