ASPECT
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Public Attributes | List of all members
aspect::Utilities::MapParsing::Options Struct Reference

Public Member Functions

 Options ()=delete
 
 Options (const std::vector< std::string > &list_of_required_keys, const std::string &property_name)
 

Public Attributes

std::vector< std::string > list_of_allowed_keys
 
std::vector< std::string > list_of_required_keys
 
std::string property_name
 
bool allow_multiple_values_per_key
 
bool allow_missing_keys
 
bool store_values_per_key
 
bool check_values_per_key
 
std::vector< unsigned int > n_values_per_key
 

Detailed Description

A struct that bundles all the available options for parse_map_to_double_array().

Definition at line 105 of file utilities.h.

Constructor & Destructor Documentation

§ Options() [1/2]

aspect::Utilities::MapParsing::Options::Options ( )
delete

Delete the default constructor, because we want to ensure that at least the required options are always set.

§ Options() [2/2]

aspect::Utilities::MapParsing::Options::Options ( const std::vector< std::string > &  list_of_required_keys,
const std::string &  property_name 
)
inline

A constructor for options that only sets the required parameters and leaves all other parameters at their default values. By default the list_of_required_keys will be used as both the list of allowed and list of required keys. In other words exactly these keys and no other keys are allowed to appear in the input and all of the keys have to be specified and will be included in the output. For a documentation of the parameters see the documentation of the member variables of this class.

Definition at line 196 of file utilities.h.

References aspect::Utilities::Coordinates::cartesian_to_ellipsoidal_coordinates(), aspect::Utilities::Coordinates::cartesian_to_spherical_coordinates(), aspect::Utilities::compute_rotation_matrix_for_slice(), aspect::Utilities::distance_to_line(), aspect::Utilities::Coordinates::ellipsoidal_to_cartesian_coordinates(), aspect::Utilities::expand_dimensional_variable_names(), aspect::Utilities::extract_locally_active_dofs_with_component(), aspect::Utilities::get_unit_support_points(), aspect::Utilities::orthogonal_vectors(), aspect::Utilities::parse_input_table(), aspect::Utilities::parse_map_to_double_array(), aspect::Utilities::point_is_in_triangulation(), aspect::Utilities::polygon_contains_point(), aspect::Utilities::real_spherical_harmonic(), aspect::Utilities::rotation_matrix_from_axis(), aspect::Utilities::signed_distance_to_polygon(), aspect::Utilities::Coordinates::spherical_to_cartesian_coordinates(), aspect::Utilities::Coordinates::spherical_to_cartesian_vector(), aspect::Utilities::Coordinates::string_to_coordinate_system(), and aspect::Utilities::Coordinates::WGS84_coordinates().

Member Data Documentation

§ list_of_allowed_keys

std::vector<std::string> aspect::Utilities::MapParsing::Options::list_of_allowed_keys

A list of valid key names that are allowed to appear in the map. If this list is empty it is assumed to be equal to the list of required keys. If this list is longer than list_of_required_keys, every key that is allowed but not required will be ignored when parsing the map.

Definition at line 116 of file utilities.h.

§ list_of_required_keys

std::vector<std::string> aspect::Utilities::MapParsing::Options::list_of_required_keys

A list of valid key names that are required to appear in the map. Only these keys will be parsed into the map structure and the order of these keys determines the order of entries in the output vector.

Definition at line 125 of file utilities.h.

§ property_name

std::string aspect::Utilities::MapParsing::Options::property_name

A name that identifies the type of input property (e.g. 'density', 'viscosity') that is being parsed by this function. This name is used in generating error messages if the map does not conform to the expected format.

Definition at line 132 of file utilities.h.

§ allow_multiple_values_per_key

bool aspect::Utilities::MapParsing::Options::allow_multiple_values_per_key

If true, allow multiple values for each key. If false only allow a single value per key. In either case each key is only allowed to appear once. Multiple values for a key are delimited by a "|" character, as in "key1: value1|value2|value3, key2: value1|value2".

Definition at line 141 of file utilities.h.

§ allow_missing_keys

bool aspect::Utilities::MapParsing::Options::allow_missing_keys

Definition at line 148 of file utilities.h.

§ store_values_per_key

bool aspect::Utilities::MapParsing::Options::store_values_per_key

Whether to store the number of values per key in n_values_per_key while creating the map. This vector can be later accessed and used (for example) to check that subsequent calls to parse other input parameters have the same structure.

Definition at line 158 of file utilities.h.

§ check_values_per_key

bool aspect::Utilities::MapParsing::Options::check_values_per_key

Whether to check the number of values per key in the map against values stored in n_values_per_key. This allows to check that subsequent calls to parse other input parameters have the same structure.

Definition at line 168 of file utilities.h.

§ n_values_per_key

std::vector<unsigned int> aspect::Utilities::MapParsing::Options::n_values_per_key

A vector of unsigned integers that is used by store_values_per_key and check_values_per_key to either store the current map structure or check the map structure against an existing map. This parameter is only used if either of these two parameters are set to true

Definition at line 178 of file utilities.h.

The documentation for this struct was generated from the following file: