magic_application/src/aide.h

/*! \page Aide Aide MAGiC
Configuration de MAGiC

- \subpage Configuration 


Description du format du fichier script MAGiC\n
- \subpage  Script
*/

//-----------------------------------------------------------


/*! \page Script Description du contenu du fichier script
Un fichier script est composé de commandes exécutées en séquences depuis le début du fichier jusqu'à la fin.\n
Toute ligne commence par une variable suivie d'un espace suivi d'un signe egal suivi d'un espace et suivi de la commande et de ses arguments.\n
Si le premier caractère de la ligne est le caractère # alors la ligne est ignorée.\n\n
Les commandes disponibles dans le script MAGiC:
- \subpage creearbre
- \subpage diff 
- \subpage enregistrer
- \subpage evalarbre
- \subpage export_mg_gmsh
- \subpage export_fem_gmsh
- \subpage fichier
- \subpage importstepocc
- \subpage inter 
- \subpage p_cylindre 
- \subpage p_cone 
- \subpage p_boite 
- \subpage p_sphere 
- \subpage p_tore 
- \subpage union 
*/

//-----------------------------------------------------------

/*! \page Configuration Configuration de MAGiC
Dans chaque compte utilisateur ou MAGiC est utilisé un fichier .magic dans le home directory permet de regler quelques parametres de l'application :\n\n
Affiche_Code_Aster = 0.000000       //0. Affichage redirigé vers le fichier aster.log 1 affichage dans un terminal\n
Convergence_mailleur3d_frontal = 200.000000       //Nombre de front restant à partir duquel la destruction est obligatoire\n
Echantillon_face = 20.000000       //Nombre d'échantillon pour le calcul de la boite englobante des faces\n
Verification_coin_face_mailleur2D = 0.000000       //0. Ne fais pas la vérification 1. Fait la vérification qu'un sommet de face partage au moins deux triangles\n
Optimisation_2D = 1       //Nombre de bits = nombre de passe d'optimisation. Pour chaque bit 1=bouge de noeud 2=inverse diagonale 3=bouge de noeud inserse diagonale simultane 4=inverse diagonale bouge de noeud simulatane\n
*/

//-----------------------------------------------------------
/*! \page fichier fichier
var = fichier nom 
@brief Mise en mémoire d'un gestionnaire MAGiC
@param nom une chaine de caractére.
@return var une variable representant le gestionnaire MAGiC
@details Si nom = nouveau il y a création d'un nouveau modèle MAGiC\n
@details Sinon ouverture du fichier MAGiC donné par nom\n
*/

//-----------------------------------------------------------

/*! \page p_boite p_boite
var = p_boite arbre x1 y1 z1 x2 y2 z2
@brief Création d'une primitive solide de forme boite entre les points (x1,y1,z1) et (x2,y2,z2)
@param arbre une variable représentant un arbre caractéristique.
@param x1 un double.
@param y1 un double.
@param z1 un double.
@param x2 un double.
@param y2 un double.
@param z2 un double.
@return var une variable representant une primitive solide
*/

//-----------------------------------------------------------

/*! \page p_sphere p_sphere
var = p_sphere arbre x1 y1 z1 r
@brief Création d'une primitive solide de forme spherique de centre (x1,y1,z1) et de rayon r
@param arbre une variable représentant un arbre caractéristique.
@param x1 un double.
@param y1 un double.
@param z1 un double.
@param r un double.
@return var une variable representant une primitive solide
*/

//-----------------------------------------------------------

/*! \page p_cylindre p_cylindre
var = p_cylindre arbre x1 y1 z1 lat lon h r  
@brief Création d'une primitive solide de forme cylindrique basée sur le cercle centré en (x1,y1,z1) orienté selon les angles lat et lon pour latitute et longitude de hauteur h et de rayon r
@param arbre une variable représentant un arbre caractéristique.
@param x1 un double.
@param y1 un double.
@param z1 un double.
@param lat un double.
@param lon un double.
@param h un double.
@param r un double.
@return var une variable representant une primitive solide
*/

//-----------------------------------------------------------

