DataOutInterface< dim, spacedim > Class Template Reference
[Graphical output]

Inheritance diagram for DataOutInterface< dim, spacedim >:

Inheritance graph
[legend]

List of all members.

Public Types

enum  OutputFormat

Public Member Functions

 DataOutInterface ()
virtual ~DataOutInterface ()
void write_dx (std::ostream &out) const
void write_eps (std::ostream &out) const
void write_gmv (std::ostream &out) const
void write_gnuplot (std::ostream &out) const
void write_povray (std::ostream &out) const
void write_tecplot (std::ostream &out) const
void write_tecplot_binary (std::ostream &out) const
void write_ucd (std::ostream &out) const
void write_vtk (std::ostream &out) const
void write_deal_II_intermediate (std::ostream &out) const
void write (std::ostream &out, const OutputFormat output_format=default_format) const
void set_default_format (const OutputFormat default_format)
void set_flags (const DXFlags &dx_flags)
void set_flags (const UcdFlags &ucd_flags)
void set_flags (const GnuplotFlags &gnuplot_flags)
void set_flags (const PovrayFlags &povray_flags)
void set_flags (const EpsFlags &eps_flags)
void set_flags (const GmvFlags &gmv_flags)
void set_flags (const TecplotFlags &tecplot_flags)
void set_flags (const VtkFlags &vtk_flags)
void set_flags (const Deal_II_IntermediateFlags &deal_II_intermediate_flags)
std::string default_suffix (const OutputFormat output_format=default_format) const
void parse_parameters (ParameterHandler &prm)
unsigned int memory_consumption () const

Static Public Member Functions

static void declare_parameters (ParameterHandler &prm)

Protected Member Functions

virtual const std::vector
< typename DataOutBase::Patch
< dim, spacedim > > & 
get_patches () const =0
virtual std::vector< std::string > get_dataset_names () const =0
virtual std::vector
< std_cxx1x::tuple< unsigned
int, unsigned int, std::string > > 
get_vector_data_ranges () const

Protected Attributes

unsigned int default_subdivisions

Private Attributes

OutputFormat default_fmt
DXFlags dx_flags
UcdFlags ucd_flags
GnuplotFlags gnuplot_flags
PovrayFlags povray_flags
EpsFlags eps_flags
GmvFlags gmv_flags
TecplotFlags tecplot_flags
VtkFlags vtk_flags
Deal_II_IntermediateFlags deal_II_intermediate_flags


Detailed Description

template<int dim, int spacedim = dim>
class DataOutInterface< dim, spacedim >

This class is the interface to the DataOutBase class, as already its name might suggest. It does not offer much functionality apart from a way to access the implemented formats and a way to dynamically dispatch what output format to chose.

This class is thought as a base class to classes actually generating data for output. It has two abstract virtual functions, get_patches and get_dataset_names which are to produce the data which is actually needed. These are the only functions that need to be overloaded by a derived class. In additional to that, it has a function for each output format supported by the underlying base class which gets the output data using these two virtual functions and passes them to the raw output functions.

The purpose of this class is mainly two-fold: to support storing flags by which the output in the different output formats are controlled, and means to work with output in a way where output format, flags and other things are determined at run time. In addition to that it offers the abstract interface to derived classes briefly discussed above.

Output flags

The way we treat flags in this class is very similar to that used in the GridOut class. For detailed information on the why's and how's, as well as an example of programming, we refer to the documentation of that class.

Basically, this class stores a set of flags for each output format supported by the underlying DataOutBase class. These are used whenever one of the write_* functions is used. By default, the values of these flags are set to reasonable start-ups, but in case you want to change them, you can create a structure holding the flags for one of the output formats and set it using the set_flags functions of this class to determine all future output the object might produce by that output format.

For information on what parameters are supported by different output functions, please see the documentation of the DataOutBase class and its member classes.

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 DataOutInterface 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:

                               // 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 ();
   ...
Note that in the present example, the class DataOut was used. However, any other class derived from DataOutInterface would work alike.

Run time selection of formats

This class, much like the GridOut class, has a set of functions providing a list of supported output formats, an enum denoting all these and a function to parse a string and return the respective enum value if it is a valid output format's name (actually, these functions are inherited from the base class). Finally, there is a function write, which takes a value of this enum and dispatches to one of the actual write_* functions depending on the output format selected by this value.

The functions offering the different output format names are, respectively, default_suffix, parse_output_format, and get_output_format_names. They make the selection of ouput formats in parameter files much easier, and especially independent of the formats presently implemented. User programs need therefore not be changed whenever a new format is implemented.

Additionally, objects of this class have a default format, which can be set by the parameter "Output format" of the parameter file. Within a program, this can be changed by the member function set_default_format. Using this default format, it is possible to leave the format selection completely to the parameter file. A suitable suffix for the output file name can be obtained by default_suffix without arguments.

Author:
Wolfgang Bangerth, 1999

Member Enumeration Documentation

template<int dim, int spacedim = dim>
enum DataOutBase::OutputFormat

Provide a data type specifying the presently supported output formats.


Constructor & Destructor Documentation

template<int dim, int spacedim = dim>
DataOutInterface< dim, spacedim >::DataOutInterface (  ) 

Constructor.

template<int dim, int spacedim = dim>
virtual DataOutInterface< dim, spacedim >::~DataOutInterface (  )  [virtual]

Destructor. Does nothing, but is declared virtual since this class has virtual functions.


Member Function Documentation

template<int dim, int spacedim = dim>
void DataOutInterface< dim, spacedim >::write_dx ( std::ostream &  out  )  const

Obtain data through get_patches() and write it to out in OpenDX format. See DataOut::write_dx.

template<int dim, int spacedim = dim>
void DataOutInterface< dim, spacedim >::write_eps ( std::ostream &  out  )  const

Obtain data through get_patches() and write it to out in EPS format. See DataOut::write_eps.

template<int dim, int spacedim = dim>
void DataOutInterface< dim, spacedim >::write_gmv ( std::ostream &  out  )  const

Obtain data through get_patches() and write it to out in GMV format. See DataOut::write_gmv.

template<int dim, int spacedim = dim>
void DataOutInterface< dim, spacedim >::write_gnuplot ( std::ostream &  out  )  const

Obtain data through get_patches() and write it to out in GNUPLOT format. See DataOut::write_gnuplot.

template<int dim, int spacedim = dim>
void DataOutInterface< dim, spacedim >::write_povray ( std::ostream &  out  )  const

Obtain data through get_patches() and write it to out in POVRAY format. See DataOut::write_povray.

template<int dim, int spacedim = dim>
void DataOutInterface< dim, spacedim >::write_tecplot ( std::ostream &  out  )  const

Obtain data through get_patches() and write it to out in Tecplot format. See DataOut::write_tecplot.

template<int dim, int spacedim = dim>
void DataOutInterface< dim, spacedim >::write_tecplot_binary ( std::ostream &  out  )  const

Obtain data through get_patches() and write it in the Tecplot binary output format. Note that the name of the output file must be specified through the TecplotFlags interface.

template<int dim, int spacedim = dim>
void DataOutInterface< dim, spacedim >::write_ucd ( std::ostream &  out  )  const

Obtain data through get_patches() and write it to out in UCD format for AVS Express. See DataOut::write_ucd.

template<int dim, int spacedim = dim>
void DataOutInterface< dim, spacedim >::write_vtk ( std::ostream &  out  )  const

Obtain data through get_patches() and write it to out in Vtk format. See DataOut::write_vtk.

template<int dim, int spacedim = dim>
void DataOutInterface< dim, spacedim >::write_deal_II_intermediate ( std::ostream &  out  )  const

Obtain data through get_patches() and write it to out in deal.II intermediate format. See DataOut::write_deal_II_intermediate.

Note that the intermediate format is what its name suggests: a direct representation of internal data. It isn't standardized and will change whenever we change our internal representation. You can only expect to process files written in this format using the same version of deal.II that was used for writing.

template<int dim, int spacedim = dim>
void DataOutInterface< dim, spacedim >::write ( std::ostream &  out,
const OutputFormat  output_format = default_format 
) const

Write data and grid to out according to the given data format. This function simply calls the appropriate write_* function. If no output format is requested, the default_format is written.

An error occurs if no format is provided and the default format is default_format.

Referenced by DoFPrintSolverStep< dim, SOLVER, VECTOR >::print_vectors().

template<int dim, int spacedim = dim>
void DataOutInterface< dim, spacedim >::set_default_format ( const OutputFormat  default_format  ) 

Set the default format. The value set here is used anytime, output for format default_format is requested.

template<int dim, int spacedim = dim>
void DataOutInterface< dim, spacedim >::set_flags ( const DXFlags dx_flags  ) 

Set the flags to be used for output in OpenDX format.

template<int dim, int spacedim = dim>
void DataOutInterface< dim, spacedim >::set_flags ( const UcdFlags &  ucd_flags  ) 

Set the flags to be used for output in UCD format.

template<int dim, int spacedim = dim>
void DataOutInterface< dim, spacedim >::set_flags ( const GnuplotFlags gnuplot_flags  ) 

Set the flags to be used for output in GNUPLOT format.

template<int dim, int spacedim = dim>
void DataOutInterface< dim, spacedim >::set_flags ( const PovrayFlags &  povray_flags  ) 

Set the flags to be used for output in POVRAY format.

template<int dim, int spacedim = dim>
void DataOutInterface< dim, spacedim >::set_flags ( const EpsFlags eps_flags  ) 

Set the flags to be used for output in EPS output.

template<int dim, int spacedim = dim>
void DataOutInterface< dim, spacedim >::set_flags ( const GmvFlags &  gmv_flags  ) 

Set the flags to be used for output in GMV format.

template<int dim, int spacedim = dim>
void DataOutInterface< dim, spacedim >::set_flags ( const TecplotFlags tecplot_flags  ) 

Set the flags to be used for output in Tecplot format.

template<int dim, int spacedim = dim>
void DataOutInterface< dim, spacedim >::set_flags ( const VtkFlags &  vtk_flags  ) 

Set the flags to be used for output in VTK format.

template<int dim, int spacedim = dim>
void DataOutInterface< dim, spacedim >::set_flags ( const Deal_II_IntermediateFlags deal_II_intermediate_flags  ) 

Set the flags to be used for output in deal.II intermediate format.

template<int dim, int spacedim = dim>
std::string DataOutInterface< dim, spacedim >::default_suffix ( const OutputFormat  output_format = default_format  )  const

A function that returns the same string as the respective function in the base class does; the only exception being that if the parameter is omitted, then the value for the present default format is returned.

Referenced by DoFPrintSolverStep< dim, SOLVER, VECTOR >::print_vectors().

template<int dim, int spacedim = dim>
static void DataOutInterface< dim, spacedim >::declare_parameters ( ParameterHandler prm  )  [static]

Declare parameters for all output formats by declaring subsections within the parameter file for each output format and call the respective declare_parameters functions of the flag classes for each output format.

Some of the declared subsections may not contain entries, if the respective format does not export any flags.

Note that the top-level parameters denoting the number of subdivisions per patch and the output format are not declared, since they are only passed to virtual functions and are not stored inside objects of this type. You have to declare them yourself.

template<int dim, int spacedim = dim>
void DataOutInterface< dim, spacedim >::parse_parameters ( ParameterHandler prm  ) 

Read the parameters declared in declare_parameters and set the flags for the output formats accordingly.

The flags thus obtained overwrite all previous contents of the flag objects as default-constructed or set by the set_flags() function.

template<int dim, int spacedim = dim>
unsigned int DataOutInterface< dim, spacedim >::memory_consumption (  )  const

Determine an estimate for the memory consumption (in bytes) of this object. Since sometimes the size of objects can not be determined exactly (for example: what is the memory consumption of an STL std::map type with a certain number of elements?), this is only an estimate. however often quite close to the true value.

Reimplemented in DataOut_DoFData< DH, patch_dim, patch_space_dim >, DataOutStack< dim, spacedim, DH >, DataOut_DoFData< DoFHandler< dim >, DoFHandler< dim >::dimension, DoFHandler< dim >::space_dimension >, DataOut_DoFData< DH, DH::dimension+1 >, DataOut_DoFData< DH, DH::dimension, DH::space_dimension >, and DataOut_DoFData< DH, DH::dimension-1, DH::dimension >.

template<int dim, int spacedim = dim>
virtual const std::vector<typename DataOutBase::Patch<dim,spacedim> >& DataOutInterface< dim, spacedim >::get_patches (  )  const [protected, pure virtual]

This is the abstract function through which derived classes propagate preprocessed data in the form of Patch structures (declared in the base class DataOutBase) to the actual output function. You need to overload this function to allow the output functions to know what they shall print.

