#include <msh_basereader.hh>

Inheritance diagram for BaseMeshReader:

[legend]

Collaboration diagram for BaseMeshReader:

Classes
struct	HeaderQuery

struct	MeshDataHeader

Public Member Functions
	TYPEDEF_ERR_INFO (EI_FieldName, std::string)

	TYPEDEF_ERR_INFO (EI_Time, double)

	TYPEDEF_ERR_INFO (EI_MeshFile, std::string)

	TYPEDEF_ERR_INFO (EI_Type, std::string)

	TYPEDEF_ERR_INFO (EI_TokenizerMsg, std::string)

	TYPEDEF_ERR_INFO (EI_FileExtension, std::string)

	DECLARE_INPUT_EXCEPTION (ExcFieldNameNotFound,<< "No data for field: "<< EI_FieldName::qval<< " and time: "<< EI_Time::val<< " in the input file: "<< EI_MeshFile::qval)

	DECLARE_INPUT_EXCEPTION (ExcMissingFieldDiscretization,<< "Missing data type specification for field: "<< EI_FieldName::qval<< " and time: "<< EI_Time::val<< " in the input file: "<< EI_MeshFile::qval<< "\nPlease, add value of key 'input_discretization'.")

	DECLARE_EXCEPTION (ExcWrongFormat,<< "Wrong format of "<< EI_Type::val<< ", "<< EI_TokenizerMsg::val<< "\n"<< "in the input file: "<< EI_MeshFile::qval)

	DECLARE_EXCEPTION (ExcWrongExtension,<< "Unsupported extension "<< EI_FileExtension::qval<< " of the input file: "<< EI_MeshFile::qval)

	DECLARE_EXCEPTION (ExcWrongComponentsCount,<< "Wrong number of components of field "<< EI_FieldName::qval<< " at time "<< EI_Time::val<< " in the input file: "<< EI_MeshFile::qval)

	BaseMeshReader (const FilePath &file_name)
	Constructor. More...

void	read_raw_mesh (Mesh *mesh)

virtual void	read_physical_names (Mesh *mesh)=0

template<typename T >
ElementDataCache< T >::CacheData	get_element_data (MeshDataHeader header, unsigned int expected_n_entities, unsigned int expected_n_components, unsigned int boundary_begin)

void	set_element_ids (const Mesh &mesh)

std::vector< int > const &	get_element_ids (bool boundary_domain)

virtual MeshDataHeader &	find_header (HeaderQuery &header_query)=0

Static Public Member Functions
static std::shared_ptr< BaseMeshReader >	reader_factory (const FilePath &file_name)

static Mesh *	mesh_factory (const Input::Record &input_mesh_rec)

Protected Types
typedef std::shared_ptr< ElementDataCacheBase >	ElementDataPtr

typedef std::map< string, ElementDataPtr >	ElementDataFieldMap

Protected Member Functions
	BaseMeshReader (const FilePath &file_name, std::shared_ptr< ElementDataFieldMap > element_data_values)
	Constructor. More...

virtual void	read_nodes (Mesh *mesh)=0

virtual void	read_elements (Mesh *mesh)=0

virtual void	make_header_table ()=0

virtual void	read_element_data (ElementDataCacheBase &data_cache, MeshDataHeader header)=0

Protected Attributes
bool	has_compatible_mesh_

std::string	data_section_name_
	Store name of field data section specify for type of mesh file. More...

std::shared_ptr< ElementDataFieldMap >	element_data_values_
	Cache with last read element data. More...

Tokenizer	tok_
	Tokenizer used for reading ASCII file format. More...

vector< LongIdx >	bulk_elements_id_

vector< LongIdx >	boundary_elements_id_

Friends
class	ReaderCache

Detailed Description

Abstract parent of mesh readers.

Supported are:

GMSH reader (class GmshMeshReader)
VTK reader (class VtkMeshReader)

Definition at line 58 of file msh_basereader.hh.

Member Typedef Documentation

◆ ElementDataFieldMap

typedef std::map< string, ElementDataPtr > BaseMeshReader::ElementDataFieldMap

protected

Definition at line 217 of file msh_basereader.hh.

◆ ElementDataPtr

typedef std::shared_ptr<ElementDataCacheBase> BaseMeshReader::ElementDataPtr

protected

Definition at line 216 of file msh_basereader.hh.

Constructor & Destructor Documentation

◆ BaseMeshReader() [1/2]

BaseMeshReader::BaseMeshReader ( const FilePath & file_name )

Constructor.

Definition at line 28 of file msh_basereader.cc.

◆ BaseMeshReader() [2/2]

BaseMeshReader::BaseMeshReader	(	const FilePath &	file_name,
		std::shared_ptr< ElementDataFieldMap >	element_data_values
	)

protected

Constructor.

Definition at line 33 of file msh_basereader.cc.

Member Function Documentation

◆ DECLARE_EXCEPTION() [1/3]

