Reference documentation for deal.II version GIT relicensing-687-gbf51c6da8c 2024-05-21 02:00: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 | Private Attributes | Static Private Attributes | List of all members
Patterns::MultipleSelection Class Reference

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

Inheritance diagram for Patterns::MultipleSelection:
Inheritance graph

Public Types

enum  OutputStyle { Machine , Text , LaTeX }

Public Member Functions

 MultipleSelection (const std::string &seq)
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
std::size_t memory_consumption () const override

Static Public Member Functions

static std::unique_ptr< MultipleSelectioncreate (const std::string &description)
static ::ExceptionBaseExcCommasNotAllowed (int arg1)

Private Attributes

std::string sequence

Static Private Attributes

static const char * description_init = "[MultipleSelection"

Detailed Description

This class is much like the Selection class, but it allows the input to be a comma-separated list of values which each have to be given in the constructor argument. The input is allowed to be empty or contain values more than once and have an arbitrary number of spaces around commas. Of course commas are not allowed inside the values given to the constructor.

For example, if the string to the constructor was "ucd|gmv|eps", then the following would be legal inputs: "eps", "gmv, eps", or "".

Definition at line 902 of file patterns.h.

Member Enumeration Documentation

◆ 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

◆ MultipleSelection()

Patterns::MultipleSelection::MultipleSelection ( const std::string &  seq)

Constructor. seq is a list of valid options separated by "|".

Definition at line 1255 of file

Member Function Documentation

◆ match()

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

Return true if the string is an element of the description list passed to the constructor.

Implements Patterns::PatternBase.

Definition at line 1270 of file

◆ description()

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

Return a description of the pattern that valid strings are expected to match. Here, this is the list of valid strings passed to the constructor.

Implements Patterns::PatternBase.

Definition at line 1333 of file

◆ clone()

std::unique_ptr< PatternBase > Patterns::MultipleSelection::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 1368 of file

◆ create()

std::unique_ptr< MultipleSelection > Patterns::MultipleSelection::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 1384 of file

◆ memory_consumption()

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

Determine an estimate for the memory consumption (in bytes) of this object.

Reimplemented from Patterns::PatternBase.

Definition at line 1375 of file

Member Data Documentation

◆ sequence

std::string Patterns::MultipleSelection::sequence

List of valid strings as passed to the constructor. We don't make this string constant, as we process it somewhat in the constructor.

Definition at line 967 of file patterns.h.

◆ description_init

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

Initial part of description

Definition at line 972 of file patterns.h.

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