Implemented in DataOutReader< dim, spacedim >, MatrixOut, DataOut_DoFData< DH, patch_dim, patch_space_dim >, DataOutStack< dim, spacedim, DH >, DataOut_DoFData< DoFHandler< dim >, DoFHandler< dim >::dimension, DoFHandler< dim >::space_dimension >, DataOut_DoFData< DH, DH::dimension+1 >, DataOut_DoFData< DH, DH::dimension, DH::space_dimension >, and DataOut_DoFData< DH, DH::dimension-1, DH::dimension >.

template<int dim, int spacedim = dim>
virtual std::vector<std::string> DataOutInterface< dim, spacedim >::get_dataset_names (  )  const [protected, pure virtual]

template<int dim, int spacedim = dim>
virtual std::vector<std_cxx1x::tuple<unsigned int, unsigned int, std::string> > DataOutInterface< dim, spacedim >::get_vector_data_ranges (  )  const [protected, virtual]

This functions returns information about how the individual components of output files that consist of more than one data set are to be interpreted.

It returns a list of index pairs and corresponding name indicating which components of the output are to be considered vector-valued rather than just a collection of scalar data. The index pairs are inclusive; for example, if we have a Stokes problem in 2d with components (u,v,p), then the corresponding vector data range should be (0,1), and the returned list would consist of only a single element with a tuple such as (0,1,"velocity").

Since some of the derived classes do not know about vector data, this function has a default implementation that simply returns an empty string, meaning that all data is to be considered a collection of scalar fields.

Reimplemented in DataOutReader< dim, spacedim >, DataOut_DoFData< DH, patch_dim, patch_space_dim >, DataOut_DoFData< DoFHandler< dim >, DoFHandler< dim >::dimension, DoFHandler< dim >::space_dimension >, DataOut_DoFData< DH, DH::dimension+1 >, DataOut_DoFData< DH, DH::dimension, DH::space_dimension >, and DataOut_DoFData< DH, DH::dimension-1, DH::dimension >.


Member Data Documentation

template<int dim, int spacedim = dim>
unsigned int DataOutInterface< dim, spacedim >::default_subdivisions [protected]

The default number of subdivisions for patches. This is filled by parse_parameters() and should be obeyed by build_patches() in derived classes.

template<int dim, int spacedim = dim>
OutputFormat DataOutInterface< dim, spacedim >::default_fmt [private]

Standard output format. Use this format, if output format default_format is requested. It can be changed by the set_format function or in a parameter file.

template<int dim, int spacedim = dim>
DXFlags DataOutInterface< dim, spacedim >::dx_flags [private]

Flags to be used upon output of OpenDX data. Can be changed by using the set_flags function.

template<int dim, int spacedim = dim>
UcdFlags DataOutInterface< dim, spacedim >::ucd_flags [private]

Flags to be used upon output of UCD data. Can be changed by using the set_flags function.

template<int dim, int spacedim = dim>
GnuplotFlags DataOutInterface< dim, spacedim >::gnuplot_flags [private]

Flags to be used upon output of GNUPLOT data. Can be changed by using the set_flags function.

template<int dim, int spacedim = dim>
PovrayFlags DataOutInterface< dim, spacedim >::povray_flags [private]

Flags to be used upon output of POVRAY data. Can be changed by using the set_flags function.

template<int dim, int spacedim = dim>
EpsFlags DataOutInterface< dim, spacedim >::eps_flags [private]

Flags to be used upon output of EPS data in one space dimension. Can be changed by using the set_flags function.

template<int dim, int spacedim = dim>
GmvFlags DataOutInterface< dim, spacedim >::gmv_flags [private]

Flags to be used upon output of gmv data in one space dimension. Can be changed by using the set_flags function.

template<int dim, int spacedim = dim>
TecplotFlags DataOutInterface< dim, spacedim >::tecplot_flags [private]

Flags to be used upon output of Tecplot data in one space dimension. Can be changed by using the set_flags function.

template<int dim, int spacedim = dim>
VtkFlags DataOutInterface< dim, spacedim >::vtk_flags [private]

Flags to be used upon output of vtk data in one space dimension. Can be changed by using the set_flags function.

template<int dim, int spacedim = dim>
Deal_II_IntermediateFlags DataOutInterface< dim, spacedim >::deal_II_intermediate_flags [private]

Flags to be used upon output of deal.II intermediate data in one space dimension. Can be changed by using the set_flags function.


The documentation for this class was generated from the following file:

deal.II documentation generated on Sat Aug 15 16:51:48 2009 by doxygen 1.5.9