FieldCommonBase::SharedData Struct Reference

#include <field.hh>

Collaboration diagram for FieldCommonBase::SharedData:

Public Attributes
bool	bc_
unsigned int	n_comp_
std::string	name_
std::string	desc_
std::string	units_
const IT::Selection *	element_selection_
string	default_
const Mesh *	mesh_
Input::Array	input_list_
Input::Iterator< Input::Record >	list_it_
bool	is_fully_initialized_
std::vector< FieldEnum >	no_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 306 of file field.hh.

Member Data Documentation

bool FieldCommonBase::SharedData::bc_

True for boundary fields.

Definition at line 310 of file field.hh.

string FieldCommonBase::SharedData::default_

Possible default value of the field.

Definition at line 339 of file field.hh.

std::string FieldCommonBase::SharedData::desc_

Description of corresponding key in the Field list Record.

Definition at line 322 of file field.hh.

const IT::Selection* FieldCommonBase::SharedData::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 335 of file field.hh.

Input::Array FieldCommonBase::SharedData::input_list_

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

Definition at line 348 of file field.hh.

bool FieldCommonBase::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 358 of file field.hh.

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

Iterator to current input field descriptor.

Definition at line 353 of file field.hh.

const Mesh* FieldCommonBase::SharedData::mesh_

Pointer to the mesh on which the field lives.

Definition at line 343 of file field.hh.

unsigned int FieldCommonBase::SharedData::n_comp_

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

Definition at line 314 of file field.hh.

std::string FieldCommonBase::SharedData::name_

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

Definition at line 318 of file field.hh.

std::vector<FieldEnum> FieldCommonBase::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 365 of file field.hh.

std::string FieldCommonBase::SharedData::units_

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

Definition at line 326 of file field.hh.

---

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

• /home/jb/workspace/flow123d/src/fields/field.hh