#include <region.hh>

Collaboration diagram for RegionDB:

Classes
struct	ID

struct	Index

struct	Label

struct	RegionItem
	One item in region database. More...

Public Types
typedef std::map< unsigned int, unsigned int >	MapElementIDToRegionID

Public Member Functions
	TYPEDEF_ERR_INFO (EI_Label, const std::string)

	TYPEDEF_ERR_INFO (EI_ID, unsigned int)

	TYPEDEF_ERR_INFO (EI_IDOfOtherLabel, unsigned int)

	TYPEDEF_ERR_INFO (EI_LabelOfOtherID, const std::string)

	DECLARE_EXCEPTION (ExcAddingIntoClosed,<< "Can not add label="<< EI_Label::qval<< " into closed MaterialDispatch.\n")

	DECLARE_EXCEPTION (ExcNonuniqueID,<< "Non-unique ID during add of region id: "<< EI_ID::val<< ", label: "<< EI_Label::qval<< "\n"<< "other region with same ID but different label: "<< EI_LabelOfOtherID::qval<< " already exists\n")

	DECLARE_EXCEPTION (ExcNonuniqueLabel,<< "Non-unique label during add of region id: "<< EI_ID::val<< ", label: "<< EI_Label::qval<< "\n"<< "other region with same label but different ID: "<< EI_IDOfOtherLabel::val<< " already exists\n")

	DECLARE_EXCEPTION (ExcInconsistentBoundary,<< "Inconsistent add of region with id: "<< EI_ID::val<< ", label: "<< EI_Label::qval<< "\n"<< "both ID and label match an existing region with different boundary flag.")

	DECLARE_EXCEPTION (ExcInconsistentDimension,<< "Inconsistent add of region with id: "<< EI_ID::val<< ", label: "<< EI_Label::qval<< "\n"<< "both ID and label match an existing region with different dimension.")

	DECLARE_EXCEPTION (ExcCantAdd,<< "Can not add new region into DB, id: "<< EI_ID::val<<", label: "<< EI_Label::qval)

	DECLARE_EXCEPTION (ExcUnknownSet,<< "Operation with unknown region set: "<< EI_Label::qval)

	DECLARE_INPUT_EXCEPTION (ExcUnknownSetOperand,<< "Operation with unknown region set: "<< EI_Label::qval)

	TYPEDEF_ERR_INFO (EI_NumOp, unsigned int)

	DECLARE_INPUT_EXCEPTION (ExcWrongOpNumber,<< "Wrong number of operands. Expect 2, given: "<< EI_NumOp::val)

	RegionDB ()
	Default constructor. More...

Region	add_region (unsigned int id, const std::string &label, unsigned int dim, bool boundary)

Region	add_region (unsigned int id, const std::string &label, unsigned int dim)

Region	add_region (unsigned int id, unsigned int dim)

Region	find_label (const std::string &label) const

Region	find_id (unsigned int id) const

const std::string &	get_label (unsigned int idx) const

unsigned int	get_id (unsigned int idx) const

unsigned int	get_dim (unsigned int idx) const

void	close ()

unsigned int	size () const

unsigned int	boundary_size () const

unsigned int	bulk_size () const

Region	implicit_boundary_region ()

void	add_to_set (const string &set_name, Region region)

void	add_set (const string &set_name, const RegionSet &set)

RegionSet	union_sets (const string &set_name_1, const string &set_name_2)

RegionSet	intersection (const string &set_name_1, const string &set_name_2)

RegionSet	difference (const string &set_name_1, const string &set_name_2)

RegionSet	get_region_set (const string &set_name) const

void	read_sets_from_input (Input::Array arr)

void	read_regions_from_input (Input::Array region_list, MapElementIDToRegionID &map)

Static Public Attributes
static Input::Type::Record	region_input_type

static Input::Type::Record	region_set_input_type

static const unsigned int	max_n_regions = 64000

