documentation progress

ViennaTools · Dec 20, 2023 · 1bfc6da · 1bfc6da
1 parent 97002dc
commit 1bfc6da
Show file tree

Hide file tree

Showing 82 changed files with 334 additions and 263 deletions.
diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock
@@ -64,10 +64,9 @@ GEM
     rexml (3.2.6)
     rouge (4.1.3)
     safe_yaml (1.0.5)
-    sass-embedded (1.69.5-arm64-darwin)
-      google-protobuf (~> 3.23)
-    sass-embedded (1.69.5-x86_64-linux-gnu)
+    sass-embedded (1.69.5)
       google-protobuf (~> 3.23)
+      rake (>= 13.0.0)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     unicode-display_width (2.4.2)

diff --git a/docs/_site/assets/css/just-the-docs-dark.css.map b/docs/_site/assets/css/just-the-docs-dark.css.map
diff --git a/docs/_site/assets/css/just-the-docs-default.css.map b/docs/_site/assets/css/just-the-docs-default.css.map
diff --git a/docs/_site/assets/css/just-the-docs-light.css.map b/docs/_site/assets/css/just-the-docs-light.css.map
diff --git a/docs/_site/assets/js/search-data.json b/docs/_site/assets/js/search-data.json
diff --git a/docs/_site/cellset/index.html b/docs/_site/cellset/index.html
diff --git a/docs/_site/compact/index.html b/docs/_site/compact/index.html
diff --git a/docs/_site/deps/index.html b/docs/_site/deps/index.html
diff --git a/docs/_site/domain/functions.html b/docs/_site/domain/functions.html
diff --git a/docs/_site/domain/index.html b/docs/_site/domain/index.html
diff --git a/docs/_site/domain/material.html b/docs/_site/domain/material.html
diff --git a/docs/_site/domain/surface.html b/docs/_site/domain/surface.html
diff --git a/docs/_site/domain/volume.html b/docs/_site/domain/volume.html
diff --git a/docs/_site/examples/TEOSdeposition.html b/docs/_site/examples/TEOSdeposition.html
diff --git a/docs/_site/examples/cantileverWetEtching.html b/docs/_site/examples/cantileverWetEtching.html
diff --git a/docs/_site/examples/exampleProcess.html b/docs/_site/examples/exampleProcess.html
diff --git a/docs/_site/examples/gdsReader.html b/docs/_site/examples/gdsReader.html
diff --git a/docs/_site/examples/holeEtching.html b/docs/_site/examples/holeEtching.html
diff --git a/docs/_site/examples/index.html b/docs/_site/examples/index.html
diff --git a/docs/_site/examples/interpolationDemo.html b/docs/_site/examples/interpolationDemo.html
diff --git a/docs/_site/examples/kdTreeBenchmark.html b/docs/_site/examples/kdTreeBenchmark.html
diff --git a/docs/_site/examples/oxideRegrowth.html b/docs/_site/examples/oxideRegrowth.html
diff --git a/docs/_site/examples/stackEtching.html b/docs/_site/examples/stackEtching.html
diff --git a/docs/_site/examples/trenchDeposition.html b/docs/_site/examples/trenchDeposition.html
diff --git a/docs/_site/examples/trenchDepositionGeometric.html b/docs/_site/examples/trenchDepositionGeometric.html
diff --git a/docs/_site/examples/volumeModel.html b/docs/_site/examples/volumeModel.html
diff --git a/docs/_site/general/index.html b/docs/_site/general/index.html
diff --git a/docs/_site/geo/basic/fin.html b/docs/_site/geo/basic/fin.html
diff --git a/docs/_site/geo/basic/hole.html b/docs/_site/geo/basic/hole.html
diff --git a/docs/_site/geo/basic/index.html b/docs/_site/geo/basic/index.html
diff --git a/docs/_site/geo/basic/plane.html b/docs/_site/geo/basic/plane.html
diff --git a/docs/_site/geo/basic/stack.html b/docs/_site/geo/basic/stack.html
diff --git a/docs/_site/geo/basic/trench.html b/docs/_site/geo/basic/trench.html
diff --git a/docs/_site/geo/custom.html b/docs/_site/geo/custom.html
diff --git a/docs/_site/geo/gdsimport.html b/docs/_site/geo/gdsimport.html
diff --git a/docs/_site/geo/index.html b/docs/_site/geo/index.html
diff --git a/docs/_site/index.html b/docs/_site/index.html
diff --git a/docs/_site/inst/index.html b/docs/_site/inst/index.html
diff --git a/docs/_site/misc/extrusion.html b/docs/_site/misc/extrusion.html
diff --git a/docs/_site/misc/index.html b/docs/_site/misc/index.html
diff --git a/docs/_site/misc/logging.html b/docs/_site/misc/logging.html
diff --git a/docs/_site/misc/parsing.html b/docs/_site/misc/parsing.html
diff --git a/docs/_site/misc/planarize.html b/docs/_site/misc/planarize.html
diff --git a/docs/_site/models/custom/advectionCallback.html b/docs/_site/models/custom/advectionCallback.html
diff --git a/docs/_site/models/custom/index.html b/docs/_site/models/custom/index.html
diff --git a/docs/_site/models/custom/particle.html b/docs/_site/models/custom/particle.html
diff --git a/docs/_site/models/custom/sourceDirection.html b/docs/_site/models/custom/sourceDirection.html
diff --git a/docs/_site/models/custom/surfaceModel.html b/docs/_site/models/custom/surfaceModel.html
diff --git a/docs/_site/models/custom/velocityField.html b/docs/_site/models/custom/velocityField.html
diff --git a/docs/_site/models/index.html b/docs/_site/models/index.html
diff --git a/docs/_site/models/prebuilt/SF6O2Etching.html b/docs/_site/models/prebuilt/SF6O2Etching.html
diff --git a/docs/_site/models/prebuilt/TEOSDeposition.html b/docs/_site/models/prebuilt/TEOSDeposition.html
diff --git a/docs/_site/models/prebuilt/anisotropic.html b/docs/_site/models/prebuilt/anisotropic.html
diff --git a/docs/_site/models/prebuilt/directional.html b/docs/_site/models/prebuilt/directional.html
diff --git a/docs/_site/models/prebuilt/fluorocarbonEtching.html b/docs/_site/models/prebuilt/fluorocarbonEtching.html
diff --git a/docs/_site/models/prebuilt/index.html b/docs/_site/models/prebuilt/index.html
diff --git a/docs/_site/models/prebuilt/isotropic.html b/docs/_site/models/prebuilt/isotropic.html
diff --git a/docs/_site/models/prebuilt/oxideRegrowth.html b/docs/_site/models/prebuilt/oxideRegrowth.html
diff --git a/docs/_site/models/prebuilt/plasmaDamage.html b/docs/_site/models/prebuilt/plasmaDamage.html
diff --git a/docs/_site/models/prebuilt/singleParticle.html b/docs/_site/models/prebuilt/singleParticle.html
diff --git a/docs/_site/output/disk.html b/docs/_site/output/disk.html
diff --git a/docs/_site/output/index.html b/docs/_site/output/index.html
diff --git a/docs/_site/output/levelset.html b/docs/_site/output/levelset.html
diff --git a/docs/_site/output/surface.html b/docs/_site/output/surface.html
diff --git a/docs/_site/output/volume.html b/docs/_site/output/volume.html
diff --git a/docs/_site/process/index.html b/docs/_site/process/index.html
diff --git a/docs/_site/start/index.html b/docs/_site/start/index.html
diff --git a/docs/compact/index.md b/docs/compact/index.md
@@ -5,7 +5,7 @@ nav_order: 10
 ---
 
 # Compact Modelling
