Flow123d  release_2.2.0-914-gf1a3a4f
Classes | Public Types | Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Friends | List of all members
Field< spacedim, Value > Class Template Reference

Class template representing a field with values dependent on: point, element, and region. More...

#include <field.hh>

Inheritance diagram for Field< spacedim, Value >:
Inheritance graph
[legend]
Collaboration diagram for Field< spacedim, Value >:
Collaboration graph
[legend]

Classes

class  FactoryBase
 
struct  SharedData
 

Public Types

typedef FieldAlgorithmBase< spacedim, ValueFieldBaseType
 
typedef std::shared_ptr< FieldBaseTypeFieldBasePtr
 
typedef FieldAlgorithmBase< spacedim, Value >::Point Point
 
typedef Value ValueType
 

Public Member Functions

 Field ()
 
 Field (const string &name, bool bc=false)
 
 Field (unsigned int component_index, string input_name, string name="", bool bc=false)
 
 Field (const Field &other)
 
Fieldoperator= (const Field &other)
 
IT::Instance get_input_type () override
 
IT::Array get_multifield_input_type () override
 
auto disable_where (const Field< spacedim, typename FieldValue< spacedim >::Enum > &control_field, const vector< FieldEnum > &value_list) -> Field &
 
void set_mesh (const Mesh &mesh) override
 
bool is_constant (Region reg) override
 
void set_field (const RegionSet &domain, FieldBasePtr field, double time=0.0)
 
void set_field (const RegionSet &domain, const Input::AbstractRecord &a_rec, double time=0.0)
 
bool set_time (const TimeStep &time, LimitSide limit_side) override
 
void copy_from (const FieldCommon &other) override
 
void field_output (std::shared_ptr< OutputTime > stream) override
 
void observe_output (std::shared_ptr< Observe > observe) override
 
FieldResult field_result (RegionSet region_set) const override
 Indicates special field states. More...
 
std::string get_value_attribute () const override
 
virtual Value::return_type const & value (const Point &p, const ElementAccessor< spacedim > &elm) const
 
virtual void value_list (const std::vector< Point > &point_list, const ElementAccessor< spacedim > &elm, std::vector< typename Value::return_type > &value_list) const
 
void add_factory (std::shared_ptr< FactoryBase > factory)
 
void set_input_list (const Input::Array &list) override
 
void compute_field_data (OutputTime::DiscreteSpace space_type, std::shared_ptr< OutputTime > stream)
 
- Public Member Functions inherited from FieldCommon
 TYPEDEF_ERR_INFO (EI_Time, double)
 
 TYPEDEF_ERR_INFO (EI_Field, std::string)
 
 DECLARE_INPUT_EXCEPTION (ExcNonascendingTime,<< "Non-ascending time: "<< EI_Time::val<< " for field "<< EI_Field::qval<< ".\n")
 
 DECLARE_INPUT_EXCEPTION (ExcMissingDomain,<< "Missing domain specification (region or r_id) in the field descriptor:")
 
 DECLARE_EXCEPTION (ExcFieldMeshDifference,<< "Two copies of the field "<< EI_Field::qval<< "call set_mesh with different arguments.\n")
 
FieldCommonname (const string &name)
 
FieldCommondescription (const string &description)
 
FieldCommoninput_default (const string &input_default)
 
FieldCommonunits (const UnitSI &units)
 Set basic units of the field. More...
 
FieldCommonset_limits (double min, double max=std::numeric_limits< double >::max())
 
FieldCommoninput_selection (Input::Type::Selection element_selection)
 
FieldCommonoutput_type (OutputTime::DiscreteSpace rt)
 
FieldCommonflags (FieldFlag::Flags::Mask mask)
 
FieldCommonflags_add (FieldFlag::Flags::Mask mask)
 
void set_components (const std::vector< string > &names)
 
const std::string & input_name () const
 
const std::string & name () const
 
const std::string description () const
 
const std::string & input_default () const
 
const UnitSIunits () const
 
std::pair< double, double > limits () const
 
OutputTime::DiscreteSpace get_output_type () const
 
bool is_bc () const
 
unsigned int n_comp () const
 
const Meshmesh () const
 
FieldFlag::Flagsflags ()
 