static const unsigned int	undefined_dim = 10

Private Types
typedef BMI::multi_index_container < RegionItem, BMI::indexed_by < BMI::ordered_unique < BMI::tag< Index > , BMI::member< RegionItem, unsigned int,&RegionItem::index > >, BMI::hashed_unique < BMI::tag< ID >, BMI::member < RegionItem, unsigned int,&RegionItem::id > >, BMI::ordered_unique < BMI::tag< Label > , BMI::member< RegionItem, std::string,&RegionItem::label > > > >	RegionTable
	Region database. More...

typedef RegionTable::index < Label >::type::iterator	LabelIter

typedef RegionTable::index< ID > ::type::iterator	IDIter

Private Member Functions
void	check_dim_consistency (IDIter it_id, unsigned int dim)
	Consistency check in common use by various add_region methods. More...

void	prepare_sets (const string &set_name_1, const string &set_name_2, RegionSet &set_1, RegionSet &set_2)

pair< string, string >	get_and_check_operands (const Input::Array &operands)

Private Attributes
RegionTable	region_set_
	Database of all regions (both boundary and bulk). More...

bool	closed_
	flag for closed database, no regions can be added, but you can add region sets More...

unsigned int	n_boundary_
	Number of boundary regions. More...

unsigned int	n_bulk_
	Number of bulk regions. More...

std::map< std::string, RegionSet >	sets_
	Map of region sets. More...

RegionSet	all
	Make part of general RegionSet table. More...

RegionSet	bulk

RegionSet	boundary

Region	implicit_bulk_

Region	implicit_boundary_

Detailed Description

Class for conversion between an index and string label of an material. Class contains only static members in order to provide globally consistent indexing of materials across various meshes and functions.

The conversion should be performed only through the input and output so that the lookup overhead could be shadowed by IO operations.

Taking sizes and creating region sets should be possible only after the database is closed. We assume that all regions are known at beginning of the program (typically after reading all meshes) however they need not be used through the whole computation.

TODO: In order to support more meshes , possibly changing during the time we need better policy for RegionDB closing. Currently we close RegionDB at first call to any of size methods. We need size information for initialization of RegionFields. However, every RegionField should be used for assembly over just one mesh (or set of meshes - supermesh?), surly this mesh has to be initialized before assembly so it could be initialized before initialization of RegionField which lives on this mesh. So the solution can be: RegionDB keeps list of meshes that has their regions registered in RegionDB. RegionField has signature of its mesh and check if the mesh is registered in the RegionDB before initialization of REgionField.

Update TODO:

make one instance of Region DB per mesh; put region indices into mesh elements make them private and provide method that returns Region accessor. ?? Speed concerns? This introduce needless copies of mesh pointer since in most cases we do not need methods label, id, dim where whole RegionnDB is needed. Thus possibly make class RegionIdx (without Mesh) and make some asking methods for label, id in RegionDB.
in RegionDB make support for sets:

/ map set name to lists of indices of its regions typedef std::vector<RegionIdx> RegionSet; std::map<std::string, RegionSet > sets_;

/ Add region to given set. Creat the set if it does not exist. add_to_set( const string& set_name, RegionIdx region); / Add a set into map, delete possible previous value, do not worry about slow copies of / the set array. add_set( const string& set_name, const RegionSet & set); RegionSet union( const string & set_name_1, const string & set_name_2); // sort + std::set_union RegionSet intersection( const string & set_name_1, const string & set_name_2); RegionSet difference( const string & set_name_1, const string & set_name_2); const RegionSet & get_set(const string & set_name); void read_sets_from_input(Input::Record rec); // see structure of RegionDB::region_set_input_type

region_sets = [ { name="set name", region_ids=[ int ...], region_labels= ["..."], // these are merger together

union=["set_1", "set_2"], // later overwrites previous intersection= difference= } ]

MODIFICATION IN MESH AND READER: Mesh reading proccess: 1) Read PhysicalNames form GMSH file, populate RegionDB (DONE in GMSH reader, may need small modifications) 2) Read region definitions from the input, see

