The Grid Entity

Classes for constructing a geometrical and topological entity, the Grid object. More...

Classes

• class BaseSpace

  Base class for spaces that may be used for mapping domains to fiber spaces. More...
  

• struct Fiber::EuclideanMetric

  A namespace-like class implementing operations that are required from a metric field that implements the Euclidean metric in 3D. More...
  

• class FiberSpace< ID >

  Base class for fields defined on some base space. More...
  

• class FieldID

  Identifier for Fields within a Grid. More...
  

• class FieldIterator

  Class for iterating over fields. More...
  

• class Timestep

  Interface class that allows optionally storing integer numbers with a grid as a consecutive timestep information. More...
  

• class Grid

  A Grid is a set of Skeleton objects, each of them accessed via some unique SkeletonID object. More...
  

• class Fiber::GridContainer

  forgot what this class was good for... More...
  

• class Representation

  A Representation is a set of Field objects, each of them accessed via some FieldID identifier. More...
  

• class RepresentationMap

  A map that associates Representer objects with Representation instances. More...
  

• class Skeleton

  A Skeleton is a set of Representation object, each of them accessed by an Representer object. More...
  

• class FieldRef

  Context information for creating a field and inserting data. More...
  

• class SkeletonID

  Identifier for Skeletons within a Grid. More...
  

• class SkeletonIterator

  Base class for iteratores over a sequence of skeletons/. More...
  

Modules

• Chart and Atlas object

  Chart objects represent coordinate systems and spatial domains where they are valid.

  
  

Typedefs

• typedef WeakPtr< BaseSpace > Representer

  The type used to reference other objects, which is the anchor of representations of a Skeleton.
  

Functions

• GRID_API int Fiber::GridInit ()
• template<int Dims> index_t Fiber::RegularTopology::NumberOfEdges (const MultiIndex< Dims > &NumberOfVertices) throw ()

  Compute the number of edges on a regular grid that consists of the given number of vertices.
  

• template<int Dims> int Fiber::RegularTopology::EdgeOrientation (index_t EdgeIndex, const MultiIndex< Dims > &NumberOfVertices) throw (int)

  Compute the orientation of a given edge index in a regular grid, given the number of vertices in the grid.
  

• template<int Dims> void Fiber::RegularTopology::ComputeFirstEdgeVertex (MultiIndex< Dims > &FirstVertex, int &Orientation, index_t EdgeIndex, const MultiIndex< Dims > &NumberOfVertices) throw (int)

  Given a linear index of an edge (the edge ID) and the multidimensional number of vertices, compute the multidimensional indices of the corresponding vertice of the edge, and the orientation of this edge.
  

• template<int Dims> MultiIndex< Dims > Fiber::RegularTopology::ComputeSecondEdgeVertex (const MultiIndex< Dims > &Vertex, int Orientation) throw ()

  Given the vertex of an edge and an orientation (0,1,2), return the second vertex of the given edge.
  

• template<int Dims> std::pair< MultiIndex< Dims >
  , MultiIndex< Dims > > Fiber::RegularTopology::ComputeEdgeVertices (index_t EdgeIndex, const MultiIndex< Dims > &NumberOfVertices) throw (int)

  Compute the both vertices that correspond to a certain edge, where the edge is linearly numbered over all edges of a multidimensional regular grid.
  

• template<int Dims> index_t Fiber::RegularTopology::ComputeEdgeIDfromVertexAndOrientation (const MultiIndex< Dims > &Vertex, int Orientation, const MultiIndex< Dims > &NumberOfVertices) throw (int)

  Given a vertex and an orientation (i.e.
  

---

Detailed Description

Classes for constructing a geometrical and topological entity, the Grid object.

---

Typedef Documentation

typedef WeakPtr<BaseSpace> Representer

The type used to reference other objects, which is the anchor of representations of a Skeleton.

The BaseSpace is a base class for chart objects as well as for other Skeleton objects.

---

Function Documentation

template<int Dims>

index_t Fiber::RegularTopology::ComputeEdgeIDfromVertexAndOrientation	(	const MultiIndex< Dims > &	Vertex,
		int	Orientation,
		const MultiIndex< Dims > &	NumberOfVertices
	)			throw (int) [inline]

Given a vertex and an orientation (i.e.

the axis in which an edge points, compute the linear ID of the corresponding edge.

Second vertex of edge is given by

   Vertex + MultiIndex<3>::BitIndex( 1 << Orientation )

where 0 < Orientation < 3

Parameters:

NumberOfVertices

The multidimensional number of vertices.

Exceptions:

Throws

an integer if the vertex does not fit into the given number of vertices, or the orientation does not match, or similar.

References Fiber::MultiIndex< Dims >::size().

template<int Dims>

std::pair<MultiIndex<Dims>, MultiIndex<Dims> > Fiber::RegularTopology::ComputeEdgeVertices	(	index_t	EdgeIndex,
		const MultiIndex< Dims > &	NumberOfVertices
	)			throw (int) [inline]

Compute the both vertices that correspond to a certain edge, where the edge is linearly numbered over all edges of a multidimensional regular grid.

Parameters:

EdgeIndex

The linear index of the edge, must be smaller than NumberOfEdges( NumberOfVertices )

Exceptions:

An

integer is thrown if the EdgeIndex is too large.

References Fiber::RegularTopology::ComputeFirstEdgeVertex(), and Fiber::RegularTopology::ComputeSecondEdgeVertex().

template<int Dims>

void Fiber::RegularTopology::ComputeFirstEdgeVertex	(	MultiIndex< Dims > &	FirstVertex,
		int &	Orientation,
		index_t	EdgeIndex,
		const MultiIndex< Dims > &	NumberOfVertices
	)			throw (int) [inline]

Given a linear index of an edge (the edge ID) and the multidimensional number of vertices, compute the multidimensional indices of the corresponding vertice of the edge, and the orientation of this edge.

Parameters:

	EdgeIndex	The linear number of the edge, must be smaller than NumberOfEdges( NumberOfVertices )
	NumberOfVertices	How many vertices are there?
	FirstVertex	Output parameter, on return will contain the first vertex
	Orientation	The number of the axis along which this edge is oriented.

Exceptions:

An

integer of value -1 is thrown if the edge index is beyond the possible range of edges.

References Fiber::MultiIndex< Dims >::size().

Referenced by Fiber::RegularTopology::ComputeEdgeVertices().

template<int Dims>

MultiIndex<Dims> Fiber::RegularTopology::ComputeSecondEdgeVertex	(	const MultiIndex< Dims > &	Vertex,
		int	Orientation
	)			throw () [inline]

Given the vertex of an edge and an orientation (0,1,2), return the second vertex of the given edge.

This the second edge is computed by adding the BitIndex along the given orientation to the vertex.

Parameters:

	Vertex	The vertex where the edge starts.
	Orientation	The number of the given dimension, must be positive or null. The result will be undefined if the Orientation equals the dimension or is larger. 0 <= Orientation < Dims

Referenced by Fiber::RegularTopology::ComputeEdgeVertices().

template<int Dims>

int Fiber::RegularTopology::EdgeOrientation	(	index_t	EdgeIndex,
		const MultiIndex< Dims > &	NumberOfVertices
	)			throw (int) [inline]

Compute the orientation of a given edge index in a regular grid, given the number of vertices in the grid.

Edges are ordered by orientation, first come all those oriented in the lowest dimension, then second, last those in the highest dimension. In a cube, all four edges in the x-direction are the first four, the second four are those aligned in y-direction, and the last four are those in z-direction.

Exceptions:

Throws

an integer of value -1 if the edge index is beyond the possible vertices.