Reference documentation for deal.II version 8.5.0
Classes | Enumerations
Textual output
Collaboration diagram for Textual output:

Classes

class  ConditionalOStream
 
class  ConvergenceTable
 
class  LogStream
 
class  LogStream::Prefix
 
class  TableHandler
 
struct  TableHandler::Column
 
class  Histogram
 
struct  Histogram::Interval
 

Enumerations

enum  ConvergenceTable::RateMode { ConvergenceTable::none, ConvergenceTable::reduction_rate, ConvergenceTable::reduction_rate_log2 }
 
enum  TableHandler::TextOutputFormat { TableHandler::table_with_headers, TableHandler::table_with_separate_column_description, TableHandler::simple_table_with_separate_column_description, TableHandler::org_mode_table }
 
enum  Histogram::IntervalSpacing { Histogram::linear, Histogram::logarithmic }
 

Detailed Description

In addition to classes that provide graphical output formats (see the Graphical output module), deal.II has a number of classes that facilitate textual output in a number of ways. They are collected in this module. See the documentation of these classes for more details.

Enumeration Type Documentation

Rate in relation to the rows.

Enumerator
none 

Do not do anything.

reduction_rate 

Quotient of values in the previous row and in this row.

reduction_rate_log2 

Logarithm of reduction_rate to the base 2 representing the order of convergence when halving the grid size, e.g. from h to h/2.

Definition at line 73 of file convergence_table.h.

Set of options how a table should be formatted when output with the write_text() function. The following possibilities exist:

  • table_with_headers: The table is formatted in such a way that the contents are aligned under the key of each column, i.e. the key sits atop each column. This is suitable for tables with few columns where the entire table can be displayed on the screen. Output looks like this:
    key1 key2 key3
    0 0 ""
    1 0 ""
    2 13 a
    1 0 ""
  • table_with_separate_column_description: This is a better format when there are many columns and the table as a whole can not be displayed on the screen. Here, the column keys are first listed one-by- one on lines of their own, and are numbered for better readability. In addition, each of these description lines are prefixed by '#' to mark these lines as comments for programs that want to read the following table as data and should ignore these descriptive lines. GNUPLOT is one such program that will automatically ignore lines so prefixed. Output with this option looks like this:
    # 1: key1
    # 2: key2
    # 3: key3
    0 0 ""
    1 0 ""
    2 13 a
    1 0 ""
  • simple_table_with_separate_column_description: This format is very similar to table_with_separate_column_description, but it skips aligning the columns with additional white space. This increases the performance of write_text() for large tables. Example output:
    # 1: key1
    # 2: key2
    # 3: key3
    0 0 ""
    1 0 ""
    2 13 a
    1 0 ""
  • org_mode_table: Outputs to org-mode (http://orgmode.org/) table format. It is easy to convert org-mode tables to HTML/LaTeX/csv. Example output:
    | key1 | key2 | key3 |
    | 0 | 0 | "" |
    | 1 | 0 | "" |
    | 2 | 13 | a |
    | 1 | 0 | "" |
Enumerator
table_with_headers 

Print the table with headers.

table_with_separate_column_description 

Print the table with separate lines for each column label.

simple_table_with_separate_column_description 

Like table_with_separate_column_description, but without aligning the column containing the column labels.

org_mode_table 

Print the table in org mode format.

Definition at line 323 of file table_handler.h.

Definition of several ways to arrange the spacing of intervals.

Enumerator
linear 

Space intervals linearly.

logarithmic 

Space intervals logarithmically.

Definition at line 75 of file histogram.h.