Skip to content
Snippets Groups Projects
Commit eeb38916 authored by Frederik Hennig's avatar Frederik Hennig
Browse files

notes on inclusivity of cell intervals

parent 57f59a3d
Branches
No related merge requests found
Pipeline #77414 passed with stages
in 6 minutes and 48 seconds
......@@ -29,13 +29,20 @@ All Python APIs are listed relative to `walberla.codegen.symbolic`.
- Symbolic Functions
- C++ API
* - Domain Axis-Aligned Bounding Box
- `domain.[xyz]_min()`, `domain.[xyz]_max()`
- `domain.[x|y|z]_min()`, `domain.[x|y|z]_max()`
- `StructuredBlockForest::getDomain()`
* - Domain Cell Bounding Box (Current Refinement Level)
- `domain_cell_bb.[xyz]_min()`, `domain_cell_bb.[xyz]_max()`
- `domain_cell_bb.[x|y|z]_min()`, `domain_cell_bb.[x|y|z]_max()`
- `StructuredBlockStorage::getDomainCellBB()`
:::
:::{note}
Similar to `CellInterval::max()` in the C++ API,
`domain_cell_bb.[x|y|z]_max()` refers to the largest valid cell index in the domain.
Therefore, a comparison with `<=` (instead of `<`) is necessary
in order to check if a cell is inside the domain.
:::
### Block Geometry
:::{list-table}
......@@ -50,6 +57,10 @@ All Python APIs are listed relative to `walberla.codegen.symbolic`.
- `StructuredBlockForest::getBlockCellBB()`
:::
:::{note}
`block_cell_bb.[x|y|z]_max()` is *inclusive* to the block's cell bounding box;
to check if a cell lies inside the block, use `<=` as a comparison operator.
:::
### Cell Geometry
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment