3.5-git
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Classes | Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
Dumux::PoreNetwork::SnappyGridManager< dim, OtherGridCreator, DiscMethod > Class Template Reference

A grid creator that matches a free-flow grid to a PNM grid. More...

#include <dumux/multidomain/boundary/freeflowporenetwork/snappygridmanager.hh>

Inheritance diagram for Dumux::PoreNetwork::SnappyGridManager< dim, OtherGridCreator, DiscMethod >:

Description

template<int dim, class OtherGridCreator, class DiscMethod = DiscretizationMethods::None>
class Dumux::PoreNetwork::SnappyGridManager< dim, OtherGridCreator, DiscMethod >

A grid creator that matches a free-flow grid to a PNM grid.

Public Types

using Grid = Dune::YaspGrid< dim, Dune::TensorProductCoordinates< Scalar, dim > >
 
using GridData = Dumux::GridData< Grid >
 

Public Member Functions

void init (const OtherGrid &otherGrid, const LowDimGridData &otherData, const std::string &modelParamGroup="")
 Make the grid. More...
 
const GridConstructionData & getGridConstructionData () const
 Return data used to create the snappy grid (needed for Dune::TensorProductCoordinates) and the locations of pores intersecting with the interface. More...
 
void init (const std::string &modelParamGroup="")
 Make the grid. Implement this method in the specialization of this class for a grid type. More...
 
Gridgrid ()
 Returns a reference to the grid. More...
 
void loadBalance ()
 Call loadBalance() function of the grid. More...
 
std::shared_ptr< GridDatagetGridData () 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...
 
std::shared_ptr< GridgridPtr_
 
Dune::GridPtr< GriddgfGridPtr_
 
std::shared_ptr< GridDatagridData_
 

Member Typedef Documentation

◆ Grid

template<int dim, class OtherGridCreator , class DiscMethod = DiscretizationMethods::None>
using Dumux::PoreNetwork::SnappyGridManager< dim, OtherGridCreator, DiscMethod >::Grid = Dune::YaspGrid<dim, Dune::TensorProductCoordinates<Scalar, dim> >

◆ GridData

using Dumux::GridManagerBase< Dune::YaspGrid< dim, Dune::TensorProductCoordinates< OtherGridCreator::Grid::ctype, OtherGridCreator::Grid::LeafGridView::dimensionworld > > >::GridData = Dumux::GridData<Grid>
inherited

Member Enumeration Documentation

◆ CellType

enum Dumux::GridManagerBase::CellType
protectedinherited

The cell types for structured grids.

Member Function Documentation

◆ dgfGridPtr()

Dune::GridPtr< Grid > & Dumux::GridManagerBase< Dune::YaspGrid< dim, Dune::TensorProductCoordinates< OtherGridCreator::Grid::ctype, OtherGridCreator::Grid::LeafGridView::dimensionworld > > >::dgfGridPtr ( )
inlineprotectedinherited

Returns a reference to the DGF grid pointer (Dune::GridPtr<Grid>).

◆ getFileExtension()

std::string Dumux::GridManagerBase< Dune::YaspGrid< dim, Dune::TensorProductCoordinates< OtherGridCreator::Grid::ctype, OtherGridCreator::Grid::LeafGridView::dimensionworld > > >::getFileExtension ( const std::string &  fileName) const
inlineprotectedinherited

Returns the filename extension of a given filename.

◆ getGridConstructionData()

template<int dim, class OtherGridCreator , class DiscMethod = DiscretizationMethods::None>
const GridConstructionData & Dumux::PoreNetwork::SnappyGridManager< dim, OtherGridCreator, DiscMethod >::getGridConstructionData ( ) const
inline

Return data used to create the snappy grid (needed for Dune::TensorProductCoordinates) and the locations of pores intersecting with the interface.

◆ getGridData()

std::shared_ptr< GridData > Dumux::GridManagerBase< Dune::YaspGrid< dim, Dune::TensorProductCoordinates< OtherGridCreator::Grid::ctype, OtherGridCreator::Grid::LeafGridView::dimensionworld > > >::getGridData ( ) const
inlineinherited

Get an owning pointer to grid data associated with the grid.

Note
Throws if no grid data is available

◆ grid()

Grid & Dumux::GridManagerBase< Dune::YaspGrid< dim, Dune::TensorProductCoordinates< OtherGridCreator::Grid::ctype, OtherGridCreator::Grid::LeafGridView::dimensionworld > > >::grid ( )
inlineinherited

Returns a reference to the grid.

◆ gridPtr()

std::shared_ptr< Grid > & Dumux::GridManagerBase< Dune::YaspGrid< dim, Dune::TensorProductCoordinates< OtherGridCreator::Grid::ctype, OtherGridCreator::Grid::LeafGridView::dimensionworld > > >::gridPtr ( )
inlineprotectedinherited

Returns a reference to the grid pointer (std::shared_ptr<Grid>)

