Documentation Home Page eHS Toolbox Home Page
Pour la documentation en FRANÇAIS, utilisez l'outil de traduction de votre navigateur Chrome, Edge ou Safari. Voir un exemple.

Licensing over eHS

eHS solver is licensed by

  • number of components you are allowed to use in the model

    • Consider eHS will always count visible elements and not all hidden generated elements.

  • performances of the solver

    • High performance will give you the full eHS experience with reduced minimum time step and our best technology to achieve the time step you desire. (such as decoupling inside the circuit)

  • specific features may be covered by a dedicated license

eHS specific licence keys

Key

Required Value

Description

Status

Key

Required Value

Description

Status

XSG_EHS

true

This will enable eHS solver.

Mandatory

EHS_TOTAL_PERFORMANCE

>0

Deprecated. See EHS_CORE_TOKEN

This indicates the total number of cores allowed.

This parameter decides the total number of eHSx32 solvers available. One eHSx32 solver will occupy a total of 1 EHS_TOTAL_PERFORMANCE token during the license verification. As an example, 4 tokens of "EHS_TOTAL_PERFORMANCE" license key allows to use either one of the following configurations: 1x eHSx128 core, 2x eHSx64 cores, 4x eHSx32 cores or any other combination that would fit within the number of tokens available.

Mandatory

EHS_CORE_TOKEN

>0

This replaces EHS_TOTAL_PERFORMANCE

This indicates the license class allowed.

It will define the maximum circuit size.

 

EHS_HIGH_PERFORMANCE_TOKEN

positive integer

Enables the highest performances of eHS (only supported in eHS Gen5)

This parameter decides the total number of cores allowed to get the highest performances. One eHSx32 solver will occupy a total of 32 EHS_HIGH_PERFORMANCE_TOKEN during the license verification. As an example, 128 EHS_HIGH_PERFORMANCE_TOKEN license key allows to use either one of the following configurations: 1x eHSx128 core, 2x eHSx64 cores, 4x eHSx32 cores or any other combination that would fit within the number of tokens available.

Optional

EHS_MACHINE_CORE_TOKEN

>0

This indicates the total number of machines allowed per model.

Mandatory

EHS_PADE5

true

This will enable specific PADE5 discretization method for Generation 5 of the eHS Solver.

Optional

EHS_X16

>0

 

Informs the user of the eHS license class as well as the number of eHS cores that were purchased.

Informative

EHS_X32

>0

Informative

EHS_X64

>0

Informative

EHS_X128

>0

Informative

FPGA related license keys

Key

Required Value

Description

Status

Key

Required Value

Description

Status

RTLAB_RT

true

Allows to execute a model in real-time mode with RT-LAB.

Mandatory

RTLAB_XHP

true

Enables the XHP mode within RT-LAB.

Mandatory

RTLAB_DEV

true

Allows to compile a model.

Mandatory

RTLAB_NUM_CORES

>0

Allows to execute a model in non real-time mode with RT-LAB.

Mandatory

XSG_EHS

true

Enables ultra-fast electric solver (eHS) on FPGA

Mandatory

XSG_PMSM_VDQ

true

Enables variable-DQ (VDQ) PMSM motor models on FPGA

Optional

XSG_PMSM_SH

true

Enables spatial harmonic  (SH) PMSM motor models on FPGA

Optional

XSG_IM

true

Enables Induction machine (Double Fed - DFIM and Squirrel Cage - SCIM)

Optional

XSG_SRM

true

Enables switched reluctance motor (SRM) models on FPGA

Optional

XSG_FDLINE

true

Enables FD Line on FPGA

 

RT-LAB related license keys

Key

Required Value

Description

Status

Key

Required Value

Description

Status

RTLAB_RT

true

Allows to execute a model in real-time mode with RT-LAB.

Mandatory

RTLAB_XHP

true

Enables the XHP mode within RT-LAB.

Mandatory

RTLAB_DEV

true

Allows to compile a model.

Mandatory

RTLAB_NUM_CORES

>0

Allows to execute a model in non real-time mode with RT-LAB.

Mandatory

 

OPAL-RT TECHNOLOGIES, Inc. | 1751, rue Richardson, bureau 1060 | Montréal, Québec Canada H3K 1G6 | opal-rt.com | +1 514-935-2323
Follow OPAL-RT: LinkedIn | Facebook | YouTube | X/Twitter