Comment trouver la syntaxe des expressions PyFlux ?

Introduction

Pour pouvoir écrire en langage PyFlux, l'utilisateur a besoin de connaître la syntaxe des expressions PyFlux (commandes Flux dans le langage PyFlux).

Comment trouver la syntaxe PyFlux

Il y a 5 méthodes pour connaître la syntaxe des expressions PyFlux . Ces méthodes sont présentées dans le tableau ci-dessous et expliquées dans les blocs suivants.

… dans un fichier de commande (1)

Pour récupérer l'expression PyFlux d'une commande Flux employée pendant la session :

• utiliser le fichier de commande * , qui enregistre les commandes Flux ** pendant le déroulement du programme Flux

* Des détails sur la gestion des fichiers de commande sont présentés dans Gestion et exécution des fichiers de commande .

** Les commandes dites « graphiques » ne sont pas automatiquement écrites dans le fichier de commande créé par défaut.

Si l'utilisateur veut récupérer ces commandes il doit activer l'écriture des commandes graphiques. Cette commande est décrite dans Activer / désactiver l'écriture des commandes graphiques .

… dans la zone Echo (2)

Pour récupérer l'expression PyFlux d'une commande Flux :

• activer la commande Flux
• récupérer la syntaxe directement dans la zone Echo

Exemple:

Echo de la commande Ouvrir projet > CASE1.FLU :

loadProject('case1.flu')

Commande Afficher l'expression PyFlux (3)

Pour connaître l'expression PyFlux d'une entité Flux (le type et les attributs) :

• dans le menu contextuel de l'entité Flux, cliquer sur la commande Afficher l'expression PyFlux
• récupérer la syntaxe dans la zone Historique

Exemple:

Affichage de l'expression PyFlux de l'entité Point[1] :

Typing Point[1]
PointCoordinates(color=Color['White'],
                 visibility=Visibility['VISIBLE'],
                 coordSys=CoordSys['CENTER'],
                 uvw=['-60',
                 '0',
                 '0'],
                 nature=Nature['STANDARD'],
                 mesh=MeshPoint['E_SHAPE'])
End typing Point[1]

Méthode type() (3')

Pour connaître l'expression PyFlux d'une entité Flux (le type et les attributs) :

• dans la zone Commande appliquer la méthode Python type() à l'entité Flux
• récupérer la syntaxe dans la zone Historique

La méthode Python type() est équivalente à la commande Flux Afficher l'expression PyFlux

Exemple:

Résultat de la commande Point[1].type() :

PointCoordinates(color=Color['White'],
                           visibility=Visibility['VISIBLE'],
                           coordSys=CoordSys['CENTER'],
                           uvw=['-60',
                           '0',
                           '0'],
                           nature=Nature['STANDARD'],
                           mesh=MeshPoint['E_SHAPE'])

Méthode help() (4)

Pour connaître la syntaxe PyFlux de la structure complète d'un type-entité Flux (les attributs, sous-types, méthodes, méthode de sélection) :

• dans la zone Commande, appliquer la méthode Python help() au type-entité Flux (type PyFlux)
• récupérer la syntaxe dans la zone Historique

Exemple:

Résultat de la commande ParameterGeom.help() :

ParameterGeom (Entity for parametrizing a geometry) : 
Type Entity (read write) Fields : - 
ParameterGeom[id name].expression (Expression for the parameter) : [1...1] of C80 (read write) -
ParameterGeom[id name].name (Name of Parameter) : [1...1] of C80 (read write)
ParameterGeom[id name].value (parameter value) : [1...1] of R08 (read)