Difference between revisions of "ONELAB scripting syntax"

Revision as of 16:13, 3 February 2012

Principe général

L'utilisation de ONELAB n'est cependant pas limitée aux codes encapsulés. N'importe quel autre programme de calcul scientifique peut également utiliser ONELAB, mais cette fois-ci au travers d'une interface. On appelle ces clients des clients interfacés.

La syntaxe d'interfaçage se base sur le principe du préprocesseur. Le préprocesseur ONELAB effectue des inclusions/exclusions conditionnelles de lignes de code et des substitutions de valeurs pour délivrer en sortie un fichier d'entrée valide pour le client. Etant donné que l'interface ONELAB est générique, càd qu'elle est identique pour tous les clients interfacés, toutes ces opérations sont réalisées sans jamais interpréter le code du client qui est considéré comme une suite de caractères sans signification.

Pour donner un exemple très simple, supposons qu'un client XYZ utilise un fichier d'entrée de type model.xyz contenant:

 ...
 B =  C + 2*0.005 + D
 ...
 

et que la valeur 0.005 soit celle d'un paramètre L=0.005 l'on veut mettre en commun avec un autre client via le serveur ONELAB. L'interfaçage ONELAB se fera en définissant un fichier model.xyz.ol contenant

OL.parameter L.number(0.005,Parameters/1Geometry,Length); 
...
B =  C + 2*OL.getValue(L) + D
...

La commande OL.parameter définit le paramètre Parameters/1Geometry/L sur le serveur ONELAB et lui attribue la valeur par défaut 0.005 et le label "Length". Lors de la conversion, ONELAB repère les commandes ONELAB dans le fichier model.xyz.ol grâce au tag OL., les traite et génère en sortie un fichier model.xyz syntaxiquement correct pour le client XYZ, à savoir dans ce cas

...
B =  C + 2*0.004 + D
...

si la valeur du paramètre L sur le serveur ONELAB au moment de la génération est 0.004, et non la valeur par défaut.

Il faut également enregistrer le solveur XYZ comme client auprès du server ONELAB. Cela se fait par la création d'un fichier model.ol contenant

OL.client XYZ.register(interfaced);
OL.client XYZ.InputFiles.Set(model.sif.ol);

Syntaxe détaillée

• Définition des clients

OL.client client_def; <client_def; ...>

où client_def est une des commandes suivantes:

name.register(interfaced|encapsulated);

enregistre un client de type interfacé ou encapsulé" (obligatoire)

name.Path(path);

définit le path système de l'exécutable (interactif)

name/InputFiles.Set(file,...);

définit la liste des fichiers d'entrée (obligatoire)

name/OutputFiles.Set(file,...)

définit la liste des fichiers de sortie (facultatif)

name.PreLineOptions(options)

définit des options en ligne de commande à placer avant la liste des fichiers d'entrée

name.LineOptions('options)

définit des options en ligne de commande à placer après la liste des fichiers d'entrée

• Définition des paramètres

OL.parameter param_def; <param_def; ...>

où client_def est une des commandes suivantes:

name.number(Value,Path,ShortHelp);

définitions d'un paramètre numérique

name.MinMax(Min,Max,Step);

attribution d'un range à un paramètre numérique, name doit avoir été défini au préalable

name.string(Value,Path,ShortHelp);

• Branchements conditionnels

OL.iftrue(param)

• Inclusion d'un fichier

OL.include(filename)