typedef std::map<unsigned int, unsigned int> MapElementIDToRegionID; RegionDB::read_regions_from_input(Input::Array region_list, MapElementIDToRegionID &map);

  (TODO in RegionDB, also creates (and return to Mesh) element regions modification map: std::map< unsigned int, RegionIdx>
   that maps element IDs to the new region names, GMSH reader should have setter method to accept this map
   and modify the elements during reading)

3) Read region sets - TODO in RegionDB 4) Read boundary key of the Mesh record and mark appropriate regions as boundary (TODO in RegionDB) 5) Read nodes (DONE in GMSH reader) 6) Read elements, per element:

possibly modify region according map
find element ID: if found: add_region(ID, get_label, dim, get_boundary_flag) // possibly set dimension of the region if it is undefined not found: add_region(ID, default_label, dim, false)
if region is boundary put element into Mesh::bc_elements
else put it into Mesh::element

7) Setup topology - we has to connect Boundary with existing bc_elements, and add the remaining elements, after we remove support for old bCD files we may skip creation of remaining boundary elements since there will be no way how to set BC on them.

Definition at line 296 of file region.hh.

Member Typedef Documentation

typedef RegionTable::index<ID>::type::iterator RegionDB::IDIter

private

Definition at line 555 of file region.hh.

typedef RegionTable::index<Label>::type::iterator RegionDB::LabelIter

private

Definition at line 554 of file region.hh.

typedef std::map<unsigned int, unsigned int> RegionDB::MapElementIDToRegionID

Map representing the relevance of elements to regions

Definition at line 301 of file region.hh.

typedef BMI::multi_index_container< RegionItem, BMI::indexed_by< BMI::ordered_unique< BMI::tag<Index>, BMI::member<RegionItem, unsigned int, &RegionItem::index > >, BMI::hashed_unique< BMI::tag<ID>, BMI::member<RegionItem, unsigned int, &RegionItem::id> >, BMI::ordered_unique< BMI::tag<Label>, BMI::member<RegionItem, std::string, &RegionItem::label> > > > RegionDB::RegionTable

private

Region database.

Definition at line 551 of file region.hh.

Constructor & Destructor Documentation

RegionDB::RegionDB ( )

Default constructor.

Definition at line 73 of file region.cc.

Member Function Documentation

Region RegionDB::add_region	(	unsigned int	id,
		const std::string &	label,
		unsigned int	dim,
		bool	boundary
	)

This method adds new region into the database and returns its index. This requires full specification of the region that is given in PhysicalNames section of the GMSH MSH format or in Mesh input record.

If ID or label are found in the DB, we distinguish following cases: 1) ID is found, label is not found : warning ID has already assigned label 2) ID is not found, label is found : report error - assigning same label to different IDs 3) both ID and label are found, in same region : check remaining data, return existing region 4) , in different : warning ID has already assigned label

Parameter id is any unique non-negative integer, parameter label is unique string identifier of the region, dim is dimension of reference elements in the region and boundary is true if the region consist of boundary elements (where one can apply boundary condition).

Definition at line 107 of file region.cc.

Here is the caller graph for this function:

Region RegionDB::add_region	(	unsigned int	id,
		const std::string &	label,
		unsigned int	dim
	)

As the previous, but set the 'boundary; flag according to the label (labels starting with dot '.' are boundary). Used in read_regions_from_input ( with undefined dimension) to read regions given in 'regions' key of the 'mesh' input record.

Definition at line 152 of file region.cc.

Region RegionDB::add_region	(	unsigned int	id,
		unsigned int	dim
	)

As the previous, but generates automatic label of form 'region_ID' if the region with same ID is not already present. Set bulk region. Meant to be used when reading elements from MSH file. Again, if the region is defined already, we just check consistency.

