]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Add usage doc.
authorwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 23 Jun 1999 12:43:40 +0000 (12:43 +0000)
committerwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Wed, 23 Jun 1999 12:43:40 +0000 (12:43 +0000)
git-svn-id: https://svn.dealii.org/trunk@1449 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/include/grid/grid_out.h

index 7f05f80178e2053ae1f59a22076aa6403d8ee040..ab195cd046083a6ad6cf8cdc4c4b843102eb2abf 100644 (file)
  * which is a thin line relative to the extension of the picture of 300.
  * 
  *
+ * \subsection{Usage}
+ * Usage is simple: either you use the direct form
+ * \begin{verbatim}
+ *   ofstream output_file("some_filename");
+ *   GridOut::write_gnuplot (tria, output_file);
+ * \end{verbatim}
+ * if you know which format you want to have, or if you want the format to be
+ * a runtime parameter, you can write
+ * \begin{verbatim}
+ *   GridOut::OutputFormat grid_format =
+ *                   GridOut::parse_output_format(get_format_name_from_somewhere());
+ *   ofstream output_file("some_filename" + GridOut::default_suffix(output_format));
+ *   GridOut::write (tria, output_file, output_format);
+ * \end{verbatim}
+ * The function #get_output_format_names()# provides a list of possible names of
+ * output formats in a string that is understandable by the #ParameterHandler# class.
+ *
+ *
  * @author Wolfgang Bangerth, 1999; postscript format based on an implementation by Stefan Nauber, 1999
  */
 class GridOut 

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.