Flow123d  master-f44eb46
field_algo_base.impl.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 field_algo_base.impl.hh
15  * @brief
16  */
17 
18 #ifndef field_algo_base_IMPL_HH_
19 #define field_algo_base_IMPL_HH_
20 
21 #include <string>
22 #include <limits>
23 #include <memory>
24 using namespace std;
25 
27 
28 #include "fields/field_values.hh"
29 
30 #include "tools/unit_converter.hh"
31 
32 #include "tools/time_governor.hh"
33 #include "input/factory.hh"
34 #include "input/accessors.hh"
36 
37 namespace it = Input::Type;
38 
39 
40 
41 
42 /******************************************************************************************
43  * Implementation of FieldBase<...>
44  */
45 
46 template <int spacedim, class Value>
48 : value_(r_value_),
49  field_result_(result_other),
50  component_idx_(undef_idx),
51  unit_conversion_coefficient_(1.0)
52 {
53  value_.set_n_comp(n_comp);
54 }
55 
56 
57 
58 template <int spacedim, class Value>
60  return ""; //fmt::format("R{:d}_to_{}", spacedim, Value::type_name() ); // maybe change template name
61 }
62 
63 
64 
65 template <int spacedim, class Value>
67  //stringstream ss;
68  //ss << "[" << Value::NRows_ << ", " << Value::NCols_ << "]";
69  return it::Abstract("Field_"+template_name(), "Abstract for all time-space functions.")
70  .allow_auto_conversion("FieldConstant")
72  //.add_attribute(FlowAttribute::field_value_shape(), ss.str() )
73  .close();
74 }
75 
76 
77 template <int spacedim, class Value>
80  if (is_enum_valued) {
81  ASSERT_PERMANENT( !(value_selection==Input::Type::Selection()) ).error("Not defined 'value_selection' for enum element type.\n");
82  param_vec.push_back( std::make_pair("element_input_type", std::make_shared<it::Selection>(value_selection)) );
83  } else {
84  param_vec.push_back( std::make_pair("element_input_type", std::make_shared<typename Value::ElementInputType>()) );
85  }
86 
87  return it::Instance(get_input_type(), param_vec).close();
88 }
89 
90 template <int spacedim, class Value>
92  return it::Record("FieldAlgorithmBase_common_aux", "")
94  "Unit of the field values provided in the main input file, in the external file, or "
95  "by a function (FieldPython).")
96  .close();
97 }
98 
99 template <int spacedim, class Value>
100 shared_ptr< FieldAlgorithmBase<spacedim, Value> >
102 {
103  shared_ptr< FieldAlgorithmBase<spacedim, Value> > func;
104  func = rec.factory< FieldAlgorithmBase<spacedim, Value> >(init_data.n_comp_);
105  func->init_from_input(rec, init_data);
106  return func;
107 }
108 
109 
110 
111 template <int spacedim, class Value>
113  THROW( ExcInputInitUnsupported() << EI_Field(typeid(this).name()) );
114 }
115 
116 
117 
118 template <int spacedim, class Value>
120  time_ = time;
121  return false; // no change
122 }
123 
124 
125 
126 template <int spacedim, class Value>
128 }
129 
130 
131 
132 template<int spacedim, class Value>
134  return (Value::NRows_ ? 0 : value_.n_rows());
135 }
136 
137 
138 template<int spacedim, class Value>
141  FMT_UNUSED ElementCacheMap &cache_map,
142  FMT_UNUSED unsigned int region_patch_idx)
143 {
144  ASSERT_PERMANENT(false).error("Must be implemented in descendants!\n");
145 }
146 
147 
148 template<int spacedim, class Value>
150 {}
151 
152 
153 template<int spacedim, class Value>
155  const struct FieldAlgoBaseInitData& init_data)
156 {
157  Input::Record unit_record;
158  if ( rec.opt_val("unit", unit_record) ) {
159  if (!Value::is_scalable()) {
160  WarningOut().fmt("Setting unit conversion coefficient of non-floating point field at address {}\nCoefficient will be skipped.\n",
161  rec.address_string());
162  }
163  std::string unit_str = unit_record.val<std::string>("unit_formula");
164  try {
165  this->unit_conversion_coefficient_ = init_data.unit_si_.convert_unit_from(unit_str);
166  } catch (ExcInvalidUnit &e) {
167  e << rec.ei_address();
168  throw;
169  } catch (ExcNoncorrespondingUnit &e) {
170  e << rec.ei_address();
171  throw;
172  }
173  }
174 }
175 
176 
177 
178 
179 #endif //FUNCTION_BASE_IMPL_HH_
#define ASSERT_PERMANENT(expr)
Allow use shorter versions of macro names if these names is not used with external library.
Definition: asserts.hh:348
Directing class of FieldValueCache.
static const Input::Type::Instance & get_input_type_instance(Input::Type::Selection value_selection=Input::Type::Selection())
static std::shared_ptr< FieldAlgorithmBase< spacedim, Value > > function_factory(const Input::AbstractRecord &rec, const struct FieldAlgoBaseInitData &init_data)
virtual void init_from_input(const Input::Record &rec, const struct FieldAlgoBaseInitData &init_data)
unsigned int n_comp() const
virtual void cache_update(FieldValueCache< typename Value::element_type > &data_cache, ElementCacheMap &cache_map, unsigned int region_patch_idx)
virtual void cache_reinit(const ElementCacheMap &cache_map)
Allows reinit data members or structures in descendants during reinit of FieldValueCache of 'parental...
static std::string template_name()
virtual bool set_time(const TimeStep &time)
static Input::Type::Abstract & get_input_type()
virtual void set_mesh(const Mesh *mesh)
void init_unit_conversion_coefficient(const Input::Record &rec, const struct FieldAlgoBaseInitData &init_data)
Init value of unit_conversion_coefficient_ from input.
static const Input::Type::Record & get_field_algo_common_keys()
Value value_
Last value, prevents passing large values (vectors) by value.
FieldAlgorithmBase(unsigned int n_comp=0)
Accessor to the polymorphic input data of a type given by an AbstracRecord object.
Definition: accessors.hh:458
const std::shared_ptr< Type > factory(Arguments... arguments) const
Accessor to the data with type Type::Record.
Definition: accessors.hh:291
string address_string() const
Definition: accessors.cc:184
EI_Address ei_address() const
Definition: accessors.cc:178
bool opt_val(const string &key, Ret &value) const
const Ret val(const string &key) const
Class for declaration of polymorphic Record.
Abstract & allow_auto_conversion(const string &type_default)
Allows shorter input of the Abstract providing the default value to the "TYPE" key.
Abstract & close()
Close the Abstract and add its to type repository (see TypeRepository::add_type).
Abstract & root_of_generic_subtree()
static Default optional()
The factory function to make an empty default value which is optional.
Definition: type_record.hh:124
Helper class that stores data of generic types.
Definition: type_generic.hh:89
const Instance & close() const
Used for set Instance to TypeRepository.
Record type proxy class.
Definition: type_record.hh:182
Record & close() const
Close the Record for further declarations of keys.
Definition: type_record.cc:304
Record & declare_key(const string &key, std::shared_ptr< TypeBase > type, const Default &default_value, const string &description, TypeBase::attribute_map key_attributes=TypeBase::attribute_map())
Declares a new key of the Record.
Definition: type_record.cc:503
Template for classes storing finite set of named values.
Definition: mesh.h:362
Representation of one time step..
static const Input::Type::Record & get_input_type()
double convert_unit_from(std::string actual_unit) const
Convert and check user-defined unit.
Definition: unit_si.cc:217
@ result_other
#define THROW(whole_exception_expr)
Wrapper for throw. Saves the throwing point.
Definition: exceptions.hh:53
const unsigned int undef_idx
Definition: index_types.hh:32
#define WarningOut()
Macro defining 'warning' record of log.
Definition: logger.hh:278
#define FMT_UNUSED
Definition: posix.h:75
Helper struct stores data for initizalize descentants of FieldAlgorithmBase.
const UnitSI & unit_si_
Basic time management class.