Dumux::GridManager< Grid > Class Template Reference

The grid manager (this is the class used by the user) for all supported grid managers that constructs a grid from information in the input file and handles the data. More...

#include <dumux/io/grid/gridmanager_base.hh>

Inheritance diagram for Dumux::GridManager< Grid >:

Description

template<class Grid>
class Dumux::GridManager< Grid >

Note

This class is specialised below for all supported grid managers. It inherits the functionality of the base class Dumux::GridManagerBase.

Public Types
using	Grid = Grid
using	GridData = Dumux::GridData< Grid >

Public Member Functions
void	init (const std::string &modelParamGroup="")
	Make the grid. Implement this method in the specialization of this class for a grid type. More...
Grid &	grid ()
	Returns a reference to the grid. More...
const Grid &	grid () const
	Returns a const reference to the grid. More...
void	loadBalance ()
	Call loadBalance() function of the grid. More...
std::shared_ptr< GridData >	getGridData () const
	Get an owning pointer to grid data associated with the grid. More...
bool	hasGridData () const
	Check whether there is data associated with the grid. More...

Protected Types
enum	CellType
	The cell types for structured grids. More...

Protected Member Functions
std::shared_ptr< Grid > &	gridPtr ()
	Returns a reference to the grid pointer (std::shared_ptr<Grid>) More...
Dune::GridPtr< Grid > &	dgfGridPtr ()
	Returns a reference to the DGF grid pointer (Dune::GridPtr<Grid>). More...
std::string	getFileExtension (const std::string &fileName) const
	Returns the filename extension of a given filename. More...
void	makeGridFromFile (const std::string &fileName, const std::string &modelParamGroup)
	Makes a grid from a file. We currently support. More...
void	makeGridFromDgfFile (const std::string &fileName)
	Makes a grid from a DGF file. This is used by grid managers that only support DGF. More...
void	makeStructuredGrid (CellType cellType, const std::string &modelParamGroup)
	Makes a structured cube grid using the structured grid factory. More...
void	maybeRefineGrid (const std::string &modelParamGroup)
	Refines a grid after construction if GridParameterGroup.Refinement is set in the input file. More...

Protected Attributes
bool	enableDgfGridPointer_
	A state variable if the DGF Dune::GridPtr has been enabled. It is always enabled if a DGF grid file was used to create the grid. More...
bool	enableGmshDomainMarkers_
	A state variable if domain markers have been read from a Gmsh file. More...
bool	enableVtkData_
	A state variable if cell or point data have been read from a VTK file. More...
std::shared_ptr< Grid >	gridPtr_
Dune::GridPtr< Grid >	dgfGridPtr_
std::shared_ptr< GridData >	gridData_

Member Typedef Documentation

Grid

using Dumux::GridManagerBase< Grid >::Grid = Grid

inherited

GridData

using Dumux::GridManagerBase< Grid >::GridData = Dumux::GridData<Grid>

inherited

Member Enumeration Documentation

CellType

enum Dumux::GridManagerBase::CellType

protectedinherited

Member Function Documentation

dgfGridPtr()

Dune::GridPtr< Grid > & Dumux::GridManagerBase< Grid >::dgfGridPtr ( )

inlineprotectedinherited

getFileExtension()

std::string Dumux::GridManagerBase< Grid >::getFileExtension ( const std::string &  fileName ) const

inlineprotectedinherited

getGridData()

std::shared_ptr< GridData > Dumux::GridManagerBase< Grid >::getGridData ( ) const

inlineinherited

Note

Throws if no grid data is available

grid() [1/2]

Grid & Dumux::GridManagerBase< Grid >::grid ( )

inlineinherited

grid() [2/2]

const Grid & Dumux::GridManagerBase< Grid >::grid ( ) const

inlineinherited

gridPtr()

std::shared_ptr< Grid > & Dumux::GridManagerBase< Grid >::gridPtr ( )

inlineprotectedinherited

hasGridData()

bool Dumux::GridManagerBase< Grid >::hasGridData ( ) const

inlineinherited

init()

void Dumux::GridManagerBase< Grid >::init ( const std::string &  modelParamGroup = "" )

inlineinherited

loadBalance()

void Dumux::GridManagerBase< Grid >::loadBalance ( )

inlineinherited

makeGridFromDgfFile()

void Dumux::GridManagerBase< Grid >::makeGridFromDgfFile ( const std::string &  fileName )

inlineprotectedinherited

makeGridFromFile()

void Dumux::GridManagerBase< Grid >::makeGridFromFile ( const std::string &  fileName, const std::string &  modelParamGroup  )

inlineprotectedinherited

• dgf (Dune Grid Format)
• msh (Gmsh mesh format)
• vtp/vtu (VTK file formats)

makeStructuredGrid()

void Dumux::GridManagerBase< Grid >::makeStructuredGrid ( CellType  cellType, const std::string &  modelParamGroup  )

inlineprotectedinherited

maybeRefineGrid()

void Dumux::GridManagerBase< Grid >::maybeRefineGrid ( const std::string &  modelParamGroup )

inlineprotectedinherited

Member Data Documentation

dgfGridPtr_

Dune::GridPtr<Grid> Dumux::GridManagerBase< Grid >::dgfGridPtr_

protectedinherited

enableDgfGridPointer_

bool Dumux::GridManagerBase< Grid >::enableDgfGridPointer_

protectedinherited

enableGmshDomainMarkers_

bool Dumux::GridManagerBase< Grid >::enableGmshDomainMarkers_

protectedinherited

enableVtkData_

bool Dumux::GridManagerBase< Grid >::enableVtkData_

protectedinherited

gridData_

std::shared_ptr<GridData> Dumux::GridManagerBase< Grid >::gridData_

protectedinherited

gridPtr_

std::shared_ptr<Grid> Dumux::GridManagerBase< Grid >::gridPtr_

protectedinherited

---

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

• gridmanager_base.hh