Dune::SPTopology< dim > Class Template Reference

description of the grid's topology More...

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

Inheritance diagram for Dune::SPTopology< dim >:

Public Member Functions
	SPTopology (const unsigned int periodic=0)
	constructor
	SPTopology (const This &other)
	~SPTopology ()
const This &	operator= (const This &other)
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
unsigned int	neighbor (const unsigned int node, const int face) const
	obtain neighbor of a node over a face
bool	periodic (const int i) const
	determine whether a direction is periodic
unsigned int	periodic () const
	obtain the periodicity bit field

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

dim	dimension of the grid

Constructor & Destructor Documentation

SPTopology() [1/2]

template<int dim>

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

inlineexplicit

constructor

Parameters

[in]

periodic

bit field specifying which directions should be periodic (defaults to 0)

SPTopology() [2/2]

template<int dim>

Dune::SPTopology< dim >::SPTopology ( const This &  other )

inline

~SPTopology()

template<int dim>

Dune::SPTopology< dim >::~SPTopology

inline

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]	node	index of the node
[in]	face	number 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]	node	index of the node
[in]	face	number 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

numNodes()

template<int dim>

unsigned int Dune::SPTopology< dim >::numNodes ( ) const

inline

number of cubes forming this topology

operator=()

template<int dim>

const SPTopology< dim >::This & Dune::SPTopology< dim >::operator= ( const This &  other )

inline

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

periodic() [2/2]

template<int dim>

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

inline

determine whether a direction is periodic

Parameters

[in]

i

direction (0 <= i < dimension)

Note

This method only makes sense in case of a single node

Returns

true, if direction i is periodic

Member Data Documentation

dimension

template<int dim>

const int Dune::SPTopology< dim >::dimension = dim

static

dimension of the domain

numFaces

template<int dim>

const int Dune::SPTopology< dim >::numFaces = 2*dimension

static

number of faces of a cube

---

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

• topology.hh