* <li>EPS output based on an earlier implementation by Stefan Nauber
* for the old DataOut class
*
- * <li>Povray output by Thomas Richter
+ * <li>@ref SoftwarePovray output by Thomas Richter
*
- * <li>Tecplot output by Benjamin Shelton Kirk
+ * <li>@ref SoftwareTecplot output by Benjamin Shelton Kirk
*
* </ul>
*
};
/**
- * Flags controlling the details of
- * output in UCD format.
+ * Flags controlling the details
+ * of output in UCD format for
+ * @ref SoftwareAVS.
*
* @ingroup IO
*/
* of the file stating the date of
* creation and some other data.
* While this is supported by the
- * UCD format (and the AVS program),
+ * UCD format and @ref SoftwareAVS,
* some other programs get confused
* by this, so you can switch it off
* this way.
};
/**
- * Flags controlling the details of
- * output in Tecplot format.
+ * Flags controlling the details
+ * of output in @ref
+ * SoftwareTecplot format.
*
* @ingroup IO
*/
enum OutputFormat {
default_format,
/**
- * Output for IBM OpenDX.
+ * Output for @ref SoftwareOpenDX.
*/
dx,
/**
- * Output in AVS UCD format.
+ * Output in the UCD format
+ * for @ref SoftwareAVS.
*/
ucd,
/**
- * Output for the gnuplot tool.
+ * Output for the @ref
+ * SoftwareGnuplot tool.
*/
gnuplot,
/**
- * Output for the povray raytracer.
+ * Output for the @ref
+ * SoftwarePovray
+ * raytracer.
*/
povray,
/**
*/
gmv,
/**
- * Output for tecplot in
- * text format.
+ * Output for @ref
+ * SoftwareTecplot in text
+ * format.
*/
tecplot,
/**
- * Output for tecplot in
- * binaryformat. Faster and
- * smaller than text
+ * Output for @ref
+ * SoftwareTecplot in
+ * binary format. Faster
+ * and smaller than text
* format.
*/
tecplot_binary,
};
/**
- * Write the given list of patches to the output stream in <a
- * href="www.opendx.org">OpenDX</a> format.
+ * Write the given list of patches to the output stream in @ref
+ * SoftwareOpenDX format.
*
- * Since OpenDX uses some kind of visual data flow oriented
+ * Since @ref SoftwareOpenDX uses some kind of visual data flow oriented
* programming language, some of these programs are provided in
* <tt>contrib/dx</tt>.
*/
std::ostream &out);
/**
- * Write the given list of patches to the output stream in <a
- * href="http://www.amtec.com">Tecplot</a>
- * ASCII format (FEBLOCK).
+ * Write the given list of patches to the output stream in @ref
+ * SoftwareTecplot ASCII format (FEBLOCK).
*
* For more information consult the Tecplot Users and Reference
* manuals.
std::ostream &out);
/**
- * Write the given list of patches to the output stream in Tecplot
- * binary format.
+ * Write the given list of patches to the output stream in @ref
+ * SoftwareTecplot binary format.
*
* For this to work properly <tt>./configure</tt> checks for the
* Tecplot API at build time. To write Tecplot binary files directly
/**
* Write the given list of patches to the output stream in UCD format
- * described in the AVS developer's guide. Due to limitations in the
- * present format, only node based data can be output, which in one
- * reason why we invented the patch concept. In order to write higher
- * order elements, you may split them up into several subdivisions of
- * each cell. These subcells will then, however, also appear as
- * different cells by programs which understand the UCD format.
+ * described in the AVS developer's guide (now @ref SoftwareAVS). Due
+ * to limitations in the present format, only node based data can be
+ * output, which in one reason why we invented the patch concept. In
+ * order to write higher order elements, you may split them up into
+ * several subdivisions of each cell. These subcells will then,
+ * however, also appear as different cells by programs which
+ * understand the UCD format.
*
* No use is made of the possibility to give model data since these
* are not supported by all UCD aware programs. You may give cell data
void write_tecplot_binary (std::ostream &out) const;
/**
- * Obtain data through get_patches()
- * and write it to <tt>out</tt>
- * in UCD format. See
+ * Obtain data through
+ * get_patches() and write it to
+ * <tt>out</tt> in UCD format for
+ * @ref SoftwareAVS. See
* DataOut::write_ucd.
*/
void write_ucd (std::ostream &out) const;