Dune Core Modules (2.9.0)

Dune::SPTopology< dim > Class Template Reference

description of the grid's topology More...

#include <dune/grid/spgrid/topology.hh>

Public Member Functions

 SPTopology (const unsigned int periodic=0)
 constructor More...
 
unsigned int numNodes () const
 number of cubes forming this topology
 
bool hasNeighbor (const unsigned int node, const int face) const
 check whether a node has a neighbor over a face More...
 
unsigned int neighbor (const unsigned int node, const int face) const
 obtain neighbor of a node over a face More...
 
bool periodic (const int i) const
 determine whether a direction is periodic More...
 
unsigned int periodic () const
 obtain the periodicity bit field More...
 

Static Public Attributes

static const int dimension = dim
 dimension of the domain
 
static const int numFaces = 2*dimension
 number of faces of a cube
 

Detailed Description

template<int dim>
class Dune::SPTopology< dim >

description of the grid's topology

The topology of a Cartesian grid is a set of cubes (called nodes, here) and their connectivity.

Note
Currently, only 1 node is supported.
Template Parameters
dimdimension of the grid

Constructor & Destructor Documentation

◆ SPTopology()

template<int dim>
Dune::SPTopology< dim >::SPTopology ( const unsigned int  periodic = 0)
inlineexplicit

constructor

Parameters
[in]periodicbit field specifying which directions should be periodic (defaults to 0)

Member Function Documentation

◆ hasNeighbor()

template<int dim>
bool Dune::SPTopology< dim >::hasNeighbor ( const unsigned int  node,
const int  face 
) const
inline

check whether a node has a neighbor over a face

Parameters
[in]nodeindex of the node
[in]facenumber of the face
Returns
true, if there is a neighbor

◆ neighbor()

template<int dim>
unsigned int Dune::SPTopology< dim >::neighbor ( const unsigned int  node,
const int  face 
) const
inline

obtain neighbor of a node over a face

Parameters
[in]nodeindex of the node
[in]facenumber of the face
Note
The neighboring node will have the given node as neighbor over the opposite face.
Returns
the index of the neighboring node

◆ periodic() [1/2]

template<int dim>
unsigned int Dune::SPTopology< dim >::periodic
inline

obtain the periodicity bit field

Note
This method only makes sense in case of a single node
Returns
the bitfield specifying which directions are periodic

References Dune::Functions::BasisFactory::Experimental::periodic().

◆ periodic() [2/2]

template<int dim>
bool Dune::SPTopology< dim >::periodic ( const int  i) const
inline

determine whether a direction is periodic

Parameters
[in]idirection (0 <= i < dimension)
Note
This method only makes sense in case of a single node
Returns
true, if direction i is periodic

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 27, 23:31, 2024)