Flow123d  jenkins-Flow123d-windows-release-multijob-285
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_
 
const IT::Selectioninput_element_selection_
 
string input_default_
 
const Meshmesh_
 
Input::Array input_list_
 
Input::Iterator< Input::Recordlist_it_
 
bool is_fully_initialized_
 
std::vector< FieldEnumno_check_values_
 

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 356 of file field_common.hh.

Constructor & Destructor Documentation

FieldCommon::SharedData::SharedData ( )
inline

Empty constructor.

Definition at line 360 of file field_common.hh.

Member Data Documentation

bool FieldCommon::SharedData::bc_

True for boundary fields.

Definition at line 360 of file field_common.hh.

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

Names of field components.

Definition at line 373 of file field_common.hh.

string FieldCommon::SharedData::input_default_

Possible default value of the field.

Definition at line 398 of file field_common.hh.

std::string FieldCommon::SharedData::input_description_

Description of corresponding key in the Field list Record.

Definition at line 381 of file field_common.hh.

const 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.

In fact we must use raw pointer since selection may not be constructed yet (static variable).

Definition at line 394 of file field_common.hh.

Input::Array FieldCommon::SharedData::input_list_

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

Definition at line 407 of file field_common.hh.

std::string FieldCommon::SharedData::input_name_

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

Definition at line 377 of file field_common.hh.

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 417 of file field_common.hh.

Input::Iterator<Input::Record> FieldCommon::SharedData::list_it_

Iterator to current input field descriptor.

Definition at line 412 of file field_common.hh.

const Mesh* FieldCommon::SharedData::mesh_

Pointer to the mesh on which the field lives.

Definition at line 402 of file field_common.hh.

unsigned int FieldCommon::SharedData::n_comp_

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

Definition at line 369 of file field_common.hh.

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 424 of file field_common.hh.

UnitSI FieldCommon::SharedData::units_

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

Definition at line 385 of file field_common.hh.


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