integration of modifications from Gerald Nicolas

[modules/homard.git] / src / HOMARD / HOMARD_Boundary.hxx

diff --git a/src/HOMARD/HOMARD_Boundary.hxx b/src/HOMARD/HOMARD_Boundary.hxx
index f92456e78dd2eb3c923613ada6b40493f1f55743..5cf972aae1237921d6d7f292e1145cfb4bf8dda1 100644 (file)
--- a/src/HOMARD/HOMARD_Boundary.hxx
+++ b/src/HOMARD/HOMARD_Boundary.hxx
@@ -21,6 +21,15 @@
 //  File   : HOMARD_Boundary.hxx
 //  Author : Paul RASCLE, EDF
 //  Module : HOMARD
+//
+// Remarques :
+// L'ordre de description des fonctions est le meme dans tous les fichiers
+// HOMARD_aaaa.idl, HOMARD_aaaa.hxx, HOMARD_aaaa.cxx, HOMARD_aaaa_i.hxx, HOMARD_aaaa_i.cxx :
+// 1. Les generalites : Name, Delete, DumpPython, Dump, Restore
+// 2. Les caracteristiques
+// 3. Le lien avec les autres structures
+//
+// Quand les 2 fonctions Setxxx et Getxxx sont presentes, Setxxx est decrit en premier
 
 #ifndef _HOMARD_Boundary_HXX_
 #define _HOMARD_Boundary_HXX_
@@ -35,34 +44,39 @@ public:
   HOMARD_Boundary();
   ~HOMARD_Boundary();
 
+// Generalites
   void                          SetName( const char* Name );
   std::string                   GetName() const;
-  std::string                   GetDumpPython() const;
 
-  void                          SetLimit( double X0, double X1, double X2 );
-  std::vector<double>           GetLimit() const;
+  std::string                   GetDumpPython() const;
 
-  void                          SetMeshFile( const char* MeshFile );
-  std::string                   GetMeshFile() const;
+// Caracteristiques
+  void                          SetType( int Type );
+  int                           GetType() const;
 
   void                          SetMeshName( const char* MeshName );
   std::string                   GetMeshName() const;
 
+  void                          SetMeshFile( const char* MeshFile );
+  std::string                   GetMeshFile() const;
+
   void                          SetCylinder( double X0, double X1, double X2, double X3,
                                              double X4, double X5, double X6 );
   void                          SetSphere( double X0, double X1, double X2, double X3 );
-  std::vector<double>           GetCoords() const;
 
-  void                          SetType( int Type );
-  int                           GetType() const;
+  std::vector<double>           GetCoords() const;
 
-  std::string                   GetCaseCreation() const;
-  void                          SetCaseCreation( const char* NomCasCreation );
+  void                          SetLimit( double X0, double X1, double X2 );
+  std::vector<double>           GetLimit() const;
 
   void                          AddGroup( const char* LeGroupe);
   void                          SetGroups(const std::list<std::string>& ListGroup );
   const std::list<std::string>& GetGroups() const;
 
+// Liens avec les autres structures
+  std::string                   GetCaseCreation() const;
+  void                          SetCaseCreation( const char* NomCasCreation );
+
 private:
   std::string                   _Name;
   std::string                   _NomCasCreation;