Flow123d  JS_before_hm-1804-gf2ad740aa
flow_attribute_lib.hh
Go to the documentation of this file.
1 /*!
2  *
3  * Copyright (C) 2015 Technical University of Liberec. All rights reserved.
4  *
5  * This program is free software; you can redistribute it and/or modify it under
6  * the terms of the GNU General Public License version 3 as published by the
7  * Free Software Foundation. (http://www.gnu.org/licenses/gpl-3.0.en.html)
8  *
9  * This program is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11  * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
12  *
13  *
14  * @file attribute_lib.hh
15  * @brief
16  */
17 
18 #ifndef ATTRIBUTE_LIB_HH_
19 #define ATTRIBUTE_LIB_HH_
20 
21 using namespace std;
22 
23 /**
24  * @brief Class with static methods provided special attributes of Flow123D application.
25  *
26  * This class contains only attributes typical for Flow123D application. Base attributes
27  * are stored in @p Input::Type::Attributes.
28  */
30 public:
31 
32  /**
33  * Specify a unit of a field.
34  *
35  * Format of value: record with base units as keys and exponents as their values, e.g.
36  * { "m" : 0, "md" : 0, "kg" : 0, "s" : 0, "A" : 0, "K" : 0, "mol" : 0, "cd" : 0 }
37  */
38  inline static string field_unit()
39  { return "key_field_unit"; }
40 
41  /**
42  * Specify a value of the field.
43  *
44  * Format of value: record e.g.
45  * { "subfields": true, "shape": [ 1, 1 ], "type": "Float" }
46  */
47  inline static string field_value_shape()
48  { return "field_value_shape"; }
49 
50  /**
51  * Specify path where multifields of the equation get their names.
52  *
53  * Format of value: string, pattern of address, e.g.
54  * "/problem/solute_equation/substances/ * /name"
55  */
56  inline static string subfields_address()
57  { return "subfields_address"; }
58 
59  /**
60  * Specify default value of Field.
61  *
62  * Format of value: string, e.g.
63  * "0.0"
64  */
65  inline static string field_default_value()
66  { return "field_default_value"; }
67 
68 };
69 
70 #endif /* ATTRIBUTE_LIB_HH_ */
FlowAttribute::field_value_shape
static string field_value_shape()
Definition: flow_attribute_lib.hh:47
FlowAttribute::field_unit
static string field_unit()
Definition: flow_attribute_lib.hh:38
FlowAttribute::subfields_address
static string subfields_address()
Definition: flow_attribute_lib.hh:56
FlowAttribute::field_default_value
static string field_default_value()
Definition: flow_attribute_lib.hh:65
std
Definition: doxy_dummy_defs.hh:5
FlowAttribute
Class with static methods provided special attributes of Flow123D application.
Definition: flow_attribute_lib.hh:29