Flow123d  JS_before_hm-1830-gb19ac973c
field_coords.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_coords.hh
15  * @brief
16  */
17 
18 #ifndef FIELD_COORDS_HH_
19 #define FIELD_COORDS_HH_
20 
21 #include "fields/field_common.hh" // for FieldCommon::T...
22 #include "fields/field_value_cache.hh" // for FieldValueCache
23 #include "fields/eval_points.hh" // for EvalPoints
24 #include "fem/mapping_p1.hh"
25 #include "mesh/ref_element.hh"
26 
27 namespace IT=Input::Type;
28 
29 
30 /**
31  * Specialized field represents coordinate variables ('x', 'y', 'z') of FieldFormula.
32  */
33 class FieldCoords : public FieldCommon {
34 public:
35 
36  /// Constructor
38  : value_cache_( FieldValueCache<double>(3, 1) )
39  {
40  this->multifield_ = false;
41  unsigned int cache_size = 1.1 * CacheMapElementNumber::get();
42  value_cache_.reinit(cache_size);
43  value_cache_.resize(cache_size);
44  this->set_shape(3, 1);
45  }
46 
48  ASSERT(false).error("This method can't be used for FieldCoords");
49 
50  IT::Abstract abstract = IT::Abstract();
52  return inst;
53  }
54 
56  ASSERT(false).error("This method can't be used for FieldCoords");
57 
58  IT::Array arr = IT::Array( IT::Integer() );
59  return arr;
60  }
61 
62  void set_mesh(const Mesh &mesh) override {
63  this->mesh_ = &mesh;
64  }
65 
66  bool is_constant(FMT_UNUSED Region reg) override {
67  return false;
68  }
69 
70  bool set_time(FMT_UNUSED const TimeStep &time, FMT_UNUSED LimitSide limit_side) override {
71  return false;
72  }
73 
74  void copy_from(FMT_UNUSED const FieldCommon & other) override {
75  ASSERT(false).error("Forbidden method for FieldCoords!");
76  }
77 
78  void field_output(FMT_UNUSED std::shared_ptr<OutputTime> stream, FMT_UNUSED OutputTime::DiscreteSpaceFlags type) override {
79  ASSERT(false).error("Forbidden method for FieldCoords!");
80  }
81 
82  void observe_output(FMT_UNUSED std::shared_ptr<Observe> observe) override {
83  ASSERT(false).error("Forbidden method for FieldCoords!");
84  }
85 
86  FieldResult field_result(FMT_UNUSED RegionSet region_set) const override {
87  return result_none;
88  }
89 
90  std::string get_value_attribute() const override {
91  double limit = std::numeric_limits<double>::max();
92  return fmt::format("{{ \"shape\": [ 3, 1 ], \"type\": \"Double\", \"limit\": [ {}, {} ] }}", -limit, +limit);
93  }
94 
96  {}
97 
98  /// Implements FieldCommon::cache_allocate
99  void cache_reallocate(FMT_UNUSED const ElementCacheMap &cache_map, FMT_UNUSED unsigned int region_idx) const override
100  {}
101 
102  /// Implements FieldCommon::cache_update
103  void cache_update(ElementCacheMap &cache_map, unsigned int region_patch_idx) const override {
104  std::shared_ptr<EvalPoints> eval_points = cache_map.eval_points();
105  unsigned int reg_chunk_begin = cache_map.region_chunk_begin(region_patch_idx);
106  unsigned int reg_chunk_end = cache_map.region_chunk_end(region_patch_idx);
107  unsigned int last_element_idx = -1;
108  ElementAccessor<3> elm;
109  arma::vec3 coords;
110  unsigned int dim = 0;
111 
112  for (unsigned int i_data = reg_chunk_begin; i_data < reg_chunk_end; ++i_data) { // i_eval_point_data
113  unsigned int elm_idx = cache_map.eval_point_data(i_data).i_element_;
114  if (elm_idx != last_element_idx) {
115  elm = mesh_->element_accessor( elm_idx );
116  dim = elm.dim();
117  last_element_idx = elm_idx;
118  }
119 
120  unsigned int i_point = cache_map.eval_point_data(i_data).i_eval_point_;
121  switch (dim) {
122  case 0:
123  coords = *elm.node(0);
124  break;
125  case 1:
126  coords = MappingP1<1,3>::project_unit_to_real(RefElement<1>::local_to_bary(eval_points->local_point<1>(i_point)),
128  break;
129  case 2:
130  coords = MappingP1<2,3>::project_unit_to_real(RefElement<2>::local_to_bary(eval_points->local_point<2>(i_point)),
132  break;
133  case 3:
134  coords = MappingP1<3,3>::project_unit_to_real(RefElement<3>::local_to_bary(eval_points->local_point<3>(i_point)),
136  break;
137  default:
138  coords = arma::vec3("0 0 0"); //Should not happen
139  }
140  value_cache_.set(i_data) = coords;
141  }
142  }
143 
144  /// Implements FieldCommon::value_cache
146  return &value_cache_;
147  }
148 
149  /// Implements FieldCommon::value_cache
150  const FieldValueCache<double> * value_cache() const override {
151  return &value_cache_;
152  }
153 
154  /// Implements FieldCommon::set_dependency().
155  std::vector<const FieldCommon *> set_dependency(FMT_UNUSED FieldSet &field_set, FMT_UNUSED unsigned int i_reg) const override {
157  }
158 
159 private:
160  /**
161  * Field value data cache
162  *
163  * See implementation of Field<spacedim, Value>::value_cache_
164  */
166 
167  const Mesh *mesh_; ///< Pointer to the mesh.
168 };
169 
170 #endif /* FIELD_COORDS_HH_ */
result_none
@ result_none
Definition: field_algo_base.hh:71
EvalPointData::i_element_
unsigned int i_element_
mesh_idx of ElementAccessor appropriate to element
Definition: field_value_cache.hh:74
ElementAccessor::dim
unsigned int dim() const
Definition: accessors.hh:190
FieldCoords
Definition: field_coords.hh:33
FieldCoords::value_cache
const FieldValueCache< double > * value_cache() const override
Implements FieldCommon::value_cache.
Definition: field_coords.hh:150
CacheMapElementNumber::get
static unsigned int get()
Return number of stored elements.
Definition: field_value_cache.hh:93
EvalPointData::i_eval_point_
unsigned int i_eval_point_
index of point in EvalPoint object
Definition: field_value_cache.hh:75
ref_element.hh
Class RefElement defines numbering of vertices, sides, calculation of normal vectors etc.
FieldCoords::value_cache
FieldValueCache< double > * value_cache() override
Implements FieldCommon::value_cache.
Definition: field_coords.hh:145
FieldCoords::cache_update
void cache_update(ElementCacheMap &cache_map, unsigned int region_patch_idx) const override
Implements FieldCommon::cache_update.
Definition: field_coords.hh:103
RefElement
Definition: ref_element.hh:339
ASSERT
#define ASSERT(expr)
Allow use shorter versions of macro names if these names is not used with external library.
Definition: asserts.hh:347
FieldCommon::set_shape
void set_shape(uint n_rows, uint n_cols)
Definition: field_common.hh:530
FieldCoords::field_output
void field_output(FMT_UNUSED std::shared_ptr< OutputTime > stream, FMT_UNUSED OutputTime::DiscreteSpaceFlags type) override
Definition: field_coords.hh:78
FieldCoords::get_value_attribute
std::string get_value_attribute() const override
Definition: field_coords.hh:90
Input::Type::Integer
Class for declaration of the integral input data.
Definition: type_base.hh:483
ElementCacheMap
Directing class of FieldValueCache.
Definition: field_value_cache.hh:151
eval_points.hh
FieldResult
FieldResult
Definition: field_algo_base.hh:70
FieldCommon::mesh
const Mesh * mesh() const
Definition: field_common.hh:272
std::vector
Definition: doxy_dummy_defs.hh:7
ElementAccessor< 3 >
FieldCoords::cache_reallocate
void cache_reallocate(FMT_UNUSED const ElementCacheMap &cache_map, FMT_UNUSED unsigned int region_idx) const override
Implements FieldCommon::cache_allocate.
Definition: field_coords.hh:99
arma::vec3
Definition: doxy_dummy_defs.hh:17
fmt::format
std::string format(CStringRef format_str, ArgList args)
Definition: format.h:3141
FieldCoords::value_cache_
FieldValueCache< double > value_cache_
Definition: field_coords.hh:165
ElementCacheMap::eval_point_data
const EvalPointData & eval_point_data(unsigned int point_idx) const
Return item of eval_point_data_ specified by its position.
Definition: field_value_cache.hh:267
Region
Definition: region.hh:146
OutputTime::DiscreteSpaceFlags
std::array< bool, 4 > DiscreteSpaceFlags
Definition: output_time.hh:122
ElementCacheMap::region_chunk_end
unsigned int region_chunk_end(unsigned int region_patch_idx) const
Return end position of region chunk in FieldValueCache.
Definition: field_value_cache.hh:250
MappingP1::project_unit_to_real
static RealPoint project_unit_to_real(const BaryPoint &point, const ElementMap &map)
Definition: mapping_p1.cc:85
FieldCoords::set_input_list
void set_input_list(FMT_UNUSED const Input::Array &list, FMT_UNUSED const TimeGovernor &tg) override
Definition: field_coords.hh:95
FieldCommon::multifield_
bool multifield_
Definition: field_common.hh:675
TimeStep
Representation of one time step..
Definition: time_governor.hh:123
TimeGovernor
Basic time management functionality for unsteady (and steady) solvers (class Equation).
Definition: time_governor.hh:310
ElementCacheMap::eval_points
std::shared_ptr< EvalPoints > eval_points() const
Getter of eval_points object.
Definition: field_value_cache.hh:193
FieldCommon
Common abstract parent of all Field<...> classes.
Definition: field_common.hh:74
FieldCoords::FieldCoords
FieldCoords()
Constructor.
Definition: field_coords.hh:37
Input::Type::Abstract
Class for declaration of polymorphic Record.
Definition: type_abstract.hh:62
Input::Type::Instance
Helper class that stores data of generic types.
Definition: type_generic.hh:89
FieldCoords::set_mesh
void set_mesh(const Mesh &mesh) override
Definition: field_coords.hh:62
LimitSide
LimitSide
Definition: field_common.hh:61
FieldCoords::copy_from
void copy_from(FMT_UNUSED const FieldCommon &other) override
Definition: field_coords.hh:74
FieldSet
Container for various descendants of FieldCommonBase.
Definition: field_set.hh:159
ElementAccessor::node
NodeAccessor< 3 > node(unsigned int ni) const
Definition: accessors.hh:245
Input::Type
Definition: balance.hh:41
ElementCacheMap::region_chunk_begin
unsigned int region_chunk_begin(unsigned int region_patch_idx) const
Return begin position of region chunk in FieldValueCache.
Definition: field_value_cache.hh:244
Mesh
Definition: mesh.h:98
Input::Type::Array
Class for declaration of inputs sequences.
Definition: type_base.hh:339
Input::Array
Accessor to input data conforming to declared Array.
Definition: accessors.hh:566
FieldCoords::field_result
FieldResult field_result(FMT_UNUSED RegionSet region_set) const override
Definition: field_coords.hh:86
field_value_cache.hh
MappingP1
Affine mapping between reference and actual cell.
Definition: mapping_p1.hh:58
FieldCoords::get_input_type
IT::Instance get_input_type() override
Definition: field_coords.hh:47
Armor::Array
Definition: armor.hh:597
FieldCoords::get_multifield_input_type
IT::Array get_multifield_input_type() override
Definition: field_coords.hh:55
mapping_p1.hh
Class MappingP1 implements the affine transformation of the unit cell onto the actual cell.
FieldCoords::set_dependency
std::vector< const FieldCommon * > set_dependency(FMT_UNUSED FieldSet &field_set, FMT_UNUSED unsigned int i_reg) const override
Implements FieldCommon::set_dependency().
Definition: field_coords.hh:155
std::list
Definition: doxy_dummy_defs.hh:9
FieldCoords::mesh_
const Mesh * mesh_
Pointer to the mesh.
Definition: field_coords.hh:167
Mesh::element_accessor
virtual ElementAccessor< 3 > element_accessor(unsigned int idx) const
Create and return ElementAccessor to element of given idx.
Definition: mesh.cc:817
FieldCoords::is_constant
bool is_constant(FMT_UNUSED Region reg) override
Definition: field_coords.hh:66
FieldCommon::time
double time() const
Definition: field_common.hh:285
FieldCoords::observe_output
void observe_output(FMT_UNUSED std::shared_ptr< Observe > observe) override
Definition: field_coords.hh:82
field_common.hh
FMT_UNUSED
#define FMT_UNUSED
Definition: posix.h:75
FieldCoords::set_time
bool set_time(FMT_UNUSED const TimeStep &time, FMT_UNUSED LimitSide limit_side) override
Definition: field_coords.hh:70