Definition at line 164 of file region.cc.

void RegionDB::add_set	(	const string &	set_name,
		const RegionSet &	set
	)

Add a set into map, delete possible previous value.

Parameters

set_name	Name of added set
set	Added RegionSet

Definition at line 281 of file region.cc.

Here is the caller graph for this function:

void RegionDB::add_to_set	(	const string &	set_name,
		Region	region
	)

Definition at line 264 of file region.cc.

Here is the caller graph for this function:

unsigned int RegionDB::boundary_size ( ) const

Returns total number boundary regions.

Definition at line 249 of file region.cc.

Here is the caller graph for this function:

unsigned int RegionDB::bulk_size ( ) const

Returns total number bulk regions.

Definition at line 256 of file region.cc.

Here is the caller graph for this function:

void RegionDB::check_dim_consistency	(	IDIter	it_id,
		unsigned int	dim
	)

private

Consistency check in common use by various add_region methods.

Definition at line 90 of file region.cc.

Here is the caller graph for this function:

void RegionDB::close ( )

Close this class for adding labels. This is necessary to return correct size for material indexed arrays and vectors. After calling this method you can call method size and method idx_of_label rise an exception for any unknown label.

Definition at line 224 of file region.cc.

Here is the caller graph for this function:

RegionDB::DECLARE_EXCEPTION ( ExcAddingIntoClosed )

RegionDB::DECLARE_EXCEPTION	(	ExcNonuniqueID	,
		<< "Non-unique ID during add of region id: "<< EI_ID::val<< "	,
		label:"<< EI_Label::qval<< "\n"<< "other region with same ID but different label:"<< EI_LabelOfOtherID::qval<< "already exists\n"
	)

RegionDB::DECLARE_EXCEPTION	(	ExcNonuniqueLabel	,
		<< "Non-unique label during add of region id: "<< EI_ID::val<< "	,
		label:"<< EI_Label::qval<< "\n"<< "other region with same label but different ID:"<< EI_IDOfOtherLabel::val<< "already exists\n"
	)

RegionDB::DECLARE_EXCEPTION	(	ExcInconsistentBoundary	,
		<< "Inconsistent add of region with id: "<< EI_ID::val<< "	,
		label:"<< EI_Label::qval<< "\n"<< "both ID and label match an existing region with different boundary flag."
	)

RegionDB::DECLARE_EXCEPTION	(	ExcInconsistentDimension	,
		<< "Inconsistent add of region with id: "<< EI_ID::val<< "	,
		label:"<< EI_Label::qval<< "\n"<< "both ID and label match an existing region with different dimension."
	)

RegionDB::DECLARE_EXCEPTION	(	ExcCantAdd	,
		<< "Can not add new region into	DB,
		id:"<< EI_ID::val<<"	,
		label:"<< EI_Label::qval
	)

RegionDB::DECLARE_EXCEPTION	(	ExcUnknownSet	,
		<< "Operation with unknown region set: "<< EI_Label::qval
	)

RegionDB::DECLARE_INPUT_EXCEPTION	(	ExcUnknownSetOperand	,
		<< "Operation with unknown region set: "<< EI_Label::qval
	)

RegionDB::DECLARE_INPUT_EXCEPTION	(	ExcWrongOpNumber	,
		<< "Wrong number of operands. Expect	2,
		given:"<< EI_NumOp::val
	)

RegionSet RegionDB::difference	(	const string &	set_name_1,
		const string &	set_name_2
	)

Get RegionSets of specified names and create their difference Throws ExcUnknownSet for invalid name.

Parameters

set_name_1	Name of first RegionSet
set_name_2	Name of second RegionSet

Returns: RegionSet created of difference operation

Definition at line 317 of file region.cc.

Here is the caller graph for this function:

Region RegionDB::find_id ( unsigned int id) const

Returns a Region with given id. If it is not found it returns undefined Region.

