Reference documentation for deal.II version Git a3b517947a 2019-09-22 22:52:08 -0400
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
GridOutFlags::Ucd Struct Reference

#include <deal.II/grid/grid_out.h>

Public Member Functions

 Ucd (const bool write_preamble=false, const bool write_faces=false, const bool write_lines=false)
 
void parse_parameters (ParameterHandler &param)
 

Static Public Member Functions

static void declare_parameters (ParameterHandler &param)
 

Public Attributes

bool write_preamble
 
bool write_faces
 
bool write_lines
 

Detailed Description

Flags describing the details of output in UCD format.

Definition at line 165 of file grid_out.h.

Constructor & Destructor Documentation

◆ Ucd()

GridOutFlags::Ucd::Ucd ( const bool  write_preamble = false,
const bool  write_faces = false,
const bool  write_lines = false 
)

Constructor.

Definition at line 119 of file grid_out.cc.

Member Function Documentation

◆ declare_parameters()

void GridOutFlags::Ucd::declare_parameters ( ParameterHandler param)
static

Declare parameters in ParameterHandler.

Definition at line 130 of file grid_out.cc.

◆ parse_parameters()

void GridOutFlags::Ucd::parse_parameters ( ParameterHandler param)

Parse parameters of ParameterHandler.

Definition at line 139 of file grid_out.cc.

Member Data Documentation

◆ write_preamble

bool GridOutFlags::Ucd::write_preamble

Write a comment at the beginning of the file stating the date of creation and some other data. While this is supported by the UCD format (and the AVS program), some other programs get confused by this, so the default is to not write a preamble. However, a preamble can be written using this flag.

Default: false.

Definition at line 176 of file grid_out.h.

◆ write_faces

bool GridOutFlags::Ucd::write_faces

When writing a mesh, write boundary faces explicitly if their boundary indicator is not the default boundary indicator, which is zero. This is necessary if you later want to re-read the grid and want to get the same boundary indicators for the different parts of the boundary of the triangulation.

It is not necessary if you only want to write the triangulation to view or print it.

Default: false.

Definition at line 190 of file grid_out.h.

◆ write_lines

bool GridOutFlags::Ucd::write_lines

When writing a mesh, write boundary lines explicitly if their boundary indicator is not the default boundary indicator, which is zero. This is necessary if you later want to re-read the grid and want to get the same boundary indicators for the different parts of the boundary of the triangulation.

It is not necessary if you only want to write the triangulation to view or print it.

This directive is ignored if dim!=3.

Default: false.

Definition at line 206 of file grid_out.h.


The documentation for this struct was generated from the following files: