dune-spgrid 2.8.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
Dune::SPDomain< ct, dim > Class Template Reference

description of the computational domain More...

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

Public Types

typedef SPCube< ct, dim > Cube
 
typedef SPTopology< dim > Topology
 
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
 
 SPDomain (const std::vector< Cube > &cubes, const Topology &topology)
 
const Cubecube () const
 
const Topologytopology () const
 
bool contains (const GlobalVector &x) const
 determine whether the domain contains a point x
 

Static Public Member Functions

static This unitCube ()
 obtain a domain modelling the unit cube
 

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
ctcoordinate type (e.g., double)
dimdimension of the domain

Member Typedef Documentation

◆ ctype

template<class ct , int dim>
typedef Cube::ctype Dune::SPDomain< ct, dim >::ctype

coordinate type

◆ Cube

template<class ct , int dim>
typedef SPCube< ct, dim > Dune::SPDomain< ct, dim >::Cube

◆ GlobalVector

template<class ct , int dim>
typedef Cube::GlobalVector Dune::SPDomain< ct, dim >::GlobalVector

type of global vectors, i.e., vectors within the domain

◆ Topology

template<class ct , int dim>
typedef SPTopology< dim > Dune::SPDomain< ct, dim >::Topology

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]aone corner of the domain
[in]bthe 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]xpoint to consider
Returns
true, if x is contained in the domain

◆ cube()

template<class ct , int dim>
const Cube & Dune::SPDomain< ct, dim >::cube ( ) const
inline
Todo:
please doc me

◆ 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}$

Member Data Documentation

◆ dimension

template<class ct , int dim>
const int Dune::SPDomain< ct, dim >::dimension = Cube::dimension
static

dimension of the domain


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