Model Reference

This is the catalogue of models RAMSES can load. Each family has its own page with equations, parameters in declaration order, and worked examples. For the record syntax that references these models, see Dynamic Data Records.

How a Model Name Resolves

RAMSES adds the family prefix (exc_, tor_, inj_, twop_) automatically, so AC1A and exc_AC1A are the same model. Names are case sensitive.

A model can be in one of three states, and the tables below say which:

State	Meaning
Built in	Handled directly by the family dispatcher, no prefix
Registered	Compiled and mapped to a name, callable from a data file
Not registered	Compiled but reachable only after adding a case through URAMSES

Compiled is not the same as reachable

Several models ship inside the library under no name at all. They cannot be loaded by writing their name in a data file, however correct the spelling. The Hydro-Québec families (models/*/hq/) are excluded from the build entirely and cannot be enabled through URAMSES either.

Exciters

IEEE Exciters and Custom Exciters

Data-file name	State	Documented on
CONSTANT, 1ST_ORDER	Built in	Custom Exciters
GENERIC1, GENERIC2	Built in	Custom Exciters
GENERIC	Registered, since 3.57	Custom Exciters
kundur	Registered	Custom Exciters
AC1A, AC4A, IEEET5	Registered	IEEE Exciters
ST1A, ST1A_IEEEST, ST1A_PSS2B, ST1A_PSS4B	Registered	IEEE Exciters
SEXS, SEXS_IEEEST	Registered	IEEE Exciters
EXPIC1_PSS2B	Registered	IEEE Exciters
ENTSOE_simp	Registered	IEEE Exciters
AC1A_MAXEX2, AC1A_RETRO*, AC8B, DC3A, EXPIC1, SEXS_STAB3_lim, ST1A_lim	Not registered	IEEE Exciters

Governors

IEEE Governors and Custom Governors

Data-file name	State	Documented on
CONSTANT, 1ST_ORDER	Built in	Custom Governors
HYDRO_GENERIC1, THERMAL_GENERIC1	Built in	Custom Governors
DEGOV1, ENTSOE_simp	Registered, since 3.40	IEEE Governors
GAST, TGOV1, HYGOV	Registered, since 3.50	IEEE Governors
tor_gasturbm, tor_govclasm, tor_govhydr, tor_govnuc	Not registered	Custom Governors

Injectors

Injector Models

Data-file name	State
LOAD, RESTLD	Built in
INDMACH1, INDMACH2	Built in
SVC_GENERIC1	Built in
THEVEQ	Built in
PQ, IBG	Registered
WT3, WT4	Registered
BESS, GFOL, GFOR	Registered
vfd_load, PMU	Registered
VFAULT	Registered, added automatically by RAMSES
inj_INDM1, inj_PVG	Not registered
inj_norton	Excluded from the build

Two-Port Models

Two-Port Models

Data-file name	State
HVDC_LCC	Registered
HVDC_VSC_SC	Registered
DCL_WCL	Registered
twop_HVDC_VSC	Not registered

Discrete Controllers

Discrete Controller Models

Discrete controllers take no prefix in the data file, though the dispatcher prepends dctl_ internally.

Data-file name	State
LTC, LTC2, LTCINV, OLTC2	Built in
PST	Built in
UVLS, UVPROT, FRT	Built in
MAIS	Built in
RT	Built in
SIM_MINMAXVOLT, SIM_MINMAXSPEED	Built in
VOLT_VAR	Built in
line_prot	Registered as dctl_line_prot

The Synchronous Machine

The machine itself is not selected by name; every SYNC_MACH record uses the same model, parameterised by the record’s own fields.

• Synchronous Machine Model, equations and parameters
• Parameter Conversion, converting between the XT and RL forms

Next Steps

• Dynamic Data Records, the record syntax that references these models
• User-Defined Models, write and register a model of your own