Dune Core Modules (unstable)

Dune::StructuredGridFactory< YaspGrid< dim, EquidistantCoordinates< ctype, dim > > > Class Template Reference

Specialization of the StructuredGridFactory for YaspGrid. More...

#include <dune/grid/yaspgrid/structuredyaspgridfactory.hh>

Static Public Member Functions

static std::unique_ptr< GridTypecreateCubeGrid (const FieldVector< ctype, dimworld > &lowerLeft, const FieldVector< ctype, dimworld > &upperRight, const std::array< unsigned int, dim > &elements)
 Create a structured cube grid. More...
 
static std::unique_ptr< GridTypecreateSimplexGrid (const FieldVector< ctype, dimworld > &, const FieldVector< ctype, dimworld > &, const std::array< unsigned int, dim > &)
 Create a structured simplex grid. More...
 

Detailed Description

template<class ctype, int dim>
class Dune::StructuredGridFactory< YaspGrid< dim, EquidistantCoordinates< ctype, dim > > >

Specialization of the StructuredGridFactory for YaspGrid.

This allows a YaspGrid to be constructed using the StructuredGridFactory just like the unstructured Grids. There are two limitations:

  • YaspGrid does not support simplices
  • If the lower left corner should not be at the origin, the second template parameter of Yaspgrid has to be chosen as Dune::EquidistantOffsetCoordinates<ctype,dim>.

Member Function Documentation

◆ createCubeGrid()

template<class ctype , int dim>
static std::unique_ptr<GridType> Dune::StructuredGridFactory< YaspGrid< dim, EquidistantCoordinates< ctype, dim > > >::createCubeGrid ( const FieldVector< ctype, dimworld > &  lowerLeft,
const FieldVector< ctype, dimworld > &  upperRight,
const std::array< unsigned int, dim > &  elements 
)
inlinestatic

Create a structured cube grid.

Parameters
lowerLeftLower left corner of the grid
upperRightUpper right corner of the grid
elementsNumber of elements in each coordinate direction
Note
The default variant of YaspGrid only supports lowerLeft at the origin. Use YaspGrid<dim, EquidistantOffsetCoordinates<ctype,dim> > instead for non-trivial origin.

References DUNE_THROW.

◆ createSimplexGrid()

template<class ctype , int dim>
static std::unique_ptr<GridType> Dune::StructuredGridFactory< YaspGrid< dim, EquidistantCoordinates< ctype, dim > > >::createSimplexGrid ( const FieldVector< ctype, dimworld > &  ,
const FieldVector< ctype, dimworld > &  ,
const std::array< unsigned int, dim > &   
)
inlinestatic

Create a structured simplex grid.

Note
Simplices are not supported in YaspGrid, so this functions unconditionally throws a GridError.

References DUNE_THROW.


The documentation for this class was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.80.0 (Mar 28, 23:30, 2024)