From d547dd2251ee4477a6386e47d09ac57d5a32fa78 Mon Sep 17 00:00:00 2001 From: Ralf Hartmann Date: Fri, 23 Sep 2005 08:10:07 +0000 Subject: [PATCH] Function parameters. Add doc. git-svn-id: https://svn.dealii.org/trunk@11511 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/deal.II/include/grid/grid_in.h | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/deal.II/deal.II/include/grid/grid_in.h b/deal.II/deal.II/include/grid/grid_in.h index 8f65ae5604..036c127dbe 100644 --- a/deal.II/deal.II/include/grid/grid_in.h +++ b/deal.II/deal.II/include/grid/grid_in.h @@ -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 MESH. */ - 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 + * TAU grid format. + * + * 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 -- 2.39.5