/*! \page p_tore p_tore
var = p_tore arbre x1 y1 z1 lat lon R r  
@brief Création d'une primitive solide de forme torique basée sur le cercle centré en (x1,y1,z1) orienté selon les angles lat et lon pour latitute et longitude de grand rayon R  et de petit rayon r
@param arbre une variable représentant un arbre caractéristique.
@param x1 un double.
@param y1 un double.
@param z1 un double.
@param lat un double.
@param lon un double.
@param h un double.
@param r un double.
@return var une variable representant une primitive solide
*/

//-----------------------------------------------------------

/*! \page p_cone p_cone
var = p_cone arbre x1 y1 z1 lat lon h r  
@brief Création d'une primitive solide de forme conqiue basée sur le cercle centré en (x1,y1,z1) orienté selon les angles lat et lon pour latitute et longitude de hauteur h  et de petit rayon r
@param arbre une variable représentant un arbre caractéristique.
@param x1 un double.
@param y1 un double.
@param z1 un double.
@param lat un double.
@param lon un double.
@param h un double.
@param r un double.
@return var une variable representant une primitive solide
*/

//-----------------------------------------------------------
/*! \page union union
var = union arbre p1 p2 nom_semantique
@brief Création d'une opération booléene d'union entre deux primitives
@param arbre une variable représentant un arbre caractéristique.
@param p1 une primitive.
@param p2 une primitive.
@param nom_semantique OPTIONNEL nom pour donner un sens physique à l'opération. Les choix sont : chamfrein, conge, intersection, percage, soustraction, union, extrusion
@return var une variable representant une primitive
@details Si aucun nom de sémantique n'est donné le qualificatif SANS est attribué
*/
//-----------------------------------------------------------
/*! \page diff diff
var = diff arbre p1 p2 nom_semantique
@brief Création d'une opération booléene de soustraction entre deux primitives
@param arbre une variable représentant un arbre caractéristique.
@param p1 une primitive.
@param p2 une primitive.
@param nom_semantique OPTIONNEL nom pour donner un sens physique à l'opération. Les choix sont : chamfrein, conge, intersection, percage, soustraction, union, extrusion
@return var une variable representant une primitive
@details Si aucun nom de sémantique n'est donné le qualificatif SANS est attribué
*/
//-----------------------------------------------------------
/*! \page inter inter
var = union arbre p1 p2 nom_semantique
@brief Création d'une opération booléene d'intersection entre deux primitives
@param arbre une variable représentant un arbre caractéristique.
@param p1 une primitive.
@param p2 une primitive.
@param nom_semantique OPTIONNEL nom pour donner un sens physique à l'opération. Les choix sont : chamfrein, conge, intersection, percage, soustraction, union, extrusion
@return var une variable representant une primitive
@details Si aucun nom de sémantique n'est donné le qualificatif SANS est attribué
*/
//-----------------------------------------------------------

/*! \page creearbre creearbre
var = creearbre gest nom
@brief Création d'un arbre caractéristique
@param gest une variable représentant un modèle MAGiC
@param nom une chaine de caractère. Ce nom n'est pas utilisé par la suite
@return var une variable representant un arbre caractéristique
*/

//-----------------------------------------------------------
/*! \page evalarbre evalarbre
var = evalarbre arbre nom avecstep avecstl eps eps2
@brief Evaluation du modèle BREP à partir d'un arbre caractéristique
@param arbre une variable représentant un arbre caractéristique
@param nom une string représentant un nom de fichier pour enregistrer le fichier opencascade sur le disque (L'extension s'ajoute automatiquement au nom du fichier)
@param avecstep un boolean qui permet une version du fichier BREP en STEP
@param avecstl un boolean qui permet la création d'une triangulation associée aux entitées BREP crées
@param eps OPTIONNEL un double pour la précison de opencascade dans la fermeture des entitées BREP - Defaut = 1e-6.
@param eps2 OPTIONNEL un double pour la distance entre la triangulation et la géométrie  - Defaut = 1.
@return var une variable representant une geometrie
*/

//-----------------------------------------------------------
/*! \page enregistrer enregistrer
var = enregistrer gest nom
@brief Sauvegarde d'un fichier MAGiC
@param gest une variable représentant un gestionnaire MAGiC
@param nom une string représentant un nom de fichier (L'extension s'ajoute automatiquement au nom du fichier).
@return var une variable inutilisable
*/

//-----------------------------------------------------------
/*! \page export_mg_gmsh export_mg_gmsh
var = export_mg_gmsh gest nom num
@brief Exportation d'un MG_MAILLAGE MAGiC en format GMSH
@param gest une variable représentant un gestionnaire MAGiC
@param nom une string représentant un nom de fichier gmsh (L'extension s'ajoute automatiquement au nom du fichier).
@param num un integer qui représente un numero sequantielle de maillage (entre 1 et n)
@return var une variable inutilisable
*/

//-----------------------------------------------------------
/*! \page export_fem_gmsh export_fem_gmsh
var = export_fem_gmsh gest nom num
@brief Exportation d'un FEM_MAILLAGE MAGiC en format GMSH
@param gest une variable représentant un gestionnaire MAGiC
@param nom une string représentant un nom de fichier gmsh (L'extension s'ajoute automatiquement au nom du fichier).
@param num un integer qui représente un numero sequantielle de maillage (entre 1 et n)
@return var une variable inutilisable
*/
//-----------------------------------------------------------
/*! \page importstepocc importstepocc
var = importstepocc gest nom eps
@brief importation d'un fichier STEP en MAGiC via opencascade
@param gest une variable représentant un gestionnaire MAGiC
@param nom une string représentant le nom de fichier STEP.
@param eps OPTIONNEL un double pour la précison de opencascade dans la fermeture des entitées BREP - Defaut = 1e-6.
@return var une variable de type geometrie
*/
Revision:	737
Committed:	Thu Sep 24 22:47:31 2015 UTC (9 years, 7 months ago) by francois
Content type:	text/plain
File size:	10138 byte(s)
Log Message:	Mise a jour de la documentation webmagic pour donner un fichier de help pour faire un script
#	User	Rev	Content
1	francois	737	/*! \page Aide Aide MAGiC
2			Configuration de MAGiC
3
4			- \subpage Configuration
5
6
7			Description du format du fichier script MAGiC\n
8			- \subpage Script
9			*/
10
11			//-----------------------------------------------------------
12
13
14			/*! \page Script Description du contenu du fichier script
15			Un fichier script est composé de commandes exécutées en séquences depuis le début du fichier jusqu'à la fin.\n
16			Toute ligne commence par une variable suivie d'un espace suivi d'un signe egal suivi d'un espace et suivi de la commande et de ses arguments.\n
17			Si le premier caractère de la ligne est le caractère # alors la ligne est ignorée.\n\n
18			Les commandes disponibles dans le script MAGiC:
19			- \subpage creearbre
20			- \subpage diff
21			- \subpage enregistrer
22			- \subpage evalarbre
23			- \subpage export_mg_gmsh
24			- \subpage export_fem_gmsh
25			- \subpage fichier
26			- \subpage importstepocc
27			- \subpage inter
28			- \subpage p_cylindre
29			- \subpage p_cone
30			- \subpage p_boite
31			- \subpage p_sphere
32			- \subpage p_tore
33			- \subpage union
34			*/
35
36			//-----------------------------------------------------------
37
38			/*! \page Configuration Configuration de MAGiC
39			Dans chaque compte utilisateur ou MAGiC est utilisé un fichier .magic dans le home directory permet de regler quelques parametres de l'application :\n\n
40			Affiche_Code_Aster = 0.000000 //0. Affichage redirigé vers le fichier aster.log 1 affichage dans un terminal\n
41			Convergence_mailleur3d_frontal = 200.000000 //Nombre de front restant à partir duquel la destruction est obligatoire\n
42			Echantillon_face = 20.000000 //Nombre d'échantillon pour le calcul de la boite englobante des faces\n
43			Verification_coin_face_mailleur2D = 0.000000 //0. Ne fais pas la vérification 1. Fait la vérification qu'un sommet de face partage au moins deux triangles\n
44			Optimisation_2D = 1 //Nombre de bits = nombre de passe d'optimisation. Pour chaque bit 1=bouge de noeud 2=inverse diagonale 3=bouge de noeud inserse diagonale simultane 4=inverse diagonale bouge de noeud simulatane\n
45			*/
46
47			//-----------------------------------------------------------
48			/*! \page fichier fichier
49			var = fichier nom
50			@brief Mise en mémoire d'un gestionnaire MAGiC
51			@param nom une chaine de caractére.
52			@return var une variable representant le gestionnaire MAGiC
53			@details Si nom = nouveau il y a création d'un nouveau modèle MAGiC\n
54			@details Sinon ouverture du fichier MAGiC donné par nom\n
55			*/
56
57			//-----------------------------------------------------------
58
59			/*! \page p_boite p_boite
60			var = p_boite arbre x1 y1 z1 x2 y2 z2
61			@brief Création d'une primitive solide de forme boite entre les points (x1,y1,z1) et (x2,y2,z2)
62			@param arbre une variable représentant un arbre caractéristique.
63			@param x1 un double.
64			@param y1 un double.
65			@param z1 un double.
66			@param x2 un double.
67			@param y2 un double.
68			@param z2 un double.
69			@return var une variable representant une primitive solide
70			*/
71
72			//-----------------------------------------------------------
73
74			/*! \page p_sphere p_sphere
75			var = p_sphere arbre x1 y1 z1 r
76			@brief Création d'une primitive solide de forme spherique de centre (x1,y1,z1) et de rayon r
77			@param arbre une variable représentant un arbre caractéristique.
78			@param x1 un double.
79			@param y1 un double.
80			@param z1 un double.
81			@param r un double.
82			@return var une variable representant une primitive solide
83			*/
84
85			//-----------------------------------------------------------
86
87			/*! \page p_cylindre p_cylindre
88			var = p_cylindre arbre x1 y1 z1 lat lon h r
89			@brief Création d'une primitive solide de forme cylindrique basée sur le cercle centré en (x1,y1,z1) orienté selon les angles lat et lon pour latitute et longitude de hauteur h et de rayon r
90			@param arbre une variable représentant un arbre caractéristique.
91			@param x1 un double.
92			@param y1 un double.
93			@param z1 un double.
94			@param lat un double.
95			@param lon un double.
96			@param h un double.
97			@param r un double.
98			@return var une variable representant une primitive solide
99			*/
100
101			//-----------------------------------------------------------
102
103			/*! \page p_tore p_tore
104			var = p_tore arbre x1 y1 z1 lat lon R r
105			@brief Création d'une primitive solide de forme torique basée sur le cercle centré en (x1,y1,z1) orienté selon les angles lat et lon pour latitute et longitude de grand rayon R et de petit rayon r
106			@param arbre une variable représentant un arbre caractéristique.
107			@param x1 un double.
108			@param y1 un double.
109			@param z1 un double.
110			@param lat un double.
111			@param lon un double.
112			@param h un double.
113			@param r un double.
114			@return var une variable representant une primitive solide
115			*/
116
117			//-----------------------------------------------------------
118
119			/*! \page p_cone p_cone
120			var = p_cone arbre x1 y1 z1 lat lon h r
121			@brief Création d'une primitive solide de forme conqiue basée sur le cercle centré en (x1,y1,z1) orienté selon les angles lat et lon pour latitute et longitude de hauteur h et de petit rayon r
122			@param arbre une variable représentant un arbre caractéristique.
123			@param x1 un double.
124			@param y1 un double.
125			@param z1 un double.
126			@param lat un double.
127			@param lon un double.
128			@param h un double.
129			@param r un double.
130			@return var une variable representant une primitive solide
131			*/
132
133			//-----------------------------------------------------------
134			/*! \page union union
135			var = union arbre p1 p2 nom_semantique
136			@brief Création d'une opération booléene d'union entre deux primitives
137			@param arbre une variable représentant un arbre caractéristique.
138			@param p1 une primitive.
139			@param p2 une primitive.
140			@param nom_semantique OPTIONNEL nom pour donner un sens physique à l'opération. Les choix sont : chamfrein, conge, intersection, percage, soustraction, union, extrusion
141			@return var une variable representant une primitive
142			@details Si aucun nom de sémantique n'est donné le qualificatif SANS est attribué
143			*/
144			//-----------------------------------------------------------
145			/*! \page diff diff
146			var = diff arbre p1 p2 nom_semantique
147			@brief Création d'une opération booléene de soustraction entre deux primitives
148			@param arbre une variable représentant un arbre caractéristique.
149			@param p1 une primitive.
150			@param p2 une primitive.
151			@param nom_semantique OPTIONNEL nom pour donner un sens physique à l'opération. Les choix sont : chamfrein, conge, intersection, percage, soustraction, union, extrusion
152			@return var une variable representant une primitive
153			@details Si aucun nom de sémantique n'est donné le qualificatif SANS est attribué
154			*/
155			//-----------------------------------------------------------
156			/*! \page inter inter
157			var = union arbre p1 p2 nom_semantique
158			@brief Création d'une opération booléene d'intersection entre deux primitives
159			@param arbre une variable représentant un arbre caractéristique.
160			@param p1 une primitive.
161			@param p2 une primitive.
162			@param nom_semantique OPTIONNEL nom pour donner un sens physique à l'opération. Les choix sont : chamfrein, conge, intersection, percage, soustraction, union, extrusion
163			@return var une variable representant une primitive
164			@details Si aucun nom de sémantique n'est donné le qualificatif SANS est attribué
165			*/
166			//-----------------------------------------------------------
167
168			/*! \page creearbre creearbre
169			var = creearbre gest nom
170			@brief Création d'un arbre caractéristique
171			@param gest une variable représentant un modèle MAGiC
172			@param nom une chaine de caractère. Ce nom n'est pas utilisé par la suite
173			@return var une variable representant un arbre caractéristique
174			*/
175
176			//-----------------------------------------------------------
177			/*! \page evalarbre evalarbre
178			var = evalarbre arbre nom avecstep avecstl eps eps2
179			@brief Evaluation du modèle BREP à partir d'un arbre caractéristique
180			@param arbre une variable représentant un arbre caractéristique
181			@param nom une string représentant un nom de fichier pour enregistrer le fichier opencascade sur le disque (L'extension s'ajoute automatiquement au nom du fichier)
182			@param avecstep un boolean qui permet une version du fichier BREP en STEP
183			@param avecstl un boolean qui permet la création d'une triangulation associée aux entitées BREP crées
184			@param eps OPTIONNEL un double pour la précison de opencascade dans la fermeture des entitées BREP - Defaut = 1e-6.
185			@param eps2 OPTIONNEL un double pour la distance entre la triangulation et la géométrie - Defaut = 1.
186			@return var une variable representant une geometrie
187			*/
188
189			//-----------------------------------------------------------
190			/*! \page enregistrer enregistrer
191			var = enregistrer gest nom
192			@brief Sauvegarde d'un fichier MAGiC
193			@param gest une variable représentant un gestionnaire MAGiC
194			@param nom une string représentant un nom de fichier (L'extension s'ajoute automatiquement au nom du fichier).
195			@return var une variable inutilisable
196			*/
197
198			//-----------------------------------------------------------
199			/*! \page export_mg_gmsh export_mg_gmsh
200			var = export_mg_gmsh gest nom num
201			@brief Exportation d'un MG_MAILLAGE MAGiC en format GMSH
202			@param gest une variable représentant un gestionnaire MAGiC
203			@param nom une string représentant un nom de fichier gmsh (L'extension s'ajoute automatiquement au nom du fichier).
204			@param num un integer qui représente un numero sequantielle de maillage (entre 1 et n)
205			@return var une variable inutilisable
206			*/
207
208			//-----------------------------------------------------------
209			/*! \page export_fem_gmsh export_fem_gmsh
210			var = export_fem_gmsh gest nom num
211			@brief Exportation d'un FEM_MAILLAGE MAGiC en format GMSH
212			@param gest une variable représentant un gestionnaire MAGiC
213			@param nom une string représentant un nom de fichier gmsh (L'extension s'ajoute automatiquement au nom du fichier).
214			@param num un integer qui représente un numero sequantielle de maillage (entre 1 et n)
215			@return var une variable inutilisable
216			*/
217			//-----------------------------------------------------------
218			/*! \page importstepocc importstepocc
219			var = importstepocc gest nom eps
220			@brief importation d'un fichier STEP en MAGiC via opencascade
221			@param gest une variable représentant un gestionnaire MAGiC
222			@param nom une string représentant le nom de fichier STEP.
223			@param eps OPTIONNEL un double pour la précison de opencascade dans la fermeture des entitées BREP - Defaut = 1e-6.
224			@return var une variable de type geometrie
225			*/