Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ParameterVariable nameDescription
Name
UCM_NAME

The name of the model is used in the code generation so it cannot contain any special symbols or space and must start with a letter.

It must correspond to the file name.

EX: ucm_<Name>.def

Description
UCM_DESCRIPTION
It allows to easily identify the model with a brief description.
Type
UCM_TYPE
It identifies what time f UCM it is, either Network Element or Commands Block.
Load flow
UCM_LOADFLOW_TYPE

Only active for a Network element, it specifies the type of load flow enabled.

It can be No Load flow (value by default), Admittance, or Generation.

Category
UCM_CATEGORY
This parameter is used to categories the model. EX: Breaker, transformer... the default value is User.
Execution Time
UCM_EXEC_TIME

This parameter specifies the average execution time in seconds estimated by the developer and used by the task mapper.

The default value is 5us.

The value can also be measured through an initial simulation run of a model containing only the UCM and necessary control inputs if it is expected that the execution time varies based on the input values (e.g. with if/then/else statements). A higher step size may temporarily be necessary to make sure overruns don't cause performance misreading. To get the measured value, open the HyperView Real-Time Tab, start the monitoring, reset the performance values once after a few seconds of simulation, then look at the Exec Max value after a few more seconds.

Version
UCM_VERSION
It allows the developer to specify what version of the UCM it is. 
Use Iteration
UCM_ITERATION
This parameter indicates if the UCM uses iteration or not.

...