Versions Compared

Key

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

...

  • Generates a Fortran/CPP wrapper, which intermediates between Kepler actor and user code in terms of:
    • reading/writing of in/out physical data (IDS)
    • passing arguments of standard types to/from the actor
  • Creates a Kepler actor that:
    • calls a user code
    • provides error handling
    • calls debugger (if run in "debug" mode)
    • calls batch submission commands for MPI based actors


4.1.2 FC2K main window

Image RemovedImage Added

Fig. 1. FC2K main window


Warning

If you open an existing project, all relative paths defined within project will be relative to a directory within which FC2K was started


4.1.3 Actor description

 Image RemovedImage Added

Fig. 2. FC2K actor description

...


Warning

A name of user subroutine must be exactly the same as it was defined in user code


4.1.4 Environment

Image RemovedImage Added

Fig. 3. FC2K environment tab

...

Below you can find explanation of FC2K arguments tab.

Image Removed

Image Added

Fig. 4. "Arguments" tab
  • Type - Defines a type of an argument. It is possible to choose either IDS based type (e.g. equilibrium, topinfo, etc.) or primitive type (e.g. int, long, double, char)
  • Single slice - Determines if IDS is passed as single slice or an array. (This setting is valid for IDS types only )
    • if turned ON - Only one slice is passed. An actor will get an additional port to define a time.
    • if turned OFF - All IDSes for given shot run is passed.
  • Is array - Determines if a primitive type  is passed as a scalar or an array
    • if turned ON - An argument is passed as an array. It requires definition of array size (dynamic array are not supported) 
    • if turned OFF - An argument is passed as a scalar.
  • Array size - Defines the size of an array of primitive types (-1 in case of arrays of dynamic size)
  • Input - Defines argument as an input
  • Output - Defines argument as an output
  • Label - User defined name of an argument (and actor port)


Warning

Restrictions concerning type and order of arguments

Arguments specified in this tab must match a type and order of arguments of the routine/function.


Image RemovedImage Added

Fig. 5. An example of subroutine arguments

...

Code specific parameters are all parameters which are specific to the code (like switches, scaling parameters, and parameters for built-in analytical models) as well as parameters to explicitly overrule fields in the ITM data IMAS data structures.

Fig. 6. "Parameters" tab

...

4.1.7 "Source" tab explained

Image RemovedImage Added

Fig. 7. "Source" tab

...

"Main library" field allows to define a path to library containing user subroutine/function.

Image RemovedImage Added

Fig. 8. "Source" tab - A path to "main" and "optional" library

...

"Custom libraries" are non-standard static libraries required for building the user code.

Image RemovedImage Added

Fig. 9. "Source" tab - A list of "custom" libraries

...

"System libraries" are system libraries handled by pkg-config mechanism and required for building the user code.

Image RemovedImage Added

Fig. 10. "Source" tab - A list of "system" libraries

...

  • add library from the list,
  • remove library
  • display detailed info (library definition returned by pkg-config mechanism)

Image RemovedImage Added

Fig. 11. Adding "system" libraries


Tip
  • Tooltips show a detailed info about parameters that would be added to Makefile for selected library
  • "Search" field allows for easy filtering the list of libraries
  • Only ITM IMAS libraries (80+) are shown by default. To see a list of all libraries (250+) defined by pkg-config mechanism "List all system libraries" checkbox should be selected.
  • The libraries marked as built for compiler other than currently selected one are filtered out of the list. To turn off this filter unselect appropriate checkbox


...

A user, using this tab, selects programming language of codes provided, compiler used to built library and type of code execution (sequential or parallel)

Image RemovedImage Added

Fig. 12. "Settings" tab - code description

...

The "Interface" tab specifies interface for Kepler actor.

Image RemovedImage Added

Fig. 14. "Interface" tab

...