Dune::GmshReader< GridType > Class Template Reference

Read Gmsh mesh file. More...

#include <dune/grid/io/file/gmshreader.hh>

Public Types
typedef GridType	Grid
using	Opts = Gmsh::ReaderOptions
	Dynamic Gmsh reader interface.

Public Member Functions
	GmshReader (const std::string &fileName, Gmsh::ReaderOptions options=defaultOpts)
	Construct a Gmsh reader object (alternatively use one of the static member functions).
	GmshReader (const std::string &fileName, GridFactory< Grid > &factory, Gmsh::ReaderOptions options=defaultOpts)
	Construct a Gmsh reader object from a file name and a grid factory.
const std::vector< int > &	elementData () const
	Access element data (maps element index to Gmsh physical entity).
const std::vector< int > &	boundaryData () const
	Access boundary data (maps boundary segment index to Gmsh physical entity).
bool	hasElementData () const
	If element data is available.
bool	hasBoundaryData () const
	If boundary data is available.
std::vector< int >	extractElementData ()
	Erase element data from reader and return the data.
std::vector< int >	extractBoundaryData ()
	Erase boundary data from reader and return the data.
std::unique_ptr< Grid >	createGrid ()
	Create the grid.

Static Public Member Functions
static std::unique_ptr< Grid >	read (const std::string &fileName, bool verbose=true, bool insertBoundarySegments=true)
static std::unique_ptr< Grid >	read (const std::string &fileName, std::vector< int > &boundarySegmentToPhysicalEntity, std::vector< int > &elementToPhysicalEntity, bool verbose=true, bool insertBoundarySegments=true)
	Read Gmsh file, possibly with data.
static void	read (Dune::GridFactory< Grid > &factory, const std::string &fileName, bool verbose=true, bool insertBoundarySegments=true)
	Read Gmsh grid file into a GridFactory object.
static void	read (Dune::GridFactory< Grid > &factory, const std::string &fileName, DataFlagArg boundarySegmentData, DataArg elementData, bool verbose=true)
	read Gmsh file, possibly with data
static void	read (Dune::GridFactory< Grid > &factory, const std::string &fileName, std::vector< int > &boundarySegmentToPhysicalEntity, std::vector< int > &elementToPhysicalEntity, bool verbose, bool insertBoundarySegments)
	Read Gmsh file, possibly with data.

Static Public Attributes
static constexpr Opts	defaultOpts

Detailed Description

template<typename GridType>
class Dune::GmshReader< GridType >

Read Gmsh mesh file.

Read a .msh (version 2) file generated using Gmsh and construct a grid using the grid factory interface.

The file format used by gmsh can hold grids that are more general than the simplex grids that the gmsh grid generator is able to construct. We try to read as many grids as possible, as long as they are valid files. You can test this by checking whether gmsh will load the file and display its content.

All grids in a gmsh file live in three-dimensional Euclidean space. If the world dimension of the grid type that you are reading the file into is less than three, the remaining coordinates are simply ignored.

Member Typedef Documentation

Grid

template<typename GridType>

typedef GridType Dune::GmshReader< GridType >::Grid

Opts

template<typename GridType>

using Dune::GmshReader< GridType >::Opts = Gmsh::ReaderOptions

Dynamic Gmsh reader interface.

Constructor & Destructor Documentation

GmshReader() [1/2]

template<typename GridType>

Dune::GmshReader< GridType >::GmshReader ( const std::string & fileName, Gmsh::ReaderOptions options = defaultOpts )

inline

Construct a Gmsh reader object (alternatively use one of the static member functions).

Construct a Gmsh reader object from a file name

Parameters

fileName	Name of the file to read from.
options	Options of the type Dune::Gmsh::ReaderOptions

To pass several options, combine them with the |-operator like this

using Opt = Dune::Gmsh::ReaderOptions;
auto reader = Dune::GmshReader("grid.msh", Opt::verbose | Opt::readElementData)

Per default the reader has enabled the following options

• Dune::Gmsh::ReaderOptions::verbose
• Dune::Gmsh::ReaderOptions::insertBoundarySegments
• Dune::Gmsh::ReaderOptions::readBoundaryData
• Dune::Gmsh::ReaderOptions::readElementData

Passing any option to the interface will overwrite these defaults.

A Dune grid object can be obtained via the createGrid() member

Warning

All options are automatically false when the file is in Version 4 Gmsh format.

GmshReader() [2/2]

template<typename GridType>

Dune::GmshReader< GridType >::GmshReader ( const std::string & fileName, GridFactory< Grid > & factory, Gmsh::ReaderOptions options = defaultOpts )

inline

Construct a Gmsh reader object from a file name and a grid factory.

Parameters

fileName	Name of the file to read from.
options	Options of the type Dune::Gmsh::ReaderOptions

Use this constructor if you need access to the grid factory after the grid has been read, e.g., for obtaining boundary segment insertion indices.

Member Function Documentation

boundaryData()

template<typename GridType>

const std::vector< int > & Dune::GmshReader< GridType >::boundaryData ( ) const

inline

Access boundary data (maps boundary segment index to Gmsh physical entity).

createGrid()

template<typename GridType>

std::unique_ptr< Grid > Dune::GmshReader< GridType >::createGrid ( )

inline

Create the grid.

elementData()

template<typename GridType>

const std::vector< int > & Dune::GmshReader< GridType >::elementData ( ) const

inline

Access element data (maps element index to Gmsh physical entity).

extractBoundaryData()

template<typename GridType>

std::vector< int > Dune::GmshReader< GridType >::extractBoundaryData ( )

