Reference documentation for deal.II version 8.5.0
Namespaces | Classes | Enumerations
Collaboration diagram for Input:

Namespaces

 Patterns
 

Classes

class  DataOutReader< dim, spacedim >
 
class  Patterns::PatternBase
 
class  Patterns::Integer
 
class  Patterns::Double
 
class  Patterns::Selection
 
class  Patterns::List
 
class  Patterns::Map
 
class  Patterns::MultipleSelection
 
class  Patterns::Bool
 
class  Patterns::Anything
 
class  Patterns::FileName
 
class  Patterns::DirectoryName
 
class  ParameterHandler
 
class  MultipleParameterLoop
 
class  MultipleParameterLoop::Entry
 
class  MultipleParameterLoop::UserClass
 
class  PathSearch
 
class  GridIn< dim, spacedim >
 

Enumerations

enum  Patterns::PatternBase::OutputStyle { Patterns::PatternBase::Machine, Patterns::PatternBase::Text, Patterns::PatternBase::LaTeX }
 
enum  Patterns::FileName::FileType { Patterns::FileName::input = 0, Patterns::FileName::output = 1 }
 
enum  ParameterHandler::OutputStyle {
  ParameterHandler::Text = 1, ParameterHandler::LaTeX = 2, ParameterHandler::Description = 3, ParameterHandler::XML = 4,
  ParameterHandler::JSON = 5, ParameterHandler::ShortText = 193
}
 
enum  MultipleParameterLoop::Entry::MultipleEntryType { MultipleParameterLoop::Entry::variant, MultipleParameterLoop::Entry::array }
 
enum  PathSearch::Position { PathSearch::back, PathSearch::front, PathSearch::after_none }
 
enum  GridIn< dim, spacedim >::Format {
  GridIn< dim, spacedim >::Default, GridIn< dim, spacedim >::unv, GridIn< dim, spacedim >::ucd, GridIn< dim, spacedim >::abaqus,
  GridIn< dim, spacedim >::dbmesh, GridIn< dim, spacedim >::xda, GridIn< dim, spacedim >::msh, GridIn< dim, spacedim >::netcdf,
  GridIn< dim, spacedim >::tecplot, GridIn< dim, spacedim >::vtk
}
 

Detailed Description

deal.II can read meshes in a number of different formats. However, all of them are constrained to so-called "coarse meshes", i.e. meshes that have no refinement hierarchy and in particular no hanging nodes. The GridIn class describes in detail what formats are supported.

In addition, deal.II can read an intermediate graphics format using the DataOutReader. This format is used as an intermediate step between data associated with a simulation and is written by the DataOutBase class (or through the more derived classes described in the Graphical output module). The DataOutReader class reads this data back in, and it can then be converted to any of a number of data formats supported by visualization programs.

Finally, the ParameterHandler and MultipleParameterLoop classes (and the associated Patterns namespace) are used to deal with parameter files describing run-time parameters to a program that one doesn't want to hard-code within the program source.

The PathSearch class

The PathSearch class is a helper class in input handling. It is used to find a file in a list of directories, in much the same way as unix systems find executables among the directories listed in the PATH environment variable.

Enumeration Type Documentation

List of possible description output formats.

Capitalization chosen for similarity to ParameterHandler::OutputStyle.

Enumerator
Machine 

Simple text suitable for machine parsing in the static public member functions for all of the built in inheriting classes.

Preferably human readable, but machine parsing is more critical.

Text 

Easily human readable plain text format suitable for plain text documentation.

LaTeX 

Easily human readable LaTeX format suitable for printing in manuals.

Definition at line 75 of file parameter_handler.h.

Files can be used for input or output. This can be specified in the constructor by choosing the flag type.

Enumerator
input 

Open for input.

output 

Open for output.

Definition at line 794 of file parameter_handler.h.

List of possible output formats.

The formats down the list with prefix Short and bit 6 and 7 set reproduce the old behavior of not writing comments or original values to the files.

Enumerator
Text 

Write human readable output suitable to be read by ParameterHandler again.

LaTeX 

Write parameters as a LaTeX table.

Description 

Write out declared parameters with description and possible values.

XML 

Write out everything as an XML file.

See the general documentation of this class for an example of output.

JSON 

Write out everything as a JSON file.

ShortText 

Write input for ParameterHandler without comments or changed default values.

Definition at line 1580 of file parameter_handler.h.

Declare what a multiple entry is: a variant entry (in curly braces {, }) or an array (in double curly braces {{, }}).

Enumerator
variant 

A variant entry.

array 

An array entry.

Definition at line 2559 of file parameter_handler.h.

Position for adding a new item to a list.

Enumerator
back 

Add new item at end of list.

front 

Add new item at front of list.

after_none 

Add in path list after empty element.

Definition at line 89 of file path_search.h.

template<int dim, int spacedim = dim>
enum GridIn::Format

List of possible mesh input formats. These values are used when calling the function read() in order to determine the actual reader to be called.

Enumerator
Default 

Use GridIn::default_format stored in this object.

unv 

Use read_unv()

ucd 

Use read_ucd()

abaqus 

Use read_abaqus()

dbmesh 

Use read_dbmesh()

xda 

Use read_xda()

msh 

Use read_msh()

netcdf 

Use read_netcdf()

tecplot 

Use read_tecplot()

vtk 

Use read_vtk()

Definition at line 307 of file grid_in.h.