Definition at line 190 of file region.cc.

Here is the caller graph for this function:

Region RegionDB::find_label ( const std::string & label) const

Returns a Region with given label. If it is not found it returns undefined Region.

Definition at line 179 of file region.cc.

Here is the caller graph for this function:

pair< string, string > RegionDB::get_and_check_operands ( const Input::Array & operands)

private

Read two operands from input array of strings and check if given names are existing sets. Return pair of checked set names.

Definition at line 348 of file region.cc.

Here is the caller graph for this function:

unsigned int RegionDB::get_dim ( unsigned int idx) const

Return dimension of region with given index idx.

Definition at line 216 of file region.cc.

unsigned int RegionDB::get_id ( unsigned int idx) const

Return original ID for given index idx.

Definition at line 208 of file region.cc.

const std::string & RegionDB::get_label ( unsigned int idx) const

Return original label for given index idx.

Definition at line 200 of file region.cc.

RegionSet RegionDB::get_region_set ( const string & set_name) const

Get region set of specified name. Three sets are defined by default: "ALL" - set of all regions both bulk and boundary. "BULK" - set of all bulk regions "BOUNDARY" - set of all boundary regions

Parameters

set_name Name of set

Returns: RegionSet of specified name. Returns Empty vector if the set of given name doesn't exist.

Definition at line 365 of file region.cc.

Here is the caller graph for this function:

Region RegionDB::implicit_boundary_region ( )

Returns implicit bulk region. Returns implicit boundary region. Is used for boundary elements created by Flow123d itself. This region has label "IMPLICIT_BOUNDARY".

Definition at line 85 of file region.cc.

Here is the caller graph for this function:

RegionSet RegionDB::intersection	(	const string &	set_name_1,
		const string &	set_name_2
	)

Get RegionSets of specified names and create their intersection. Throws ExcUnknownSet for invalid name.

Parameters

set_name_1	Name of first RegionSet
set_name_2	Name of second RegionSet

Returns: RegionSet created of intersection operation

Definition at line 303 of file region.cc.

Here is the caller graph for this function:

void RegionDB::prepare_sets	(	const string &	set_name_1,
		const string &	set_name_2,
		RegionSet &	set_1,
		RegionSet &	set_2
	)

private

Prepare region sets for union, intersection and difference operation. Get sets of names set_name_1 and set_name_2 and sort them. Throws ExcUnknownSet if the set with given name does not exist.

Definition at line 331 of file region.cc.

Here is the caller graph for this function:

void RegionDB::read_regions_from_input	(	Input::Array	region_list,
		MapElementIDToRegionID &	map
	)

Reads elements and their affiliation to region sets defined by user in input file Format of input record is defined in variable RegionDB::region_input_type

Parameters

region_list	Array input records which define region sets and elements
map	Map to which is loaded data

Definition at line 474 of file region.cc.

Here is the caller graph for this function:

void RegionDB::read_sets_from_input ( Input::Array arr)

Reads region sets defined by user in input file Format of input record is defined in variable RegionDB::region_set_input_type

Parameters

arr	Array input records which define region sets

Definition at line 374 of file region.cc.

Here is the caller graph for this function:

unsigned int RegionDB::size ( ) const

Returns maximal index + 1

Definition at line 242 of file region.cc.

Here is the caller graph for this function:

RegionDB::TYPEDEF_ERR_INFO	(	EI_Label	,
		const std::string
	)

RegionDB::TYPEDEF_ERR_INFO	(	EI_ID	,
		unsigned	int
	)

RegionDB::TYPEDEF_ERR_INFO	(	EI_IDOfOtherLabel	,
		unsigned	int
	)

RegionDB::TYPEDEF_ERR_INFO	(	EI_LabelOfOtherID	,
		const std::string
	)

RegionDB::TYPEDEF_ERR_INFO	(	EI_NumOp	,
		unsigned	int
	)

