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::SPCube< ct, dim > Class Template Reference

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

Public Types

typedef ct ctype
 coordinate type More...
 
typedef FieldVector< ctype, dimensionGlobalVector
 type of global vectors, i.e., vectors within the domain More...
 

Public Member Functions

 SPCube ()
 default constructor More...
 
 SPCube (const GlobalVector &a, const GlobalVector &b)
 constructor More...
 
const GlobalVectororigin () const
 obtain lower left corner More...
 
const GlobalVectorwidth () const
 obtain width More...
 
bool contains (const GlobalVector &x) const
 determine whether the cube 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 = dim
 dimension of the domain More...
 

Member Typedef Documentation

◆ ctype

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

coordinate type

◆ GlobalVector

template<class ct , int dim>
typedef FieldVector< ctype, dimension > Dune::SPCube< ct, dim >::GlobalVector

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

Constructor & Destructor Documentation

◆ SPCube() [1/2]

template<class ct , int dim>
Dune::SPCube< ct, dim >::SPCube
inline

default constructor

◆ SPCube() [2/2]

template<class ct , int dim>
Dune::SPCube< ct, dim >::SPCube ( const GlobalVector a,
const GlobalVector b 
)
inline

constructor

Parameters
[in]aone corner of the cube
[in]bthe opposite corner of the cube
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.

Member Function Documentation

◆ contains()

template<class ct , int dim>
bool Dune::SPCube< ct, dim >::contains ( const GlobalVector x) const
inline

determine whether the cube contains a point x

Parameters
[in]xpoint to consider
Returns
true, if x is contained in the cube

◆ origin()

template<class ct , int dim>
const SPCube< ct, dim >::GlobalVector & Dune::SPCube< ct, dim >::origin
inline

obtain lower left corner

Returns
a reference to the origin of the cube

◆ unitCube()

template<class ct , int dim>
SPCube< ct, dim >::This Dune::SPCube< ct, dim >::unitCube
inlinestatic

obtain a domain modelling the unit cube

Returns
a domain modelling $[0,1]^{dim}$

◆ width()

template<class ct , int dim>
const SPCube< ct, dim >::GlobalVector & Dune::SPCube< ct, dim >::width
inline

obtain width

Returns
a reference to the width of the cube

Member Data Documentation

◆ dimension

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

dimension of the domain


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