◆ hasGridData()

bool Dumux::GridManagerBase< Dune::YaspGrid< dim, Dune::TensorProductCoordinates< OtherGridCreator::Grid::ctype, OtherGridCreator::Grid::LeafGridView::dimensionworld > > >::hasGridData ( ) const
inlineinherited

Check whether there is data associated with the grid.

◆ init() [1/2]

template<int dim, class OtherGridCreator , class DiscMethod = DiscretizationMethods::None>
void Dumux::PoreNetwork::SnappyGridManager< dim, OtherGridCreator, DiscMethod >::init ( const OtherGrid &  otherGrid,
const LowDimGridData &  otherData,
const std::string &  modelParamGroup = "" 
)
inline

Make the grid.

◆ init() [2/2]

void Dumux::GridManagerBase< Dune::YaspGrid< dim, Dune::TensorProductCoordinates< OtherGridCreator::Grid::ctype, OtherGridCreator::Grid::LeafGridView::dimensionworld > > >::init ( const std::string &  modelParamGroup = "")
inlineinherited

Make the grid. Implement this method in the specialization of this class for a grid type.

◆ loadBalance()

void Dumux::GridManagerBase< Dune::YaspGrid< dim, Dune::TensorProductCoordinates< OtherGridCreator::Grid::ctype, OtherGridCreator::Grid::LeafGridView::dimensionworld > > >::loadBalance ( )
inlineinherited

Call loadBalance() function of the grid.

◆ makeGridFromDgfFile()

void Dumux::GridManagerBase< Dune::YaspGrid< dim, Dune::TensorProductCoordinates< OtherGridCreator::Grid::ctype, OtherGridCreator::Grid::LeafGridView::dimensionworld > > >::makeGridFromDgfFile ( const std::string &  fileName)
inlineprotectedinherited

Makes a grid from a DGF file. This is used by grid managers that only support DGF.

◆ makeGridFromFile()

void Dumux::GridManagerBase< Dune::YaspGrid< dim, Dune::TensorProductCoordinates< OtherGridCreator::Grid::ctype, OtherGridCreator::Grid::LeafGridView::dimensionworld > > >::makeGridFromFile ( const std::string &  fileName,
const std::string &  modelParamGroup 
)
inlineprotectedinherited

Makes a grid from a file. We currently support.

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

◆ makeStructuredGrid()

void Dumux::GridManagerBase< Dune::YaspGrid< dim, Dune::TensorProductCoordinates< OtherGridCreator::Grid::ctype, OtherGridCreator::Grid::LeafGridView::dimensionworld > > >::makeStructuredGrid ( CellType  cellType,
const std::string &  modelParamGroup 
)
inlineprotectedinherited

Makes a structured cube grid using the structured grid factory.

◆ maybeRefineGrid()

void Dumux::GridManagerBase< Dune::YaspGrid< dim, Dune::TensorProductCoordinates< OtherGridCreator::Grid::ctype, OtherGridCreator::Grid::LeafGridView::dimensionworld > > >::maybeRefineGrid ( const std::string &  modelParamGroup)
inlineprotectedinherited

Refines a grid after construction if GridParameterGroup.Refinement is set in the input file.

Member Data Documentation

◆ dgfGridPtr_

Dune::GridPtr<Grid> Dumux::GridManagerBase< Dune::YaspGrid< dim, Dune::TensorProductCoordinates< OtherGridCreator::Grid::ctype, OtherGridCreator::Grid::LeafGridView::dimensionworld > > >::dgfGridPtr_
protectedinherited

◆ enableDgfGridPointer_

bool Dumux::GridManagerBase< Dune::YaspGrid< dim, Dune::TensorProductCoordinates< OtherGridCreator::Grid::ctype, OtherGridCreator::Grid::LeafGridView::dimensionworld > > >::enableDgfGridPointer_
protectedinherited

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.

◆ enableGmshDomainMarkers_

bool Dumux::GridManagerBase< Dune::YaspGrid< dim, Dune::TensorProductCoordinates< OtherGridCreator::Grid::ctype, OtherGridCreator::Grid::LeafGridView::dimensionworld > > >::enableGmshDomainMarkers_
protectedinherited

A state variable if domain markers have been read from a Gmsh file.

◆ gridData_

std::shared_ptr<GridData> Dumux::GridManagerBase< Dune::YaspGrid< dim, Dune::TensorProductCoordinates< OtherGridCreator::Grid::ctype, OtherGridCreator::Grid::LeafGridView::dimensionworld > > >::gridData_
protectedinherited

◆ gridPtr_

std::shared_ptr<Grid> Dumux::GridManagerBase< Dune::YaspGrid< dim, Dune::TensorProductCoordinates< OtherGridCreator::Grid::ctype, OtherGridCreator::Grid::LeafGridView::dimensionworld > > >::gridPtr_
protectedinherited

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