RegionSet RegionDB::union_sets	(	const string &	set_name_1,
		const string &	set_name_2
	)

Get RegionSets of specified names and create their union

Parameters

set_name_1	Name of first RegionSet
set_name_2	Name of second RegionSet

Returns: RegionSet created of union operation

Definition at line 289 of file region.cc.

Here is the caller graph for this function:

Member Data Documentation

RegionSet RegionDB::all

private

Make part of general RegionSet table.

Definition at line 576 of file region.hh.

RegionSet RegionDB::boundary

private

Definition at line 576 of file region.hh.

RegionSet RegionDB::bulk

private

Definition at line 576 of file region.hh.

bool RegionDB::closed_

private

flag for closed database, no regions can be added, but you can add region sets

Definition at line 566 of file region.hh.

Region RegionDB::implicit_boundary_

private

Definition at line 582 of file region.hh.

Region RegionDB::implicit_bulk_

private

Implicit bulk and boundary regions. For GMSH mesh format only implicit_boundary is used for boundary elements that are not explicitly in the mesh file.

Definition at line 582 of file region.hh.

const unsigned int RegionDB::max_n_regions = 64000

static

Introduce an artificial limit to keep all material indexed arrays of reasonable size.

Definition at line 343 of file region.hh.

unsigned int RegionDB::n_boundary_

private

Number of boundary regions.

Definition at line 568 of file region.hh.

unsigned int RegionDB::n_bulk_

private

Number of bulk regions.

Definition at line 570 of file region.hh.

IT::Record RegionDB::region_input_type

static

Initial value:

=
        IT::Record("Region", "Definition of region of elements.")
        .declare_key("name",IT::String(), IT::Default::obligatory(),
                "Label (name) of the region. Has to be unique in one mesh.\n")
        .declare_key("id", IT::Integer(0), IT::Default::obligatory(),
                "The ID of the region to which you assign label.")
        .declare_key("element_list", IT::Array( IT::Integer(0) ), IT::Default::optional(),
                "Specification of the region by the list of elements. This is not recomended")
        .close()

Format of input record which defined elements and their affiliation to region sets

Definition at line 306 of file region.hh.

RegionTable RegionDB::region_set_

private

Database of all regions (both boundary and bulk).

Definition at line 563 of file region.hh.

IT::Record RegionDB::region_set_input_type

static

Initial value:

=
        IT::Record("RegionSet", "Definition of one region set.")
        .declare_key("name", IT::String(), IT::Default::obligatory(),
                "Unique name of the region set.")
        .declare_key("region_ids", IT::Array( IT::Integer(0)),
                "List of region ID numbers that has to be added to the region set.")
        .declare_key("region_labels", IT::Array( IT::String()),
                "List of labels of the regions that has to be added to the region set.")
        .declare_key("union", IT::Array( IT::String(), 2,2),
                "Defines region set as a union of given pair of sets. Overrides previous keys.")
        .declare_key("intersection", IT::Array( IT::String(), 2,2),
                "Defines region set as an intersection of given pair of sets. Overrides previous keys.")
        .declare_key("difference", IT::Array( IT::String(), 2,2),
                "Defines region set as a difference of given pair of sets. Overrides previous keys.")
        .close()

Format of input record which defined regions and their affiliation to region sets

Definition at line 310 of file region.hh.

std::map<std::string, RegionSet > RegionDB::sets_

private

Map of region sets.

Definition at line 573 of file region.hh.

const unsigned int RegionDB::undefined_dim = 10

static

Undefined dimension for regions introduced from mesh input record. Dimensions 0,1,2,3 are valid.

Definition at line 347 of file region.hh.

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

/home/jb/workspace/flow123d/src/mesh/region.hh
/home/jb/workspace/flow123d/src/mesh/region.cc

Classes

Public Types

Public Member Functions

Static Public Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

else put it into Mesh::element

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation