ASPECT
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 85 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 174 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

Definition at line 95 of file utilities.h.

§ list_of_required_keys

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

Definition at line 103 of file utilities.h.

§ property_name

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

Definition at line 110 of file utilities.h.

§ allow_multiple_values_per_key

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

Definition at line 119 of file utilities.h.

§ allow_missing_keys

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

Definition at line 126 of file utilities.h.

§ store_values_per_key

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

Definition at line 136 of file utilities.h.

§ check_values_per_key

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

Definition at line 146 of file utilities.h.

§ n_values_per_key

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

Definition at line 156 of file utilities.h.

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