Go to Overview over all GrAL packages.

---

               

---

CartesianGrid3D Class Reference

3D Cartesian grid class. More...

#include <cartesian3d.h>

Inheritance diagram for CartesianGrid3D:

[legend]Collaboration diagram for CartesianGrid3D:

[legend]List of all members.

Public Types
typedef index_map_nd< 3 >	index_map_type
typedef index_map_type::index_type	index_type
typedef Complex2D	archetype_type
typedef archetype_type const *	archetype_iterator
typedef archetype_geom	archetype_geom_type
Public Methods
	CartesianGrid3D ()
	CartesianGrid3D (int vx, int vy, int vz)
unsigned	NumOfVertices () const
unsigned	NumOfCells () const
VertexIterator	FirstVertex () const
CellIterator	FirstCell () const
unsigned	NumOfXVertices () const
unsigned	NumOfYVertices () const
unsigned	NumOfZVertices () const
unsigned	NumOfXCells () const
unsigned	NumOfYCells () const
unsigned	NumOfZCells () const
unsigned	NumOfArchetypes () const
archetype_type const &	Archetype (int a) const
archetype_type const &	ArchetypeOf (Cell const &) const
archetype_type const &	ArchetypeOf (cell_handle) const
archetype_handle	archetype_of (cell_handle) const
archetype_handle	archetype_of (Cell const &) const
archetype_geom_type	ArchetypeGeom (archetype_type const &A=*BeginArchetype()) const
archetype_handle	handle (archetype_iterator a) const
Static Public Methods
archetype_iterator	BeginArchetype ()
archetype_iterator	EndArchetype ()
Friends
class	archetype_geom
class	Vertex_Cartesian3D
class	Cell_Cartesian3D
class	VertexOnCellIterator_Cartesian3D

---

Detailed Description

3D Cartesian grid class.

At present, this implements only a Cell-VertexInputGridRange.

Todo:

Implement the full set of grid elements and iterators, in particular Edge and Facet types.

CartesianGrid3D(1,1,1) gives an error in cell_map (division by 0). Check this in index_map_nd<>.

Implement validity checks for iterators

Definition at line 55 of file cartesian3d.h.

---

Member Typedef Documentation

typedef index_map_nd<3> CartesianGrid3D::index_map_type

Definition at line 57 of file cartesian3d.h. Referenced by CartesianGrid3D.

typedef index_map_type::index_type CartesianGrid3D::index_type

Definition at line 58 of file cartesian3d.h.

typedef Complex2D CartesianGrid3D::archetype_type

Definition at line 60 of file cartesian3d.h.

typedef archetype_type const* CartesianGrid3D::archetype_iterator

Definition at line 61 of file cartesian3d.h. Referenced by BeginArchetype.

typedef archetype_geom CartesianGrid3D::archetype_geom_type

Definition at line 97 of file cartesian3d.h. Referenced by ArchetypeGeom.

---

Constructor & Destructor Documentation

CartesianGrid3D::CartesianGrid3D (    )  [inline]

Definition at line 105 of file cartesian3d.h. References index_map_type.

CartesianGrid3D::CartesianGrid3D (  int    vx, int    vy, int    vz )  [inline]

Definition at line 112 of file cartesian3d.h. References index_map_type.

---

Member Function Documentation

unsigned CartesianGrid3D::NumOfVertices (    )  const [inline]

Definition at line 122 of file cartesian3d.h. References index_map_nd< 3 >::max_flat_index. Referenced by main.

unsigned CartesianGrid3D::NumOfCells (    )  const [inline]

Definition at line 123 of file cartesian3d.h. References index_map_nd< 3 >::max_flat_index. Referenced by main.

Vertex_Cartesian3D CartesianGrid3D::FirstVertex (    )  const [inline]

Definition at line 317 of file cartesian3d.h. References grid_types_Cartesian3D::Vertex.

Cell_Cartesian3D CartesianGrid3D::FirstCell (    )  const [inline]

Definition at line 321 of file cartesian3d.h. References grid_types_Cartesian3D::Cell.

unsigned CartesianGrid3D::NumOfXVertices (    )  const [inline]

Definition at line 127 of file cartesian3d.h. References index_map_nd< 3 >::max_tuple.

unsigned CartesianGrid3D::NumOfYVertices (    )  const [inline]

Definition at line 128 of file cartesian3d.h. References index_map_nd< 3 >::max_tuple.

unsigned CartesianGrid3D::NumOfZVertices (    )  const [inline]

Definition at line 129 of file cartesian3d.h. References index_map_nd< 3 >::max_tuple.

unsigned CartesianGrid3D::NumOfXCells (    )  const [inline]

Definition at line 130 of file cartesian3d.h. References index_map_nd< 3 >::max_tuple.

unsigned CartesianGrid3D::NumOfYCells (    )  const [inline]

Definition at line 131 of file cartesian3d.h. References index_map_nd< 3 >::max_tuple.

unsigned CartesianGrid3D::NumOfZCells (    )  const [inline]

Definition at line 132 of file cartesian3d.h. References index_map_nd< 3 >::max_tuple.

archetype_iterator CartesianGrid3D::BeginArchetype (    )  [inline, static]

Definition at line 135 of file cartesian3d.h. References archetype_iterator. Referenced by Archetype, ArchetypeOf, EndArchetype, handle, and main.

archetype_iterator CartesianGrid3D::EndArchetype (    )  [inline, static]

Definition at line 137 of file cartesian3d.h. References BeginArchetype.

unsigned CartesianGrid3D::NumOfArchetypes (    )  const [inline]

Definition at line 138 of file cartesian3d.h.

archetype_type const& CartesianGrid3D::Archetype (  int    a )  const [inline]

Definition at line 140 of file cartesian3d.h. References BeginArchetype.

archetype_type const& CartesianGrid3D::ArchetypeOf (  Cell const &    )  const [inline]

Definition at line 145 of file cartesian3d.h. References BeginArchetype, and grid_types_Cartesian3D::Cell.

archetype_type const& CartesianGrid3D::ArchetypeOf (  cell_handle    )  const [inline]

Definition at line 147 of file cartesian3d.h. References BeginArchetype, and grid_types_Cartesian3D::cell_handle.

archetype_handle CartesianGrid3D::archetype_of (  cell_handle    )  const [inline]

Definition at line 150 of file cartesian3d.h. References grid_types_Cartesian3D::archetype_handle, and grid_types_Cartesian3D::cell_handle.

archetype_handle CartesianGrid3D::archetype_of (  Cell const &    )  const [inline]

Definition at line 152 of file cartesian3d.h. References grid_types_Cartesian3D::archetype_handle, and grid_types_Cartesian3D::Cell.

archetype_geom_type CartesianGrid3D::ArchetypeGeom (  archetype_type const &    A = *BeginArchetype() )  const [inline]

Definition at line 155 of file cartesian3d.h. References archetype_geom_type.

archetype_handle CartesianGrid3D::handle (  archetype_iterator    a )  const [inline]

Definition at line 159 of file cartesian3d.h. References grid_types_Cartesian3D::archetype_handle, and BeginArchetype.

---

Friends And Related Function Documentation

friend class archetype_geom [friend]

Definition at line 99 of file cartesian3d.h.

friend class Vertex_Cartesian3D [friend]

Definition at line 100 of file cartesian3d.h.

friend class Cell_Cartesian3D [friend]

Definition at line 101 of file cartesian3d.h.

friend class VertexOnCellIterator_Cartesian3D [friend]

Definition at line 102 of file cartesian3d.h.

---

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

• Gral/Grids/Cartesian3D/cartesian3d.h
• src/Cartesian3D/cartesian3d.C

---

Copyright (c) Guntram Berti 1997-2002. See the GrAL Homepage for up-to-date information.

---