FieldFlag::Flags get_flags () const
 
double time () const
 
bool is_jump_time ()
 
unsigned int input_list_size () const
 
bool changed () const
 
void mark_input_times (const TimeGovernor &tg)
 
void set_component_index (unsigned int idx)
 
bool is_multifield () const
 
virtual ~FieldCommon ()
 

Static Public Attributes

static const unsigned int space_dim = spacedim
 

Protected Types

typedef pair< double, FieldBasePtrHistoryPoint
 Pair: time, pointer to FieldBase instance. More...
 
typedef boost::circular_buffer< HistoryPointRegionHistory
 Nearest history of one region. More...
 
typedef Field< spacedim, typename FieldValue< spacedim >::Enum > ControlField
 
- Protected Types inherited from FieldCommon
enum  TimeStatus { TimeStatus::changed, TimeStatus::constant, TimeStatus::unknown }
 

Protected Member Functions

void update_history (const TimeStep &time)
 
void check_initialized_region_fields_ ()
 
std::shared_ptr< FieldFE< spacedim, Value > > get_field_fe ()
 
- Protected Member Functions inherited from FieldCommon
 FieldCommon ()
 
 FieldCommon (const FieldCommon &other)
 
void set_history_changed ()
 

Protected Attributes

std::shared_ptr< SharedDatadata_
 
std::shared_ptr< ControlFieldno_check_control_field_
 
std::vector< FieldBasePtrregion_fields_
 
std::vector< std::shared_ptr< FactoryBase > > factories_
 
- Protected Attributes inherited from FieldCommon
std::string name_
 
std::shared_ptr< SharedDatashared_
 
TimeStatus set_time_result_
 
double last_time_ = -numeric_limits<double>::infinity()
 
LimitSide last_limit_side_ = LimitSide::left
 
bool is_jump_time_
 
OutputTime::DiscreteSpace type_of_output_data_ = OutputTime::ELEM_DATA
 
unsigned int component_index_
 
bool multifield_
 
FieldFlag::Flags flags_ = FieldFlag::declare_input & FieldFlag::equation_input & FieldFlag::allow_output
 Field flags. Default setting is "an equation input field, that can read from user input, and can be written to output". More...
 

Friends

template<int dim, class Val >
class MultiField
 

Additional Inherited Members

- Static Public Member Functions inherited from FieldCommon
static IT::Record field_descriptor_record (const string &record_name)
 
static const std::string field_descriptor_record_description (const string &record_name)
 
static bool print_message_table (ostream &stream, std::string equation_name)
 
- Static Protected Attributes inherited from FieldCommon
static const unsigned int history_length_limit_ =3
 
static std::vector< MessageDatamessages_data_ = std::vector<FieldCommon::MessageData>()
 Vector of data of initialization messages. More...
 

Detailed Description

template<int spacedim, class Value>
class Field< spacedim, Value >

Class template representing a field with values dependent on: point, element, and region.

By "field" we mean a mapping of a a pair (Point, Time) to a Value, where Point is from spacedim dimensional ambient space, Time is real number (set by set_time method), and Value type representing range of the field, which can be: real scalar, integer scalar (a discrete value), real vector of fixed (compile time) size, real vector of runtime size, or a matrix of fixed dimensions. Extensions to vectors or matrices of integers, or to variable tensors are possible. For vector and matrix values we use classes provided by Armadillo library for linear algebra. The Value template parameter should FieldValue<> template, usual choices are: FieldValue<spacedim>::Scalar, FieldValue<spacedim>::Integer, FieldValue<spacedim>::Enum, FieldValue<spacedim>::VectorFixed, FieldValue<spacedim>::TensorFixed.

This class assign particular fields (instances of descendants of FiledBase) to the regions. It keeps a table of pointers to fields for every possible bulk region index (very same functionality, but for boundary regions is provided by BCField class). This class has interface very similar to FiledBase, however key methods value, and value_list are not virtual in this class by contrast these methods are inlined to minimize overhead for simplest fields like FieldConstant.

TODO: currently it works only for spacedim==3 since we have only mesh in 3D ambient space.

Definition at line 62 of file field.hh.

Member Typedef Documentation

template<int spacedim, class Value>
typedef Field<spacedim, typename FieldValue<spacedim>::Enum > Field< spacedim, Value >::ControlField
protected

If this pointer is set, turn off check of initialization in the set_time method on the regions where the method get_constant_enum_value of the control field returns value from no_check_values_. This field is private copy, its set_time method is called from the set_Time method of actual object.

Definition at line 340 of file field.hh.

template<int spacedim, class Value>
typedef std::shared_ptr< FieldBaseType > Field< spacedim, Value >::FieldBasePtr

Definition at line 66 of file field.hh.

template<int spacedim, class Value>
typedef FieldAlgorithmBase<spacedim, Value> Field< spacedim, Value >::FieldBaseType

Definition at line 65 of file field.hh.

template<int spacedim, class Value>
typedef pair<double, FieldBasePtr> Field< spacedim, Value >::HistoryPoint
protected

Pair: time, pointer to FieldBase instance.

Definition at line 317 of file field.hh.

template<int spacedim, class Value>
typedef FieldAlgorithmBase<spacedim, Value>::Point Field< spacedim, Value >::Point

Definition at line 67 of file field.hh.

template<int spacedim, class Value>
typedef boost::circular_buffer<HistoryPoint> Field< spacedim, Value >::RegionHistory
protected

Nearest history of one region.

Definition at line 319 of file field.hh.

template<int spacedim, class Value>
typedef Value Field< spacedim, Value >::ValueType

Definition at line 68 of file field.hh.

Constructor & Destructor Documentation

template<int spacedim, class Value >
Field< spacedim, Value >::Field ( )

Default constructor.

Definition at line 39 of file field.impl.hh.

template<int spacedim, class Value >
Field< spacedim, Value >::Field ( const string &  name,
bool  bc = false 
)

Definition at line 52 of file field.impl.hh.

template<int spacedim, class Value >
Field< spacedim, Value >::Field ( unsigned int  component_index,
string  input_name,
string  name = "",
bool  bc = false 
)

Constructor that must be used for create of MultiField components.

Set parameters component_index_, shared_->input_name_ and name_. Parameter name_ of Field is consisted of component name and MultiField name.

Definition at line 68 of file field.impl.hh.

template<int spacedim, class Value >
Field< spacedim, Value >::Field ( const Field< spacedim, Value > &  other)

Copy constructor. Keeps shared history, declaration data, mesh.

Definition at line 84 of file field.impl.hh.

Member Function Documentation

template<int spacedim, class Value >
void Field< spacedim, Value >::add_factory ( std::shared_ptr< FactoryBase factory)

Add a new factory for creating Field algorithms on individual regions. The last factory is tried first, the last one is always the default implementation Field<...>::FactoryBase.

The Field<...> object keeps a list of such factories. When the instance of a new field algorithm has to be created from the input field descriptor, we pass through the list of factories backward and let factories to create the field algorithm instance from the actual input field descriptor. The first instance (non-null pointer) is used.

Definition at line 524 of file field.impl.hh.

Here is the caller graph for this function:

template<int spacedim, class Value >
void Field< spacedim, Value >::check_initialized_region_fields_ ( )
protected

Check that whole field list (region_fields_) is set, possibly use default values for unset regions.

Definition at line 468 of file field.impl.hh.

Here is the caller graph for this function:

template<int spacedim, class Value >
void Field< spacedim, Value >::compute_field_data ( OutputTime::DiscreteSpace  space_type,
std::shared_ptr< OutputTime stream 
)

Interpolate given field into output discrete space_type and store the values into storage of output time stream for postponed output.

Definition at line 581 of file field.impl.hh.

Here is the caller graph for this function:

template<int spacedim, class Value >
void Field< spacedim, Value >::copy_from ( const FieldCommon other)
overridevirtual

Check that other has same type and assign from it.

Implements FieldCommon.

Definition at line 317 of file field.impl.hh.

template<int spacedim, class Value >
auto Field< spacedim, Value >::disable_where ( const Field< spacedim, typename FieldValue< spacedim >::Enum > &  control_field,
const vector< FieldEnum > &  value_list 
) -> Field &

By this method you can allow that the field need not to be set on regions (and times) where the given control_field is FieldConstant and has value in given value_list. We check this in the set_time method. Through this mechanism we can switch of e.g. boundary data fields according to the type of the boundary condition.

