Dune::SPDomain< ct, dim > Class Template Reference

description of the computational domain More...

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

Public Types
typedef Cube::ctype	ctype
	coordinate type
typedef Cube::GlobalVector	GlobalVector
	type of global vectors, i.e., vectors within the domain

Public Member Functions
	SPDomain (const GlobalVector &a, const GlobalVector &b)
	constructor More...
	SPDomain (const std::vector< Cube > &cubes, const Topology &topology)
const Cube &	cube () const
const Topology &	topology () const
bool	contains (const GlobalVector &x) const
	determine whether the domain contains a point x More...

Static Public Member Functions
static This	unitCube ()
	obtain a domain modelling the unit cube More...

Static Public Attributes
static const int	dimension = Cube::dimension
	dimension of the domain

Detailed Description

template<class ct, int dim>
class Dune::SPDomain< ct, dim >

description of the computational domain

Template Parameters

ct	coordinate type (e.g., double)
dim	dimension of the domain

Constructor & Destructor Documentation

SPDomain() [1/2]

template<class ct , int dim>

Dune::SPDomain< ct, dim >::SPDomain ( const GlobalVector &  a, const GlobalVector &  b  )

inline

constructor

Parameters

[in]	a	one corner of the domain
[in]	b	the opposite corner of the domain

Note

The only restriction on the given corners is that they are opposite to each other. It is not guaranteed, that one of the corners will be returned by the method origin.

SPDomain() [2/2]

template<class ct , int dim>

Dune::SPDomain< ct, dim >::SPDomain ( const std::vector< Cube > &  cubes, const Topology &  topology  )

inline

Todo:

please doc me

Member Function Documentation

contains()

template<class ct , int dim>

bool Dune::SPDomain< ct, dim >::contains ( const GlobalVector &  x ) const

inline

determine whether the domain contains a point x

Parameters

[in]

x

point to consider

Returns

true, if x is contained in the domain

References Dune::SPDomain< ct, dim >::cube().

cube()

template<class ct , int dim>

const Cube& Dune::SPDomain< ct, dim >::cube ( ) const

inline

Todo:

please doc me

Referenced by Dune::SPDomain< ct, dim >::contains().

topology()

template<class ct , int dim>

const Topology& Dune::SPDomain< ct, dim >::topology ( ) const

inline

Todo:

please doc me

unitCube()

template<class ct , int dim>

SPDomain< ct, dim >::This Dune::SPDomain< ct, dim >::unitCube

inlinestatic

obtain a domain modelling the unit cube

Returns

a domain modelling \([0,1]^{dim}\)

---

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

• dune/grid/spgrid/domain.hh