Reference documentation for deal.II version GIT f3d24b0aad 2022-12-01 05: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\}}\)
ParameterHandler Member List

This is the complete list of members for ParameterHandler, including all inherited members.

actionsParameterHandlerprivate
add_action(const std::string &entry, const std::function< void(const std::string &value)> &action)ParameterHandler
add_parameter(const std::string &entry, ParameterType &parameter, const std::string &documentation="", const Patterns::PatternBase &pattern= *Patterns::Tools::Convert< ParameterType >::to_pattern(), const bool has_to_be_set=false)ParameterHandler
assert_that_entries_have_been_set() constParameterHandler
check_no_subscribers() const noexceptSubscriptorprivate
clear()ParameterHandler
counterSubscriptormutableprivate
counter_mapSubscriptormutableprivate
declare_alias(const std::string &existing_entry_name, const std::string &alias_name, const bool alias_is_deprecated=false)ParameterHandler
declare_entry(const std::string &entry, const std::string &default_value, const Patterns::PatternBase &pattern=Patterns::Anything(), const std::string &documentation="", const bool has_to_be_set=false)ParameterHandler
DefaultStyle enum valueParameterHandler
Description enum valueParameterHandler
enter_subsection(const std::string &subsection)ParameterHandler
entriesParameterHandlerprivate
entries_set_statusParameterHandlerprivate
ExcAlreadyAtTopLevel()ParameterHandlerstatic
ExcCannotOpenIncludeStatementFile(int arg1, std::string arg2, std::string arg3)ParameterHandlerstatic
ExcCannotParseLine(int arg1, std::string arg2, std::string arg3)ParameterHandlerstatic
ExcEntryAlreadyExists(std::string arg1)ParameterHandlerstatic
ExcEntryUndeclared(std::string arg1)ParameterHandlerstatic
ExcInUse(int arg1, std::string arg2, std::string arg3)Subscriptorstatic
ExcInvalidEntryForPattern(int arg1, std::string arg2, std::string arg3, std::string arg4, std::string arg5)ParameterHandlerstatic
ExcInvalidXMLParameterFile()ParameterHandlerstatic
ExcNoSubscriber(std::string arg1, std::string arg2)Subscriptorstatic
ExcNoSubsection(int arg1, std::string arg2, std::string arg3)ParameterHandlerstatic
ExcUnbalancedSubsections(std::string arg1, std::string arg2)ParameterHandlerstatic
ExcValueDoesNotMatchPattern(std::string arg1, std::string arg2)ParameterHandlerstatic
get(const std::string &entry_string) constParameterHandler
get(const std::vector< std::string > &entry_subsection_path, const std::string &entry_string) constParameterHandler
get_bool(const std::string &entry_name) constParameterHandler
get_bool(const std::vector< std::string > &entry_subsection_path, const std::string &entry_string) constParameterHandler
get_current_full_path(const std::string &name) constParameterHandlerprivate
get_current_full_path(const std::vector< std::string > &sub_path, const std::string &name) constParameterHandlerprivate
get_current_path() constParameterHandlerprivate
get_double(const std::string &entry_name) constParameterHandler
get_double(const std::vector< std::string > &entry_subsection_path, const std::string &entry_string) constParameterHandler
get_entries_wrongly_not_set() constParameterHandler
get_integer(const std::string &entry_string) constParameterHandler
get_integer(const std::vector< std::string > &entry_subsection_path, const std::string &entry_string) constParameterHandler
JSON enum valueParameterHandler
KeepDeclarationOrder enum valueParameterHandler
LaTeX enum valueParameterHandler
leave_subsection()ParameterHandler
list_subscribers(StreamType &stream) constSubscriptorinline
list_subscribers() constSubscriptor
load(Archive &ar, const unsigned int version)ParameterHandlerinline
log_parameters(LogStream &out, const OutputStyle style=DefaultStyle)ParameterHandler
log_parameters_section(LogStream &out, const OutputStyle style=DefaultStyle)ParameterHandler
map_iterator typedefSubscriptorprivate
map_value_type typedefSubscriptorprivate
memory_consumption() constParameterHandler
MultipleParameterLoop classParameterHandlerfriend
mutexSubscriptorprivatestatic
n_subscriptions() constSubscriptorinline
object_infoSubscriptormutableprivate
operator=(const ParameterHandler &)=deleteParameterHandler
Subscriptor::operator=(const Subscriptor &)Subscriptorinline
Subscriptor::operator=(Subscriptor &&) noexceptSubscriptor
operator==(const ParameterHandler &prm2) constParameterHandler
OutputStyle enum nameParameterHandler
ParameterHandler()ParameterHandler
ParameterHandler(const ParameterHandler &)=deleteParameterHandler
parse_input(std::istream &input, const std::string &filename="input file", const std::string &last_line="", const bool skip_undefined=false)ParameterHandlervirtual
parse_input(const std::string &filename, const std::string &last_line="", const bool skip_undefined=false, const bool assert_mandatory_entries_are_found=false)ParameterHandlervirtual
parse_input_from_json(std::istream &input, const bool skip_undefined=false)ParameterHandlervirtual
parse_input_from_string(const std::string &s, const std::string &last_line="", const bool skip_undefined=false)ParameterHandlervirtual
parse_input_from_xml(std::istream &input, const bool skip_undefined=false)ParameterHandlervirtual
path_separatorParameterHandlerprivatestatic
patternsParameterHandlerprivate
print_parameters(std::ostream &out, const OutputStyle style) constParameterHandler
print_parameters(const std::string &filename, const OutputStyle style=DefaultStyle) constParameterHandler
PRM enum valueParameterHandler
recursively_print_parameters(const boost::property_tree::ptree &tree, const std::vector< std::string > &target_subsection_path, const ParameterHandler::OutputStyle style, const unsigned int indent_level, std::ostream &out) constParameterHandlerprivate
save(Archive &ar, const unsigned int version) constParameterHandlerinline
scan_line(std::string line, const std::string &input_filename, const unsigned int current_line_n, const bool skip_undefined)ParameterHandlerprivate
serialize(Archive &archive, const unsigned int version)ParameterHandler
set(const std::string &entry_name, const std::string &new_value)ParameterHandler
set(const std::string &entry_name, const char *new_value)ParameterHandler
set(const std::string &entry_name, const long int new_value)ParameterHandler
set(const std::string &entry_name, const double new_value)ParameterHandler
set(const std::string &entry_name, const bool new_value)ParameterHandler
Short enum valueParameterHandler
ShortJSON enum valueParameterHandler
ShortLaTeX enum valueParameterHandler
ShortPRM enum valueParameterHandler
ShortText enum valueParameterHandler
ShortXML enum valueParameterHandler
subscribe(std::atomic< bool > *const validity, const std::string &identifier="") constSubscriptor
Subscriptor()Subscriptorinline
Subscriptor(const Subscriptor &)Subscriptorinline
Subscriptor(Subscriptor &&) noexceptSubscriptor
subsection_pathParameterHandlerprivate
subsection_path_exists(const std::vector< std::string > &sub_path) constParameterHandler
Text enum valueParameterHandler
unsubscribe(std::atomic< bool > *const validity, const std::string &identifier="") constSubscriptor
validity_pointersSubscriptormutableprivate
XML enum valueParameterHandler
~ParameterHandler() override=defaultParameterHandlervirtual
~Subscriptor()Subscriptorvirtual