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

Container for equidistant coordinates in a YaspGrid with non-trivial origin. More...

#include <dune/grid/yaspgrid/coordinates.hh>

Public Types
typedef ct	ctype
	export the coordinate type

Public Member Functions
	EquidistantOffsetCoordinates ()
	default constructor
	EquidistantOffsetCoordinates (const Dune::FieldVector< ct, dim > &lowerLeft, const Dune::FieldVector< ct, dim > &upperRight, const std::array< int, dim > &s)
	construct a container with all necessary information
ct	meshsize (int d, int i) const
ct	coordinate (int d, int i) const
int	size (int d) const
ct	origin (int d) const
EquidistantOffsetCoordinates< ct, dim >	refine (std::bitset< dim > ovlp_low, std::bitset< dim > ovlp_up, int overlap, bool keep_ovlp) const
void	print (std::ostream &s) const
	print information on this container

Static Public Attributes
static const int	dimension = dim
	export dimension

Detailed Description

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

Container for equidistant coordinates in a YaspGrid with non-trivial origin.

Template Parameters

ct	the coordinate type
dim	the dimension of the grid

Member Typedef Documentation

ctype

template<class ct , int dim>

typedef ct Dune::EquidistantOffsetCoordinates< ct, dim >::ctype

export the coordinate type

Constructor & Destructor Documentation

EquidistantOffsetCoordinates() [1/2]

template<class ct , int dim>

Dune::EquidistantOffsetCoordinates< ct, dim >::EquidistantOffsetCoordinates ( )

inline

default constructor

EquidistantOffsetCoordinates() [2/2]

template<class ct , int dim>

Dune::EquidistantOffsetCoordinates< ct, dim >::EquidistantOffsetCoordinates ( const Dune::FieldVector< ct, dim > &  lowerLeft, const Dune::FieldVector< ct, dim > &  upperRight, const std::array< int, dim > &  s  )

inline

construct a container with all necessary information

Parameters

lowerLeft	the lower left corner of the grid
upperRight	the upper right corner of the grid
s	the size (in codim 0 elements) of the grid on this processor

the size information is kept with this container, because this is the natural way to handle this for a tensorproduct grid.

Member Function Documentation

coordinate()

template<class ct , int dim>

ct Dune::EquidistantOffsetCoordinates< ct, dim >::coordinate ( int  d, int  i  ) const

inline

Returns

a coordinate given a direction and an index

Parameters

d	the direction to be used
i	the global coordinate index

meshsize()

template<class ct , int dim>

ct Dune::EquidistantOffsetCoordinates< ct, dim >::meshsize ( int  d, int  i  ) const

inline

Returns

the meshsize in given direction at given position

Parameters

d	the direction to be used
i	the global coordinate index where to return the meshsize

origin()

template<class ct , int dim>

ct Dune::EquidistantOffsetCoordinates< ct, dim >::origin ( int  d ) const

inline

Returns

the dth component of the origin

Parameters

d	the direction to be used

print()

template<class ct , int dim>

void Dune::EquidistantOffsetCoordinates< ct, dim >::print ( std::ostream &  s ) const

inline

print information on this container

refine()

template<class ct , int dim>

EquidistantOffsetCoordinates< ct, dim > Dune::EquidistantOffsetCoordinates< ct, dim >::refine ( std::bitset< dim >  ovlp_low, std::bitset< dim >  ovlp_up, int  overlap, bool  keep_ovlp  ) const

inline

Returns

a container that represents the same grid after one step of uniform refinement

Parameters

ovlp_low	whether we have an overlap area at the lower processor boundary
ovlp_up	whether we have an overlap area at the upper processor boundary
overlap	the size of the overlap region
keep_ovlp	the refinement option parameter to be used

size()

template<class ct , int dim>

int Dune::EquidistantOffsetCoordinates< ct, dim >::size ( int  d ) const

inline

Returns

the size in given direction

Parameters

d	the direction to be used

Member Data Documentation

dimension

template<class ct , int dim>

const int Dune::EquidistantOffsetCoordinates< ct, dim >::dimension = dim

static

export dimension

---

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

• coordinates.hh