Example documentation

.gitignore

@@ -15,6 +15,9 @@ fastvpinns.egg-info/
 
 #ignore output files
 examples/**/output/
+examples/**/output_*
+examples/**/__pycache__/
+
 
 # pytest 
 *.vtk
@@ -23,10 +26,7 @@ sensor_points.png
 .egg-info/
 
 #result files
-examples/**/*.png
-examples/**/*.vtk
-examples/**/*.txt
-examples/**/*.svg
-examples/**/*.index
-examples/**/*.csv
+# examples/**/*.png # as the README.md uses png image files
+examples/**/sensor_points.png
+
 

examples/forward_problems_2d/README.MD

@@ -0,0 +1,27 @@
+# Examples of Solving Forward Problems in 2D
+
+This section contains examples of solving forward problems in 2D using the `fastvpinns` package. The examples are organized as follows:
+
+- [Complex Mesh](./complex_mesh)
+- [uniform_mesh](./uniform_mesh)
+- [hard_boundary_constraints](./hard_boundary_constraints)
+
+## Complex Mesh
+---
+
+This section holds the example on how we can solve a forward problem using convection-diffusion equation in 2D using a complex mesh. 
+
+## Uniform Grid
+---
+
+This section holds the example on how we can solve a forward problem using convection-diffusion equation in 2D using a uniform mesh.
+- [Poisson2D](./uniform_mesh/poisson_2d)
+- [Helmholtz2D](./uniform_mesh/helmholtz_2d)
+
+## hard_boundary_constraints
+---
+
+This section deals with the example on how we can solve a forward problem using Poisson equation in 2D using hard boundary constraints.
+
+- [Poisson2D With Hard Boundary Constraints](./hard_boundary_constraints/poisson_2d)
+