deal.II version 9.7.0
\(\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\}}\)
Loading...
Searching...
No Matches
MultipleParameterLoop::Entry Class Reference

Detailed Description

An object in the list of entries with multiple values.

Definition at line 2217 of file parameter_handler.h.

Public Types

enum  MultipleEntryType { variant , array }

Public Member Functions

 Entry ()
 Entry (const std::vector< std::string > &Path, const std::string &Name, const std::string &Value)
void split_different_values ()
std::size_t memory_consumption () const

Public Attributes

std::vector< std::string > subsection_path
std::string entry_name
std::string entry_value
std::vector< std::string > different_values
MultipleEntryType type

Member Enumeration Documentation

◆ MultipleEntryType

enum MultipleParameterLoop::Entry::MultipleEntryType

Declare what a multiple entry is: a variant entry (in curly braces {, }) or an array (in double curly braces {{, }}).

Enumerator
variant 

A variant entry.

array 

An array entry.

Definition at line 2225 of file parameter_handler.h.

Constructor & Destructor Documentation

◆ Entry() [1/2]

MultipleParameterLoop::Entry::Entry ( )
inline

Constructor

Definition at line 2240 of file parameter_handler.h.

◆ Entry() [2/2]

MultipleParameterLoop::Entry::Entry ( const std::vector< std::string > & Path,
const std::string & Name,
const std::string & Value )

Construct an object with given subsection path, name and value. The splitting up into the different variants is done later by split_different_values.

Definition at line 2441 of file parameter_handler.cc.

Member Function Documentation

◆ split_different_values()

void MultipleParameterLoop::Entry::split_different_values ( )

Split the entry value into the different branches.

Definition at line 2453 of file parameter_handler.cc.

◆ memory_consumption()

std::size_t MultipleParameterLoop::Entry::memory_consumption ( ) const

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

Definition at line 2505 of file parameter_handler.cc.

Member Data Documentation

◆ subsection_path

std::vector<std::string> MultipleParameterLoop::Entry::subsection_path

Path to variant entry.

Definition at line 2262 of file parameter_handler.h.

◆ entry_name

std::string MultipleParameterLoop::Entry::entry_name

Name of entry.

Definition at line 2267 of file parameter_handler.h.

◆ entry_value

std::string MultipleParameterLoop::Entry::entry_value

Original variant value.

Definition at line 2272 of file parameter_handler.h.

◆ different_values

std::vector<std::string> MultipleParameterLoop::Entry::different_values

List of entry values constructed out of what was given in the input file.

Definition at line 2278 of file parameter_handler.h.

◆ type

MultipleEntryType MultipleParameterLoop::Entry::type

Store whether this entry is a variant entry or an array.

Definition at line 2283 of file parameter_handler.h.

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