-{: .fs-9 .fw-500}
+{: .fs-9 .fw-700}
 
 ---
 

diff --git a/docs/domain/functions.md b/docs/domain/functions.md
@@ -5,5 +5,11 @@ parent: Simulation Domain
 nav_order: 3
 ---
 
+# `psDomain` Member Functions 
+{: .fs-9 .fw-500 }
+
+---
+
+
 Coming soon
 {: .label .label-yellow}
diff --git a/docs/domain/material.md b/docs/domain/material.md
@@ -6,6 +6,7 @@ nav_order: 2
 ---
 
 # Material Mapping
+{: .fs-9 .fw-500 }
 
 ---
 

diff --git a/docs/general/index.md b/docs/general/index.md
@@ -0,0 +1,29 @@
+---
+layout: default
+title: General Notes
+nav_order: 4
+---
+
+# General Notes
+{: .fs-9 .fw-700}
+
+---
+
+## Numeric Types
+
+ViennaPS supports the utilization of either `float` or `double` as the underlying numeric type. While `float` might offer slightly higher performance in some cases, it is generally recommended to use `double` in your simulation due to its enhanced precision.
+
+It's essential to note that the choice of numeric type is a static (compile-time) parameter in every ViennaPS class and function. Once a numeric type is selected for a particular simulation, it is not possible to switch to a different numeric type within the program.
+
+Additionally, for users working with Python bindings, it's important to be aware that the Python interface always uses `double` as the numeric type.
+
+## Switching between 2D and 3D mode
+
+ViennaPS provides the flexibility for users to choose between 2D and 3D modes during compile time. The dimensionality is specified as a second template (static) parameter, and most classes and functions in ViennaPS adhere to this structure. It's important to note that 2D and 3D classes cannot be mixed within the same simulation, and the choice of dimensionality is fixed at compile time.
+
+For users who need to transition from a 2D to a 3D simulation, ViennaPS offers the [psExtrude]({% link misc/extrusion.md %}) utility. This utility enables the extrusion of a 2D domain to 3D, providing a seamless way to extend simulations across different dimensions.
+
+## Using Smart Pointers
+
+Coming soon
+{: .label .label-yellow}
diff --git a/docs/index.md b/docs/index.md
@@ -10,7 +10,7 @@ nav_order: 1
 Process Simulation Library
 {: .fs-6 .fw-300 }
 