BaseMeshReader::DECLARE_EXCEPTION	(	ExcWrongComponentsCount	,
		<< "Wrong number of components of field "<< EI_FieldName::qval<< " at time "<< EI_Time::val<< " in the input file: "<< EI_MeshFile::qval
	)

◆ DECLARE_EXCEPTION() [2/3]

BaseMeshReader::DECLARE_EXCEPTION	(	ExcWrongExtension	,
		<< "Unsupported extension "<< EI_FileExtension::qval<< " of the input file: "<< EI_MeshFile::qval
	)

◆ DECLARE_EXCEPTION() [3/3]

BaseMeshReader::DECLARE_EXCEPTION	(	ExcWrongFormat	,
		<< "Wrong format of "<< EI_Type::val<< "	,
		"<< EI_TokenizerMsg::val<< "\n"<< "in the input file:"<< EI_MeshFile::qval
	)

◆ DECLARE_INPUT_EXCEPTION() [1/2]

BaseMeshReader::DECLARE_INPUT_EXCEPTION	(	ExcFieldNameNotFound	,
		<< "No data for field: "<< EI_FieldName::qval<< " and time: "<< EI_Time::val<< " in the input file: "<< EI_MeshFile::qval
	)

◆ DECLARE_INPUT_EXCEPTION() [2/2]

BaseMeshReader::DECLARE_INPUT_EXCEPTION	(	ExcMissingFieldDiscretization	,
		<< "Missing data type specification for field: "<< EI_FieldName::qval<< " and time: "<< EI_Time::val<< " in the input file: "<< EI_MeshFile::qval<< "\	nPlease,
		add value of key 'input_discretization'."
	)

◆ find_header()

virtual MeshDataHeader& BaseMeshReader::find_header ( HeaderQuery & header_query )

pure virtual

Find data header for time and field given by header_query.

Implemented in VtkMeshReader, PvdMeshReader, and GmshMeshReader.

◆ get_element_data()

template<typename T >

ElementDataCache< T >::CacheData BaseMeshReader::get_element_data	(	MeshDataHeader	header,
		unsigned int	expected_n_entities,
		unsigned int	expected_n_components,
		unsigned int	boundary_begin
	)

Reads ElementData sections of opened mesh file. Method must be call after set_data_header method. If such section has not been yet read, we read the data section into raw buffer data. The buffer must have size at least n_components * n_entities. Indexes in the map must be smaller then n_entities.

Possible optimizations: If the map ID lookup seem slow, we may assume that IDs are in increasing order, use simple array of IDs instead of map and just check that they comes in in correct order.

Parameters

n_entities	count of entities (elements)
n_components	count of components (size of returned data is given by n_entities*n_components)
boundary_domain	flag determines that data is read for boundary or bulk elements
component_idx	component index of MultiField; 0 for single component fields.

Definition at line 95 of file msh_basereader.cc.

◆ get_element_ids()

std::vector< int > const & BaseMeshReader::get_element_ids ( bool boundary_domain )

Returns vector of boundary or bulk element IDs to read. Used by GMSH reader only.

Definition at line 88 of file msh_basereader.cc.

Here is the caller graph for this function:

◆ make_header_table()

virtual void BaseMeshReader::make_header_table ( )

protectedpure virtual

Reads table of data headers specific for each descendants.

Implemented in VtkMeshReader, PvdMeshReader, and GmshMeshReader.

◆ mesh_factory()

Mesh * BaseMeshReader::mesh_factory ( const Input::Record & input_mesh_rec )

static

This static method gets accessor to record with function input, dispatch to correct constructor and initialize appropriate function object from the input. Allow to make optimization of elements and nodes order if flag optimize_mesh is set Returns pointer to Mesh.

Definition at line 52 of file msh_basereader.cc.

Here is the caller graph for this function:

◆ read_element_data()

virtual void BaseMeshReader::read_element_data	(	ElementDataCacheBase &	data_cache,
		MeshDataHeader	header
	)

protectedpure virtual

Read element data to data cache

Implemented in VtkMeshReader, PvdMeshReader, and GmshMeshReader.

Here is the caller graph for this function:

◆ read_elements()

virtual void BaseMeshReader::read_elements ( Mesh * mesh )

protectedpure virtual

Method for reading of elements.

Implemented in PvdMeshReader, VtkMeshReader, and GmshMeshReader.

Here is the caller graph for this function:

◆ read_nodes()

virtual void BaseMeshReader::read_nodes ( Mesh * mesh )

protectedpure virtual

private method for reading of nodes

Implemented in PvdMeshReader, VtkMeshReader, and GmshMeshReader.

Here is the caller graph for this function:

◆ read_physical_names()

virtual void BaseMeshReader::read_physical_names ( Mesh * mesh )

pure virtual

Read regions from the mesh file and save the physical sections as regions in the RegionDB.

Implemented in VtkMeshReader, PvdMeshReader, and GmshMeshReader.

◆ read_raw_mesh()

void BaseMeshReader::read_raw_mesh ( Mesh * mesh )

