Dune Core Modules (2.3.1)

Dune::StructuredGridFactory< YaspGrid< dim > > Class Template Reference

Specialization of the StructuredGridFactory for YaspGrid. More...

#include <dune/grid/utility/structuredgridfactory.hh>

Static Public Member Functions

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

Detailed Description

template<int dim>
class Dune::StructuredGridFactory< YaspGrid< 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
  • YaspGrid only support grids which have their lower left corder at the origin.

Member Function Documentation

◆ createCubeGrid()

template<int dim>
static shared_ptr<GridType> Dune::StructuredGridFactory< YaspGrid< dim > >::createCubeGrid ( const FieldVector< ctype, dimworld > &  lowerLeft,
const FieldVector< ctype, dimworld > &  upperRight,
const 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
YaspGrid only supports lowerLeft at the origin. This function throws a GridError if this requirement is not met.

◆ createSimplexGrid()

template<int dim>
static shared_ptr<GridType> Dune::StructuredGridFactory< YaspGrid< dim > >::createSimplexGrid ( const FieldVector< ctype, dimworld > &  lowerLeft,
const FieldVector< ctype, dimworld > &  upperRight,
const array< unsigned int, dim > &  elements 
)
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 (May 14, 22:30, 2024)