![]() |
Reference documentation for deal.II version 8.1.0
|
#include <data_out_base.h>
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_vtu (std::ostream &out) const |
void | write_vtu_in_parallel (const char *filename, MPI_Comm comm) const |
void | write_pvtu_record (std::ostream &out, const std::vector< std::string > &piece_names) const |
void | write_pvd_record (std::ostream &out, const std::vector< std::pair< double, std::string > > ×_and_names) const |
void | write_visit_record (std::ostream &out, const std::vector< std::string > &piece_names) const |
void | write_visit_record (std::ostream &out, const std::vector< std::vector< std::string > > &piece_names) const |
void | write_svg (std::ostream &out) const |
void | write_deal_II_intermediate (std::ostream &out) const |
XDMFEntry | create_xdmf_entry (const std::string &h5_filename, const double cur_time, MPI_Comm comm) const DEAL_II_DEPRECATED |
XDMFEntry | create_xdmf_entry (const DataOutFilter &data_filter, const std::string &h5_filename, const double cur_time, MPI_Comm comm) const |
XDMFEntry | create_xdmf_entry (const DataOutFilter &data_filter, const std::string &h5_mesh_filename, const std::string &h5_solution_filename, const double cur_time, MPI_Comm comm) const |
void | write_xdmf_file (const std::vector< XDMFEntry > &entries, const std::string &filename, MPI_Comm comm) const |
void | write_hdf5_parallel (const std::string &filename, MPI_Comm comm) const DEAL_II_DEPRECATED |
void | write_hdf5_parallel (const DataOutFilter &data_filter, const std::string &filename, MPI_Comm comm) const |
void | write_hdf5_parallel (const DataOutFilter &data_filter, const bool write_mesh_file, const std::string &mesh_filename, const std::string &solution_filename, MPI_Comm comm) const |
void | write_filtered_data (DataOutFilter &filtered_data) 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 SvgFlags &svg_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) |
std::size_t | 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 |
SvgFlags | svg_flags |
Deal_II_IntermediateFlags | deal_II_intermediate_flags |
Additional Inherited Members | |
![]() | |
enum | OutputFormat { default_format, none, dx, ucd, gnuplot, povray, eps, gmv, tecplot, tecplot_binary, vtk, vtu, svg, deal_II_intermediate, hdf5 } |
![]() | |
DeclException2 (ExcInvalidDatasetSize, int, int,<< "The number of points in this data set is "<< arg1<< ", but we expected "<< arg2<< " in each space direction.") | |
DeclException0 (ExcNoPatches) | |
DeclException0 (ExcTecplotAPIError) | |
DeclException1 (ExcErrorOpeningTecplotFile, char *,<< "There was an error opening Tecplot file "<< arg1<< " for output") | |
![]() | |
template<int dim, int spacedim> | |
static void | write_dx (const std::vector< Patch< dim, spacedim > > &patches, const std::vector< std::string > &data_names, const std::vector< std_cxx1x::tuple< unsigned int, unsigned int, std::string > > &vector_data_ranges, const DXFlags &flags, std::ostream &out) |
template<int dim, int spacedim> | |
static void | write_eps (const std::vector< Patch< dim, spacedim > > &patches, const std::vector< std::string > &data_names, const std::vector< std_cxx1x::tuple< unsigned int, unsigned int, std::string > > &vector_data_ranges, const EpsFlags &flags, std::ostream &out) |
template<int dim, int spacedim> | |
static void | write_gmv (const std::vector< Patch< dim, spacedim > > &patches, const std::vector< std::string > &data_names, const std::vector< std_cxx1x::tuple< unsigned int, unsigned int, std::string > > &vector_data_ranges, const GmvFlags &flags, std::ostream &out) |
template<int dim, int spacedim> | |
static void | write_gnuplot (const std::vector< Patch< dim, spacedim > > &patches, const std::vector< std::string > &data_names, const std::vector< std_cxx1x::tuple< unsigned int, unsigned int, std::string > > &vector_data_ranges, const GnuplotFlags &flags, std::ostream &out) |
template<int dim, int spacedim> | |
static void | write_povray (const std::vector< Patch< dim, spacedim > > &patches, const std::vector< std::string > &data_names, const std::vector< std_cxx1x::tuple< unsigned int, unsigned int, std::string > > &vector_data_ranges, const PovrayFlags &flags, std::ostream &out) |
template<int dim, int spacedim> | |
static void | write_tecplot (const std::vector< Patch< dim, spacedim > > &patches, const std::vector< std::string > &data_names, const std::vector< std_cxx1x::tuple< unsigned int, unsigned int, std::string > > &vector_data_ranges, const TecplotFlags &flags, std::ostream &out) |
template<int dim, int spacedim> | |
static void | write_tecplot_binary (const std::vector< Patch< dim, spacedim > > &patches, const std::vector< std::string > &data_names, const std::vector< std_cxx1x::tuple< unsigned int, unsigned int, std::string > > &vector_data_ranges, const TecplotFlags &flags, std::ostream &out) |
template<int dim, int spacedim> | |
static void | write_ucd (const std::vector< Patch< dim, spacedim > > &patches, const std::vector< std::string > &data_names, const std::vector< std_cxx1x::tuple< unsigned int, unsigned int, std::string > > &vector_data_ranges, const UcdFlags &flags, std::ostream &out) |
template<int dim, int spacedim> | |
static void | write_vtk (const std::vector< Patch< dim, spacedim > > &patches, const std::vector< std::string > &data_names, const std::vector< std_cxx1x::tuple< unsigned int, unsigned int, std::string > > &vector_data_ranges, const VtkFlags &flags, std::ostream &out) |
template<int dim, int spacedim> | |
static void | write_vtu (const std::vector< Patch< dim, spacedim > > &patches, const std::vector< std::string > &data_names, const std::vector< std_cxx1x::tuple< unsigned int, unsigned int, std::string > > &vector_data_ranges, const VtkFlags &flags, std::ostream &out) |
static void | write_vtu_header (std::ostream &out, const VtkFlags &flags) |
static void | write_vtu_footer (std::ostream &out) |
template<int dim, int spacedim> | |
static void | write_vtu_main (const std::vector< Patch< dim, spacedim > > &patches, const std::vector< std::string > &data_names, const std::vector< std_cxx1x::tuple< unsigned int, unsigned int, std::string > > &vector_data_ranges, const VtkFlags &flags, std::ostream &out) |
template<int dim, int spacedim> | |
static void | write_svg (const std::vector< Patch< dim, spacedim > > &patches, const std::vector< std::string > &data_names, const std::vector< std_cxx1x::tuple< unsigned int, unsigned int, std::string > > &vector_data_ranges, const SvgFlags &flags, std::ostream &out) |
template<int dim, int spacedim> | |
static void | write_deal_II_intermediate (const std::vector< Patch< dim, spacedim > > &patches, const std::vector< std::string > &data_names, const std::vector< std_cxx1x::tuple< unsigned int, unsigned int, std::string > > &vector_data_ranges, const Deal_II_IntermediateFlags &flags, std::ostream &out) |
template<int dim, int spacedim> | |
static void | write_hdf5_parallel (const std::vector< Patch< dim, spacedim > > &patches, const DataOutFilter &data_filter, const std::string &filename, MPI_Comm comm) |
template<int dim, int spacedim> | |
static void | write_hdf5_parallel (const std::vector< Patch< dim, spacedim > > &patches, const DataOutFilter &data_filter, const bool write_mesh_file, const std::string &mesh_filename, const std::string &solution_filename, MPI_Comm comm) |
template<int dim, int spacedim> | |
static void | write_filtered_data (const std::vector< Patch< dim, spacedim > > &patches, const std::vector< std::string > &data_names, const std::vector< std_cxx1x::tuple< unsigned int, unsigned int, std::string > > &vector_data_ranges, DataOutFilter &filtered_data) |
static std::pair< unsigned int, unsigned int > | determine_intermediate_format_dimensions (std::istream &input) |
static OutputFormat | parse_output_format (const std::string &format_name) |
static std::string | get_output_format_names () |
static std::string | default_suffix (const OutputFormat output_format) |
static std::size_t | memory_consumption () |
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() 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.
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.
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:
Note that in the present example, the class DataOut
was used. However, any other class derived from DataOutInterface
would work alike.
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.
Definition at line 2283 of file data_out_base.h.
enum DataOutBase::OutputFormat |
Provide a data type specifying the presently supported output formats.
Definition at line 1385 of file data_out_base.h.
DataOutInterface< dim, spacedim >::DataOutInterface | ( | ) |
Constructor.
|
virtual |
Destructor. Does nothing, but is declared virtual since this class has virtual functions.
void DataOutInterface< dim, spacedim >::write_dx | ( | std::ostream & | out | ) | const |
Obtain data through get_patches() and write it to out
in OpenDX format. See DataOutBase::write_dx.
void DataOutInterface< dim, spacedim >::write_eps | ( | std::ostream & | out | ) | const |
Obtain data through get_patches() and write it to out
in EPS format. See DataOutBase::write_eps.
void DataOutInterface< dim, spacedim >::write_gmv | ( | std::ostream & | out | ) | const |
Obtain data through get_patches() and write it to out
in GMV format. See DataOutBase::write_gmv.
void DataOutInterface< dim, spacedim >::write_gnuplot | ( | std::ostream & | out | ) | const |
Obtain data through get_patches() and write it to out
in GNUPLOT format. See DataOutBase::write_gnuplot.
void DataOutInterface< dim, spacedim >::write_povray | ( | std::ostream & | out | ) | const |
Obtain data through get_patches() and write it to out
in POVRAY format. See DataOutBase::write_povray.
void DataOutInterface< dim, spacedim >::write_tecplot | ( | std::ostream & | out | ) | const |
Obtain data through get_patches() and write it to out
in Tecplot format. See DataOutBase::write_tecplot.
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.
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. See DataOutBase::write_ucd.
void DataOutInterface< dim, spacedim >::write_vtk | ( | std::ostream & | out | ) | const |
Obtain data through get_patches() and write it to out
in Vtk format. See DataOutBase::write_vtk.
void DataOutInterface< dim, spacedim >::write_vtu | ( | std::ostream & | out | ) | const |
Obtain data through get_patches() and write it to out
in Vtu (VTK's XML) format. See DataOutBase::write_vtu.
Some visualization programs, such as ParaView, can read several separate VTU files to parallelize visualization. In that case, you need a .pvtu
file that describes which VTU files form a group. The DataOutInterface::write_pvtu_record() function can generate such a master record. Likewise, DataOutInterface::write_visit_record() does the same for VisIt. Finally, DataOutInterface::write_pvd_record() can be used to group together the files that jointly make up a time dependent simulation.
void DataOutInterface< dim, spacedim >::write_vtu_in_parallel | ( | const char * | filename, |
MPI_Comm | comm | ||
) | const |
Collective MPI call to write the solution from all participating nodes (those in the given communicator) to a single compressed .vtu file on a shared file system. The communicator can be a sub communicator of the one used by the computation. This routine uses MPI I/O to achieve high performance on parallel filesystems. Also see DataOutInterface::write_vtu().
void DataOutInterface< dim, spacedim >::write_pvtu_record | ( | std::ostream & | out, |
const std::vector< std::string > & | piece_names | ||
) | const |
Some visualization programs, such as ParaView, can read several separate VTU files to parallelize visualization. In that case, you need a .pvtu
file that describes which VTU files (written, for example, through the write_vtu() function) form a group. The current function can generate such a master record.
The file so written contains a list of (scalar or vector) fields whose values are described by the individual files that comprise the set of parallel VTU files along with the names of these files. This function gets the names and types of fields through the get_patches() function of this class like all the other write_xxx() functions. The second argument to this function specifies the names of the files that form the parallel set.
pvtu
files that each describe one time step of a time dependent simulation, see the DataOutInterface::write_pvd_record() function.pvtu
records. However, it can read visit records as written by the write_visit_record() function. void DataOutInterface< dim, spacedim >::write_pvd_record | ( | std::ostream & | out, |
const std::vector< std::pair< double, std::string > > & | times_and_names | ||
) | const |
In ParaView it is possible to visualize time-dependent data tagged with the current integration time of a time dependent simulation. To use this feature you need a .pvd
file that describes which VTU or PVTU file belongs to which timestep. This function writes a file that provides this mapping, i.e., it takes a list of pairs each of which indicates a particular time instant and the corresponding file that contains the graphical data for this time instant.
A typical use case, in program that computes a time dependent solution, would be the following (time
and time_step
are member variables of the class with types double
and unsigned int
, respectively; the variable times_and_names
is of type std::vector<std::pair<double,std::string> >
):
.pvtu
file that references multiple parts of a parallel computation.void DataOutInterface< dim, spacedim >::write_visit_record | ( | std::ostream & | out, |
const std::vector< std::string > & | piece_names | ||
) | const |
This function is the exact equivalent of the write_pvtu_record() function but for the VisIt visualization program and for one visualization graph (or one time step only). See there for the purpose of this function.
This function is documented in the "Creating a master file for parallel" section (section 5.7) of the "Getting data into VisIt" report that can be found here: https://wci.llnl.gov/codes/visit/2.0.0/GettingDataIntoVisIt2.0.0.pdf
void DataOutInterface< dim, spacedim >::write_visit_record | ( | std::ostream & | out, |
const std::vector< std::vector< std::string > > & | piece_names | ||
) | const |
This function is equivalent to the write_visit_record() above but for multiple time steps. Here is an example of how the function would be used:
This function is documented in the "Creating a master file for parallel" section (section 5.7) of the "Getting data into VisIt" report that can be found here: https://wci.llnl.gov/codes/visit/2.0.0/GettingDataIntoVisIt2.0.0.pdf
void DataOutInterface< dim, spacedim >::write_svg | ( | std::ostream & | out | ) | const |
Obtain data through get_patches() and write it to out
in SVG format. See DataOutBase::write_svg.
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 DataOutBase::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.
XDMFEntry DataOutInterface< dim, spacedim >::create_xdmf_entry | ( | const std::string & | h5_filename, |
const double | cur_time, | ||
MPI_Comm | comm | ||
) | const |
Create an XDMFEntry based on the data in this DataOutInterface.
XDMFEntry DataOutInterface< dim, spacedim >::create_xdmf_entry | ( | const DataOutFilter & | data_filter, |
const std::string & | h5_filename, | ||
const double | cur_time, | ||
MPI_Comm | comm | ||
) | const |
Create an XDMFEntry based on the data in the data_filter. This assumes the mesh and solution data were written to a single file. See write_xdmf_file() for an example of usage.
XDMFEntry DataOutInterface< dim, spacedim >::create_xdmf_entry | ( | const DataOutFilter & | data_filter, |
const std::string & | h5_mesh_filename, | ||
const std::string & | h5_solution_filename, | ||
const double | cur_time, | ||
MPI_Comm | comm | ||
) | const |
Create an XDMFEntry based on the data in the data_filter. This assumes the mesh and solution data were written to separate files. See write_xdmf_file() for an example of usage.
void DataOutInterface< dim, spacedim >::write_xdmf_file | ( | const std::vector< XDMFEntry > & | entries, |
const std::string & | filename, | ||
MPI_Comm | comm | ||
) | const |
Write an XDMF file based on the provided vector of XDMFEntry objects. Below is an example of how to use this function with HDF5 and the DataOutFilter:
void DataOutInterface< dim, spacedim >::write_hdf5_parallel | ( | const std::string & | filename, |
MPI_Comm | comm | ||
) | const |
Write the data in this class without redundancy filtering to a single HDF5 file containing both the mesh and solution values.
void DataOutInterface< dim, spacedim >::write_hdf5_parallel | ( | const DataOutFilter & | data_filter, |
const std::string & | filename, | ||
MPI_Comm | comm | ||
) | const |
Write the data in data_filter to a single HDF5 file containing both the mesh and solution values. Below is an example of how to use this function with the DataOutFilter:
void DataOutInterface< dim, spacedim >::write_hdf5_parallel | ( | const DataOutFilter & | data_filter, |
const bool | write_mesh_file, | ||
const std::string & | mesh_filename, | ||
const std::string & | solution_filename, | ||
MPI_Comm | comm | ||
) | const |
Write the data in data_filter to HDF5 file(s). If write_mesh_file is false, the mesh data will not be written and the solution file will contain only the solution values. If write_mesh_file is true and the filenames are the same, the resulting file will contain both mesh data and solution values.
void DataOutInterface< dim, spacedim >::write_filtered_data | ( | DataOutFilter & | filtered_data | ) | const |
DataOutFilter is an intermediate data format that reduces the amount of data that will be written to files. The object filled by this function can then later be used again to write data in a concrete file format; see, for example, DataOutBase::write_hdf5_parallel().
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
.
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.
void DataOutInterface< dim, spacedim >::set_flags | ( | const DXFlags & | dx_flags | ) |
Set the flags to be used for output in OpenDX format.
void DataOutInterface< dim, spacedim >::set_flags | ( | const UcdFlags & | ucd_flags | ) |
Set the flags to be used for output in UCD format.
void DataOutInterface< dim, spacedim >::set_flags | ( | const GnuplotFlags & | gnuplot_flags | ) |
Set the flags to be used for output in GNUPLOT format.
void DataOutInterface< dim, spacedim >::set_flags | ( | const PovrayFlags & | povray_flags | ) |
Set the flags to be used for output in POVRAY format.
void DataOutInterface< dim, spacedim >::set_flags | ( | const EpsFlags & | eps_flags | ) |
Set the flags to be used for output in EPS output.
void DataOutInterface< dim, spacedim >::set_flags | ( | const GmvFlags & | gmv_flags | ) |
Set the flags to be used for output in GMV format.
void DataOutInterface< dim, spacedim >::set_flags | ( | const TecplotFlags & | tecplot_flags | ) |
Set the flags to be used for output in Tecplot format.
void DataOutInterface< dim, spacedim >::set_flags | ( | const VtkFlags & | vtk_flags | ) |
Set the flags to be used for output in VTK format.
void DataOutInterface< dim, spacedim >::set_flags | ( | const SvgFlags & | svg_flags | ) |
Set the flags to be used for output in SVG format.
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.
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, i.e. the correct suffix for the format that was set through set_default_format() or parse_parameters() before calling this function.
|
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.
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.
std::size_t 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.
|
protectedpure 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 >, DataOut_DoFData< DH, patch_dim, patch_space_dim >, DataOut_DoFData< DH, DH::dimension, DH::space_dimension >, DataOut_DoFData< DoFHandler< dim >, DoFHandler< dim >::dimension, DoFHandler< dim >::space_dimension >, DataOut_DoFData< DH, DH::dimension+1 >, DataOut_DoFData< DH, DH::dimension-1, DH::dimension >, DataOutStack< dim, spacedim, DH >, and MatrixOut.
|
protectedpure virtual |
Abstract virtual function through which the names of data sets are obtained by the output functions of the base class.
Implemented in DataOutReader< dim, spacedim >, DataOut_DoFData< DH, patch_dim, patch_space_dim >, DataOut_DoFData< DH, DH::dimension, DH::space_dimension >, DataOut_DoFData< DoFHandler< dim >, DoFHandler< dim >::dimension, DoFHandler< dim >::space_dimension >, DataOut_DoFData< DH, DH::dimension+1 >, DataOut_DoFData< DH, DH::dimension-1, DH::dimension >, DataOutStack< dim, spacedim, DH >, and MatrixOut.
|
protectedvirtual |
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< DH, DH::dimension, DH::space_dimension >, DataOut_DoFData< DoFHandler< dim >, DoFHandler< dim >::dimension, DoFHandler< dim >::space_dimension >, DataOut_DoFData< DH, DH::dimension+1 >, and DataOut_DoFData< DH, DH::dimension-1, DH::dimension >.
|
protected |
The default number of subdivisions for patches. This is filled by parse_parameters() and should be obeyed by build_patches() in derived classes.
Definition at line 2882 of file data_out_base.h.
|
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.
Definition at line 2890 of file data_out_base.h.
|
private |
Flags to be used upon output of OpenDX data. Can be changed by using the set_flags
function.
Definition at line 2896 of file data_out_base.h.
|
private |
Flags to be used upon output of UCD data. Can be changed by using the set_flags
function.
Definition at line 2902 of file data_out_base.h.
|
private |
Flags to be used upon output of GNUPLOT data. Can be changed by using the set_flags
function.
Definition at line 2908 of file data_out_base.h.
|
private |
Flags to be used upon output of POVRAY data. Can be changed by using the set_flags
function.
Definition at line 2914 of file data_out_base.h.
|
private |
Flags to be used upon output of EPS data in one space dimension. Can be changed by using the set_flags
function.
Definition at line 2921 of file data_out_base.h.
|
private |
Flags to be used upon output of gmv data in one space dimension. Can be changed by using the set_flags
function.
Definition at line 2928 of file data_out_base.h.
|
private |
Flags to be used upon output of Tecplot data in one space dimension. Can be changed by using the set_flags
function.
Definition at line 2935 of file data_out_base.h.
|
private |
Flags to be used upon output of vtk data in one space dimension. Can be changed by using the set_flags
function.
Definition at line 2942 of file data_out_base.h.
|
private |
Flags to be used upon output of svg data in one space dimension. Can be changed by using the set_flags
function.
Definition at line 2949 of file data_out_base.h.
|
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.
Definition at line 2956 of file data_out_base.h.