]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Function parameters. Add doc.
authorRalf Hartmann <Ralf.Hartmann@dlr.de>
Fri, 23 Sep 2005 08:10:07 +0000 (08:10 +0000)
committerRalf Hartmann <Ralf.Hartmann@dlr.de>
Fri, 23 Sep 2005 08:10:07 +0000 (08:10 +0000)
git-svn-id: https://svn.dealii.org/trunk@11511 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/include/grid/grid_in.h

index 8f65ae560451451844e798a69d0aa1e88a0e2f84..036c127dbe771e455de2d3944ae7d9d7a0adf0d4 100644 (file)
@@ -202,7 +202,7 @@ class GridIn
                                      * #default_format variable is
                                      * used.
                                      */
-    void read (std::istream &, Format format=Default);
+    void read (std::istream &in, Format format=Default);
     
                                     /**
                                      * Open the file given by the
@@ -212,40 +212,44 @@ class GridIn
                                      * to find files. The file class
                                      * used is <code>MESH</code>.
                                      */
-    void read (const std::string&, Format format=Default);
+    void read (const std::string &in, Format format=Default);
     
                                     /**
                                      * Read grid data from an ucd file.
                                      * Numerical data is ignored.
                                      */
-    void read_ucd (std::istream &);
+    void read_ucd (std::istream &in);
 
                                     /**
                                      * Read grid data from a file
                                      * containing data in the DB mesh
                                      * format.
                                      */
-    void read_dbmesh (std::istream &);
+    void read_dbmesh (std::istream &in);
     
                                     /**
                                      * Read grid data from a file
                                      * containing data in the XDA
                                      * format.
                                      */
-    void read_xda (std::istream &);
+    void read_xda (std::istream &in);
     
                                     /**
                                      * Read grid data from an msh file.
                                      */
-    void read_msh (std::istream &);
+    void read_msh (std::istream &in);
     
                                     /**
-                                     * Read grid data from a netcdf
-                                     * file.  This requires the
+                                     * Read grid data from a NetCDF
+                                     * file. The only data format
+                                     * currently supported is the
+                                     * <tt>TAU grid format</tt>.
+                                     *
+                                     * This function requires the
                                      * library to be linked with the
-                                     * netcdf library.
+                                     * NetCDF library.
                                      */
-    void read_netcdf (const std::string &);
+    void read_netcdf (const std::string &filename);
     
                                     /**
                                      * Returns the standard suffix

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.