Definition at line 150 of file field.impl.hh.

template<int spacedim, class Value >
void Field< spacedim, Value >::field_output ( std::shared_ptr< OutputTime stream)
overridevirtual

Implementation of FieldCommonBase::output().

Implements FieldCommon.

Definition at line 334 of file field.impl.hh.

template<int spacedim, class Value >
FieldResult Field< spacedim, Value >::field_result ( RegionSet  region_set) const
overridevirtual

Indicates special field states.

Returns true, if field is currently set to a time in which it is discontinuous. Return possible values from the enum FieldResult, see description there. The initial state is field_none, if the field is correctly set on all regions of the region_set given as parameter we return state field_other

  • Special field values spatially constant. Could allow optimization of tensor multiplication and tensor or vector addition. field_result_ should be set in constructor and in set_time method of particular Field implementation. We return value result_none, if the field is not initialized on the region of the given element accessor elm. Other possible results are: result_zeros, result_eye, result_ones, result_constant, result_other see FieldResult for explanation.

Implements FieldCommon.

Definition at line 372 of file field.impl.hh.

template<int spacedim, class Value >
std::shared_ptr< FieldFE< spacedim, Value > > Field< spacedim, Value >::get_field_fe ( )
protected

Check that the field is in fact FieldFE set on all bulk regions, return shared pointer to that FieldFE or NULL if the Field is not FieldFE.

Definition at line 681 of file field.impl.hh.

Here is the caller graph for this function:

template<int spacedim, class Value >
it::Instance Field< spacedim, Value >::get_input_type ( )
overridevirtual

Returns reference to input type of particular field instance, this is static member input_type of the corresponding FieldBase class (i.e. with same template parameters). However, for fields returning "Enum" we have to create whole unique Input::Type hierarchy using following method meka_input_tree. every instance since every such field use different Selection for initialization, even if all returns just unsigned int.

Implements FieldCommon.

Definition at line 133 of file field.impl.hh.

Here is the caller graph for this function:

template<int spacedim, class Value >
it::Array Field< spacedim, Value >::get_multifield_input_type ( )
overridevirtual

Returns input type for MultiField instance. TODO: temporary solution, see multifield_

Implements FieldCommon.

Definition at line 140 of file field.impl.hh.

template<int spacedim, class Value >
std::string Field< spacedim, Value >::get_value_attribute ( ) const
overridevirtual

Return value of input type attribute 'field_value_shape' that is appended to the input type of this field in FieldSet::make_field_descriptor_type and also to the output field selection created in EquationOutput::make_output_type. This attribute is used by GeoMop to have semantics of the input and output field data.

Attribute value is a valid JSON (and/or flow style YAML) with keys: 'subfields' - value True for multifields, False or not presented for single value fields 'shape' - [ NRows, Ncols] ... given by FieldValue 'type' - <element type>=""> (Double or Integer) ... given by FieldValue 'limit' - bounds of the field values.

Implements FieldCommon.

Definition at line 395 of file field.impl.hh.

template<int spacedim, class Value >
bool Field< spacedim, Value >::is_constant ( Region  reg)
overridevirtual

Direct read access to the table of Field pointers on regions. Implementation of FieldCommonBase::is_constant(). See also Field<>::field_result which provide better information about special field values.

Implements FieldCommon.

Definition at line 190 of file field.impl.hh.

template<int spacedim, class Value >
void Field< spacedim, Value >::observe_output ( std::shared_ptr< Observe observe)
overridevirtual

Implementation of FieldCommonBase::observe_output().

Implements FieldCommon.

Definition at line 347 of file field.impl.hh.

template<int spacedim, class Value >
Field< spacedim, Value > & Field< spacedim, Value >::operator= ( const Field< spacedim, Value > &  other)

Assignment operator. Same properties as copy constructor, but class member name_ is not copied.

Question: do we really need this, isn't copy constructor enough? Answer: It is necessary in (usual) case when Field instance is created as the class member but is filled later by assignment possibly from other class. TODO: operator can be merged with copy constructor, but we must provide to set correct value of name in method copy_from

Definition at line 98 of file field.impl.hh.