-[Get started now]({% link start/index.md %}){: .btn .fs-5 .mb-4 .mb-md-0 .mr-2 }
+[Get started now]({% link inst/index.md %}){: .btn .fs-5 .mb-4 .mb-md-0 .mr-2 }
 [View it on GitHub](https://github.com/ViennaTools/ViennaPS){: .btn .fs-5 .mb-4 .mb-md-0 }
 
 ---

diff --git a/docs/inst/index.md b/docs/inst/index.md
@@ -21,7 +21,7 @@ nav_order: 3
 
 * C++17 Compiler with OpenMP support
 
-## First Steps
+## Installation
 
 Since this is a header only project, it does not require any installation. However, we recommend the following procedure in order to set up all dependencies correctly and relocate all header files to a designated directory:
 

diff --git a/docs/models/prebuilt/fluorocarbonEtching.md b/docs/models/prebuilt/fluorocarbonEtching.md
@@ -22,4 +22,7 @@ MathJax = {
 ```c++
 #include <psFluorocarbonEtching.hpp>
 ```
----
+---
+
+Coming soon
+{: .label .label-yellow}
diff --git a/docs/models/prebuilt/oxideRegrowth.md b/docs/models/prebuilt/oxideRegrowth.md
@@ -22,4 +22,7 @@ MathJax = {
 ```c++
 #include <psOxideRegrowth.hpp>
 ```
----
+---
+
+Coming soon
+{: .label .label-yellow}
diff --git a/docs/models/prebuilt/plasmaDamage.md b/docs/models/prebuilt/plasmaDamage.md
@@ -22,4 +22,7 @@ MathJax = {
 ```c++
 #include <psPlasmaDamage.hpp>
 ```
----
+---
+
+Coming soon
+{: .label .label-yellow}
diff --git a/docs/output/disk.md b/docs/output/disk.md
@@ -5,5 +5,10 @@ parent: Geometry Output
 nav_order: 3
 ---
 
+# Disk Mesh
+{: .fs-9 .fw-500 }
+
+---
+
 Coming soon
 {: .label .label-yellow}
diff --git a/docs/output/index.md b/docs/output/index.md
@@ -5,5 +5,11 @@ nav_order: 9
 has_children: true
 ---
 
-Coming soon
-{: .label .label-yellow}
+# Geometry Output
+{: .fs-9 .fw-700 }
+
+---
+
+ViennaPS provides various methods for outputting the surface or volume of the processed domain. The data is typically saved in the [VTK](https://docs.vtk.org/en/latest/design_documents/VTKFileFormats.html) file format, with surfaces stored in `.vtp` files and volumes in `.vtu` files. For visualization, we recommend using [ParaView](https://www.paraview.org/), a powerful open-source visualization tool. Below, you'll find further details on the available geometry outputs.
+
+In addition to VTK file formats, ViennaPS provides the flexibility to store level sets directly in the proprietary `.lvst` format. This feature enables users to save intermediate states during the process, allowing for more detailed analysis and the ability to revisit specific simulation stages. 
diff --git a/docs/output/levelset.md b/docs/output/levelset.md
@@ -5,5 +5,10 @@ parent: Geometry Output
 nav_order: 1
 ---
 
+# Level Set
+{: .fs-9 .fw-500 }
+
+---
+
 Coming soon
 {: .label .label-yellow}
diff --git a/docs/output/surface.md b/docs/output/surface.md
@@ -5,5 +5,10 @@ parent: Geometry Output
 nav_order: 2
 ---
 
+# Surface Mesh
+{: .fs-9 .fw-500 }
+
+---
+
 Coming soon
 {: .label .label-yellow}
diff --git a/docs/output/volume.md b/docs/output/volume.md
@@ -5,5 +5,10 @@ parent: Geometry Output
 nav_order: 3
 ---
 
+# Volume Mesh
+{: .fs-9 .fw-500 }
+
+---
+
 Coming soon
 {: .label .label-yellow}
diff --git a/docs/start/index.md b/docs/start/index.md
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,7 +5,7 @@ nav_order: 10 @@
     ---
     # Compact Modelling
-    {: .fs-9 .fw-500}
+    {: .fs-9 .fw-700}
     ---
@@ Expand Down @@