/usr/include/dolfin/parameter/Parameters.h is in libdolfin-dev 1.4.0+dfsg-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 | // Copyright (C) 2009-2011 Anders Logg
//
// This file is part of DOLFIN.
//
// DOLFIN is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// DOLFIN is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with DOLFIN. If not, see <http://www.gnu.org/licenses/>.
//
// Modified by Johan Hake, 2009
// Modified by Garth N. Wells, 2009
//
// First added: 2009-05-08
// Last changed: 2011-10-24
#ifndef __PARAMETERS_H
#define __PARAMETERS_H
#include <set>
#include <map>
#include <vector>
#include "Parameter.h"
#include <dolfin/log/log.h>
namespace boost
{
namespace program_options
{
class variables_map;
class options_description;
}
}
namespace dolfin
{
class XMLParameters;
/// This class stores a set of parameters. Each parameter is
/// identified by a unique string (the key) and a value of some
/// given value type. Parameter sets can be nested at arbitrary
/// depths.
///
/// A parameter may be either int, double, string or boolean valued.
///
/// Parameters may be added as follows:
///
/// Parameters p("my_parameters");
/// p.add("relative_tolerance", 1e-15);
/// p.add("absolute_tolerance", 1e-15);
/// p.add("gmres_restart", 30);
/// p.add("monitor_convergence", false);
///
/// Parameters may be changed as follows:
///
/// p["gmres_restart"] = 50;
///
/// Parameter values may be retrieved as follows:
///
/// int gmres_restart = p["gmres_restart"];
///
/// Parameter sets may be nested as follows:
///
/// Parameters q("nested_parameters");
/// p.add(q);
///
/// Nested parameters may then be accessed by
///
/// p("nested_parameters")["..."]
///
/// Parameters may be nested at arbitrary depths.
///
/// Parameters may be parsed from the command-line as follows:
///
/// p.parse(argc, argv);
///
/// Note: spaces in parameter keys are not allowed (to simplify
/// usage from command-line).
class Parameters
{
public:
/// Create empty parameter set
explicit Parameters(std::string key = "parameters");
/// Destructor
virtual ~Parameters();
/// Copy constructor
Parameters(const Parameters& parameters);
/// Return name for parameter set
std::string name() const;
/// Rename parameter set
void rename(std::string key);
/// Clear parameter set
void clear();
/// Add an unset parameter of type T. For example, to create a
/// unset parameter of type bool, do
/// parameters.add<bool>("my_setting")
template<typename T>
void add(std::string key)
{
dolfin_error("Parameters.h",
"create parameter of requested type",
"Type '%s' is not allowed", key.c_str());
}
/// Add an unset parameter of type T with allows parameters. For
/// example, to create a unset parameter of type bool, do
/// parameters.add<bool>("my_setting")
template<typename T>
void add(std::string key, T min, T max)
{
dolfin_error("Parameters.h",
"create parameter of requested type",
"Type '%s' is not allowed", key.c_str());
}
/// Add an unset parameter of type T with allows parameters. For
/// example, to create a unset parameter of type bool, do
/// parameters.add<bool>("my_setting")
template<typename T>
void add(std::string key, std::set<T> valid_values)
{
dolfin_error("Parameters.h",
"create parameter of requested type",
"Type '%s' is not allowed", key.c_str());
}
/// Add int-valued parameter
void add(std::string key, int value);
/// Add int-valued parameter with given range
void add(std::string key, int value, int min_value, int max_value);
/// Add double-valued parameter
void add(std::string key, double value);
/// Add double-valued parameter with given range
void add(std::string key, double value, double min_value, double max_value);
/// Add string-valued parameter
void add(std::string key, std::string value);
/// Add string-valued parameter
void add(std::string key, const char* value);
/// Add string-valued parameter with given range
void add(std::string key, std::string value, std::set<std::string> range);
/// Add string-valued parameter with given range
void add(std::string key, const char* value, std::set<std::string> range);
/// Add bool-valued parameter
void add(std::string key, bool value);
/// Add nested parameter set
void add(const Parameters& parameters);
/// Remove parameter or parameter set with given key
void remove(std::string key);
/// Parse parameters from command-line
virtual void parse(int argc, char* argv[]);
/// Update parameters with another set of parameters
void update(const Parameters& parameters);
/// Return parameter for given key
Parameter& operator[] (std::string key);
/// Return parameter for given key (const version)
const Parameter& operator[] (std::string key) const;
// Note: We would have liked to use [] also for access of nested
// parameter sets just like we do in Python but we can't overload
// on return type.
/// Return nested parameter set for given key
Parameters& operator() (std::string key);
/// Return nested parameter set for given key (const)
const Parameters& operator() (std::string key) const;
/// Assignment operator
const Parameters& operator= (const Parameters& parameters);
/// Check if parameter set has key (parameter or nested parameter set)
bool has_key(std::string key) const;
/// Check if parameter set has given parameter
bool has_parameter(std::string key) const;
/// Check if parameter set has given nested parameter set
bool has_parameter_set(std::string key) const;
/// Return a vector of parameter keys
void get_parameter_keys(std::vector<std::string>& keys) const;
/// Return a vector of parameter set keys
void get_parameter_set_keys(std::vector<std::string>& keys) const;
/// Return informal string representation (pretty-print)
std::string str(bool verbose) const;
// Return pointer to parameter for given key and 0 if not found
Parameter* find_parameter(std::string key) const;
// Return pointer to parameter set for given key and 0 if not found
Parameters* find_parameter_set(std::string key) const;
protected:
/// Parse filtered options (everything except PETSc options)
void parse_common(int argc, char* argv[]);
/// Parse filtered options (only PETSc options)
void parse_petsc(int argc, char* argv[]);
private:
// Add all parameters as options to a boost::program_option instance
void
add_parameter_set_to_po(boost::program_options::options_description& desc,
const Parameters ¶meters,
std::string base_name="") const;
// Read in values from the boost::variable_map
void read_vm(boost::program_options::variables_map& vm,
Parameters ¶meters,
std::string base_name="");
// Parameter set key
std::string _key;
// Map from key to parameter
std::map<std::string, Parameter*> _parameters;
// Map from key to parameter sets
std::map<std::string, Parameters*> _parameter_sets;
};
// Specialised templated for unset parameters
template<> inline void Parameters::add<std::size_t>(std::string key)
{ _parameters[key] = new IntParameter(key); }
template<> inline void Parameters::add<std::size_t>(std::string key,
std::size_t min,
std::size_t max)
{
_parameters[key] = new IntParameter(key);
_parameters[key]->set_range((int) min, (int) max);
}
template<> inline void Parameters::add<int>(std::string key)
{ _parameters[key] = new IntParameter(key); }
template<> inline void Parameters::add<int>(std::string key, int min, int max)
{
_parameters[key] = new IntParameter(key);
_parameters[key]->set_range(min, max);
}
template<> inline void Parameters::add<double>(std::string key)
{ _parameters[key] = new DoubleParameter(key); }
template<> inline void Parameters::add<double>(std::string key, double min,
double max)
{
_parameters[key] = new DoubleParameter(key);
_parameters[key]->set_range(min, max);
}
template<> inline void Parameters::add<std::string>(std::string key)
{ _parameters[key] = new StringParameter(key); }
template<> inline void Parameters::add(std::string key,
std::set<std::string> valid_values)
{
_parameters[key] = new StringParameter(key);
_parameters[key]->set_range(valid_values);
}
template<> inline void Parameters::add<bool>(std::string key)
{ _parameters[key] = new BoolParameter(key); }
// Default empty parameters
extern Parameters empty_parameters;
}
#endif
|