Here is the caller graph for this function:

template<int spacedim, class Value >
void Field< spacedim, Value >::set_field ( const RegionSet domain,
FieldBasePtr  field,
double  time = 0.0 
)

Assigns given field to all regions in given region set domain. Field is added to the history with given time and possibly used in the next call of the set_time method. Caller is responsible for correct construction of given field.

Use this method only if necessary.

Default time simplify setting steady fields.

Definition at line 199 of file field.impl.hh.

Here is the caller graph for this function:

template<int spacedim, class Value >
void Field< spacedim, Value >::set_field ( const RegionSet domain,
const Input::AbstractRecord a_rec,
double  time = 0.0 
)

Same as before but the field is first created using FieldBase::function_factory(), from given abstract record accessor a_rec.

Definition at line 226 of file field.impl.hh.

template<int spacedim, class Value >
void Field< spacedim, Value >::set_input_list ( const Input::Array list)
overridevirtual

Set the data list from which field will read its input. It is list of "field descriptors". When reading from the input list we consider only field descriptors containing key of named by the field name. These field descriptors has to have times forming ascending sequence.

The list is used by set_time method to set field on individual regions to actual FieldBase descendants.

Implements FieldCommon.

Definition at line 550 of file field.impl.hh.

template<int spacedim, class Value >
void Field< spacedim, Value >::set_mesh ( const Mesh mesh)
overridevirtual

Set mesh pointer and resize region arrays.

Implements abstract method.

Reimplemented from FieldCommon.

Definition at line 160 of file field.impl.hh.

Here is the caller graph for this function:

template<int spacedim, class Value >
bool Field< spacedim, Value >::set_time ( const TimeStep time,
LimitSide  limit_side 
)
overridevirtual

Check that whole field list is set, possibly use default values for unset regions and call set_time for every field in the field list.

Returns true if the field has been changed.

Implements FieldCommon.

Definition at line 239 of file field.impl.hh.

template<int spacedim, class Value >
void Field< spacedim, Value >::update_history ( const TimeStep time)
protected

Read input into regions_history_ possibly pop some old values from the history queue to keep its size less then history_length_limit_.

Definition at line 409 of file field.impl.hh.

Here is the caller graph for this function:

template<int spacedim, class Value >
Value::return_type const & Field< spacedim, Value >::value ( const Point p,
const ElementAccessor< spacedim > &  elm 
) const
inlinevirtual

Returns one value in one given point on an element given by ElementAccessor elm. It returns reference to he actual value in order to avoid temporaries for vector and tensor values.

Definition at line 368 of file field.hh.

Here is the caller graph for this function:

template<int spacedim, class Value>
void Field< spacedim, Value >::value_list ( const std::vector< Point > &  point_list,
const ElementAccessor< spacedim > &  elm,
std::vector< typename Value::return_type > &  value_list 
) const
inlinevirtual

Returns std::vector of scalar values in several points at once. The base class implements trivial implementation using the value(,,) method. This is not optimal as it involves lot of virtual calls, but this overhead can be negligible for more complex fields as Python of Formula.

Definition at line 382 of file field.hh.

Here is the caller graph for this function:

Friends And Related Function Documentation

template<int spacedim, class Value>
template<int dim, class Val >
friend class MultiField
friend

Definition at line 353 of file field.hh.

Member Data Documentation

template<int spacedim, class Value>
std::shared_ptr<SharedData> Field< spacedim, Value >::data_
protected

Definition at line 331 of file field.hh.

template<int spacedim, class Value>
std::vector<std::shared_ptr<FactoryBase> > Field< spacedim, Value >::factories_
protected

Definition at line 348 of file field.hh.

template<int spacedim, class Value>
std::shared_ptr<ControlField> Field< spacedim, Value >::no_check_control_field_
protected

Definition at line 341 of file field.hh.

template<int spacedim, class Value>
std::vector< FieldBasePtr > Field< spacedim, Value >::region_fields_
protected

Table with pointers to fields on individual regions.

Definition at line 346 of file field.hh.

template<int spacedim, class Value>
const unsigned int Field< spacedim, Value >::space_dim = spacedim
static

Definition at line 70 of file field.hh.


The documentation for this class was generated from the following files: