Skip to content

Commit

Permalink
Adding tables on the MOAB file spec
Browse files Browse the repository at this point in the history
  • Loading branch information
@pshriwise
pshriwise committed Feb 27, 2024
1 parent a36e4c5 commit b0b55b7
Show file tree
Hide file tree
Showing 3 changed files with 82 additions and 13 deletions.
6 changes: 5 additions & 1 deletion docs/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,8 @@
'titles_only': False
}

html_css_files = [ 'css/custom.css' ]
html_static_path = ['_static']
html_css_files = [ '_static/theme_override.css' ]
maximum_signature_line_length = 80

# Add any paths that contain custom static files (such as style sheets) here,
Expand All @@ -112,3 +113,6 @@
}
breathe_default_project = "DAGMC"
breathe_default_members = ('members', 'undoc-members')

def setup(app):
app.add_css_file('theme_override.css')
88 changes: 76 additions & 12 deletions docs/developerguide/h5m_file_spec.rst
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,80 @@
DAGMC File Specification
========================

.. table:: Geometric EntitySet Tag Descriptions

+-----------------------+------------------+------------+------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+
| Tag Name | Type | Real Type | Size | Purpose | Tagged On |
+=======================+==================+============+======+==================================================================================================================================================================================================================================================================================================================================================================+=============+
| `GLOBAL_ID` | `MB_TYPE_INT` | `int` | 1 | Value of an ID associated with a geometric `EntitySet`. | `EntitySet` |
| `GEOM_SENSE_2` | `EntityHandle` | `uint64_t` | 2 | Relates a surface to the two volumes on either side of the surface. An entry in the first position indicates tht the surafce has a sense that is forward with respect to the volume `EntityHandle` in that position. An entry in the second position indicates that the surface has a sense reversed with respect to the volume `EntityHandle` in that position. | |
| `GEOM_SENSE_N_ENTS` | `EntityHandle` | `uint64_t` | N | Relates a curve to any topologically adjacent surface `EntitySet`s. | `EntitySet` |
| `GEOM_SENSE_N_SENSES` | `MB_TYPE_INT` | `int` | N | Curve sense data correllated with the `GEOM_SENSE_N_ENTS` information. Values are `1` for a forward senses and `-1` for reversed senses. | `EntitySet` |
| `CATEGORY` | `MB_TYPE_OPAQUE` | `char` | 32 | The geometric category of an `EntitySet`. One of "Vertex", "Curve", "Surface", "Volume", or "Group" | `EntitySet` |
| `GEOM_DIM` | `MB_TYPE_INT` | `int` | 1 | The dimensionality of a geometric `EntitySet`. See table below for meaning of values. | `EntitySet` |
| `NAME` | `MB_TYPE_OPAQUE` | `char` | 32 | A name assigned to an `EntitySet`. Use to indicate material assignments, boundary conditions, temperatures, and the implicit complement on `EntitySet`'s with a `CATEGORY` tag whose value is "Group" | `EntitySet` |
| | | | | | |
+-----------------------+------------------+------------+------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+
+-----------------------+------------------+------------+------+-------------+--------------------------------------------------------------------------------------------------------------+
| Tag Name | Type | Real Type | Size | Tagged On | Purpose |
+=======================+==================+============+======+=============+==============================================================================================================+
| `GLOBAL_ID` | `MB_TYPE_INT` | `int` | 1 | `EntitySet` | Value of an ID associated with a geometric `EntitySet`. |
+-----------------------+------------------+------------+------+-------------+--------------------------------------------------------------------------------------------------------------+
| `GEOM_SENSE_2` | `EntityHandle` | `uint64_t` | 2 | `EntitySet` | Relates a surface to the two volumes on either side of the surface. An entry in the first position |
| | | | | | indicates tht the surafce has a sense that is forward with respect to |
| | | | | | the volume `EntityHandle` in that position. An entry in the second position |
| | | | | | indicates that the surface has a sense reversed with respect to the volume `EntityHandle` in that position. |
+-----------------------+------------------+------------+------+-------------+--------------------------------------------------------------------------------------------------------------+
| `GEOM_SENSE_N_ENTS` | `EntityHandle` | `uint64_t` | N | `EntitySet` | Relates a curve to any topologically adjacent surface `EntitySet`s. |
+-----------------------+------------------+------------+------+-------------+--------------------------------------------------------------------------------------------------------------+
| `GEOM_SENSE_N_SENSES` | `MB_TYPE_INT` | `int` | N | `EntitySet` | Curve sense data correllated with the `GEOM_SENSE_N_ENTS` information. |
| | | | | | Values are `1` for a forward senses and `-1` for reversed senses. |
+-----------------------+------------------+------------+------+-------------+--------------------------------------------------------------------------------------------------------------+
| `CATEGORY` | `MB_TYPE_OPAQUE` | `char` | 32 | `EntitySet` | The geometric category of an `EntitySet`. One of "Vertex", "Curve", "Surface", "Volume", or "Group" |
+-----------------------+------------------+------------+------+-------------+--------------------------------------------------------------------------------------------------------------+
| `GEOM_DIM` | `MB_TYPE_INT` | `int` | 1 | `EntitySet` | The dimensionality of a geometric `EntitySet`. See table below for meaning of values. |
+-----------------------+------------------+------------+------+-------------+--------------------------------------------------------------------------------------------------------------+
| `NAME` | `MB_TYPE_OPAQUE` | `char` | 32 | `EntitySet` | A name assigned to an `EntitySet`. Use to indicate material assignments, |
| | | | | | boundary conditions, temperatures, and the implicit complement on |
| | | | | | `EntitySet`'s with a `CATEGORY` tag whose value is "Group" |
+-----------------------+------------------+------------+------+-------------+--------------------------------------------------------------------------------------------------------------+


.. table:: Dimensionality Values of the `GEOM_DIM` Tag

+----------------+----------------------+
| Geometry Object | Dimensionality [*]_ |
+================+======================+
| Vertex | 0 |
+----------------+----------------------+
| Curve | 1 |
+----------------+----------------------+
| Surface | 2 |
+----------------+----------------------+
| Volume | 3 |
+----------------+----------------------+

.. [*] The value of the `GEOM_DIM` tag on the geometric `EntitySet`.
.. table:: Oriented Bounding Box Tree Tag Descriptions

+------------+------------------+------------+------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+
| Tag Name | Type | True Type | Size | Purpose | Tagged On |
+============+==================+============+======+======================================================================================================================================================================+=============+
| `OBB_ROOT` | `EntityHandle` | `uint64_t` | 1 | This tag resides on geometric `EntitySet`'s. Its value is the handle of the associated OBB tree root `EntitySet`. | `EntitySet` |
+------------+------------------+------------+------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+
| `OBB_GSET` | `EntityHandle` | `uint64_t` | 1 | This tag resides on OBB tree root `EntitySet`'s. Its value is the handle of the associated geometric `EntitySet.` | `EntitySet` |
+------------+------------------+------------+------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+
| `OBB` | `MB_TYPE_DOUBLE` | `double` | 9 | This tag resides on `EntitySets` in an OBB tree. The value of this tag is nine doubles representing the oriented bounding box for this `EntitySet`-node in the tree. | `EntitySet` |
+------------+------------------+------------+------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+


Topology¶
~~~~~~~~

Every mesh-based geometry contains entity sets that are either
volumes, surfaces, or curves. There are two types of relationships that can
relate entities to other entities. The first is called a parent-child
relationship. Volumes are parents to surfaces that make up that volume; surfaces
are parents to curves; and curves are parents to the geometric vertices.

The second type of relationship is the set relationship, which is different from
a parent-child relationship. Each surface and curve is an entity set. The
surface entity sets contain the triangles and their vertices for that surface.
The curve entity sets contain edges and their vertices. The volume entity sets,
however, are empty. While a volume is parent to surfaces (the parent-child
relationship), the volume does not contain any mesh entities.

Sense tags¶ Each surface is tagged with the two volume handles of the adjacent
volumes. The first of the two surfaces is designated as the forward direction
and the second is designated with the reverse direction. It is important to note
that these surfaces senses may not be consistent with how an MC code determines
the surface sense.
1 change: 1 addition & 0 deletions docs/developerguide/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ Developer's Guide
:maxdepth: 1

understanding_ray_history
h5m_file_spec

0 comments on commit b0b55b7

Please sign in to comment.