Reference documentation for deal.II version GIT relicensing-716-g780c71344e 2024-05-22 16:20:02+00:00
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Static Private Attributes | List of all members
Patterns::FileName Class Reference

#include <deal.II/base/patterns.h>

Inheritance diagram for Patterns::FileName:
Inheritance graph

Public Types

enum  FileType { input = 0 , output = 1 }
enum  OutputStyle { Machine , Text , LaTeX }

Public Member Functions

 FileName (const FileType type=input)
virtual bool match (const std::string &test_string) const override
virtual std::string description (const OutputStyle style=Machine) const override
virtual std::unique_ptr< PatternBaseclone () const override
virtual std::size_t memory_consumption () const

Static Public Member Functions

static std::unique_ptr< FileNamecreate (const std::string &description)

Public Attributes

FileType file_type

Static Private Attributes

static const char * description_init = "[FileName"

Detailed Description

A pattern that can be used to indicate when a parameter is intended to be the name of a file. By itself, this class does not check whether the string that is given in a parameter file actually corresponds to an existing file (it could, for example, be the name of a file to which you want to write output). Functionally, the class is therefore equivalent to the Anything class. However, it allows to specify the intent of a parameter. The flag given to the constructor also allows to specify whether the file is supposed to be an input or output file.

The reason for the existence of this class is to support graphical user interfaces for editing parameter files. These may open a file selection dialog if the filename is supposed to represent an input file.

Definition at line 1081 of file patterns.h.

Member Enumeration Documentation

◆ FileType

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


Open for input.


Open for output.

Definition at line 1088 of file patterns.h.

◆ OutputStyle

List of possible description output formats.

Capitalization chosen for similarity to ParameterHandler::OutputStyle.


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.


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


Easily human readable LaTeX format suitable for printing in manuals.

Definition at line 96 of file patterns.h.

Constructor & Destructor Documentation

◆ FileName()

Patterns::FileName::FileName ( const FileType  type = input)

Constructor. The type of the file can be specified by choosing the flag.

Definition at line 1525 of file

Member Function Documentation

◆ match()

bool Patterns::FileName::match ( const std::string &  test_string) const

Return true if the string matches its constraints, i.e. always.

Implements Patterns::PatternBase.

Definition at line 1532 of file

◆ description()

std::string Patterns::FileName::description ( const OutputStyle  style = Machine) const

Return a description of the pattern that valid strings are expected to match. Here, this is the string "[Filename]".

Implements Patterns::PatternBase.

Definition at line 1540 of file

◆ clone()

std::unique_ptr< PatternBase > Patterns::FileName::clone ( ) const

Return a copy of the present object, which is newly allocated on the heap. Ownership of that object is transferred to the caller of this function.

Implements Patterns::PatternBase.

Definition at line 1576 of file

◆ create()

std::unique_ptr< FileName > Patterns::FileName::create ( const std::string &  description)

Create a new object if the start of description matches description_init. Ownership of that object is transferred to the caller of this function.

Definition at line 1584 of file

◆ memory_consumption()

std::size_t Patterns::PatternBase::memory_consumption ( ) const

Determine an estimate for the memory consumption (in bytes) of this object. To avoid unnecessary overhead, we do not force derived classes to provide this function as a virtual overloaded one, but rather try to cast the present object to one of the known derived classes and if that fails then take the size of this base class instead and add 32 byte (this value is arbitrary, it should account for virtual function tables, and some possible data elements). Since there are usually not many thousands of objects of this type around, and since the memory_consumption mechanism is used to find out where memory in the range of many megabytes is, this seems like a reasonable approximation.

On the other hand, if you know that your class deviates from this assumption significantly, you can still overload this function.

Reimplemented in Patterns::Selection, Patterns::List, Patterns::Map, Patterns::Tuple, and Patterns::MultipleSelection.

Definition at line 189 of file

Member Data Documentation

◆ file_type

FileType Patterns::FileName::file_type

file type flag

Definition at line 1131 of file patterns.h.

◆ description_init

const char * Patterns::FileName::description_init = "[FileName"

Initial part of description

Definition at line 1145 of file patterns.h.

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