Reads raw data of mesh (only nodes and elements) from the GMSH or VTKfile. Input of the mesh allows changing regions within the input file.

Definition at line 74 of file msh_basereader.cc.

◆ reader_factory()

std::shared_ptr< BaseMeshReader > BaseMeshReader::reader_factory ( const FilePath & file_name )

static

This static method gets file path object of reader, dispatch to correct constructor and initialize appropriate function object from the input. Returns shared pointer to BaseMeshReader.

Definition at line 38 of file msh_basereader.cc.

Here is the caller graph for this function:

◆ set_element_ids()

void BaseMeshReader::set_element_ids ( const Mesh & mesh )

Set ID vectors from a different mesh. Must be set in order to determine for which IDs the GMSH reader should read the data. Could possibly read just a subset.

Definition at line 81 of file msh_basereader.cc.

◆ TYPEDEF_ERR_INFO() [1/6]

BaseMeshReader::TYPEDEF_ERR_INFO	(	EI_FieldName	,
		std::string
	)

◆ TYPEDEF_ERR_INFO() [2/6]

BaseMeshReader::TYPEDEF_ERR_INFO	(	EI_FileExtension	,
		std::string
	)

◆ TYPEDEF_ERR_INFO() [3/6]

BaseMeshReader::TYPEDEF_ERR_INFO	(	EI_MeshFile	,
		std::string
	)

◆ TYPEDEF_ERR_INFO() [4/6]

BaseMeshReader::TYPEDEF_ERR_INFO	(	EI_Time	,
		double
	)

◆ TYPEDEF_ERR_INFO() [5/6]

BaseMeshReader::TYPEDEF_ERR_INFO	(	EI_TokenizerMsg	,
		std::string
	)

◆ TYPEDEF_ERR_INFO() [6/6]

BaseMeshReader::TYPEDEF_ERR_INFO	(	EI_Type	,
		std::string
	)

Friends And Related Function Documentation

◆ ReaderCache

friend class ReaderCache

friend

Definition at line 264 of file msh_basereader.hh.

Member Data Documentation

◆ boundary_elements_id_

vector<LongIdx> BaseMeshReader::boundary_elements_id_

protected

Definition at line 262 of file msh_basereader.hh.

◆ bulk_elements_id_

vector<LongIdx> BaseMeshReader::bulk_elements_id_

protected

Vector of both bulk and boundary IDs. Bulk elements come first, then boundary elements, but only the portion that appears in input mesh file and has ID assigned. If set through set_element_ids, the GMSH reader only reads given IDs and check that all IDs are read.

Definition at line 262 of file msh_basereader.hh.

◆ data_section_name_

std::string BaseMeshReader::data_section_name_

protected

Store name of field data section specify for type of mesh file.

Definition at line 251 of file msh_basereader.hh.

◆ element_data_values_

std::shared_ptr<ElementDataFieldMap> BaseMeshReader::element_data_values_

protected

Cache with last read element data.

Definition at line 254 of file msh_basereader.hh.

◆ has_compatible_mesh_

bool BaseMeshReader::has_compatible_mesh_

protected

Flag stores that check of compatible mesh was performed.

This flag has effect only for VTK reader.

Definition at line 248 of file msh_basereader.hh.

◆ tok_

Tokenizer BaseMeshReader::tok_

protected

Tokenizer used for reading ASCII file format.

Definition at line 257 of file msh_basereader.hh.

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

/home/runner/work/flow123d/flow123d/src/io/msh_basereader.hh
/home/runner/work/flow123d/flow123d/src/io/msh_basereader.cc

Classes

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ ElementDataFieldMap

◆ ElementDataPtr

Constructor & Destructor Documentation

◆ BaseMeshReader() [1/2]

◆ BaseMeshReader() [2/2]

Member Function Documentation

◆ DECLARE_EXCEPTION() [1/3]

◆ DECLARE_EXCEPTION() [2/3]

◆ DECLARE_EXCEPTION() [3/3]

◆ DECLARE_INPUT_EXCEPTION() [1/2]

◆ DECLARE_INPUT_EXCEPTION() [2/2]

◆ find_header()

◆ get_element_data()

◆ get_element_ids()

◆ make_header_table()

◆ mesh_factory()

◆ read_element_data()

◆ read_elements()

◆ read_nodes()

◆ read_physical_names()

◆ read_raw_mesh()

◆ reader_factory()

◆ set_element_ids()

◆ TYPEDEF_ERR_INFO() [1/6]

◆ TYPEDEF_ERR_INFO() [2/6]

◆ TYPEDEF_ERR_INFO() [3/6]

◆ TYPEDEF_ERR_INFO() [4/6]

◆ TYPEDEF_ERR_INFO() [5/6]

◆ TYPEDEF_ERR_INFO() [6/6]

Friends And Related Function Documentation

◆ ReaderCache

Member Data Documentation

◆ boundary_elements_id_

◆ bulk_elements_id_

◆ data_section_name_

◆ element_data_values_

◆ has_compatible_mesh_

◆ tok_