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 ajoutass
- \subpage creearbre
- \subpage creeassemblage
- \subpage diff 
- \subpage enregistrer
- \subpage evalarbre
- \subpage evalassemblage
- \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 ajoutass ajoutass
var = ajoutass arbre prim  
@brief Ajoute une primitive dans un arbre
@param arbre une variable représentant un arbre caractéristique.
@param prim une variable représentant une primitive
@return var une variable inutilisable
*/
//-----------------------------------------------------------
/*! \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 creeassemblage creeassemblage
var = creeassemblage arbre nom
@brief Création d'un assemblage dans un arbre caractéristique
@param arbre une variable représentant un arbre caractéristique
@param nom une chaine de caractère. Ce nom n'est pas utilisé par la suite
@return var une variable representant un assemblage
*/

//-----------------------------------------------------------
/*! \page evalarbre evalarbre
var = evalarbre arbre nom avecstep avecstl eps eps2
@brief Evaluation du modèle BREP à partir de la derniere primitive 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 evalassemblage evalassemblage
var = evalassemblage arbre assemb nom avecfusion avecstep avecstl eps eps2
@brief Evaluation du modèle BREP à partir d'un assemblage
@param arbre une variable représentant un arbre caractéristique
@param assemb une variable représentant un assemblage
@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 avecfusion un boolean qui permet de fusionner les entites communes a deux volumes avec l'apparaition des cofaces
@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:	747
Committed:	Tue Oct 6 19:53:22 2015 UTC (9 years, 7 months ago) by francois
Content type:	text/plain
File size:	12054 byte(s)
Log Message:	gestion du multivolume a l'importation des fichiers OCC avec triangulation associée
#	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	couturad	740	- \subpage ajoutass
20	francois	737	- \subpage creearbre
21	couturad	740	- \subpage creeassemblage
22	francois	737	- \subpage diff
23			- \subpage enregistrer
24			- \subpage evalarbre
25	couturad	740	- \subpage evalassemblage
26	francois	737	- \subpage export_mg_gmsh
27			- \subpage export_fem_gmsh
28			- \subpage fichier
29			- \subpage importstepocc
30			- \subpage inter
31			- \subpage p_cylindre
32			- \subpage p_cone
33			- \subpage p_boite
34			- \subpage p_sphere
35			- \subpage p_tore
36			- \subpage union
37			*/
38
39			//-----------------------------------------------------------
40
41			/*! \page Configuration Configuration de MAGiC
42			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
43			Affiche_Code_Aster = 0.000000 //0. Affichage redirigé vers le fichier aster.log 1 affichage dans un terminal\n
44			Convergence_mailleur3d_frontal = 200.000000 //Nombre de front restant à partir duquel la destruction est obligatoire\n
45			Echantillon_face = 20.000000 //Nombre d'échantillon pour le calcul de la boite englobante des faces\n
46			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
47			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
48			*/
49
50			//-----------------------------------------------------------
51			/*! \page fichier fichier
52			var = fichier nom
53			@brief Mise en mémoire d'un gestionnaire MAGiC
54			@param nom une chaine de caractére.
55			@return var une variable representant le gestionnaire MAGiC
56			@details Si nom = nouveau il y a création d'un nouveau modèle MAGiC\n
57			@details Sinon ouverture du fichier MAGiC donné par nom\n
58			*/
59
60			//-----------------------------------------------------------
61
62			/*! \page p_boite p_boite
63			var = p_boite arbre x1 y1 z1 x2 y2 z2
64			@brief Création d'une primitive solide de forme boite entre les points (x1,y1,z1) et (x2,y2,z2)
65			@param arbre une variable représentant un arbre caractéristique.
66			@param x1 un double.
67			@param y1 un double.
68			@param z1 un double.
69			@param x2 un double.
70			@param y2 un double.
71			@param z2 un double.
72			@return var une variable representant une primitive solide
73			*/
74
75			//-----------------------------------------------------------
76
77			/*! \page p_sphere p_sphere
78			var = p_sphere arbre x1 y1 z1 r
79			@brief Création d'une primitive solide de forme spherique de centre (x1,y1,z1) et de rayon r
80			@param arbre une variable représentant un arbre caractéristique.
81			@param x1 un double.
82			@param y1 un double.
83			@param z1 un double.
84			@param r un double.
85			@return var une variable representant une primitive solide
86			*/
87
88			//-----------------------------------------------------------
89
90			/*! \page p_cylindre p_cylindre
91			var = p_cylindre arbre x1 y1 z1 lat lon h r
92			@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
93			@param arbre une variable représentant un arbre caractéristique.
94			@param x1 un double.
95			@param y1 un double.
96			@param z1 un double.
97			@param lat un double.
98			@param lon un double.
99			@param h un double.
100			@param r un double.
101			@return var une variable representant une primitive solide
102			*/
103
104			//-----------------------------------------------------------
105
106			/*! \page p_tore p_tore
107			var = p_tore arbre x1 y1 z1 lat lon R r
108			@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
109			@param arbre une variable représentant un arbre caractéristique.
110			@param x1 un double.
111			@param y1 un double.
112			@param z1 un double.
113			@param lat un double.
114			@param lon un double.
115			@param h un double.
116			@param r un double.
117			@return var une variable representant une primitive solide
118			*/
119
120			//-----------------------------------------------------------
121
122			/*! \page p_cone p_cone
123			var = p_cone arbre x1 y1 z1 lat lon h r
124			@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
125			@param arbre une variable représentant un arbre caractéristique.
126			@param x1 un double.
127			@param y1 un double.
128			@param z1 un double.
129			@param lat un double.
130			@param lon un double.
131			@param h un double.
132			@param r un double.
133			@return var une variable representant une primitive solide
134			*/
135	couturad	740	//-----------------------------------------------------------
136	francois	737
137	couturad	740	/*! \page ajoutass ajoutass
138			var = ajoutass arbre prim
139			@brief Ajoute une primitive dans un arbre
140			@param arbre une variable représentant un arbre caractéristique.
141			@param prim une variable représentant une primitive
142			@return var une variable inutilisable
143			*/
144	francois	737	//-----------------------------------------------------------
145			/*! \page union union
146			var = union arbre p1 p2 nom_semantique
147			@brief Création d'une opération booléene d'union 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 diff diff
157			var = diff arbre p1 p2 nom_semantique
158			@brief Création d'une opération booléene de soustraction 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			/*! \page inter inter
168			var = union arbre p1 p2 nom_semantique
169			@brief Création d'une opération booléene d'intersection entre deux primitives
170			@param arbre une variable représentant un arbre caractéristique.
171			@param p1 une primitive.
172			@param p2 une primitive.
173			@param nom_semantique OPTIONNEL nom pour donner un sens physique à l'opération. Les choix sont : chamfrein, conge, intersection, percage, soustraction, union, extrusion
174			@return var une variable representant une primitive
175			@details Si aucun nom de sémantique n'est donné le qualificatif SANS est attribué
176			*/
177			//-----------------------------------------------------------
178
179			/*! \page creearbre creearbre
180			var = creearbre gest nom
181			@brief Création d'un arbre caractéristique
182			@param gest une variable représentant un modèle MAGiC
183			@param nom une chaine de caractère. Ce nom n'est pas utilisé par la suite
184			@return var une variable representant un arbre caractéristique
185			*/
186
187			//-----------------------------------------------------------
188	couturad	740
189			/*! \page creeassemblage creeassemblage
190			var = creeassemblage arbre nom
191			@brief Création d'un assemblage dans un arbre caractéristique
192			@param arbre une variable représentant un arbre caractéristique
193			@param nom une chaine de caractère. Ce nom n'est pas utilisé par la suite
194			@return var une variable representant un assemblage
195			*/
196
197			//-----------------------------------------------------------
198	francois	737	/*! \page evalarbre evalarbre
199			var = evalarbre arbre nom avecstep avecstl eps eps2
200	francois	741	@brief Evaluation du modèle BREP à partir de la derniere primitive d'un arbre caractéristique
201	francois	737	@param arbre une variable représentant un arbre caractéristique
202			@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)
203			@param avecstep un boolean qui permet une version du fichier BREP en STEP
204			@param avecstl un boolean qui permet la création d'une triangulation associée aux entitées BREP crées
205			@param eps OPTIONNEL un double pour la précison de opencascade dans la fermeture des entitées BREP - Defaut = 1e-6.
206			@param eps2 OPTIONNEL un double pour la distance entre la triangulation et la géométrie - Defaut = 1.
207			@return var une variable representant une geometrie
208			*/
209
210			//-----------------------------------------------------------
211	couturad	740	/*! \page evalassemblage evalassemblage
212	francois	747	var = evalassemblage arbre assemb nom avecfusion avecstep avecstl eps eps2
213	couturad	740	@brief Evaluation du modèle BREP à partir d'un assemblage
214			@param arbre une variable représentant un arbre caractéristique
215			@param assemb une variable représentant un assemblage
216			@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)
217	francois	747	@param avecfusion un boolean qui permet de fusionner les entites communes a deux volumes avec l'apparaition des cofaces
218	couturad	740	@param avecstep un boolean qui permet une version du fichier BREP en STEP
219			@param avecstl un boolean qui permet la création d'une triangulation associée aux entitées BREP crées
220			@param eps OPTIONNEL un double pour la précison de opencascade dans la fermeture des entitées BREP - Defaut = 1e-6.
221			@param eps2 OPTIONNEL un double pour la distance entre la triangulation et la géométrie - Defaut = 1.
222			@return var une variable representant une geometrie
223			*/
224
225			//-----------------------------------------------------------
226	francois	737	/*! \page enregistrer enregistrer
227			var = enregistrer gest nom
228			@brief Sauvegarde d'un fichier MAGiC
229			@param gest une variable représentant un gestionnaire MAGiC
230			@param nom une string représentant un nom de fichier (L'extension s'ajoute automatiquement au nom du fichier).
231			@return var une variable inutilisable
232			*/
233
234			//-----------------------------------------------------------
235			/*! \page export_mg_gmsh export_mg_gmsh
236			var = export_mg_gmsh gest nom num
237			@brief Exportation d'un MG_MAILLAGE MAGiC en format GMSH
238			@param gest une variable représentant un gestionnaire MAGiC
239			@param nom une string représentant un nom de fichier gmsh (L'extension s'ajoute automatiquement au nom du fichier).
240			@param num un integer qui représente un numero sequantielle de maillage (entre 1 et n)
241			@return var une variable inutilisable
242			*/
243
244			//-----------------------------------------------------------
245			/*! \page export_fem_gmsh export_fem_gmsh
246			var = export_fem_gmsh gest nom num
247			@brief Exportation d'un FEM_MAILLAGE MAGiC en format GMSH
248			@param gest une variable représentant un gestionnaire MAGiC
249			@param nom une string représentant un nom de fichier gmsh (L'extension s'ajoute automatiquement au nom du fichier).
250			@param num un integer qui représente un numero sequantielle de maillage (entre 1 et n)
251			@return var une variable inutilisable
252			*/
253			//-----------------------------------------------------------
254			/*! \page importstepocc importstepocc
255			var = importstepocc gest nom eps
256			@brief importation d'un fichier STEP en MAGiC via opencascade
257			@param gest une variable représentant un gestionnaire MAGiC
258			@param nom une string représentant le nom de fichier STEP.
259			@param eps OPTIONNEL un double pour la précison de opencascade dans la fermeture des entitées BREP - Defaut = 1e-6.
260			@return var une variable de type geometrie
261			*/