Reference documentation for deal.II version GIT 9c452b2474 2022-05-26 18:30: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:
[legend]

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 981 of file patterns.h.

Member Enumeration Documentation

◆ OutputStyle

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 98 of file patterns.h.

Member Function Documentation

◆ match()

bool Patterns::Selection::match ( const std::string &  test_string) const
overridevirtualinherited

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

Implements Patterns::PatternBase.

Definition at line 546 of file patterns.cc.

◆ memory_consumption()

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

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

Reimplemented from Patterns::PatternBase.

Definition at line 620 of file patterns.cc.

Member Data Documentation

◆ sequence

std::string Patterns::Selection::sequence
privateinherited

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 434 of file patterns.h.


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