Table of Contents |
---|
...
1. What code wrapper actually does?
The code wrapper intermediates between Kepler actor and user code:
- Passes variables of language built-in types (int, char, etc) from actor to the code
- Reads IDS(ses) from UAL and passes data to user code
- Passes input code parameters (XML/XSD files) to user code
- Calls user subroutine/function
- Saves output IDS(ses)
2. Development of Fortran codes
2.1 Subroutine syntax
subroutine name ( <in/out arguments list> [,code_parameters] [,diagnostic_info] )
- name - subroutine name
- in/out arguments list - a list of input and output subroutine arguments
- diagnostic_info - arbitrary output diagnostic information
2.2. Arguments list
- A mandatory position
- A list of input and output subroutine arguments including:
- Fortran intrisic data types, eg:
integer :: input
character(50) :: charstring
integer,dimension(4) :: tabint
- IDSes, eg:
type (typeids_equilibrium) ,pointer :: equilibriumin (:)<== SINGE SLICE
type (typeids_core_distsourceprofiles) ,pointer :: distsourceout(:)
coreprofoutout <== ALL SLICES
- Fortran intrisic data types, eg:
Warning |
---|
|
Warning |
Always describe IDS as an array. In case of time slice, the size of the input IDS is 1 (!)
|
2.3. Code parameters
- user defined input parameters
- input / optional
Argument of type: type_param
Code Block type typeids_parameters_paraminput ! character(len=132), dimension(:), pointer :: parameters_value character(len=132), dimension(:), pointer :: parameters_default_param character(len=132), dimension(:), pointer :: schema endtype
- Derived type type_param describes:
parameters_value
- Actual value of the code parameters (instance of coparam/parameters in XML format).parameters_default_param
- Default value of the code parameters (instance of coparam/parameters in XML format).schema
- Code parameters schema.
- An example:
type(type_param) :: codeparam
{{
2.4. Diagnostic info
- arbitrary output diagnostic information
output / optional
Code Block !---- Diagnostic info ---- integer, intent(out) :: user_out_outputFlag character(len=:), pointer, intent(out) :: user_out_diagnosticInfo
outputFlag
- indicates if user subroutine was successfully executedoutpuflag = 0
- SUCCESS, no action is takenoutputFlag > 0
- WARNING, a warning message is displayed, workflow continuue executionoutputFlag < 0
- ERROR, actor throws an exception, workflow stops
diagnosticInfo
- an arbitrary string
2.5. Examples
Code Block | ||
---|---|---|
| ||
subroutine noids(input, output) integer, intent(in):: input integer, intent(out):: output |
Code Block | ||
---|---|---|
| ||
subroutine equil2dist(equilibriuminequilibrium_in, distsourceoutcore_prof_out) use euITMimas_schemas implicit none !input type (typeids_equilibrium), pointer :: equilibriumin(:)equilibrium_in !output type (typeids_core_distsourceprofiles), pointer :: distsourceout(:)core_prof_out |
Code Block | ||
---|---|---|
| ||
subroutine teststring(coreprof,equi,tabint,tabchar,codeparam) use euITMimas_schemas implicit none !input type(typeids_core_coreprof),pointer,dimension(:)profiles) :: coreprof integer, dimension(4), intent(in) :: tabint !output type(typeids_equilibrium),pointer,dimension(:) :: equi character(50), intent(out) :: tabchar !code parameters type(type_param), intent(in) :: codeparam |
3 Development of C++ codes
3.1 Function syntax
void name ( <in/out arguments list> [,code_parameters] [,diagnostic_info] )
- name - function name
- code_parameters - optional - user defined input parameters
- diagnostic_info - arbitrary output diagnostic information
3.2 Arguments list
- in/out arguments list
- mandatory
- a list of input and output function arguments including:
- CPP intrisic data types, eg:
- int &x
- double &y
- IDSes, eg:
- ItmNsIdsNs::ItmIDS::antennas & antItmNs::Itm::equilibriumArray & eqequilibrium & eq <= SINGLE SLICE
- IdsNs::IDS::core_profiles & cp <= ALL SLICE'S
- CPP intrisic data types, eg:
3.3 Code parameters
- Optional
- User defined input parameters
Argument of type: ItmNsIdsNs::codeparam_t &
Code Block language cpp typedef struct { char **parameters; char **default_param; char **schema; } codeparam_t;
- A structure codeparam_t describes:
- parameters - Actual value of the code parameters (instance of coparam/parameters in XML format).
- default_param - Default value of the code parameters (instance of coparam/parameters in XML format).
- schema - Code parameters schema.
- An example: ItmNsIdsNs::codeparam_t & codeparam
3.4 Diagnostic info
- arbitrary output diagnostic information
output / optional
Code Block language cpp void name(...., int* output_flag, char** diagnostic_info)
output_flag
- indicates if user subroutine was successfully executedoutput_flag = 0
- SUCCESS, no action is taken
- WARNING, a warning message is displayed, workflow continuue executionoutput_flag
> 0
- ERROR, actor throws an exception, workflow stopsoutput_flag
< 0
diagnostic_info
- an arbitrary string
Warning |
---|
Required header Do not forget to add #include "UALClasses.h" while playing with IDSes! |
3.5 Examples
Code Block | ||||
---|---|---|---|---|
| ||||
void simplecppactornoids(double &x, double &y) |
Code Block | ||||
---|---|---|---|---|
| ||||
void simplecppactor(ItmNsIdsNs::ItmIDS::equilibriumArrayequilibrium &eq, double &x, double &y) |
Code Block | ||||
---|---|---|---|---|
| ||||
void mycppfunctionbis_init(); void mycppfunction(ItmNsIdsNs::ItmIDS::summarycore_profiles& sumcp, ItmNs::Itm::equilibriumArray& eq, int& x, ItmNs::Itm::coreimpur& cor, double& y, ItmNsIdsNs::codeparam_t& codeparam) |
Info |
---|
Initialization If user function needs any pre-initialization, an additional function <name>_init could be defined. |
4. Delivery of the user code
The user code should be delivered as a static library.
Please find examples of the simple "makefiles" below:
Code Block | ||||
---|---|---|---|---|
| ||||
F90 = $(ITM_INTEL_FC)ifort COPTS = -g -O0 -assume no2underscore -fPIC -shared-intel INCLUDES = $(shell eval-pkg-config --cflags ual-$(ITM_INTEL_OBJECTCODE)imas-ifort) all: equilibrium2distsource.o libequilibrium2distsource libequilibrium2distsource: equilibrium2distsource.o ar -rvs libequilibrium2distsource.a equilibrium2distsource.o equilibrium2distsource.o: equilibrium2distsource.f90 $(F90) $(COPTS) -c -o $@ $^ ${INCLUDES} clean: rm -f *.o *.a |
Code Block | ||
---|---|---|
| ||
CXX=g++ CXXFLAGS= -g -fPIC CXXINCLUDES= ${shell eval-pkg-config --cflags ualimas-cpp-gnu} all: libsimplecppactor.a libsimplecppactor.a: simplecppactor.o ar -rvs $@ $^ simplecppactor.o: simplecppactor.cpp $(CXX) $(CXXFLAGS) $(CXXINCLUDES) -c -o $@ $^ clean: rm *.a *.o |
Tip |
---|
Recomendations
|
...