]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Doc update.
authorcvs <cvs@0785d39b-7218-0410-832d-ea1e28bc413d>
Thu, 7 Oct 1999 16:31:54 +0000 (16:31 +0000)
committercvs <cvs@0785d39b-7218-0410-832d-ea1e28bc413d>
Thu, 7 Oct 1999 16:31:54 +0000 (16:31 +0000)
git-svn-id: https://svn.dealii.org/trunk@1749 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/base/include/base/data_out_base.h

index 79718a8539d28740c62631155a5d32abfd70111a..02c0f2e15f34c8fa913a008e01dec8905c966c2a 100644 (file)
@@ -910,6 +910,48 @@ class DataOutBase
  * its member classes.
  *
  *
+ * \section{Run time selection of output parameters}
+ *
+ * In the output flags classes, described above, many flags are
+ * defined for output in the different formats. In order to make them
+ * available to the input file handler class #ParameterHandler#, each
+ * of these has a function declaring these flags to the parameter
+ * handler and to read them back from an actual input file. In order
+ * to avoid that in user programs these functions have to be called
+ * for each available output format and the respective flag class, the
+ * present #DataOut_Interface# class offers a function
+ * #declare_parameters# which calls the respective function of all
+ * known output format flags classes. The flags of each such format
+ * are packed together in a subsection in the input file.
+ * Likewise, there is a function #parse_parameters# which reads
+ * these parameters and stores them in the flags associated with
+ * this object (see above).
+ * 
+ * Using these functions, you do not have to track which formats are
+ * presently implemented.
+ *
+ * Usage is as follows:
+ * \begin{verbatim}
+ *                               // within function declaring parameters:
+ *   ...
+ *   prm.enter_subsection ("Output format options");
+ *     DataOutInterface<dim>::declare_parameters (prm);
+ *   prm.leave_subsection ();
+ *   ...
+ *
+ *
+ *                               // within function doing the output:
+ *   ...
+ *   DataOut<dim> out;
+ *   prm.enter_subsection ("Output format options");
+ *   out.parse_parameters (prm);
+ *   prm.leave_subsection ();
+ *   ...
+ * \end{verbatim}
+ * Note that in the present example, the class #DataOut# was used. However, any
+ * other class derived from #DataOut_Interface# would work alike.
+ *
+ *
  * \subsection{Run time selection of formats}
  *
  * This class, much like the #GridOut# class, has a set of functions
@@ -927,6 +969,7 @@ class DataOutBase
  * the formats presently implemented. User programs need therefore not
  * be changed whenever a new format is implemented.
  *
+ *
  * @author Wolfgang Bangerth, 1999
  */
 template <int dim>

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.