Flow123d  master-f44eb46
field_constant.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_constant.hh
15  * @brief
16  */
17 
18 #ifndef FIELD_CONSTANT_HH_
19 #define FIELD_CONSTANT_HH_
20 
21 #include <stdio.h> // for sprintf
22 #include <string.h> // for memcpy
23 #include <new> // for operator new[]
24 #include <string> // for operator<<
25 #include <vector> // for vector
26 #include <armadillo>
27 #include "fields/field_algo_base.hh" // for FieldAlgorithmBase
28 #include "fields/field_values.hh" // for FieldValue<>::TensorFixed
29 #include "tools/unit_converter.hh" // for ExcInvalidUnit, ExcNonc...
30 #include "input/accessors.hh" // for ExcTypeMismatch, ExcAcc...
31 #include "input/accessors_impl.hh" // for Record::val, Iterator::...
32 #include "input/storage.hh" // for ExcStorageTypeMismatch
33 #include "input/type_record.hh" // for Record::ExcRecordKeyNot...
34 #include "system/exceptions.hh" // for ExcAssertMsg::~ExcAsser...
35 template <int spacedim> class ElementAccessor;
36 
37 
38 /**
39  * Class representing spatially constant fields.
40  *
41  */
42 template <int spacedim, class Value>
43 class FieldConstant : public FieldAlgorithmBase<spacedim, Value>
44 {
45 public:
48 
49  /**
50  * Default constructor, optionally we need number of components @p n_comp in the case of Vector valued fields.
51  */
52  FieldConstant(unsigned int n_comp=0);
53 
54 
55  /**
56  * Return Record for initialization of FieldConstant that is derived from Abstract given by @p a_type
57  * and the individual elements of the possible Value (vector, tensor) have Input::Type @p eit.
58  */
59  static const Input::Type::Record & get_input_type();
60 
61  /**
62  *
63  */
65 
66  /**
67  * Smart setter from the given value to return.
68  */
69  FieldConstant<spacedim, Value> &set_value(const typename Value::return_type &val);
70 
71  /**
72  * This method initialize actual value of the field given from the given Input::Record @p rec.
73  */
74  virtual void init_from_input(const Input::Record &rec, const struct FieldAlgoBaseInitData& init_data) override;
75 
76 
77 
79  ElementCacheMap &cache_map, unsigned int region_patch_idx) override;
80 
81 
82  virtual ~FieldConstant();
83 
84 protected:
85  /// Compare field value with given minimal and maximal limits.
86  void check_field_limits(const Input::Record &rec, const struct FieldAlgoBaseInitData& init_data);
87 
88 private:
89  /// Registrar of class to factory
90  static const int registrar;
91 
92 };
93 
94 
95 #endif /* FIELD_CONSTANT_HH_ */
Directing class of FieldValueCache.
unsigned int n_comp() const
Space< spacedim >::Point Point
void cache_update(FieldValueCache< typename Value::element_type > &data_cache, ElementCacheMap &cache_map, unsigned int region_patch_idx) override
static const Input::Type::Record & get_input_type()
void check_field_limits(const Input::Record &rec, const struct FieldAlgoBaseInitData &init_data)
Compare field value with given minimal and maximal limits.
FieldConstant< spacedim, Value > & set_value(const typename Value::return_type &val)
static Input::Type::Array get_tensor_input_type()
Implementation.
static const int registrar
Registrar of class to factory.
FieldConstant(unsigned int n_comp=0)
virtual ~FieldConstant()
virtual void init_from_input(const Input::Record &rec, const struct FieldAlgoBaseInitData &init_data) override
FieldAlgorithmBase< spacedim, Value >::Point Point
FieldAlgorithmBase< spacedim, Value > FactoryBaseType
Accessor to the data with type Type::Record.
Definition: accessors.hh:291
Class for declaration of inputs sequences.
Definition: type_base.hh:339
Record type proxy class.
Definition: type_record.hh:182
Helper struct stores data for initizalize descentants of FieldAlgorithmBase.