Some docs on geometry output

ViennaTools · Jan 18, 2024 · 8dee837 · 8dee837
1 parent 51ab747
commit 8dee837
Show file tree

Hide file tree

Showing 8 changed files with 304 additions and 163 deletions.
diff --git a/docs/_site/assets/js/search-data.json b/docs/_site/assets/js/search-data.json
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/output/levelset.md b/docs/output/levelset.md
@@ -10,5 +10,41 @@ nav_order: 1
 
 ---
 
-Coming soon
-{: .label .label-yellow}
+## Saving the Domain
+
+Documentation Coming soon
+{: .label .label-yellow}
+
+## Visualization
+
+ViennaPS provides a feature enabling users to save the level set grid points explicitly for each material layer within the domain in the VTK file format. This export includes the level set value associated with each grid point. Users also have the option to specify a width parameter, determining the number of grid points around the zero level set. This functionality enhances the ability to analyze and visualize the level set information in a detailed and customizable manner.
+
+__Example usage:__
+
+<details markdown="1">
+<summary markdown="1">
+C++
+{: .label .label-blue }
+</summary>
+```c++
+auto domain = psSmartPointer<psDomain<NumericType, D>>::New();
+...
+// create geometry in domain
+...
+domain->saveLevelSetMesh("fileNamePrefix", 3 /* width */);
+```
+</details>
+
+<details markdown="1">
+<summary markdown="1">
+Python:
+{: .label .label-green }
+</summary>
+```python
+domain = vps.Domain()
+...
+# create geometry in domain
+...
+domain.saveLevelSetMesh(fileName="fileNamePrefix", width=3)
+```
+</details>
diff --git a/docs/output/surface.md b/docs/output/surface.md
@@ -10,5 +10,35 @@ nav_order: 2
 
 ---
 
-Coming soon
-{: .label .label-yellow}
+Documentation Coming soon
+{: .label .label-yellow}
+
+__Example usage:__
+
+<details markdown="1">
+<summary markdown="1">
+C++
+{: .label .label-blue }
+</summary>
+```c++
+auto domain = psSmartPointer<psDomain<NumericType, D>>::New();
+...
+// create geometry in domain
+...
+domain->saveSurfaceMesh("fileName", true);
+```
+</details>
+
+<details markdown="1">
+<summary markdown="1">
+Python:
+{: .label .label-green }
+</summary>
+```python
+domain = vps.Domain()
+...
+# create geometry in domain
+...
+domain.saveSurfaceMesh(fileName="fileName", addMaterialIds=True)
+```
+</details>
diff --git a/docs/output/volume.md b/docs/output/volume.md
@@ -10,5 +10,35 @@ nav_order: 3
 
 ---
 
-Coming soon
-{: .label .label-yellow}
+Documentation Coming soon
+{: .label .label-yellow}
+
+__Example usage:__
+
+<details markdown="1">
+<summary markdown="1">
+C++
+{: .label .label-blue }
+</summary>
+```c++
+auto domain = psSmartPointer<psDomain<NumericType, D>>::New();
+...
+// create geometry in domain
+...
+domain->saveVolumeMesh("fileName");
+```
+</details>
+
+<details markdown="1">
+<summary markdown="1">
+Python:
+{: .label .label-green }
+</summary>
+```python
+domain = vps.Domain()
+...
+# create geometry in domain
+...
+domain.saveVolumeMesh(fileName="fileName")
+```
+</details>
diff --git a/include/psDomain.hpp b/include/psDomain.hpp
@@ -218,7 +218,8 @@ template <class NumericType = float, int D = 3> class psDomain {
     std::cout << "**************************" << std::endl;
   }
 
-  // Save the level set as a VTK file.
+  // Save all level sets as a VTK files. The width parameter specifies the
+  // number of grid points around the zero level set to be saved.
   void saveLevelSetMesh(std::string name, int width = 1) {
     for (int i = 0; i < levelSets->size(); i++) {
       auto mesh = psSmartPointer<lsMesh<NumericType>>::New();