Flow123d  JB_transport-9331eee
field.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.impl.hh
15  * @brief
16  */
17 
18 #ifndef FIELD_IMPL_HH_
19 #define FIELD_IMPL_HH_
20 
21 #include "field.hh"
22 #include "field_algo_base.impl.hh"
23 #include "field_fe.hh"
24 #include "fields/eval_subset.hh"
25 #include "fields/eval_points.hh"
27 #include "fields/field_set.hh"
28 #include "mesh/region.hh"
30 #include "input/accessors.hh"
31 #include "io/observe.hh"
32 #include "io/output_mesh.hh"
33 #include "io/output_element.hh"
34 
35 
36 /******************************************************************************************
37  * Implementation of Field<...>
38  */
39 
40 template<int spacedim, class Value>
42 : data_(std::make_shared<SharedData>()),
43  value_cache_( FieldValueCache<typename Value::element_type>(Value::NRows_, Value::NCols_) )
44 {
45  // n_comp is nonzero only for variable size vectors Vector, VectorEnum, ..
46  // this invariant is kept also by n_comp setter
47  shared_->n_comp_ = (Value::NRows_ ? 0 : 1);
48  this->add_factory( std::make_shared<FactoryBase>() );
49 
50  unsigned int cache_size = CacheMapElementNumber::get();
51  value_cache_.reinit(cache_size);
52  value_cache_.resize(cache_size);
53 
54  this->multifield_ = false;
55  this->set_shape( Value::NRows_, Value::NCols_ );
56 }
57 
58 
59 template<int spacedim, class Value>
60 Field<spacedim,Value>::Field(const string &name, bool bc)
61 : data_(std::make_shared<SharedData>()),
62  value_cache_( FieldValueCache<typename Value::element_type>(Value::NRows_, Value::NCols_) )
63 {
64  // n_comp is nonzero only for variable size vectors Vector, VectorEnum, ..
65  // this invariant is kept also by n_comp setter
66  shared_->n_comp_ = (Value::NRows_ ? 0 : 1);
67  shared_->bc_=bc;
68  this->name( name );
69  this->add_factory( std::make_shared<FactoryBase>() );
70  unsigned int cache_size = CacheMapElementNumber::get();
71  value_cache_.reinit(cache_size);
72  value_cache_.resize(cache_size);
73 
74  this->multifield_ = false;
75  this->set_shape( Value::NRows_, Value::NCols_ );
76 }
77 
78 
79 
80 template<int spacedim, class Value>
81 Field<spacedim,Value>::Field(unsigned int component_index, string input_name, string name, bool bc)
82 : data_(std::make_shared<SharedData>()),
83  value_cache_( FieldValueCache<typename Value::element_type>(Value::NRows_, Value::NCols_) )
84 {
85  // n_comp is nonzero only for variable size vectors Vector, VectorEnum, ..
86  // this invariant is kept also by n_comp setter
87  shared_->n_comp_ = (Value::NRows_ ? 0 : 1);
88  this->set_component_index(component_index);
89  this->name_ = (name=="") ? input_name : name;
90  this->shared_->input_name_ = input_name;
91  shared_->bc_ = bc;
92 
93  unsigned int cache_size = CacheMapElementNumber::get();
94  value_cache_.reinit(cache_size);
95  value_cache_.resize(cache_size);
96 
97  this->multifield_ = false;
98  this->set_shape( Value::NRows_, Value::NCols_ );
99 }
100 
101 
102 template<int spacedim, class Value>
104 : FieldCommon(other),
105  data_(other.data_),
106  region_fields_(other.region_fields_),
107  factories_(other.factories_),
108  value_cache_(other.value_cache_)
109 {
110  if (other.no_check_control_field_)
111  no_check_control_field_ = make_shared<ControlField>(*other.no_check_control_field_);
112 
113  this->multifield_ = false;
114  this->set_shape( Value::NRows_, Value::NCols_ );
115 }
116 
117 
118 template<int spacedim, class Value>
120 {
121  //ASSERT( flags().match(FieldFlag::input_copy) )(this->name())(other.name()).error("Try to assign to non-copy field from the field.");
122  ASSERT(other.shared_->mesh_).error("Must call set_mesh before assign to other field.\n");
123  ASSERT( !shared_->mesh_ || (shared_->mesh_==other.shared_->mesh_) ).error("Assignment between fields with different meshes.\n");
124 
125  // check for self assignement
126  if (&other == this) return *this;
127 
128  // class members derived from FieldCommon
129  shared_ = other.shared_;
130  shared_->is_fully_initialized_ = false;
131  set_time_result_ = other.set_time_result_;
132  last_time_ = other.last_time_;
133  last_limit_side_ = other.last_limit_side_;
134  is_jump_time_ = other.is_jump_time_;
135  component_index_ = other.component_index_;
136  this->multifield_ = false;
137 
138  // class members of Field class
139  data_ = other.data_;
140  factories_ = other.factories_;
141  region_fields_ = other.region_fields_;
142  value_cache_ = other.value_cache_;
143  this->shape_ = other.shape_;
144 
145  if (other.no_check_control_field_) {
146  no_check_control_field_ = make_shared<ControlField>(*other.no_check_control_field_);
147  }
148 
149  return *this;
150 }
151 
152 
153 
154 template<int spacedim, class Value>
155 typename Value::return_type Field<spacedim,Value>::operator() (BulkPoint &p) {
156  return p.elm_cache_map()->get_value<Value>(value_cache_, p.elem_patch_idx(), p.eval_point_idx());
157 }
158 
159 
160 
161 template<int spacedim, class Value>
162 typename Value::return_type Field<spacedim,Value>::operator() (SidePoint &p) {
163  return p.elm_cache_map()->get_value<Value>(value_cache_, p.elem_patch_idx(), p.eval_point_idx());
164 }
165 
166 
167 
168 template<int spacedim, class Value>
169 typename Value::return_type
170 Field<spacedim,Value>::operator[] (unsigned int i_cache_point) const
171 {
172  return Value::get_from_array( this->value_cache_, i_cache_point );
173 }
174 
175 
176 
177 template<int spacedim, class Value>
179  return FieldBaseType::get_input_type_instance(shared_->input_element_selection_);
180 }
181 
182 
183 
184 template<int spacedim, class Value>
186  ASSERT_PERMANENT(false).error("This method can't be used for Field");
187 
188  it::Array arr = it::Array( it::Integer() );
189  return arr;
190 }
191 
192 
193 
194 template<int spacedim, class Value>
196  const Field<spacedim, typename FieldValue<spacedim>::Enum > &control_field,
197  const vector<FieldEnum> &value_list) -> Field &
198 {
199  no_check_control_field_=std::make_shared<ControlField>(control_field);
200  shared_->no_check_values_=value_list;
201  return *this;
202 }
203 
204 template<int spacedim, class Value>
205 void Field<spacedim,Value>::set_mesh(const Mesh &in_mesh) {
206  // since we allow copy of fields before set_mesh is called
207  // we have to check that all copies set the same mesh
208  if (shared_->mesh_ && shared_->mesh_ != &in_mesh) {
209  THROW(ExcFieldMeshDifference() << EI_Field(name()) );
210  }
211 
212  shared_->mesh_ = &in_mesh;
213 
214  // initialize table if it is empty, we assume that the RegionDB is closed at this moment
215  region_fields_.resize( mesh()->region_db().size() );
216  RegionHistory init_history(history_length_limit_); // capacity
217  data_->region_history_.resize( mesh()->region_db().size(), init_history );
218 
219  if (no_check_control_field_) no_check_control_field_->set_mesh(in_mesh);
220 }
221 
222 
223 /*
224 template<int spacedim, class Value>
225 std::shared_ptr< typename Field<spacedim,Value>::FieldBaseType >
226 Field<spacedim,Value>::operator[] (Region reg)
227 {
228  ASSERT_PERMANENT_LT(reg.idx(), this->region_fields_.size());
229  return this->region_fields_[reg.idx()];
230 }
231 */
232 
233 
234 template <int spacedim, class Value>
236  ASSERT(this->set_time_result_ != TimeStatus::unknown).error("Unknown time status.\n");
237  ASSERT_LT(reg.idx(), this->region_fields_.size());
238  FieldBasePtr region_field = this->region_fields_[reg.idx()];
239  return ( region_field && region_field->is_constant_in_space() );
240 }
241 
242 
243 template<int spacedim, class Value>
245  FieldBasePtr field,
246  double time,
247  std::vector<std::string> region_set_names)
248 {
249  ASSERT_PTR(field).error("Null field pointer.\n");
250 
251  ASSERT_PTR( mesh() ).error("Null mesh pointer, set_mesh() has to be called before set().\n");
252  ASSERT_EQ( field->n_comp() , shared_->n_comp_);
253  field->set_mesh( mesh() , is_bc() );
254 
255  for (auto set_name : region_set_names) {
256  RegionSet domain = mesh()->region_db().get_region_set(set_name);
257  if (domain.size() == 0) continue;
258 
259  HistoryPoint hp = HistoryPoint(time, field);
260  for(const Region &reg: domain) {
261  RegionHistory &region_history = data_->region_history_[reg.idx()];
262  // insert hp into descending time sequence
263  ASSERT( region_history.size() == 0 || region_history[0].first < hp.first)(hp.first)(region_history[0].first)
264  .error("Can not insert smaller time then last time in field's history.\n");
265  region_history.push_front(hp);
266  }
267  }
268  set_history_changed();
269 }
270 
271 
272 
273 template<int spacedim, class Value>
275  const Input::AbstractRecord &a_rec,
276  double time,
277  std::vector<std::string> region_set_names)
278 {
279  FieldAlgoBaseInitData init_data(input_name(), n_comp(), units(), limits(), flags());
280  set(FieldBaseType::function_factory(a_rec, init_data), time, region_set_names);
281 }
282 
283 
284 
285 template<int spacedim, class Value>
286 bool Field<spacedim, Value>::set_time(const TimeStep &time_step, LimitSide limit_side)
287 {
288  ASSERT_PTR( mesh() )( name() ).error("NULL mesh pointer of field with given name. set_mesh must be called before.\n");
289 
290  // Skip setting time if the new time is equal to current time of the field
291  // and if either the field is continuous in that time or the current limit side is same as the new one.
292  if (time_step.end() == last_time_) {
293  if ( ! is_jump_time() ||
294  limit_side == last_limit_side_) {
295  last_limit_side_ = limit_side;
296  return changed();
297  }
298  }
299 
300  last_time_=time_step.end();
301  last_limit_side_ = limit_side;
302 
303  // possibly update our control field
304  if (no_check_control_field_) {
305  no_check_control_field_->set_time(time_step, limit_side);
306  }
307 
308  if(set_time_result_ == TimeStatus::changed_forced)
309  set_time_result_ = TimeStatus::changed;
310  else
311  set_time_result_ = TimeStatus::constant;
312 
313  // read all descriptors satisfying time.ge(input_time)
314  update_history(time_step);
315  check_initialized_region_fields_();
316 
317  //
318  is_jump_time_=false;
319  // set time_step on all regions
320  // for regions that match type of the field domain
321  for(const Region &reg: mesh()->region_db().get_region_set("ALL") ) {
322  auto rh = data_->region_history_[reg.idx()];
323 
324  // skip regions with no matching BC flag
325  if (reg.is_boundary() != is_bc()) continue;
326 
327  // Check regions with empty history, possibly set default.
328  if ( rh.empty()) continue;
329 
330  double last_time_in_history = rh.front().first;
331  unsigned int history_size=rh.size();
332  unsigned int i_history;
333  ASSERT( time_step.ge(last_time_in_history) ).error("Setting field time back in history not fully supported yet!");
334 
335  // set history index
336  if ( time_step.gt(last_time_in_history) ) {
337  // in smooth time_step
338  i_history=0;
339  } else {
340  // time_step .eq. input_time; i.e. jump time
341  is_jump_time_=true;
342  if (limit_side == LimitSide::right) {
343  i_history=0;
344  } else {
345  i_history=1;
346  }
347  }
348  i_history=min(i_history, history_size - 1);
349  ASSERT(i_history >= 0).error("Empty field history.");
350  // possibly update field pointer
351 
352  auto new_ptr = rh.at(i_history).second;
353  if (new_ptr != region_fields_[reg.idx()]) {
354  region_fields_[reg.idx()]=new_ptr;
355  set_time_result_ = TimeStatus::changed;
356  }
357  // let FieldBase implementation set the time
358  if ( new_ptr->set_time(time_step) ) set_time_result_ = TimeStatus::changed;
359 
360  }
361 
362  return changed();
363 }
364 
365 
366 template<int spacedim, class Value>
368  ASSERT( flags().match(FieldFlag::equation_input))(other.name())(this->name())
369  .error("Can not copy to the non-input field.");
370 
371  // do not use copy if the field have its own input
372  if ( flags().match(FieldFlag::declare_input)
373  && this->shared_->input_list_.size() != 0 ) return;
374 
375  if (typeid(other) == typeid(*this)) {
376  auto const &other_field = dynamic_cast< Field<spacedim, Value> const &>(other);
377  this->operator=(other_field);
378  }
379 }
380 
381 
382 
383 template<int spacedim, class Value>
384 void Field<spacedim, Value>::field_output(std::shared_ptr<OutputTime> stream, OutputTime::DiscreteSpace type)
385 {
386  // currently we cannot output boundary fields
387  if (!is_bc()) {
388  ASSERT_LT( type, OutputTime::N_DISCRETE_SPACES ).error();
389  this->compute_field_data( type, stream);
390  }
391 }
392 
393 
394 
395 template<int spacedim, class Value>
397 
398  FieldResult result_all = result_none;
399  for(Region &reg : region_set) {
400  auto f = region_fields_[reg.idx()];
401  if (f) {
402  FieldResult fr = f->field_result();
403  if (result_all == result_none) // first region
404  result_all = fr;
405  else if (fr != result_all)
406  result_all = result_other; // if results from individual regions are different
407  } else return result_none; // if field is undefined on any region of the region set
408  }
409 
410  if (result_all == result_constant && region_set.size() > 1)
411  return result_other; // constant result for individual regions could be non-constant on the whole region set
412 
413  return result_all;
414 
415 }
416 
417 
418 template<int spacedim, class Value>
420 {
421  int nrows = Value::NRows_;
422  int ncols = Value::NCols_;
423  string type = "Integer";
425  type = "Double";
426 
427  return fmt::format("{{ \"shape\": [ {}, {} ], \"type\": \"{}\", \"limit\": [ {}, {} ] }}",
428  nrows, ncols, type, this->limits().first, this->limits().second);
429 }
430 
431 
432 template<int spacedim, class Value>
434  ASSERT_PTR( mesh() ).error("Null mesh pointer, set_mesh() has to be called before.\n");
435 
436  // read input up to given time
437  double input_time;
438  if (shared_->input_list_.size() != 0) {
439  while( shared_->list_idx_ < shared_->input_list_.size()
440  && time.ge( input_time = time.read_time( shared_->input_list_[shared_->list_idx_].find<Input::Tuple>("time") ) ) ) {
441 
442  const Input::Record & actual_list_item = shared_->input_list_[shared_->list_idx_];
443  // get domain specification
444  RegionSet domain;
445  Input::Array domain_name_array;
446  unsigned int id;
447  if (actual_list_item.opt_val("region", domain_name_array)) {
448  std::vector<string> domain_names = mesh()->region_db().get_and_check_operands(domain_name_array);
449  domain = mesh()->region_db().union_set(domain_names);
450 
451  } else if (actual_list_item.opt_val("rid", id)) {
452  Region region;
453  try {
454  region = mesh()->region_db().find_id(id);
455  } catch (RegionDB::ExcUniqueRegionId &e) {
456  e << actual_list_item.ei_address();
457  throw;
458  }
459  if (region.is_valid())
460  domain.push_back(region);
461  else
462  THROW(RegionDB::ExcUnknownRegion() << RegionDB::EI_ID(id) );
463  } else {
464  THROW(ExcMissingDomain()
465  << actual_list_item.ei_address() );
466  }
467 
468  // get field instance
469  for(auto rit = factories_.rbegin() ; rit != factories_.rend(); ++rit) {
470  FieldBasePtr field_instance = (*rit)->create_field(actual_list_item, *this);
471  if (field_instance) // skip descriptors without related keys
472  {
473  // add to history
474  ASSERT_EQ( field_instance->n_comp() , shared_->n_comp_);
475  field_instance->set_mesh( mesh() , is_bc() );
476  for(const Region &reg: domain) {
477  // if region history is empty, add new field
478  // or if region history is not empty and the input_time is higher, add new field
479  // otherwise (region history is not empty and the input_time is the same),
480  // rewrite the region field
481  if( data_->region_history_[reg.idx()].size() == 0
482  || data_->region_history_[reg.idx()].back().first < input_time)
483  {
484  data_->region_history_[reg.idx()].push_front(
485  HistoryPoint(input_time, field_instance));
486  //DebugOut() << "Update history" << print_var(this->name()) << print_var(reg.label()) << print_var(input_time);
487  }
488  else
489  {
490  data_->region_history_[reg.idx()].back() =
491  HistoryPoint(input_time, field_instance);
492  }
493  }
494  break;
495  }
496  }
497 
498  ++shared_->list_idx_;
499  }
500  }
501 }
502 
503 template<int spacedim, class Value>
505  ASSERT_PTR(mesh()).error("Null mesh pointer.");
506  //if (shared_->is_fully_initialized_) return;
507 
508  // check there are no empty field pointers, collect regions to be initialized from default value
509  RegionSet regions_to_init; // empty vector
510 
511  for(const Region &reg : mesh()->region_db().get_region_set("ALL") )
512  if (reg.is_boundary() == is_bc()) { // for regions that match type of the field domain
513  RegionHistory &rh = data_->region_history_[reg.idx()];
514  if ( rh.empty() || ! rh[0].second) // empty region history
515  {
516  // test if check is turned on and control field is FieldConst
517  if (no_check_control_field_ && no_check_control_field_->is_constant(reg) ) {
518  // get constant enum value
519  auto elm = ElementAccessor<spacedim>(mesh(), reg);
520  FieldEnum value = no_check_control_field_->value(elm.centre(),elm);
521  // check that the value is in the disable list
522  if ( std::find(shared_->no_check_values_.begin(), shared_->no_check_values_.end(), value)
523  != shared_->no_check_values_.end() )
524  continue; // the field is not needed on this region
525  }
526  if (shared_->input_default_ != "") { // try to use default
527  regions_to_init.push_back( reg );
528  } else {
529  THROW( ExcMissingFieldValue() << EI_FieldInputName(input_name()) << EI_FieldName(name())
530  << EI_RegId(reg.id()) << EI_RegLabel(reg.label()) );
531  }
532  }
533  }
534 
535  // possibly set from default value
536  if ( regions_to_init.size() ) {
537  std::string region_list;
538  // has to deal with fact that reader can not deal with input consisting of simple values
539  string default_input=input_default();
540  auto input_type = get_input_type().make_instance().first;
541  Input::ReaderToStorage reader( default_input, *input_type, Input::FileFormat::format_JSON );
542 
543  auto a_rec = reader.get_root_interface<Input::AbstractRecord>();
544  FieldAlgoBaseInitData init_data(input_name(), n_comp(), units(), limits(), flags());
545  auto field_ptr = FieldBaseType::function_factory( a_rec , init_data );
546  field_ptr->set_mesh( mesh(), is_bc() );
547  for(const Region &reg: regions_to_init) {
548  data_->region_history_[reg.idx()]
549  .push_front(HistoryPoint( 0.0, field_ptr) );
550  region_list+=" "+reg.label();
551  }
552  FieldCommon::messages_data_.push_back( MessageData(input_default(), name(), region_list) );
553 
554  }
555  //shared_->is_fully_initialized_ = true;
556 }
557 
558 
559 template<int spacedim, class Value>
560 void Field<spacedim,Value>::add_factory(const std::shared_ptr<FactoryBase> factory) {
561  factories_.push_back( factory );
562 }
563 
564 
565 template<int spacedim, class Value>
567  Input::AbstractRecord field_record;
568  if (rec.opt_val(field.input_name(), field_record)) {
569  FieldAlgoBaseInitData init_data(field.input_name(), field.n_comp(), field.units(), field.limits(), field.get_flags());
570  return FieldBaseType::function_factory(field_record, init_data );
571  }
572  else
573  return FieldBasePtr();
574 }
575 
576 
577 template<int spacedim, class Value>
579  return in_rec.find<Input::AbstractRecord>(input_name);
580 }
581 
582 
583 
584 
585 template<int spacedim, class Value>
587  if (! flags().match(FieldFlag::declare_input)) return;
588 
589  // check that times forms ascending sequence
590  double time,last_time=0.0;
591 
593  it != list.end();
594  ++it) {
595  for(auto rit = factories_.rbegin() ; rit != factories_.rend(); ++rit) {
596  if ( (*rit)->is_active_field_descriptor( (*it), this->input_name() ) ) {
597  shared_->input_list_.push_back( Input::Record( *it ) );
598  time = tg.read_time( it->find<Input::Tuple>("time") );
599  if (time < last_time) {
600  THROW( ExcNonascendingTime()
601  << EI_Time(time)
602  << EI_Field(input_name())
603  << it->ei_address());
604  }
605  last_time = time;
606 
607  break;
608  }
609  }
610  }
611 
612 }
613 
614 
615 
616 template<int spacedim, class Value>
617 void Field<spacedim,Value>::set_output_data_cache(OutputTime::DiscreteSpace space_type, std::shared_ptr<OutputTime> stream) {
618  typedef typename Value::element_type ElemType;
619 
620  auto output_cache_base = stream->prepare_compute_data<ElemType>(this->name(), space_type,
621  (unsigned int)Value::NRows_, (unsigned int)Value::NCols_);
622  output_data_cache_ = std::dynamic_pointer_cast<ElementDataCache<ElemType>>(output_cache_base);
623 }
624 
625 
626 template<int spacedim, class Value>
627 void Field<spacedim,Value>::compute_field_data(OutputTime::DiscreteSpace space_type, std::shared_ptr<OutputTime> stream) {
628  std::shared_ptr<OutputMeshBase> output_mesh = stream->get_output_mesh_ptr();
629  ASSERT(output_mesh);
630 
631  ASSERT_EQ(space_type, OutputTime::NATIVE_DATA);
632 
633  /* Copy data to array */
634  std::shared_ptr< FieldFE<spacedim, Value> > field_fe_ptr = this->get_field_fe();
635 
636  if (field_fe_ptr) {
637  auto native_output_data_base = stream->prepare_compute_data<double>(this->name(), space_type,
638  (unsigned int)Value::NRows_, (unsigned int)Value::NCols_,
639  typeid(field_fe_ptr->get_dofhandler()->ds()->fe()[0_d].get()).name(), // should be used better solution of fe_type setting
640  // e.g. method 'name()' of FiniteElement and descendants
641  field_fe_ptr->get_dofhandler()->max_elem_dofs());
642  // try casting actual ElementDataCache
643  auto native_output_data = std::dynamic_pointer_cast<ElementDataCache<double>>(native_output_data_base);
644  field_fe_ptr->native_data_to_cache(*native_output_data);
645  } else {
646  WarningOut().fmt("Field '{}' of native data space type is not of type FieldFE. Output will be skipped.\n", this->name());
647  }
648 
649  /* Set the last time */
650  stream->update_time(this->time());
651 
652 }
653 
654 
655 template<int spacedim, class Value>
657 {
658  for (unsigned int i=0; i<offsets.size(); ++i) {
659  if (offsets[i] == -1) continue; // skip empty value
660  auto ret_value = Value::get_from_array(this->value_cache_, i);
661  const Value &ele_value = Value( ret_value );
662  output_data_cache_->store_value(offsets[i], ele_value.mem_ptr() );
663  }
664 }
665 
666 
667 template<int spacedim, class Value>
668 void Field<spacedim,Value>::fill_observe_value(std::shared_ptr<ElementDataCacheBase> output_cache_base, const std::vector<int> &offsets)
669 {
670  typedef typename Value::element_type ElemType;
671 
672  std::shared_ptr<ElementDataCache<ElemType>> observe_data_cache =
673  std::dynamic_pointer_cast<ElementDataCache<ElemType>>(output_cache_base);
674 
675  for (unsigned int i=0; i<offsets.size(); ++i) {
676  if (offsets[i] == -1) continue; // skip empty value
677  auto ret_value = Value::get_from_array(this->value_cache_, i);
678  const Value &ele_value = Value( ret_value );
679  observe_data_cache->store_value(offsets[i], ele_value.mem_ptr() );
680  }
681 }
682 
683 
684 template<int spacedim, class Value>
685 std::shared_ptr< FieldFE<spacedim, Value> > Field<spacedim,Value>::get_field_fe() {
686  ASSERT_EQ(this->mesh()->region_db().size(), region_fields_.size()).error();
687  ASSERT(!this->shared_->bc_).error("FieldFE output of native data is supported only for bulk fields!");
688 
689  std::shared_ptr< FieldFE<spacedim, Value> > field_fe_ptr;
690 
691  bool is_fe = (region_fields_.size()>0); // indicate if FieldFE is defined on all bulk regions
692  is_fe = is_fe && region_fields_[1] && (typeid(*region_fields_[1]) == typeid(FieldFE<spacedim, Value>));
693  for (unsigned int i=3; i<2*this->mesh()->region_db().bulk_size(); i+=2)
694  if (!region_fields_[i] || (region_fields_[i] != region_fields_[1])) {
695  is_fe = false;
696  break;
697  }
698  if (is_fe) {
699  field_fe_ptr = std::dynamic_pointer_cast< FieldFE<spacedim, Value> >( region_fields_[1] );
700  }
701 
702  return field_fe_ptr;
703 }
704 
705 
706 template<int spacedim, class Value>
707 void Field<spacedim, Value>::cache_reallocate(const ElementCacheMap &cache_map, unsigned int region_idx) const {
708  // Call cache_reinit of FieldAlgoBase descendant on appropriate region
709  if (region_fields_[region_idx] != nullptr)
710  region_fields_[region_idx]->cache_reinit(cache_map);
711 }
712 
713 
714 template<int spacedim, class Value>
715 void Field<spacedim, Value>::cache_update(ElementCacheMap &cache_map, unsigned int region_patch_idx) const {
716  unsigned int region_idx = cache_map.region_idx_from_chunk_position(region_patch_idx);
717  if (region_fields_[region_idx] != nullptr) // skips bounadry regions for bulk fields and vice versa
718  region_fields_[region_idx]->cache_update(value_cache_, cache_map, region_patch_idx);
719 }
720 
721 
722 template<int spacedim, class Value>
724  if (region_fields_[i_reg] != nullptr) return region_fields_[i_reg]->set_dependency(*this->shared_->default_fieldset_);
725  else return std::vector<const FieldCommon *>();
726 }
727 
728 
729 template<int spacedim, class Value>
731  return &value_cache_;
732 }
733 
734 
735 template<>
737  return nullptr;
738 }
739 
740 template<>
742  return nullptr;
743 }
744 
745 
746 template<int spacedim, class Value>
748  return &value_cache_;
749 }
750 
751 
752 template<>
754  return nullptr;
755 }
756 
757 template<>
759  return nullptr;
760 }
761 
762 
763 
764 
765 #endif /* FIELD_IMPL_HH_ */
FieldCommon::units
FieldCommon & units(const UnitSI &units)
Set basic units of the field.
Definition: field_common.hh:153
result_none
@ result_none
Definition: field_algo_base.hh:71
LimitSide::right
@ right
FieldCommon::shared_
std::shared_ptr< SharedData > shared_
Definition: field_common.hh:682
BulkPoint::elem_patch_idx
unsigned int elem_patch_idx() const
Definition: eval_subset.hh:79
Field::set_dependency
std::vector< const FieldCommon * > set_dependency(unsigned int i_reg) const override
Definition: field.impl.hh:723
Field::cache_reallocate
void cache_reallocate(const ElementCacheMap &cache_map, unsigned int region_idx) const override
Implements FieldCommon::cache_allocate.
Definition: field.impl.hh:707
CacheMapElementNumber::get
static unsigned int get()
Return number of stored elements.
Definition: field_value_cache.hh:94
reader_to_storage.hh
FieldCommon::last_limit_side_
LimitSide last_limit_side_
Definition: field_common.hh:706
Field::value_cache
FieldValueCache< double > * value_cache() override
Implements FieldCommon::value_cache.
Definition: field.impl.hh:730
eval_subset.hh
BulkPoint::elm_cache_map
const ElementCacheMap * elm_cache_map() const
Definition: eval_subset.hh:73
Field::fill_data_value
void fill_data_value(const std::vector< int > &offsets) override
Implements FieldCommon::fill_data_value.
Definition: field.impl.hh:656
Input::ReaderToStorage
Reader for (slightly) modified input files.
Definition: reader_to_storage.hh:96
Field::compute_field_data
void compute_field_data(OutputTime::DiscreteSpace space_type, std::shared_ptr< OutputTime > stream)
Definition: field.impl.hh:627
Field< spacedim, FieldValue< 3 >::Tensor >::HistoryPoint
pair< double, FieldBasePtr > HistoryPoint
Pair: time, pointer to FieldBase instance.
Definition: field.hh:378
FieldCommon::last_time_
double last_time_
Definition: field_common.hh:705
Field::set_time
bool set_time(const TimeStep &time, LimitSide limit_side) override
Definition: field.impl.hh:286
MeshBase::region_db
const RegionDB & region_db() const
Definition: mesh.h:175
FieldCommon::flags
FieldFlag::Flags & flags()
Definition: field_common.hh:290
Field::value_cache_
FieldValueCache< typename Value::element_type > value_cache_
Definition: field.hh:420
ASSERT
#define ASSERT(expr)
Definition: asserts.hh:351
FieldCommon::set_shape
void set_shape(uint n_rows, uint n_cols)
Definition: field_common.hh:574
FieldCommon::messages_data_
static std::vector< MessageData > messages_data_
Vector of data of initialization messages.
Definition: field_common.hh:739
Field::check_initialized_region_fields_
void check_initialized_region_fields_()
Definition: field.impl.hh:504
FieldCommon::set_component_index
void set_component_index(unsigned int idx)
Definition: field_common.hh:452
Input::Type::Integer
Class for declaration of the integral input data.
Definition: type_base.hh:483
Field::Field
Field()
Definition: field.impl.hh:41
ElementCacheMap
Directing class of FieldValueCache.
Definition: field_value_cache.hh:152
FieldEnum
unsigned int FieldEnum
Definition: field_values.hh:56
eval_points.hh
value
static constexpr bool value
Definition: json.hpp:87
RegionIdx::is_valid
bool is_valid() const
Returns false if the region has undefined/invalid value.
Definition: region.hh:77
FieldResult
FieldResult
Definition: field_algo_base.hh:70
field_set.hh
FieldCommon::mesh
const Mesh * mesh() const
Definition: field_common.hh:287
BulkPoint
Base point accessor class.
Definition: eval_subset.hh:55
Field::output_data_cache_
std::shared_ptr< ElementDataCache< typename Value::element_type > > output_data_cache_
ElementDataCache used during field output, object is shared with OutputTime.
Definition: field.hh:423
result_other
@ result_other
Definition: field_algo_base.hh:72
THROW
#define THROW(whole_exception_expr)
Wrapper for throw. Saves the throwing point.
Definition: exceptions.hh:53
std::vector< FieldEnum >
ElementAccessor
Definition: dh_cell_accessor.hh:32
TimeStep::gt
bool gt(double other_time) const
Definition: time_governor.hh:167
SidePoint
General point a+ side_begin_ + ccessor allow iterate over quadrature points of given side defined in ...
Definition: eval_subset.hh:116
Field::get_input_type
IT::Instance get_input_type() override
Definition: field.impl.hh:178
field_fe.hh
RegionIdx::idx
unsigned int idx() const
Returns a global index of the region.
Definition: region.hh:81
Field::get_field_fe
std::shared_ptr< FieldFE< spacedim, Value > > get_field_fe()
Definition: field.impl.hh:685
TimeStep::read_time
double read_time(Input::Iterator< Input::Tuple > time_it, double default_time=std::numeric_limits< double >::quiet_NaN()) const
Definition: time_governor.cc:262
fmt::format
std::string format(CStringRef format_str, ArgList args)
Definition: format.h:3141
Field::get_value_attribute
std::string get_value_attribute() const override
Definition: field.impl.hh:419
Field::cache_update
void cache_update(ElementCacheMap &cache_map, unsigned int region_patch_idx) const override
Implements FieldCommon::cache_update.
Definition: field.impl.hh:715
ASSERT_LT
#define ASSERT_LT(a, b)
Definition of comparative assert macro (Less Than) only for debug mode.
Definition: asserts.hh:301
result_constant
@ result_constant
Definition: field_algo_base.hh:73
FieldCommon::shape_
std::vector< uint > shape_
Definition: field_common.hh:549
Region
Definition: region.hh:145
Input::Iterator
Definition: accessors.hh:143
SidePoint::eval_point_idx
unsigned int eval_point_idx() const
Return index in EvalPoints object.
Definition: eval_subset.hh:135
Field::update_history
void update_history(const TimeStep &time)
Definition: field.impl.hh:433
TimeStep::end
double end() const
Definition: time_governor.hh:161
Input::Record
Accessor to the data with type Type::Record.
Definition: accessors.hh:291
FieldCommon::multifield_
bool multifield_
Definition: field_common.hh:728
ASSERT_PERMANENT
#define ASSERT_PERMANENT(expr)
Allow use shorter versions of macro names if these names is not used with external library.
Definition: asserts.hh:348
RegionDB::bulk_size
unsigned int bulk_size() const
Definition: region.cc:268
FieldAlgoBaseInitData
Helper struct stores data for initizalize descentants of FieldAlgorithmBase.
Definition: field_algo_base.hh:81
Field::operator[]
Value::return_type operator[](unsigned int i_cache_point) const
Return item of value_cache_ given by i_cache_point.
Definition: field.impl.hh:170
accessors.hh
Field::set
void set(FieldBasePtr field, double time, std::vector< std::string > region_set_names={"ALL"})
Definition: field.impl.hh:244
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:317
Field::field_result
FieldResult field_result(RegionSet region_set) const override
Indicates special field states.
Definition: field.impl.hh:396
Input::AbstractRecord
Accessor to the polymorphic input data of a type given by an AbstracRecord object.
Definition: accessors.hh:458
FieldCommon
Common abstract parent of all Field<...> classes.
Definition: field_common.hh:77
Field::data_
std::shared_ptr< SharedData > data_
Definition: field.hh:392
Input::Record::ei_address
EI_Address ei_address() const
Definition: accessors.cc:178
Field::field_output
void field_output(std::shared_ptr< OutputTime > stream, OutputTime::DiscreteSpace type) override
Definition: field.impl.hh:384
ASSERT_EQ
#define ASSERT_EQ(a, b)
Definition of comparative assert macro (EQual) only for debug mode.
Definition: asserts.hh:333
Field::factories_
std::vector< std::shared_ptr< FactoryBase > > factories_
Definition: field.hh:409
Input::Record::opt_val
bool opt_val(const string &key, Ret &value) const
Definition: accessors_impl.hh:107
Input::format_JSON
@ format_JSON
Definition: reader_to_storage.hh:60
Input::Type::Instance
Helper class that stores data of generic types.
Definition: type_generic.hh:89
Input::ReaderToStorage::get_root_interface
T get_root_interface() const
Returns the root accessor.
Definition: reader_to_storage.cc:150
LimitSide
LimitSide
Definition: field_common.hh:64
Field::get_multifield_input_type
IT::Array get_multifield_input_type() override
Definition: field.impl.hh:185
Field::region_fields_
std::vector< FieldBasePtr > region_fields_
Definition: field.hh:407
BulkPoint::eval_point_idx
unsigned int eval_point_idx() const
Return index in EvalPoints object.
Definition: eval_subset.hh:84
field_algo_base.impl.hh
Field< spacedim, FieldValue< 3 >::Tensor >::RegionHistory
boost::circular_buffer< HistoryPoint > RegionHistory
Nearest history of one region.
Definition: field.hh:380
Input::Record::find
Iterator< Ret > find(const string &key) const
Definition: accessors_impl.hh:91
FieldValue_
Definition: field_values.hh:248
Field::add_factory
void add_factory(std::shared_ptr< FactoryBase > factory)
Definition: field.impl.hh:560
Input::Type
Definition: balance.hh:41
Value
@ Value
Definition: finite_element.hh:43
observe.hh
Field< spacedim, FieldValue< 3 >::Tensor >::FieldBasePtr
std::shared_ptr< FieldBaseType > FieldBasePtr
Definition: field.hh:96
FieldFE
Definition: field.hh:60
Mesh
Definition: mesh.h:362
Field::no_check_control_field_
std::shared_ptr< ControlField > no_check_control_field_
Definition: field.hh:402
TimeGovernor::read_time
double read_time(Input::Iterator< Input::Tuple > time_it, double default_time=std::numeric_limits< double >::quiet_NaN()) const
Definition: time_governor.cc:793
Input::Type::Array
Class for declaration of inputs sequences.
Definition: type_base.hh:339
Field::set_mesh
void set_mesh(const Mesh &mesh) override
Definition: field.impl.hh:205
ElementCacheMap::region_idx_from_chunk_position
unsigned int region_idx_from_chunk_position(unsigned int chunk_pos) const
Return begin position of region chunk specified by position in map.
Definition: field_value_cache.hh:285
Input::Array
Accessor to input data conforming to declared Array.
Definition: accessors.hh:566
Field::fill_observe_value
void fill_observe_value(std::shared_ptr< ElementDataCacheBase > output_cache_base, const std::vector< int > &offsets) override
Implements FieldCommon::fill_observe_value.
Definition: field.impl.hh:668
WarningOut
#define WarningOut()
Macro defining 'warning' record of log.
Definition: logger.hh:278
Input::Tuple
Accessor to the data with type Type::Tuple.
Definition: accessors.hh:411
std
Definition: doxy_dummy_defs.hh:5
field_value_cache.hh
FieldFlag::equation_input
static constexpr Mask equation_input
The field is data parameter of the owning equation. (default on)
Definition: field_flag.hh:33
FieldCommon::get_flags
FieldFlag::Flags get_flags() const
Definition: field_common.hh:293
output_mesh.hh
Classes for auxiliary output mesh.
Field::FactoryBase::is_active_field_descriptor
virtual bool is_active_field_descriptor(const Input::Record &in_rec, const std::string &input_name)
Definition: field.impl.hh:578
region.hh
Armor::Array
Definition: armor.hh:597
FieldFlag::declare_input
static constexpr Mask declare_input
The field can be set from input. The key in input field descriptor is declared. (default on)
Definition: field_flag.hh:35
FieldCommon::SharedData
Definition: field_common.hh:588
Field::set_input_list
void set_input_list(const Input::Array &list, const TimeGovernor &tg) override
Definition: field.impl.hh:586
FieldCommon::name
const std::string & name() const
Definition: field_common.hh:246
FieldCommon::n_comp
unsigned int n_comp() const
Definition: field_common.hh:272
Field::is_constant
bool is_constant(Region reg) override
Definition: field.impl.hh:235
OutputTime::DiscreteSpace
DiscreteSpace
Definition: output_time.hh:108
FieldCommon::is_jump_time_
bool is_jump_time_
Definition: field_common.hh:712
FieldCommon::input_name
const std::string & input_name() const
Definition: field_common.hh:243
FieldCommon::limits
std::pair< double, double > limits() const
Definition: field_common.hh:261
Field
Class template representing a field with values dependent on: point, element, and region.
Definition: field.hh:92
std::list
Definition: doxy_dummy_defs.hh:9
TimeStep::ge
bool ge(double other_time) const
Definition: time_governor.hh:173
Field::disable_where
auto disable_where(const Field< spacedim, typename FieldValue< spacedim >::Enum > &control_field, const vector< FieldEnum > &value_list) -> Field &
Definition: field.impl.hh:195
ASSERT_PTR
#define ASSERT_PTR(ptr)
Definition of assert macro checking non-null pointer (PTR) only for debug mode.
Definition: asserts.hh:341
Field::FactoryBase::create_field
virtual FieldBasePtr create_field(Input::Record rec, const FieldCommon &field)
Definition: field.impl.hh:566
OutputTime::N_DISCRETE_SPACES
static const unsigned int N_DISCRETE_SPACES
Definition: output_time.hh:107
output_element.hh
Class OutputElement and its iterator OutputElementIterator on the output mesh.
Field::operator()
Value::return_type operator()(BulkPoint &p)
Return appropriate value to BulkPoint in FieldValueCache.
Definition: field.impl.hh:155
Field::copy_from
void copy_from(const FieldCommon &other) override
Definition: field.impl.hh:367
FieldCommon::time
double time() const
Definition: field_common.hh:300
ElementCacheMap::get_value
Value::return_type get_value(const FieldValueCache< typename Value::element_type > &field_cache, unsigned int elem_patch_idx, unsigned int eval_points_idx) const
Return value of evaluation point given by idx of element in patch and local point idx in EvalPoints f...
Definition: field_value_cache.hh:296
Field::set_output_data_cache
void set_output_data_cache(OutputTime::DiscreteSpace space_type, std::shared_ptr< OutputTime > stream) override
Definition: field.impl.hh:617
FieldAlgorithmBase::function_factory
static std::shared_ptr< FieldAlgorithmBase< spacedim, Value > > function_factory(const Input::AbstractRecord &rec, const struct FieldAlgoBaseInitData &init_data)
Definition: field_algo_base.impl.hh:101
field.hh
FieldCommon::MessageData
Store data of one initialization message.
Definition: field_common.hh:99
FieldCommon::set_time_result_
TimeStatus set_time_result_
Definition: field_common.hh:699
FieldCommon::name_
std::string name_
Definition: field_common.hh:677
OutputTime::NATIVE_DATA
@ NATIVE_DATA
Definition: output_time.hh:112
FieldCommon::component_index_
unsigned int component_index_
Definition: field_common.hh:722
FieldCommon::name
FieldCommon & name(const string &name)
Definition: field_common.hh:121
Field::operator=
Field & operator=(const Field &other)
Definition: field.impl.hh:119