inline

Erase boundary data from reader and return the data.

extractElementData()

template<typename GridType>

std::vector< int > Dune::GmshReader< GridType >::extractElementData ( )

inline

Erase element data from reader and return the data.

hasBoundaryData()

template<typename GridType>

bool Dune::GmshReader< GridType >::hasBoundaryData ( ) const

inline

If boundary data is available.

Note

This is false if no such data was requested

hasElementData()

template<typename GridType>

bool Dune::GmshReader< GridType >::hasElementData ( ) const

inline

If element data is available.

Note

This is false if no such data was requested

read() [1/5]

template<typename GridType>

std::unique_ptr< Grid > Dune::GmshReader< GridType >::read ( const std::string & fileName, bool verbose = true, bool insertBoundarySegments = true )

inlinestatic

Todo

doc me

read() [2/5]

template<typename GridType>

std::unique_ptr< Grid > Dune::GmshReader< GridType >::read ( const std::string & fileName, std::vector< int > & boundarySegmentToPhysicalEntity, std::vector< int > & elementToPhysicalEntity, bool verbose = true, bool insertBoundarySegments = true )

inlinestatic

Read Gmsh file, possibly with data.

Parameters

fileName	Name of the file to read from.
boundarySegmentToPhysicalEntity	Container to fill with boundary segment physical entity data (if insertBoundarySegments=true)
elementToPhysicalEntity	Container to fill with element physical entity data
verbose	Whether to be chatty
insertBoundarySegments	Whether boundary segments are inserted into the factory

Note

When insertBoundarySegments=false there is no way to correctly use the values returned in boundarySegmentToPhysicalEntity. Make sure to set insertBoundarySegments=true if you intent to do this. An alternative is to use the other overloads which provide compile-time checking of the provided parameter combinations.

Warning

The following does not work when the file is in Version 4 Gmsh format: Filling the boundarySegmentToPhysicalEntity and elementToPhysicalEntity fields, controlling verbosity, and inserting boundary segments.

Todo

This interface is error-prone and should not be exposed to the user. However, the compile-time overloads may not provide sufficient runtime flexibility in all cases. Therefore this interface is kept until a better interface can be agreed on. See https://gitlab.dune-project.org/core/dune-grid/-/issues/107

read() [3/5]

template<typename GridType>

void Dune::GmshReader< GridType >::read ( Dune::GridFactory< Grid > & factory, const std::string & fileName, bool verbose = true, bool insertBoundarySegments = true )

inlinestatic

Read Gmsh grid file into a GridFactory object.

Warning

Controlling verbosity, and inserting boundary segments does not work when the file is in Version 4 Gmsh format.

read() [4/5]

template<typename GridType>

void Dune::GmshReader< GridType >::read ( Dune::GridFactory< Grid > & factory, const std::string & fileName, DataFlagArg boundarySegmentData, DataArg elementData, bool verbose = true )

inlinestatic

read Gmsh file, possibly with data

Parameters

factory	The GridFactory to fill.
fileName	Name of the file to read from.
boundarySegmentData	Container to fill with boundary segment physical entity data, or std::ignore, or a bool value. Boundary segments are inserted when a container or true is given, otherwise they are not inserted.
elementData	Container to fill with element physical entity data, or std::ignore.
verbose	Whether to be chatty.

Containers to fill with data must be std::vector<int> lvalues. Element data is indexed by the insertion index of the element, boundarySegment data is indexed by the insertion index of the boundary intersection. These can be obtained from the factory, and are lost once the grid gets modified (refined or load-balanced).

Warning

The following does not work when the file is in Version 4 Gmsh format: Filling the boundarySegmentData and elementData fields, and controlling verbosity.

Note

At the moment the data containers are still filled internally, even if they are ignored. So not having to pass them is more of a convenience feature and less of an optimization. This may however change in the future.

read() [5/5]

template<typename GridType>

void Dune::GmshReader< GridType >::read ( Dune::GridFactory< Grid > & factory, const std::string & fileName, std::vector< int > & boundarySegmentToPhysicalEntity, std::vector< int > & elementToPhysicalEntity, bool verbose, bool insertBoundarySegments )

inlinestatic

Read Gmsh file, possibly with data.

Parameters

factory	The GridFactory to fill.
fileName	Name of the file to read from.
boundarySegmentToPhysicalEntity	Container to fill with boundary segment physical entity data (if insertBoundarySegments=true)
elementToPhysicalEntity	Container to fill with element physical entity data
verbose	Whether to be chatty
insertBoundarySegments	Whether boundary segments are inserted into the factory

Note

When insertBoundarySegments=false there is no way to correctly use the values returned in boundarySegmentToPhysicalEntity. Make sure to set insertBoundarySegments=true if you intent to do this. An alternative is to use the other overloads which provide compile-time checking of the provided parameter combinations.

Warning

The following does not work when the file is in Version 4 Gmsh format: Filling the boundarySegmentToPhysicalEntity and elementToPhysicalEntity fields, controlling verbosity, and inserting boundary segments.

Todo

This interface is error-prone and should not be exposed to the user. However, the compile-time overloads may not provide sufficient runtime flexibility in all cases. Therefore this interface is kept until a better interface can be agreed on. See https://gitlab.dune-project.org/core/dune-grid/-/issues/107

Member Data Documentation

defaultOpts

template<typename GridType>

Opts Dune::GmshReader< GridType >::defaultOpts

staticconstexpr

Initial value:

=
      Opts::verbose | Opts::insertBoundarySegments | Opts::readElementData | Opts::readBoundaryData

---

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

• gmshreader.hh