YACSGEN is a python package (module_generator) that automatically fabricates a SALOME module starting from a synthetic description of the components that it will contain. This description is made in the python language.
YACSGEN includes since version 6.5 the HXX2SALOME functionalities, and is therefore able to also generate the implementation of C++ dataflow components.
The characteristics of these components are not general but they should facilitate integration of many scientific calculation components.
It is a module (named YACSGEN) in the SALOME CVS TOOLS base that is distributed with main SALOME modules.
YACSGEN needs a Python version >= 2.4 and < 3.0. It runs on a 32-bit and 64-bit architecture.
If you get the source archive, simply decompress and untar the archive (YACSGEN-x.y.tar.gz) and add the directory thus created to PYTHONPATH. YACSGEN is also provided with binaries installation of SALOME.
A SALOME module is described using Python instructions and definitions contained in the Python module_generator package.
The first action to be done is to import these definitions:
from module_generator import Generator,Module,PYComponent
from module_generator import CPPComponent,Service,F77Component
from module_generator import Library
If you want to import all definitions, you can do that:
from module_generator import *
A SALOME module is described by giving its name <modulename> together with the list of its components (<components list>) and the name of the directory in which it will be installed (<prefix>).
Its description is in the following form:
m=Module(<modulename>,components=<components list>,prefix=<prefix>)
The statement for a module named “mymodule” with a component c1 (see below for a description of components) that will be installed in the “Install” directory will be:
m=Module("mymodule",components=[c1],prefix="Install")
Several types of components can be created:
All these types have a similar description. We will begin with the C++ type and then describe the main differences for the other types.
Firstly, a C++ component has a name. This name will be used subsequently when it is required to create instances of this component. Once compiled and installed, the SALOME module will contain a dynamic library named lib<compo>Engine.so, in which <compo> is the component name. A C++ component is implemented as a remote executable C++ object.
A C++ component has one or several services. Each service has a name that is the name of the method of the C++ object that corresponds to the component. Each service may have input and output dataflow ports and input and output datastream ports.
The only possible types for dataflow ports for the moment are:
A port is described by a python tuple with length 2, the first value is the name of the port and the second value is the type name. Input ports are described by a list of these tuples as well as the output ports.
A small example is better than a long description. A component named “mycompo” with a service named “myservice” which has an input dataflow port named “inputport” of the double type and an output data flow port with name “outputport” of the double type will have the following description:
c1=CPPComponent("mycompo",
services=[
Service("myservice",
inport=[("inputport","double"),],
outport=[("outputport","double")],
),
]
)
c1 is an intermediate Python variable that will be used to describe the list of components of a module: (components=[c1]) for a module with a single component.
In fact, this component is not particularly useful because during execution, it will take a double at the input to the execution and will provide a double at the output from the execution, but it does nothing in the meantime. Therefore, a content has to be added to it. This content will be specified in two service attributes, defs and body.
The final description becomes:
c1=CPPComponent("mycompo",
services=[
Service("myservice",
inport=[("inputport","double"),],
outport=[("outputport","double")],
defs="#include <iostream>",
body="outputport=2*inputport;",
),
]
)
Datastream ports are added to the “myservice” service by adding instream and outstream attributes to the description. These attributes must be lists of triplets with the following elements:
Possible types are “CALCIUM_double”, “CALCIUM_integer”, “CALCIUM_long”, “CALCIUM_real”, “CALCIUM_string”, “CALCIUM_logical” and “CALCIUM_complex”.
The description for an input datastream port and an output port in time dependency becomes:
c1=CPPComponent("mycompo",
services=[
Service("myservice",
inport=[("inputport","double"),],
outport=[("outputport","double")],
instream=[("porta","CALCIUM_double","T")],
outstream=[("portb","CALCIUM_double","T")],
defs="#include <iostream>",
body="ouputport=2*inputport;",
),
]
)
Obviously, calls to the CALCIUM library have to be added into body to make the service genuinely functional.
If a second service has to be added for the component, simply add another service description:
c1=CPPComponent("mycompo",
services=[
Service("myservice",
inport=[("inputport","double"),],
outport=[("outputport","double")],
instream=[("porta","CALCIUM_double","T")],
outstream=[("portb","CALCIUM_double","T")],
defs="#include <iostream>",
body="ouputport=2*inputport;",
),
Service("serv2",
inport=[("a","double"),("b","long")],
outport=[("c","double")],
body="c=b*a",
),
]
)
In this description, a second service name “serv2” has been added with 2 input dataflow ports (a and b) and an output dataflow port (c). The service is reduced to its simplest expression: it returns the product of its 2 inputs.
We have seen that the defs and body attributes are sufficient to define the body of the service but it is often more practical to use external libraries rather than put everything into these 2 attributes. This is possible provided that everything necessary for the component link step is indicated in the libs and rlibs attributes of the component.
For example, we can have:
c1=CPPComponent("mycompo",
services=[
Service("myservice",
inport=[("inputport","double"),],
outport=[("outputport","double")],
defs="extern double myfunc(double);",
body="outputport=myfunc(inputport);",
),
],
libs=[Library(name="mybib", path="/usr/local/mysoft")],
rlibs="/usr/local/mysoft"
)
libs contains a list of Library objects. On linux, if the name of the file is “libmybib.so”, the name of the library will be “mybib”. The path shows where the library is installed.
The rlibs attribute is not compulsory but it can be used to indicate a search path for dynamic libraries in execution. libs is used during the link phase. rlibs is only used during execution, it avoids the need to set the LD_LIBRARY_PATH environment variable to find the dynamic library.
Includes will be added using the defs attribute. For example:
defs="""#include "myinclude.h" """
The include paths will be specified in the includes attribute of the component in the following form:
defs="""#include "myinclude.h"
extern double myfunc(double);
"""
c1=CPPComponent("mycompo",
services=[
Service("myservice",
inport=[("inputport","double"),],
outport=[("outputport","double")],
defs=defs,
body="outputport=myfunc(inputport);",
),
],
libs=[Library(name="mybib", path="/usr/local/mysoft")],
rlibs="/usr/local/mysoft",
includes="/usr/local/mysoft/include",
)
Multiple include paths should be separated by spaces or end of line character (\n).
It is possible to add some source files with the sources attribute (a list of source files will be given).
For example, instead of using an external library, we could implement the function myfunc in a file named myfunc.cpp. The description will be:
defs="""#include "myinclude.h"
extern double myfunc(double);
"""
c1=CPPComponent("mycompo",
services=[
Service("myservice",
inport=[("inputport","double"),],
outport=[("outputport","double")],
defs=defs,
body="outputport=myfunc(inputport);",
),
],
sources=["myfunc.cpp"],
includes="/usr/local/mysoft/include",
)
For computational codes which exchange arrays, MED meshes and fields, the implementation of the SALOME component is more complex. hxx2salome is a Salome generation tool for dataflow C++ components, which is available in SALOME since version 4.
Its principle is to start the integration of a code (written in Fortran/C/C++ or any C-compatible language) by writing a C++ layer (a class), which purpose is to drive the underlying code, and exchange data at C++ standard (c++ integral types, STL strings and vectors) and MED types for numerical meshes and fields.
Then the Salome CORBA layer (a SALOME C++ component) is generated automatically by the tool. The implementation of the component, which has to be provided in standard YACSGEN through the defs and body attributes, is generated here through analysing the interface of the c++ layer written above the code.
hxx2salome tool, although still available in Salome 6 as a standalone tool, was merged within YACSGEN. For the general principles of HXX2SALOME, and the detailed documentation, please refer to the HXX2SALOME chapter of this documentation (hxx2salome : a SALOME component generator). We will only present here the embedded use of HXX2SALOME within YACSGEN.
The tool can be used in two different ways:
- within a YACSGEN python script, by using the HXX2SALOMEComponent class combined with other YACSGEN CLASSES.
- with the hxx2salome.py script, a python executable which use YACSGEN classes to reproduce the interface of the former former hxx2salome bash script.
The merge of hxx2salome within YACSGEN was done by adding a new class, called HXX2SALOMEComponent, to the YACSGEN package. Given a C++ component (a C++ layer which wraps a computational code), HXX2SALOMEComponent class parses its interface (as defined in its .hxx header), extracts the public methods, analyses the types of these methods, and uses this type information to generate the implementation. All the information is then given to YACSGEN which generate a ready-to-use component.
As an example, let’s suppose we have a code called mycode, wrapped by a C++ layer (a dynamic library libmycodeCXX.so, and its interface “mycode.hxx”, both located in directory mycodecpp_root_dir). To generate the SALOME C++ component, one should add in his YACS script:
from module_generator HXX2SALOMEComponent
c1=HXX2SALOMEComponent("mycode.hxx",
"libmycodeCXX.so",
mycodecpp_root_dir ) )
The HXX2SALOMEComponent takes three arguments : the C++ header, the C++ library, and the path where to find them. The class does the parsing of c++ and generate all the necessary information for YACSGEN to generate the SALOME module.
Finally, if the code is parallel (mpi), one has to use instead the HXX2SALOMEParaComponent. This class work exactly in the same way, but generates also the mpi code necessary for a parallel SALOME component.
hxx2salome.py script is a python executable which use YACSGEN classes to reproduce the interface of the former hxx2salome bash script. The script takes optional arguments, followed by four mandatory arguments:
hxx2salome.py --help
usage:
hxx2salome.py [options] <CPPCOMPO>_root_dir lib<CPPCOMPO>.hxx <CPPCOMPO>.so installDir
generate a SALOME component that wrapps given the C++ component
Mandatory arguments:
- <CPPCOMPO>_root_dir : install directory (absolute path) of the c++ component
- <CPPCOMPO>.hxx : header of the c++ component"
- lib<CPPCOMPO>.so : the shared library containing the c++ component
- installDir : directory where the generated files and the build should be installed
Note that <CPPCOMPO>.hxx and lib<CPPCOMPO>.so should be found in <CPPCOMPO>_root_dir)
options:
-h, --help show this help message and exit
-e ENVIRON_FILE specify the name of a environment file (bash/sh) that will
be updated
-g to create a generic gui in your component building tree
-c to compile after generation
As an example, the command to generate the mycode component would be:
hxx2salome.py -c -g -e salome.sh
mycodecpp_root_dir mycode.hxx
libmycodeCXX.so <absolute path where to install generated component>
A Fortran component is described like a C++ component, except that there are a few differences. Firstly, the F77Component definition object is used instead of the CPPComponent. Then, a special additional interface is made in Fortran. It is assumed that Fortran functions are implemented in a library (dynamic or static) that will be linked with the component and that will have several entry points with the same names as the component services. The call to this entry point will be added automatically after the C++ code supplied by the user in the body attribute.
This makes it possible to decouple practically the entire implementation of the Fortran component that will be in the external library or sources, from the implementation of the SALOME component that will only be used for encapsulation.
The following example will be used to specify these final concepts:
c3=F77Component("compo3",
services=[
Service("s1",
inport=[("a","double"),("b","long"),
("c","string")],
outport=[("d","double"),("e","long"),
("f","string")],
instream=[("a","CALCIUM_double","T"),
("b","CALCIUM_double","I")],
outstream=[("ba","CALCIUM_double","T"),
("bb","CALCIUM_double","I")],
defs="#include <unistd.h>",
body="chdir(c);"
),
],
libs=[Library(name="fcompo", path="/usr/local/fcompo")],
rlibs="/usr/local/fcompo"
)
The Fortran “compo3” component has dataflow and datastream ports like the C++ component. The Fortran dynamic library that contains the Fortran entry point s1 will be linked by means of the libs and rlibs attributes of the description. The Fortran component also supports the includes and sources attributes.
The Fortran subroutine with name s1 must have a signature with a first argument that is used to transmit the address of the component and all following arguments that are used to transmit the values of the inport and outport ports. The instream and outstream ports are managed internally to the subroutine through calls to the CALCIUM API with the address of the component as first argument.
An example of subroutine for the above definition follows:
SUBROUTINE S1(compo,A,B,C,D,E,F)
C implementation of service s1 with inport a,b,c and outport d,e,f and stream ports
include 'calcium.hf'
integer compo
real*8 a,d
integer b,e
character*(*) c,f
CALL cpldb(COMPO,CP_TEMPS,t0,t1,iter,'aa',1,n,ss,info)
CALL cpldb(COMPO,CP_ITERATION,t0,t1,iter,'ab',1,n,zz,info)
CALL cplen(COMPO,CP_ITERATION,t0,t1,iter,'ac',1,n,zn,info)
CALL cplre(COMPO,CP_ITERATION,t0,t1,iter,'ad',1,n,yr,info)
CALL cplch(COMPO,CP_ITERATION,t0,t1,iter,'ae',1,n,tch,info)
CALL cplcp(COMPO,CP_ITERATION,t0,t1,iter,'af',1,n,tcp,info)
CALL cpllo(COMPO,CP_ITERATION,t0,t1,iter,'ag',3,n,tlo,info)
CALL cpeDB(COMPO,CP_TEMPS,t0,1,'ba',1,tt,info)
CALL cpeDB(COMPO,CP_ITERATION,t0,1,'bb',1,tp,info)
d=4.5
e=3
f="zzzzzzzzzzzzzzz"
END
As a special case, since version 5.1.4, the first argument (address of the component) is not included, if there is no instream and outstream ports.
Same example without stream ports:
SUBROUTINE S1(A,B,C,D,E,F)
C implementation of service s1 with inport a,b,c and outport d,e,f
real*8 a,d
integer b,e
character*(*) c,f
d=4.5
e=3
f="zzzzzzzzzzzzzzz"
END
A piece of C++ code can be added before the call to the Fortran entry point. This piece of code must be put into the body attribute with any definitions in defs. In this case, we use the “c” input dataflow variable to change the directory with the call to chdir.
A Python component is also described like a C++ component. The only differences are in the Python object to be used to define it: PYComponent instead of CPPComponent and in the content of the defs and body attributes that must contain Python code and not C++.
Warning
The indentation of the complete block of code is automatically handled but not the internal indentation of the block.
Example Python component:
pyc1=PYComponent("mycompo",
services=[
Service("myservice",
inport=[("inputport","double"),],
outport=[("outputport","double")],
defs="import sys",
body=" outputport=2*inputport;",
),
]
)
The equivalent of the assembly with external libraries is done in this case with the possibility of importing external Python modules. Simply add the python_path attribute to the description of the component to obtain this possibility. The value to be given is a list of directories that might contain modules to be imported.
Example:
pyc1=PYComponent("mycompo",
services=[
Service("myservice",
inport=[("inputport","double"),],
outport=[("outputport","double")],
),
],
python_path=["/usr/local/mysoft","/home/chris/monsoft"],
)
Code_Aster is a software package for finite element analysis and numeric simulation in structural mechanics developed by EDF.
An Aster component is a component that is a little bit special because the software functions are implemented in Fortran but they are activated by a command supervisor written in Python. Finally, this supervisor executes a Python script but the data transfer between Python and Fortran and the integration of the command supervisor into a SALOME component have to be managed.
The start point is that it is assumed that there is an Aster installation that provides an aster python module in the form of an importable dynamic library (astermodule.so) and not a specific Python interpreter linked with this module, as is the case in the existing installation.
An Aster component is described as a Python component to which several important attributes have to be added.
The following shows a small example description of an Aster component with a single service provided with 3 input dataflow ports, one output dataflow port, 7 input datastream ports and one output datastream port:
c1=ASTERComponent("caster",
services=[
Service("s1",
inport=[("a","double"),("b","long"),
("c","string")],
outport=[("d","double")],
instream=[("aa","CALCIUM_double","T"),
("ab","CALCIUM_double","I"),
("ac","CALCIUM_integer","I"),
("ad","CALCIUM_real","I"),
("ae","CALCIUM_string","I"),
("af","CALCIUM_complex","I"),
("ag","CALCIUM_logical","I"),
],
outstream=[("ba","CALCIUM_double","T"),
("bb","CALCIUM_double","I")],
),
],
aster_dir="/local/chris/ASTER/instals/NEW9",
python_path=["/local/chris/modulegen/YACSGEN/aster/bibpyt"],
argv=["-memjeveux","10",
"-rep_outils","/local/chris/ASTER/instals/outils"],
)
Warning
Do not use the name “aster” for the component because this name is reserved for the Code_Aster python module. If the name “aster” is used, the behaviour will be completely erratic.
Although its description is very similar to the behaviour of a Python component, there is an important difference in use. The Aster component needs the description of a command set to run. This command set is transferred to each service of the component in the form of a text in an input dataflow port named “jdc” with type “string”. Therefore after generation, this Aster component will have four input dataflow ports (“jdc”, “a”, “b”, “c”) and not three as indicated in the description. It is important not to forget to initialise the “jdc” port in the coupling file with a command set.
The command supervisor has been integrated into a SALOME component and the variables received in the dataflow ports are available during execution of the command set. Similarly, values for output dataflow ports are defined by values of variables derived from execution of the command set.
Warning
Beware with the execution mode. The command supervisor has 2 execution modes (PAR_LOT=”OUI” or PAR_LOT=”NON” that are specified in the DEBUT command) (PAR_LOT = BY_BATCH). In PAR_LOT=”OUI” mode, it is compulsory to terminate the command set with a FIN (END) command which has the effect of interrupting execution. This is not the preferred method of operation with YACS. It is preferable to use PAR_LOT=”NON” mode without adding the FIN command, which avoids interrupting the execution prematurely.
These two points are not handled by YACSGEN. They must be processed separately in a context similar to the context of an Aster developer.
It is assumed that there is an Aster installation, that it is required to create a dynamically importable Python Aster module, and that a few commands are to be added to Aster to exchange data through YACS datastream ports.
To remain simple, three commands: YACS_INIT, ECRIRE_MAILLAGE and LECTURE_FORCE are added, for which the catalogs are:
YACS_INIT=PROC(nom="YACS_INIT",op=181, fr="YACS initialisation",
COMPO=SIMP(statut='o',typ='I'),
)
ECRIRE_MAILLAGE=PROC(nom="ECRIRE_MAILLAGE",op=78, fr="write mesh")
LECTURE_FORCE=PROC(nom="LECTURE_FORCE",op=189, fr="read force")
The first YACS_INIT command initialises Aster in the YACS context. It has a single simple keyword COMPO (integer type) that will be used to transfer the SALOME component identifier to other commands. This identifier will be stored in a Fortran COMMON. It is essential for calls to subprograms CPLxx and CPExx that will be used in the other two ECRIRE_MAILLAGE and LECTURE_FORCE commands.
The other two commands do not have any keyword and they retrieve the identifier from the COMMON.
The operators will be written as follows (without the declarations):
SUBROUTINE OP0189 ( IER )
C COMMANDE: LECTURE_FORCE
include 'calcium.hf'
COMMON/YACS/ICOMPO
CALL cpldb(ICOMPO,CP_TEMPS,t0,t1,iter,'aa',1,n,ss,info)
CALL cpldb(ICOMPO,CP_ITERATION,t0,t1,iter,'ab',1,n,zz,info)
CALL cplen(ICOMPO,CP_ITERATION,t0,t1,iter,'ac',1,n,zn,info)
CALL cplre(ICOMPO,CP_ITERATION,t0,t1,iter,'ad',1,n,yr,info)
CALL cplch(ICOMPO,CP_ITERATION,t0,t1,iter,'ae',1,n,tch,info)
CALL cplcp(ICOMPO,CP_ITERATION,t0,t1,iter,'af',1,n,tcp,info)
CALL cpllo(ICOMPO,CP_ITERATION,t0,t1,iter,'ag',3,n,tlo,info)
END
SUBROUTINE OP0078 ( IER )
C COMMANDE: ECRIRE_MAILLAGE
include 'calcium.hf'
COMMON/YACS/ICOMPO
CALL cpeDB(ICOMPO,CP_TEMPS,t0,1,'ba',1,tt,info)
CALL cpeDB(ICOMPO,CP_ITERATION,t0,1,'bb',1,tp,info)
END
Finally, an astermodule.so dynamic library must be constructed, and all necessary Python modules must be placed in a directory that will be indicated in the python_path attribute. Different methods can be used to obtain this result. The following Makefile is one of them:
#compiler
FC=gfortran
#SALOME
KERNEL_ROOT_DIR=/local/chris/SALOME/RELEASES/Install/KERNEL_V5
KERNEL_INCLUDES=-I$(KERNEL_ROOT_DIR)/include/salome
KERNEL_LIBS= -L$(KERNEL_ROOT_DIR)/lib/salome -lCalciumC -lSalomeDSCSuperv \
-lSalomeDSCContainer -lSalomeDatastream -lSalomeDSCSupervBasic \
-Wl,--rpath -Wl,$(KERNEL_ROOT_DIR)/lib/salome
#ASTER
ASTER_ROOT=/local/chris/ASTER/instals
ASTER_INSTALL=$(ASTER_ROOT)/NEW9
ASTER_PUB=$(ASTER_ROOT)/public
ASTER_LIBS = -L$(ASTER_INSTALL)/lib -laster \
-L$(ASTER_PUB)/scotch_4.0/bin -lscotch -lscotcherr \
-lferm -llapack -lhdf5
SOURCES=src/op0078.f src/op0189.f
CATAPY=catalo/ecrire_maillage.capy catalo/lecture_force.capy
all:pyth cata astermodule
pyth:
cp -rf $(ASTER_INSTALL)/bibpyt .
cata: commande/cata.py
cp -rf commande/cata.py* bibpyt/Cata
commande/cata.py:$(CATAPY)
$(ASTER_ROOT)/ASTK/ASTK_SERV/bin/as_run make-cmd
astermodule:astermodule.so pyth
cp -rf astermodule.so bibpyt
astermodule.so: $(SOURCES)
$(FC) -shared -o $@ $(SOURCES) $(KERNEL_INCLUDES) $(ASTER_LIBS) $(KERNEL_LIBS)
The argv attribute gives initial values to arguments such as “memjeveux” but these values are used by the generator to build the component and therefore remain constant afterwards during execution.
If you want to modify these values during execution, you need to add an input port named “argv” with type “string”. The character string that will be given as the value of this port will be used by the component to modify the arguments of the command line (see Example execution of an Aster component for an example use).
The finite elements file is automatically copied into the working directory under the name elem.1. The component uses the aster_dir attribute to locate the origin file.
YACSGEN can function with Aster 9 and higher versions.
The SALOME module is created by a generator constructed from the description of the SALOME module (m) seen previously and a Python dictionary (context) that provides some environment parameters:
g=Generator(m,context)
The following parameters are mandatory for this context:
Example creation of generator:
context={'update':1,
"prerequisites":"/local/cchris/.packages.d/envSalome",
"kernel":"/local/chris/SALOME/RELEASES/Install/KERNEL_V5"
}
g=Generator(m,context)
Once this generator has been created, simply call its commands to perform the necessary operations.
SALOME module generation: g.generate()
build configuration: g.configure()
compilation: g.make()
installation in the directory <prefix>: g.install()
create a SALOME application in the directory appli_dir:
g.make_appli(appli_dir,restrict=<liste de modules>,
altmodules=<dictionnaire de modules>)
These commands do not use any parameters except for make_appli that uses 3 parameters:
The module will be fabricated by executing a Python file that contains its description, by inputting data into the generator and generator commands.
This gives something like the following for a module with a single Fortran component:
from module_generator import Generator,Module
from module_generator import PYComponent,CPPComponent,Service,F77Component
context={"update":1,
"prerequisites":"/local/cchris/.packages.d/envSalome",
"kernel":"/local/chris/SALOME/RELEASES/Install/KERNEL_V5"
}
c1=F77Component("compo",
services=[
Service("s1",
inport=[("a","double"),
("b","long"),
("c","string")],
outport=[("d","double"),("e","long"),
("f","string")],
instream=[("a","CALCIUM_double","T"),
("b","CALCIUM_double","I")],
outstream=[("ba","CALCIUM_double","T"),
("bb","CALCIUM_double","I")],
defs="#include <unistd.h>",
body="chdir(c);"
),
],
libs=[Library(name="fcompo", path="/local/chris/modulegen/YACSGEN/fcompo")],
rlibs="/local/chris/modulegen/YACSGEN/fcompo")
m=Module("mymodule",components=[c1],prefix="Install")
g=Generator(m,context)
g.generate()
g.configure()
g.make()
g.install()
g.make_appli("appli",restrict=["KERNEL","GUI","YACS"])
If this description is in the mymodule.py file, all that is required is to execute:
python mymodule.py
which has the effect of creating the module source directory (mymodule_SRC), the module installation directory (Install) and a SALOME application directory (appli).
Obviously, it must be possible to import the module_generator package either while being in the current directory or in the PYTHONPATH.
It is always preferable (although not essential) to clean up the working directory before executing the generator.
A YACS coupling file is an XML file that describes how SALOME components previously installed in a SALOME application are coupled and executed.
See Defining a calculation scheme in the XML format for documentation about how to write a YACS XML file.
The following is an example of a YACS file using the Fortran component defined above:
<proc>
<container name="A"> </container>
<container name="B"> </container>
<service name="pipo1" >
<component>compo</component>
<method>s1</method>
<load container="A"/>
<inport name="a" type="double"/>
<inport name="b" type="int"/>
<inport name="c" type="string"/>
<outport name="d" type="double"/>
<outport name="e" type="int"/>
<outport name="f" type="string"/>
<instream name="a" type="CALCIUM_double"/>
<instream name="b" type="CALCIUM_double"/>
<outstream name="ba" type="CALCIUM_double"/>
<outstream name="bb" type="CALCIUM_double"/>
</service>
<service name="pipo2" >
<component>compo</component>
<method>s1</method>
<load container="B"/>
<inport name="a" type="double"/>
<inport name="b" type="int"/>
<inport name="c" type="string"/>
<outport name="d" type="double"/>
<outport name="e" type="int"/>
<outport name="f" type="string"/>
<instream name="a" type="CALCIUM_double"/>
<instream name="b" type="CALCIUM_double"/>
<outstream name="ba" type="CALCIUM_double"/>
<outstream name="bb" type="CALCIUM_double"/>
</service>
<stream>
<fromnode>pipo1</fromnode><fromport>ba</fromport>
<tonode>pipo2</tonode><toport>a</toport>
</stream>
<stream>
<fromnode>pipo1</fromnode><fromport>bb</fromport>
<tonode>pipo2</tonode><toport>b</toport>
</stream>
<stream>
<fromnode>pipo2</fromnode><fromport>ba</fromport>
<tonode>pipo1</tonode><toport>a</toport>
</stream>
<stream>
<fromnode>pipo2</fromnode><fromport>bb</fromport>
<tonode>pipo1</tonode><toport>b</toport>
</stream>
<parameter>
<tonode>pipo1</tonode> <toport>a</toport>
<value><double>23</double> </value>
</parameter>
<parameter>
<tonode>pipo1</tonode> <toport>b</toport>
<value><int>23</int> </value>
</parameter>
<parameter>
<tonode>pipo1</tonode> <toport>c</toport>
<value><string>/local/cchris/SALOME/SUPERV/YACS/modulegen/data1</string> </value>
</parameter>
<parameter>
<tonode>pipo2</tonode> <toport>a</toport>
<value><double>23</double> </value>
</parameter>
<parameter>
<tonode>pipo2</tonode> <toport>b</toport>
<value><int>23</int> </value>
</parameter>
<parameter>
<tonode>pipo2</tonode> <toport>c</toport>
<value><string>/local/cchris/SALOME/SUPERV/YACS/modulegen/data2</string> </value>
</parameter>
</proc>
In general terms, coupling uses two instances of the component compo (pipo1 and pipo2) of which the service s1 is executed. The datastream ports of these services are connected using fromnode, fromport, tonode, toport information in the stream sections. The dataflow ports are initialised by the parameter sections. In particular, the working directory of each component instance is initialised through input port “c” of each component instance. Each component instance is executed in a different container (A and B). These names are virtual. SALOME will decide on the effective name of the containers at the time of the startup. The following simply describes constraints on containers to be used. In fact, there is only one constraint, which is that the containers have to be different.
Once the coupling file has been written using a classical editor or the YACS graphic editor, execution can be started.
It takes place in several steps:
There are many coupling outputs:
Warning
When the application is stopped, the containers are killed, and this can cause information losses in their output files.
Each component instance is hosted in a container. Therefore all instances hosted in a container are executed in the same directory, which is the container directory. Starting from version 4.1.1 of SALOME, the working directory of a container can be specified in the coupling file. All that is necessary is to add the workingdir property to the container. The following gives a few examples:
<container name="A">
<property name="workingdir" value="/home/user/w1"/>
</container>
<container name="B">
<property name="workingdir" value="$TEMPDIR"/>
</container>
<container name="C">
<property name="workingdir" value="a/b"/>
</container>
The container A is executed in directory “/home/user/w1”. This directory will be created if it does not exist. The container B will be executed in a new temporary directory. Container C will be executed in the relative directory “a/b” (starting from the directory of the application used for the execution). This directory will be created if it does not already exist.
Components are dynamic libraries or Python modules, and they cannot be run in shell scripts. For components that use input and output files, “files” ports can be specified in the coupling file through which file transfers will be made and appropriate local names will be given. For example, a service that uses an input file a and produces an output file b will be declared as follows:
<service name="pipo1">
<component>caster</component>
<method>s1</method>
<inport name="a" type="file"/>
<outport name="b" type="file"/>
</service>
These ports can be initialised or connected to other “files” ports like ordinary ports. For example, initialisation for the input file will be in the following form:
<parameter>
<tonode>pipo1</tonode> <toport>a</toport>
<value><objref>/local/chris/tmp/unfichier</objref> </value>
</parameter>
It is impossible to initialise an output file port directly. A special node has to be used that collects outputs. A “dataout” node and the link between node “pipo1” and node “dataout” will be created:
<outnode name="dataout" >
<parameter name="f1" type="file" ref="myfile"/>
</outnode>
<datalink>
<fromnode>pipo1</fromnode><fromport>b</fromport>
<tonode>dataout</tonode> <toport>f1</toport>
</datalink>
Warning
It is impossible to use the “.” character in port names. This prevents the use of names such as fort.8 that are fairly frequent. There is a simple workaround solution, which is to replace the “.” by the “:”character (therefore fort:8 in our example) to obtain the expected result. Obviously, names containing the “:” characters cannot be used. They must be very rare.
There are a few unusual features when executing an Aster component that are presented below:
The following is a simplified example of a YACS scheme comprising a calculation node that should execute service s1 of the caster component (type Aster) with an environment variable, a mail file, a comm file and command line parameters. A more complete example is given in the directory Examples/ast1 in the distribution:
<service name="pipo1" >
<component>caster</component>
<property name="MYENVAR" value="25"/>
<method>s1</method>
<load container="A"/>
<inport name="jdc" type="string"/>
<inport name="argv" type="string"/>
<inport name="a" type="double"/>
<inport name="fort:20" type="file"/>
<outport name="d" type="double"/>
<instream name="aa" type="CALCIUM_double"/>
<outstream name="ba" type="CALCIUM_double"/>
</service>
<inline name="ljdc" >
<script>
<code>f=open(comm)</code>
<code>jdc=f.read()</code>
<code>f.close()</code>
</script>
<inport name="comm" type="string"/>
<outport name="jdc" type="string"/>
</inline>
<parameter>
<tonode>ljdc</tonode> <toport>comm</toport>
<value><string>/home/chris/jdc.comm</string> </value>
</parameter>
<datalink>
<fromnode>ljdc</fromnode><fromport>jdc</fromport>
<tonode>pipo1</tonode> <toport>jdc</toport>
</datalink>
<parameter>
<tonode>pipo1</tonode> <toport>argv</toport>
<value><string>-rep_outils /aster/outils</string> </value>
</parameter>
<parameter>
<tonode>pipo1</tonode> <toport>fort:20</toport>
<value>
<objref>/local/chris/ASTER/instals/NEW9/astest/forma01a.mmed</objref>
</value>
</parameter>
Firstly, the command set has to be specified. As mentioned above (Aster component), an additional “jdc” “string” type port has to be declared and it has to be initialised or connected. In this case, the jdc port is connected to an output port from a python node (ljdc) that will read the .comm file, for which the path is given to it by its comm input port. The component identifier is transferred to the YACS_INIT command by means of the “component” variable that is automatically added by the generator and is available to write the .comm file.
Brief example of .comm:
DEBUT(PAR_LOT="NON")
YACS_INIT(COMPO=component)
ECRIRE_MAILLAGE()
LECTURE_FORCE()
Before values of command line parameters can be specified, a component must have been created with a “string” type port named “argv”. A value then has to be given to this port. In this case, we modify the tools directory path using the rep_outils parameter.
A mesh file (.mail) is specified to an Aster component by adding a file port to the calculation node:
<inport name="fort:20" type="file"/>
The name of this file port must be the same as the local file name as expected by Aster. Usually, Aster uses the fort.20 file as an input to LIRE_MAILLAGE. As mentioned above, the dot in fort.20 cannot be used in a port name, and therefore it will be given the name fort:20. A value will then have to be given to this port that will correspond to the path of the file to be used. This is done by a parameter directive:
<parameter>
<tonode>pipo1</tonode> <toport>fort:20</toport>
<value>
<objref>/local/chris/ASTER/instals/NEW9/astest/forma01a.mmed</objref>
</value>
</parameter>
Environment variables are specified by using properties of the calculation node. In this case, we define the MYENVAR environment variable with value 25.
Before SALOME version 4.1, the only method for integrating a component was to produce a dynamic library (*.so) or a python module (*.py). This component is loaded by a SALOME executable named Container, either by dlopen in the case of the library or by import in the case of the Python module. This method is a little constraining for calculation codes like Code_Aster or Code_Saturne that are executed in a particular environment, and preferably from a shell script.
Starting from version 4.1.3, a component can be integrated as an executable or shell script. This new function is experimental at the moment and it will have to be tested more completely. However, it can be used and module_generator was adapted (starting from version 0.3) to generate standalone components. The following describes operations to be carried out to change to standalone mode for each type of component (C/C++, Python, Fortran or Aster).
All that is necessary to transform a standard C/C++ component in the form of a dynamic library into a standalone component, is to add two attributes to its description:
The following is an example of a C++ component modified to make it a standalone component:
c1=CPPComponent("compo1",services=[
Service("myservice",inport=[("inputport","double"),],
outport=[("outputport","double")],
),
],
kind="exe",
exe_path="/local/SALOME/execpp/prog",
)
The path given for exe_path corresponds to an executable with the following source:
#include "compo1.hxx"
int main(int argc, char* argv[])
{
yacsinit();
return 0;
}
It must be compiled and linked using the compo1.hxx include and the libcompo1Exelib.so library that are given in the installation of the module generated in include/salome and in lib/salome respectively.
Note
the SALOME module must be generated before compiling and linking the standalone component.
A more complete example is given in the distribution sources in the Examples/cpp2 directory.
The executable can be replaced by an intermediary shell script, but it is good to know that the call to yacsinit retrieves information necessary to initialise the component in the three environment variables (SALOME_CONTAINERNAME, SALOME_INSTANCE, SALOME_CONTAINER).
The method for a Fortran component is exactly the same. The same two attributes are added:
The following is an example of a standalone Fortran component:
c3=F77Component("compo3",services=[
Service("s1",inport=[("a","double"),("b","long"),
("c","string")],
outport=[("d","double"),("e","long"),
("f","string")],
instream=[("a","CALCIUM_double","T"),
("b","CALCIUM_double","I")],
outstream=[("ba","CALCIUM_double","T"),
("bb","CALCIUM_double","I")],
),
],
kind="exe",
exe_path="/local/SALOME/fcompo/prog",
)
The path given for exe_path corresponds to an executable with the following source:
PROGRAM P
CALL YACSINIT()
END
It must be compiled and linked using the libcompo3Exelib.so library that is located in the installation of the module generated in lib/salome, and with the Fortran source containing subroutine S1. Refer to a more complete example in distribution sources in the Examples/fort2 directory.
A very rudimentary generator has been coded for a Python component. The only possible action is to add the kind attribute (with the value “exe”). The executable is automatically generated in the module installation. It cannot be replaced by a script, unless the installation is modified.
Slightly more work is necessary for an Aster component. Three attributes have to be specified:
The following is an example description of a standalone Aster component:
c1=ASTERComponent("caster",services=[
Service("s1",inport=[("argv","string"),("a","double"),
("b","long"),("c","string")],
outport=[("d","double")],
instream=[("aa","CALCIUM_double","T"),
("ab","CALCIUM_double","I"),
("ac","CALCIUM_integer","I"),
("ad","CALCIUM_real","I"),
("ae","CALCIUM_string","I"),
("af","CALCIUM_complex","I"),
("ag","CALCIUM_logical","I"),
],
outstream=[("ba","CALCIUM_double","T"),
("bb","CALCIUM_double","I")],
),
],
aster_dir="/aster/NEW9",
kind="exe",
exe_path="/home/SALOME5/exeaster",
)
The “effective” command file always has to be specified in the XML coupling file.
By collecting all the above elements, coupling of a standalone Aster component with a standalone Fortran component is written as follows:
from module_generator import Generator,Module
from module_generator import ASTERComponent,Service,F77Component
context={'update':1,"prerequisites":"/home/SALOME5/env.sh",
"kernel":"/home/SALOME5/Install/KERNEL_V5"}
install_prefix="./exe_install"
appli_dir="exe_appli"
c1=ASTERComponent("caster",services=[
Service("s1",inport=[("a","double"),("b","long"),
("c","string")],
outport=[("d","double")],
instream=[("aa","CALCIUM_double","T"),
("ab","CALCIUM_double","I"),
("ac","CALCIUM_integer","I"),
("ad","CALCIUM_real","I"),
("ae","CALCIUM_string","I"),
("af","CALCIUM_complex","I"),
("ag","CALCIUM_logical","I"),
],
outstream=[("ba","CALCIUM_double","T"),
("bb","CALCIUM_double","I")],
),
],
kind="exe",
aster_dir="/aster/NEW9",
exe_path="/home/SALOME5/exeaster",
)
c2=F77Component("cfort",services=[
Service("s1",inport=[("a","double"),("b","long"),
("c","string")],
outport=[("d","double"),("e","long"),
("f","string")],
instream=[("a","CALCIUM_double","T"),
("b","CALCIUM_double","I")],
outstream=[("ba","CALCIUM_double","T"),
("bb","CALCIUM_double","I"),
("bc","CALCIUM_integer","I"),
("bd","CALCIUM_real","I"),
("be","CALCIUM_string","I"),
("bf","CALCIUM_complex","I"),
("bg","CALCIUM_logical","I"),
],
defs="",body="",
),
],
exe_path="/home/SALOME5/fcompo/prog",
kind="exe")
g=Generator(Module("astmod",components=[c1,c2],prefix=install_prefix),context)
g.generate()
g.configure()
g.make()
g.install()
g.make_appli(appli_dir,restrict=["KERNEL","YACS"])
The corresponding xml coupling file and Aster command file may be viewed in the distribution (Examples/ast2 directory). The complementary implantation elements are located in the fcompo directory (cfort component) and in the myaster directory (caster component).
YACSGEN is mainly targeted to the integration of Python, C++ or Fortran calculation codes. Nevertheless, if you want to generate a complete module with GUI, documentation and persistence, there are some minimal options to do that.
It is possible to add a C++ or a Python GUI to the module with the gui parameter of the module. This parameter must be a list of file names. These files can be source files (*.cxx, *.hxx or *.h for C++, *.py for python), image files (*.png, ...) and qt designer files (*.ui). You can’t mix python and C++ source files. In C++, include files with .h extension are processed with the moc qt tool.
Here is an excerpt from pygui1 example that shows how to add a python GUI to a module:
modul=Module("pycompos",components=[c1],prefix="./install",
gui=["pycomposGUI.py","demo.ui","*.png"],
)
The GUI is implemented in the pycomposGUI.py (that must be named <module name>GUI.py) python module. It uses a qt designer file demo.ui that is dynamically loaded and several images in PNG files.
Here is an excerpt from cppgui1 example that shows how to add a C++ GUI to a module:
modul=Module("cppcompos",components=[c1],prefix="./install",
gui=["cppcomposGUI.cxx","cppcomposGUI.h","demo.ui","*.png"],
)
The C++ GUI is very similar to the python GUI except that the cppcomposGUI.h file is processed by the moc and the demo.ui is processed by the uic qt tool.
By default, a CMakeLists.txt and a SalomeApp.xml files are generated but you can put your own CMakeLists.txt or SalomeApp.xml in the list to override this default.
It is possible to add an online documentation that is made with the sphinx tool (http://sphinx.pocoo.org). You need a well installed sphinx tool (1.0.x or 0.6.x). To add a documentation use the doc parameter of the module. It must be a list of file names. These files can be text files (name with extension .rst) in the reStructured format (see http://docutils.sourceforge.net/) and image files (*.png, ...). The main file must be named index.rst.
By default, a sphinx configuration file conf.py and a CMakeLists.txt are generated but you can put your own CMakeLists.txt or conf.py in the list to override this default.
Here is an excerpt from pygui1 example that shows how to add a documentation to a module:
modul=Module("pycompos",components=[c1],prefix="./install",
doc=["*.rst","*.png"],
)
Warning
The online documentation will only appear in the SALOME GUI, if your module has a minimal GUI but not if it has no GUI.
If you have a C++ or Python class or some methods that you want to add to your components, it is possible to do that by using the compodefs and inheritedclass parameters of the component (module_generator.CPPComponent or module_generator.PYComponent).
The inheritedclass parameter gives the name of the class that will be included in the parent classes of the component and the compodefs parameter is a fragment of code that will be inserted in the definition section of the component. It can be used to add definitions such as include or even a complete class.
Here is an excerpt from pygui1 example that shows how to add a method named createObject to the component pycompos:
compodefs=r"""
class A:
def createObject( self, study, name ):
"Create object. "
builder = study.NewBuilder()
father = study.FindComponent( "pycompos" )
if father is None:
father = builder.NewComponent( "pycompos" )
attr = builder.FindOrCreateAttribute( father, "AttributeName" )
attr.SetValue( "pycompos" )
object = builder.NewObject( father )
attr = builder.FindOrCreateAttribute( object, "AttributeName" )
attr.SetValue( name )
"""
c1=PYComponent("pycompos",services=[
Service("s1",inport=[("a","double"),("b","double")],
outport=[("c","double"),("d","double")],
),
],
compodefs=compodefs,
inheritedclass="A",
)
Note
If you have special characters in your code fragments such as backslash, think about using python raw strings (r”...”)
For a C++ component, the method is exactly the same. There is only one case that can be handled in Python with this method and not in C++. It’s when you want to redefine one of the component methods (DumpPython, for example). In this case, adding a class in the inheritance tree does not override the default implementation. So, for this special case, there is another parameter (addmethods) that is a code fragment that will be included in the component class to effectively redefine the method.
Here is an excerpt from cppgui1 example that shows how to redefine the DumpPython method in a C++ component:
compomethods=r"""
Engines::TMPFile* DumpPython(CORBA::Object_ptr theStudy, CORBA::Boolean isPublished,
CORBA::Boolean& isValidScript)
{
SALOMEDS::Study_var aStudy = SALOMEDS::Study::_narrow(theStudy);
if(CORBA::is_nil(aStudy))
return new Engines::TMPFile(0);
SALOMEDS::SObject_var aSO = aStudy->FindComponent("cppcompos");
if(CORBA::is_nil(aSO))
return new Engines::TMPFile(0);
std::string Script = "import cppcompos_ORB\n";
Script += "import salome\n";
Script += "compo = salome.lcc.FindOrLoadComponent('FactoryServer','cppcompos')\n";
Script += "def RebuildData(theStudy):\n";
Script += " compo.SetCurrentStudy(theStudy)\n";
const char* aScript=Script.c_str();
char* aBuffer = new char[strlen(aScript)+1];
strcpy(aBuffer, aScript);
CORBA::Octet* anOctetBuf = (CORBA::Octet*)aBuffer;
int aBufferSize = strlen(aBuffer)+1;
Engines::TMPFile_var aStreamFile = new Engines::TMPFile(aBufferSize, aBufferSize, anOctetBuf, 1);
isValidScript = true;
return aStreamFile._retn();
}
"""
c1=CPPComponent("cppcompos",services=[ Service("s1",
inport=[("a","double"),("b","double")],
outport=[("c","double")],
),
],
addedmethods=compomethods,
)
If you want to add pure CORBA methods (not SALOME services) to your components or even complete IDL interface (SALOMEDS::Driver, for example), you can do that by using the idls, interfacedefs and inheritedinterface parameters of the component.
The idls parameter must be a list of CORBA idl file names. The inheritedinterface parameter gives the name of the CORBA interface that will be included in the parent interfaces of the component interface. The interfacedefs parameter is a fragment of code that will be inserted in the idl file of the module. It can be used to add definitions such as include or even a complete interface.
Here is an excerpt from pygui1 example that shows how to add the SALOMEDS::Driver interface (with its default implementation from SALOME KERNEL) and an extra method (createObject) to a python component:
idldefs="""
#include "myinterface.idl"
"""
compodefs=r"""
import SALOME_DriverPy
class A(SALOME_DriverPy.SALOME_DriverPy_i):
def __init__(self):
SALOME_DriverPy.SALOME_DriverPy_i.__init__(self,"pycompos")
return
def createObject( self, study, name ):
"Create object. "
builder = study.NewBuilder()
father = study.FindComponent( "pycompos" )
if father is None:
father = builder.NewComponent( "pycompos" )
attr = builder.FindOrCreateAttribute( father, "AttributeName" )
attr.SetValue( "pycompos" )
object = builder.NewObject( father )
attr = builder.FindOrCreateAttribute( object, "AttributeName" )
attr.SetValue( name )
"""
c1=PYComponent("pycompos",services=[ Service("s1",
inport=[("a","double"),("b","double")],
outport=[("c","double"),("d","double")],
),
],
idls=["*.idl"],
interfacedefs=idldefs,
inheritedinterface="Idl_A",
compodefs=compodefs,
inheritedclass="A",
)
The idl file names can contain shell-style wildcards that are accepted by the python glob module. Here, there is only one file (myinterface.idl) that contains the definition of interface Idl_A:
#include "SALOMEDS.idl"
#include "SALOME_Exception.idl"
interface Idl_A : SALOMEDS::Driver
{
void createObject(in SALOMEDS::Study theStudy, in string name) raises (SALOME::SALOME_Exception);
};
In this simple case, it is also possible to include directly the content of the file with the interfacedefs parameter.
For a C++ component, the method is exactly the same, except that there is no default implementation of the Driver interface so you have to implement it.
If you define a port, you need to give a type name. YACSGEN knows about a limited set of types (see Supported SALOME types). If you want to add more types either because they have been forgotten or you want to use one from a new module, it is possible to add them with the function module_generator.add_type(). This function can also overload an existing type.
For example, to overload the definition of type GEOM_Object in GEOM module:
from module_generator import add_type
add_type("GEOM_Object", "GEOM::GEOM_Object_ptr", "GEOM::GEOM_Object_out", "GEOM", "GEOM::GEOM_Object","GEOM::GEOM_Object_ptr")
Now if you want to add a new type from a new module (unknown to YACSGEN), you need to add a module definition to YACSGEN. You can add it with the function module_generator.add_module(). This function can also overload the definition of an existing module.
For example, to overload the definition of module GEOM:
from module_generator import add_module
idldefs="""
#include "GEOM_Gen.idl"
"""
makefiledefs="""
#module GEOM
GEOM_IDL_INCLUDES = -I$(GEOM_ROOT_DIR)/idl/salome
GEOM_INCLUDES= -I$(GEOM_ROOT_DIR)/include/salome
GEOM_IDL_LIBS= -L$(GEOM_ROOT_DIR)/lib/salome -lSalomeIDLGEOM
GEOM_LIBS= -L$(GEOM_ROOT_DIR)/lib/salome
SALOME_LIBS += ${GEOM_LIBS}
SALOME_IDL_LIBS += ${GEOM_IDL_LIBS}
SALOME_INCLUDES += ${GEOM_INCLUDES}
IDL_INCLUDES += ${GEOM_IDL_INCLUDES}
"""
configdefs="""
if test "x${GEOM_ROOT_DIR}" != "x" && test -d ${GEOM_ROOT_DIR} ; then
AC_MSG_RESULT(Using GEOM installation in ${GEOM_ROOT_DIR})
else
AC_MSG_ERROR([Cannot find module GEOM. Have you set GEOM_ROOT_DIR ?],1)
fi
"""
add_module("GEOM",idldefs,makefiledefs,configdefs)
The module provides the following classes:
| SALOME module | YACS type name | IDL type name | Implementation | Comment |
|---|---|---|---|---|
| GEOM | GEOM_Object | GEOM::GEOM_Object | C++, Python | |
| SMESH | SMESH_Mesh | SMESH::SMESH_Mesh | C++, Python | |
| SMESH | SMESH_Hypothesis | SMESH::SMESH_Hypothesis | C++, Python | |
| MED | SALOME_MED/MED | SALOME_MED::MED | C++, Python | |
| MED | SALOME_MED/MESH | SALOME_MED::MESH | C++, Python | |
| MED | SALOME_MED/SUPPORT | SALOME_MED::SUPPORT | C++, Python | |
| MED | SALOME_MED/FIELD | SALOME_MED::FIELD | C++, Python | |
| MED | SALOME_MED/FIELDDOUBLE | SALOME_MED::FIELDDOUBLE | C++, Python | |
| MED | SALOME_MED/FIELDINT | SALOME_MED::FIELDINT | C++, Python | |
| KERNEL | double | double | C++, Python, F77 | |
| KERNEL | long | long | C++, Python, F77 | |
| KERNEL | string | string | C++, Python, F77 | |
| KERNEL | dblevec | dblevec | C++, Python, F77 | list of double |
| KERNEL | stringvec | stringvec | C++, Python, F77 | list of string |
| KERNEL | intvec | intvec | C++, Python, F77 | list of long |
| KERNEL | pyobj | Python | a pickled python object | |
| KERNEL | file | C++, Python, F77 | to transfer a file | |
| KERNEL | SALOME_TYPES/Parameter | SALOME_TYPES::Parameter | C++, Python | |
| KERNEL | SALOME_TYPES/ParameterList | SALOME_TYPES::ParameterList | C++, Python | |
| KERNEL | SALOME_TYPES/Variable | SALOME_TYPES::Variable | C++, Python | |
| KERNEL | SALOME_TYPES/VariableSequence | SALOME_TYPES::VariableSequence | C++, Python | |
| KERNEL | SALOME_TYPES/StateSequence | SALOME_TYPES::StateSequence | C++, Python | |
| KERNEL | SALOME_TYPES/TimeSequence | SALOME_TYPES::TimeSequence | C++, Python | |
| KERNEL | SALOME_TYPES/VarList | SALOME_TYPES::VarList | C++, Python | |
| KERNEL | SALOME_TYPES/ParametricInput | SALOME_TYPES::ParametricInput | C++, Python | |
| KERNEL | SALOME_TYPES/ParametricOutput | SALOME_TYPES::ParametricOutput | C++, Python |