Reference documentation for deal.II version GIT c14369f203 2023-10-01 07:40: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\}}\)
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | Static Private Attributes | List of all members
Patterns::Bool Class Reference

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

Inheritance diagram for Patterns::Bool:

Public Types

enum  OutputStyle { Machine , Text , LaTeX }

Public Member Functions

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

Static Public Member Functions

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

Private Attributes

std::string sequence

Static Private Attributes

static const char * description_init = "[Bool"

Detailed Description

Test for the string being either "true" or "false". This is mapped to the Selection class.

Definition at line 980 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 97 of file patterns.h.

Constructor & Destructor Documentation

◆ Bool()

Patterns::Bool::Bool ( )


Definition at line 1407 of file

Member Function Documentation

◆ description()

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

Return a description of the pattern that valid strings are expected to match.

Reimplemented from Patterns::Selection.

Definition at line 1414 of file

◆ clone()

std::unique_ptr< PatternBase > Patterns::Bool::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.

Reimplemented from Patterns::Selection.

Definition at line 1442 of file

◆ create()

std::unique_ptr< Bool > Patterns::Bool::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 1450 of file

◆ match()

bool Patterns::Selection::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 544 of file

◆ memory_consumption()

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

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

Reimplemented from Patterns::PatternBase.

Definition at line 618 of file

Member Data Documentation

◆ description_init

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

Initial part of description

Definition at line 1015 of file patterns.h.

◆ sequence

std::string Patterns::Selection::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 433 of file patterns.h.

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