ug4
lib_grid

The grid library. More...

Modules

 algorithms
 contains a variety of useful algorithms.
 
 element_callbacks
 contains grid element callback definitions for common usage
 
 grid
 Grid, MultiGrid and GridObjectCollection are contained in this group.
 
 geometric objects
 Geometric objects are the building blocks of a grid.
 
 grid-tools
 contains a variety of useful grid-tools.
 

Enumerations

enum  ug::EdgeOptions { ug::EDGEOPT_NONE = 0x00000000 , ug::EDGEOPT_STORE_ASSOCIATED_FACES = 0x00000100 , ug::EDGEOPT_STORE_ASSOCIATED_VOLUMES = 0x00000200 }
 Used to specify the way in which Grid manages edge-specific data. More...
 
enum  ug::FaceOptions { ug::FACEOPT_NONE = 0x00000000 , ug::FACEOPT_STORE_ASSOCIATED_EDGES = 0x00010000 , ug::FACEOPT_STORE_ASSOCIATED_VOLUMES = 0x00020000 , ug::FACEOPT_AUTOGENERATE_EDGES = 0x00080000 }
 Used to specify the way in which Grid manages face-specific data. More...
 
enum  ug::GridOptions {
  ug::GRIDOPT_NONE = 0x00000000 , ug::GRIDOPT_NO_INTERCONNECTION = 0x00000000 , ug::GRIDOPT_VERTEXCENTRIC_INTERCONNECTION , ug::GRIDOPT_AUTOGENERATE_SIDES ,
  ug::GRIDOPT_STANDARD_INTERCONNECTION , ug::GRIDOPT_FULL_INTERCONNECTION , ug::GRIDOPT_DEFAULT
}
 Specify how references between associated objects are stored in a grid. More...
 
enum  ug::VertexOptions { ug::VRTOPT_NONE = 0x00000000 , ug::VRTOPT_STORE_ASSOCIATED_EDGES = 0x00000001 , ug::VRTOPT_STORE_ASSOCIATED_FACES = 0x00000002 , ug::VRTOPT_STORE_ASSOCIATED_VOLUMES = 0x00000004 }
 Used to specify the way in which Grid manages vertex-specific data. More...
 
enum  ug::VolumeOptions {
  ug::VOLOPT_NONE = 0x00000000 , ug::VOLOPT_STORE_ASSOCIATED_EDGES = 0x01000000 , ug::VOLOPT_STORE_ASSOCIATED_FACES = 0x02000000 , ug::VOLOPT_AUTOGENERATE_EDGES = 0x08000000 ,
  ug::VOLOPT_AUTOGENERATE_FACES = 0x10000000
}
 Used to specify the way in which Grid manages volume-specific data. More...
 

Detailed Description

The grid library.

lib_grid not only defines basic types like ug::Grid and ug::MultiGrid, it also features tools such as the ug::Selector, ug::MGSelector, ug::SubsetHandler and ug::MGSubsetHandler as well as a vast collection of methods that work on those types. Those can mostly be found in the algorithms section.

Enumeration Type Documentation

◆ EdgeOptions

Used to specify the way in which Grid manages edge-specific data.

Enumerator
EDGEOPT_NONE 
EDGEOPT_STORE_ASSOCIATED_FACES 
EDGEOPT_STORE_ASSOCIATED_VOLUMES 

◆ FaceOptions

Used to specify the way in which Grid manages face-specific data.

Enumerator
FACEOPT_NONE 
FACEOPT_STORE_ASSOCIATED_EDGES 

minor speed-improvement for grid.get_edge(Face*, int)

FACEOPT_STORE_ASSOCIATED_VOLUMES 
FACEOPT_AUTOGENERATE_EDGES 

◆ GridOptions

Specify how references between associated objects are stored in a grid.

Enumerator
GRIDOPT_NONE 
GRIDOPT_NO_INTERCONNECTION 
GRIDOPT_VERTEXCENTRIC_INTERCONNECTION 

vertices store lists of associated geometric objects.

Note that this is the minimal required interconnection for many dynamic algorithms (i.e. deleting an object from a grid automatically enables this option.

GRIDOPT_AUTOGENERATE_SIDES 

sides are automatically created

GRIDOPT_STANDARD_INTERCONNECTION 

All elements store references to associated lower dimensional geometric objects.

Additionally GRIDOPT_VERTEXCENTRIC_INTERCONNECTION is used.

GRIDOPT_FULL_INTERCONNECTION 

All elements store references to all associated elements.

This includes GRIDOPT_VERTEXCENTRIC_INTERCONNECTION and GRIDOPT_STANDARD_INTERCONNECTION.

GRIDOPT_DEFAULT 

◆ VertexOptions

Used to specify the way in which Grid manages vertex-specific data.

Enumerator
VRTOPT_NONE 
VRTOPT_STORE_ASSOCIATED_EDGES 
VRTOPT_STORE_ASSOCIATED_FACES 
VRTOPT_STORE_ASSOCIATED_VOLUMES 

◆ VolumeOptions

Used to specify the way in which Grid manages volume-specific data.

Enumerator
VOLOPT_NONE 
VOLOPT_STORE_ASSOCIATED_EDGES 

minor speed-improvement for grid.get_edge(Volume*, int)

VOLOPT_STORE_ASSOCIATED_FACES 

speed-improvement for grid.get_face(Face*, int) ~15%

VOLOPT_AUTOGENERATE_EDGES 
VOLOPT_AUTOGENERATE_FACES