Flow123d  JS_before_hm-1804-gf2ad740aa
Public Member Functions | Public Attributes | List of all members
FieldCommon::SharedData Struct Reference

#include <field_common.hh>

Collaboration diagram for FieldCommon::SharedData:
Collaboration graph
[legend]

Public Member Functions

 SharedData ()
 

Public Attributes

bool bc_
 
unsigned int n_comp_
 
std::vector< std::string > comp_names_
 
std::string input_name_
 
std::string input_description_
 
UnitSI units_
 
IT::Selection input_element_selection_
 
string input_default_
 
const Meshmesh_
 
vector< Input::Recordinput_list_
 
unsigned int list_idx_
 
bool is_fully_initialized_
 
std::vector< FieldEnumno_check_values_
 
std::pair< double, double > limits_
 

Detailed Description

Setters for essential field properties. Data shared among copies of the same field.

This allow field copies in different equations with different time setting, but sharing common input field descriptor array and common history.

Definition at line 544 of file field_common.hh.

Constructor & Destructor Documentation

◆ SharedData()

FieldCommon::SharedData::SharedData ( )
inline

Empty constructor.

Definition at line 548 of file field_common.hh.

Member Data Documentation

◆ bc_

bool FieldCommon::SharedData::bc_

True for boundary fields.

Definition at line 549 of file field_common.hh.

◆ comp_names_

std::vector< std::string > FieldCommon::SharedData::comp_names_

Names of field components.

Definition at line 562 of file field_common.hh.

◆ input_default_

string FieldCommon::SharedData::input_default_

Possible default value of the field.

Definition at line 585 of file field_common.hh.

◆ input_description_

std::string FieldCommon::SharedData::input_description_

Description of corresponding key in the Field list Record.

Definition at line 570 of file field_common.hh.

◆ input_element_selection_

IT::Selection FieldCommon::SharedData::input_element_selection_

For Enum valued fields this is the input type selection that should be used to read possible values of the field (e.g. for FieldConstant the key 'value' has this selection input type).

Is empty selection for for non-enum values fields.

Definition at line 581 of file field_common.hh.

◆ input_list_

vector<Input::Record> FieldCommon::SharedData::input_list_

Vector of input field descriptors from which the field is set.

Definition at line 594 of file field_common.hh.

◆ input_name_

std::string FieldCommon::SharedData::input_name_

Name of the particular field. Used to name the key in the Field list Record.

Definition at line 566 of file field_common.hh.

◆ is_fully_initialized_

bool FieldCommon::SharedData::is_fully_initialized_

True after check_initialized_region_fields_ is called. That happen at first call of the set_time method.

Definition at line 604 of file field_common.hh.

◆ limits_

std::pair<double, double> FieldCommon::SharedData::limits_

Allow set minimal and maximal limit value of Field.

Definition at line 616 of file field_common.hh.

◆ list_idx_

unsigned int FieldCommon::SharedData::list_idx_

Index to current position of input field descriptor.

Definition at line 599 of file field_common.hh.

◆ mesh_

const Mesh* FieldCommon::SharedData::mesh_

Pointer to the mesh on which the field lives.

Definition at line 589 of file field_common.hh.

◆ n_comp_

unsigned int FieldCommon::SharedData::n_comp_

Number of components for fields that return variable size vectors. Zero in other cases.

Definition at line 558 of file field_common.hh.

◆ no_check_values_

std::vector<FieldEnum> FieldCommon::SharedData::no_check_values_

For which values of an enum valued field we do not check the field. User is responsible, that the value will not be called on such regions.

Definition at line 611 of file field_common.hh.

◆ units_

UnitSI FieldCommon::SharedData::units_

Units of the field values. Currently just a string description.

Definition at line 574 of file field_common.hh.


The documentation for this struct was generated from the following file: