diff --git a/docs/source/block_model.rst b/docs/source/block_model.rst index 0b464e8..ce9f616 100644 --- a/docs/source/block_model.rst +++ b/docs/source/block_model.rst @@ -3,13 +3,24 @@ Block Model Creation ==================== -.. note:: +The ``Block Model Creation`` module has been developed as a user interface for the creation of regular (Tensor) +BlockModel objects using the `discretize `_ package. A Block +Model grid is a discretization of a 3D volume into a set of rectangular cells. - Under construction. +.. figure:: /images/block_model_creation_result.png + :width: 800 -The ``Block Model`` module has been developed as a user-interface for the creation of regular (Tensor) BlockModel objects using the `discretize `_ package. +In order to determine the core extents of the block model, the user will select an input ``Object`` and +``Core depth``. The padding is controlled by ``Horizontal padding``, ``Bottom padding``, and +``Expansion factor``. The resolution is set per axis by the ``Minimum cell size`` parameters. -# .. figure:: /images/octree_grid.png -# :width: 800 +.. figure:: /images/block_model_creation_uijson.png + :width: 500 -An Block Model grid is a discretization of a 3D volume into a set of rectangular cells. +The resulting block model will have its core region set by the object and limited by the ``Core depth`` +parameter. The core region will contain cells at the requested ``Minimum cell size`` in all three +Cartesian directions. ``Horizontal`` and ``Vertical padding`` will be applied outward from the +core region to the specified distances. Within the padding region, the cells expand outward at the +provided ``Expansion factor`` rate. + +.. figure:: /images/block_model_creation_result.png diff --git a/docs/source/block_model_to_octree.rst b/docs/source/block_model_to_octree.rst index 7069667..97c39cb 100644 --- a/docs/source/block_model_to_octree.rst +++ b/docs/source/block_model_to_octree.rst @@ -3,14 +3,32 @@ Block Model to Octree ===================== -.. note:: - Under construction. +The ``Block Model to Octree`` module has been developed as a user interface for the conversion between +regular 3D grid (`BlockModel`) objects to Octree, using the `discretize `_ +package. -The ``Block model to Octree`` module has been developed as a user-interface for the conversion between regular (Tensor) BlockModel objects to Octree, using the `discretize `_ package. +.. figure:: /images/block_model_to_octree_advanced.png + :width: 800 -# .. figure:: /images/octree_grid.png -# :width: 800 +In its most simple form, the application creates an octree from the input block model. -An octree mesh is a discretization of a 3D volume into a set of rectangular cells. The cells are defined by a tree -structure, where each node has 8 children. +.. figure:: /images/block_model_to_octree_uijson_basic.png + :width: 500 + +In this case the application will create an octree with the core region matching the cells of +the block model with a small padding region where the cells are allowed to expand to the closest +octree level. + +.. figure:: /images/block_model_to_octree_basic_usage.png + :width: 800 + +Optionally, users can select a model stored on the tensor mesh. + +.. figure:: /images/block_model_to_octree_uijson_advanced.png + :width: 500 + +The octree will be then be refined in areas that contain large gradients in the selected model. + +.. figure:: /images/block_model_to_octree_advanced.png + :width: 800 diff --git a/docs/source/images/block_model_creation_result.png b/docs/source/images/block_model_creation_result.png new file mode 100644 index 0000000..9c961e8 Binary files /dev/null and b/docs/source/images/block_model_creation_result.png differ diff --git a/docs/source/images/block_model_creation_uijson.png b/docs/source/images/block_model_creation_uijson.png new file mode 100644 index 0000000..6c9c384 Binary files /dev/null and b/docs/source/images/block_model_creation_uijson.png differ diff --git a/docs/source/images/block_model_to_octree_advanced.png b/docs/source/images/block_model_to_octree_advanced.png new file mode 100644 index 0000000..34d8021 Binary files /dev/null and b/docs/source/images/block_model_to_octree_advanced.png differ diff --git a/docs/source/images/block_model_to_octree_basic_usage.png b/docs/source/images/block_model_to_octree_basic_usage.png new file mode 100644 index 0000000..48f27cf Binary files /dev/null and b/docs/source/images/block_model_to_octree_basic_usage.png differ diff --git a/docs/source/images/block_model_to_octree_uijson_advanced.png b/docs/source/images/block_model_to_octree_uijson_advanced.png new file mode 100644 index 0000000..be5ab19 Binary files /dev/null and b/docs/source/images/block_model_to_octree_uijson_advanced.png differ diff --git a/docs/source/images/block_model_to_octree_uijson_basic.png b/docs/source/images/block_model_to_octree_uijson_basic.png new file mode 100644 index 0000000..1f488c7 Binary files /dev/null and b/docs/source/images/block_model_to_octree_uijson_basic.png differ diff --git a/docs/source/images/ui_json_general.png b/docs/source/images/ui_json_general.png index 375cb2d..9f53d9c 100644 Binary files a/docs/source/images/ui_json_general.png and b/docs/source/images/ui_json_general.png differ diff --git a/docs/source/images/ui_json_refinements.png b/docs/source/images/ui_json_refinements.png index 4f44246..8551872 100644 Binary files a/docs/source/images/ui_json_refinements.png and b/docs/source/images/ui_json_refinements.png differ