See results
diff --git a/docs/docs-api/ElemshapeData/examples/runner.toml b/docs/docs-api/ElemshapeData/examples/runner.toml index ab1b7763..042cd919 100644 --- a/docs/docs-api/ElemshapeData/examples/runner.toml +++ b/docs/docs-api/ElemshapeData/examples/runner.toml @@ -1,3 +1,3 @@ BuildType = "Debug" -BuildDir = "/tmp/elemshapedata/" +BuildDir = "/tmp/easifem-tests/ElemShapeData" TargetLibs = ["easifemBase"] diff --git a/docs/docs-api/FEDOF/Copy.md b/docs/docs-api/FEDOF/Copy.md new file mode 100644 index 00000000..1613be19 --- /dev/null +++ b/docs/docs-api/FEDOF/Copy.md @@ -0,0 +1,67 @@ +# Copy + +The `Copy` method copies the contents of one `FEDOF_` object to another. This method is also used by the assignment operator (`=`) for `FEDOF_` objects. + +## Interface + +```fortran +INTERFACE + MODULE SUBROUTINE Copy(obj, obj2) + CLASS(FEDOF_), INTENT(INOUT) :: obj + CLASS(FEDOF_), INTENT(IN) :: obj2 + END SUBROUTINE Copy +END INTERFACE +``` + +## Parameters + +- `obj` - The destination `FEDOF_` object that will receive the copied data +- `obj2` - The source `FEDOF_` object whose data will be copied + +## Implementation Details + +The method performs a shallow copy of most attributes from `obj2` to `obj`: + +1. Copies basic properties: + - `isLagrange` - Flag indicating if the base interpolation is Lagrange + - `tdof` - Total number of degrees of freedom + - `tNodes`, `tEdges`, `tFaces`, `tCells` - Total count of different mesh entities + - `baseContinuity` - Continuity or conformity of basis (e.g., "H1") + - `baseInterpolation` - Type of basis functions (e.g., "LAGR", "HIER") + - `maxCellOrder`, `maxFaceOrder`, `maxEdgeOrder` - Maximum order values + +2. Sets the mesh pointer to point to the same mesh as the source object: + +```fortran +obj%mesh => obj2%mesh +``` + +3. Copies array data when allocated in the source object: + - `cellOrder` - Order of each cell + - `faceOrder` - Order of each face + - `edgeOrder` - Order of each edge + - `edgeIA`, `faceIA`, `cellIA` - Sparsity patterns for different entities + +4. Associates finite element pointers: + +```fortran +DO ii = 1, SIZE(obj2%fe) + isok = ASSOCIATED(obj2%fe(ii)%ptr) + IF (isok) THEN + obj%fe(ii)%ptr => obj2%fe(ii)%ptr + END IF +END DO +``` + +## Notes + +- This is a shallow copy - the mesh and finite element pointers in the destination object point to the same objects as the source. +- Array data is copied only if it exists in the source object. +- The method doesn't allocate new memory for arrays; it assumes the destination arrays either don't exist or are already properly allocated. +- This method is particularly useful when you need to create a duplicate of a `FEDOF_` object without creating new underlying mesh or finite element instances. + +## Example + +import EXAMPLE65 from "./examples/_Copy_test_1.md"; + +
+
+
+## Example 2
+
+import EXAMPLE2 from "./examples/_Initiate_test_2.md";
+
+Click here to see the example
+
+
+
+
+
+
+## Example 3
+
+import EXAMPLE3 from "./examples/_Initiate_test_3.md";
+
+Click here to see the example
+
+
+
+
+
+
+## Example 4
+
+import EXAMPLE4 from "./examples/_Initiate_test_4.md";
+
+Click here to see the example
+
+
+
+
+
+
+## Example 6
+
+import EXAMPLE6 from "./examples/_Initiate_test_6.md";
+
+Click here to see the example
+
+
+
+
+
+
+## Example 7
+
+import EXAMPLE7 from "./examples/_Initiate_test_7.md";
+
+Click here to see the example
+
+
+
+
+
diff --git a/docs/docs-api/MeshField/MeshField_.md b/docs/docs-api/MeshField/MeshField_.md
new file mode 100644
index 00000000..9bf9c777
--- /dev/null
+++ b/docs/docs-api/MeshField/MeshField_.md
@@ -0,0 +1,12 @@
+---
+sidebar_position: 2
+---
+
+# Structure
+
+`ScalarMeshField_` is an subclass of `AbstractMeshField_`.
+
+```fortran
+TYPE, EXTENDS(AbstractMeshField_) :: ScalarMeshField_
+END TYPE ScalarMeshField_
+```
diff --git a/docs/docs-api/MeshField/Set.md b/docs/docs-api/MeshField/Set.md
new file mode 100644
index 00000000..c7f792dd
--- /dev/null
+++ b/docs/docs-api/MeshField/Set.md
@@ -0,0 +1,7 @@
+# Set
+
+Inherited from [AbstractMeshField](/docs-api/AbstractMeshField)
+
+import EXAMPLE500 from "../AbstractMeshField/Set.md";
+
+Click here to see the example
+
+
+
+
-
+Note: This routine calls `GetElemNum2` for dim=0,1,2,3.
diff --git a/docs/docs-api/MeshSelection/GetTotalElemNum.md b/docs/docs-api/MeshSelection/GetTotalElemNum.md
new file mode 100644
index 00000000..8239b890
--- /dev/null
+++ b/docs/docs-api/MeshSelection/GetTotalElemNum.md
@@ -0,0 +1,92 @@
+# GetTotalElemNum
+
+Get the total number of elements in the mesh selection.
+
+The GetTotalElemNum method retrieves the total number of elements in a MeshSelection object. There are four different implementations:
+
+1. **GetTotalElemNum1**: Returns the total number of elements for a specific dimension when isSelectionByElemNum is true.
+2. **GetTotalElemNum2**: Returns the total number of elements for a specific dimension using both selection by element number and selection by mesh ID.
+3. **GetTotalElemNum3**: Returns the total number of elements across all dimensions when isSelectionByElemNum is true.
+4. **GetTotalElemNum4**: Returns the total number of elements across all dimensions using both selection by element number and selection by mesh ID.
+
+### Dimension Mapping
+
+- dim = 0: Size of pointElemNum or elements in pointMeshID
+- dim = 1: Size of curveElemNum or elements in curveMeshID
+- dim = 2: Size of surfaceElemNum or elements in surfaceMeshID
+- dim = 3: Size of volumeElemNum or elements in volumeMeshID
+
+### Selection Methods Used
+
+- ✅ isSelectionByMeshID (GetTotalElemNum2, GetTotalElemNum4)
+- ✅ isSelectionByElemNum (all variants)
+- ❌ isSelectionByNodeNum (not implemented)
+- ❌ isSelectionByBox (not implemented)
+
+## Interface Descriptions
+
+### GetTotalElemNum1
+
+```fortran
+MODULE FUNCTION GetTotalElemNum1(obj, dim) RESULT(ans)
+ CLASS(MeshSelection_), INTENT(IN) :: obj
+ INTEGER(I4B), INTENT(IN) :: dim
+ INTEGER(I4B) :: ans
+END FUNCTION GetTotalElemNum1
+```
+
+Returns the total number of elements for a specific dimension when isSelectionByElemNum is true.
+
+- **dim**: Dimension to retrieve element count from (0=point, 1=curve, 2=surface, 3=volume)
+- **ans**: Total number of elements in the specified dimension
+
+Note: This method only works when isSelectionByElemNum is true.
+
+### GetTotalElemNum2
+
+```fortran
+MODULE FUNCTION GetTotalElemNum2(obj, dim, dom) RESULT(ans)
+ CLASS(MeshSelection_), INTENT(IN) :: obj
+ INTEGER(I4B), INTENT(IN) :: dim
+ CLASS(AbstractDomain_), INTENT(IN) :: dom
+ INTEGER(I4B) :: ans
+END FUNCTION GetTotalElemNum2
+```
+
+Returns the total number of elements for a specific dimension using both selection by element number and selection by mesh ID.
+
+- **dim**: Dimension to retrieve element count from (0=point, 1=curve, 2=surface, 3=volume)
+- **dom**: Abstract domain containing the meshes
+- **ans**: Total number of elements in the specified dimension
+
+### GetTotalElemNum3
+
+```fortran
+MODULE FUNCTION GetTotalElemNum3(obj) RESULT(ans)
+ CLASS(MeshSelection_), INTENT(IN) :: obj
+ INTEGER(I4B) :: ans
+END FUNCTION GetTotalElemNum3
+```
+
+Returns the total number of elements across all dimensions when isSelectionByElemNum is true. It sums the sizes of pointElemNum, curveElemNum, surfaceElemNum, and volumeElemNum.
+
+- **ans**: Total number of elements across all dimensions
+
+Note: This method only works when isSelectionByElemNum is true.
+
+### GetTotalElemNum4
+
+```fortran
+MODULE FUNCTION GetTotalElemNum4(obj, dom) RESULT(ans)
+ CLASS(MeshSelection_), INTENT(IN) :: obj
+ CLASS(AbstractDomain_), INTENT(IN) :: dom
+ INTEGER(I4B) :: ans
+END FUNCTION GetTotalElemNum4
+```
+
+Returns the total number of elements across all dimensions using both selection by element number and selection by mesh ID.
+
+- **dom**: Abstract domain containing the meshes
+- **ans**: Total number of elements across all dimensions
+
+Note: This function calls GetTotalElemNum2 for each dimension (0-3) and sums the results.
diff --git a/docs/docs-api/MeshSelection/SetMaterialToMesh.md b/docs/docs-api/MeshSelection/SetMaterialToMesh.md
new file mode 100644
index 00000000..c08c8e00
--- /dev/null
+++ b/docs/docs-api/MeshSelection/SetMaterialToMesh.md
@@ -0,0 +1,67 @@
+# SetMaterialToMesh
+
+The SetMaterialToMesh methods assign material properties to mesh elements based on the mesh selection criteria. There are two implementations:
+
+1. **SetMaterialToMesh1**: Sets material properties for mesh elements of a specific dimension.
+2. **SetMaterialToMesh2**: Sets material properties for mesh elements across all dimensions (0-3).
+
+Material Assignment Mechanisms:
+
+- Elements selected by mesh IDs will have their material properties set at the entity level
+- Elements selected by element numbers will have their material properties set at the individual element level
+
+Selection Methods Used:
+
+- ✅ isSelectionByMeshID
+- ✅ isSelectionByElemNum
+- ❌ isSelectionByNodeNum (not implemented)
+- ❌ isSelectionByBox (not implemented)
+
+## Interface 1
+
+```fortran
+MODULE SUBROUTINE SetMaterialToMesh1(obj, dom, dim, medium, material)
+ CLASS(MeshSelection_), INTENT(INOUT) :: obj
+ CLASS(AbstractDomain_), INTENT(IN) :: dom
+ INTEGER(I4B), INTENT(IN) :: dim
+ INTEGER(I4B), INTENT(IN) :: medium
+ INTEGER(I4B), INTENT(IN) :: material
+END SUBROUTINE SetMaterialToMesh1
+```
+
+Sets material properties for mesh elements of a specific dimension.
+
+- **dom**: Abstract domain containing the meshes
+- **dim**: Dimension of the mesh elements to set materials for (0=point, 1=curve, 2=surface, 3=volume)
+- **medium**: Medium identifier
+- **material**: Material identifier to assign
+
+Implementation details:
+
+1. Retrieves the mesh pointer for the specified dimension
+2. For elements selected by mesh ID, sets the material at the entity level
+3. For elements selected by element number, sets the material at the individual element level
+
+## Interface 2
+
+```fortran
+MODULE SUBROUTINE SetMaterialToMesh2(obj, dom, medium, material)
+ CLASS(MeshSelection_), INTENT(INOUT) :: obj
+ CLASS(AbstractDomain_), INTENT(IN) :: dom
+ INTEGER(I4B), INTENT(IN) :: medium
+ INTEGER(I4B), INTENT(IN) :: material
+END SUBROUTINE SetMaterialToMesh2
+```
+
+Sets material properties for mesh elements across all dimensions (0-3).
+
+- **dom**: Abstract domain containing the meshes
+- **medium**: Medium identifier
+- **material**: Material identifier to assign
+
+Implementation details:
+
+1. Calls SetMaterialToMesh1 for each dimension from 0 to 3
+2. This method allows for setting materials across all dimensionalities in a single call
+
+Note: This method serves as a convenience wrapper around SetMaterialToMesh1, applying the same material and medium values to mesh elements of all dimensions selected in the MeshSelection object.
diff --git a/docs/docs-api/MeshSelection/examples/_Export_test_1.F90 b/docs/docs-api/MeshSelection/examples/_Export_test_1.F90
new file mode 100644
index 00000000..224e1ddb
--- /dev/null
+++ b/docs/docs-api/MeshSelection/examples/_Export_test_1.F90
@@ -0,0 +1,37 @@
+!> author: Vikas Sharma, Ph. D.
+! date: 2025-07-24
+! summary: This example shows how to USE `MeshSelection` WITH
+! `meshSelectionByID` option, and export it to `HDF5File_` format.
+
+PROGRAM main
+USE MeshSelection_Class
+USE HDF5File_Class
+IMPLICIT NONE
+
+TYPE(MeshSelection_) :: obj
+TYPE(HDF5File_) :: hdf5file
+
+! Initiates an instance of `MeshSelection_` WITH selection by mesh ID.
+CALL obj%Initiate(isSelectionByMeshID=.TRUE.)
+
+! Let us now add NEW entries.
+CALL obj%Add(dim=0, meshID=[1, 2, 3, 4, 5, 6])
+CALL obj%Add(dim=1, meshID=[2, 5, 6, 7])
+CALL obj%Add(dim=2, meshID=[1, 3, 5, 6, 8])
+CALL obj%Add(dim=3, meshID=[1, 8])
+
+! Now that we are done setting the DATA in the instance, let us CALL `set` method.
+CALL obj%Set()
+
+! Now we will OPEN a `HDF5File_` so that we can WRITE DATA to it.
+CALL hdf5file%Initiate(filename="./hdf5/MeshSelection.hdf5", mode="NEW")
+CALL hdf5file%OPEN()
+
+! After opening the `HDF5File_` we export the instance of `MeshSelection_` to it.
+CALL obj%Export(hdf5=hdf5file, group='')
+
+! Cleanup
+
+CALL hdf5file%DEALLOCATE()
+CALL obj%DEALLOCATE()
+END PROGRAM main
diff --git a/docs/docs-api/MeshSelection/examples/_Export_test_1.md b/docs/docs-api/MeshSelection/examples/_Export_test_1.md
index d263c4c4..52512cdf 100644
--- a/docs/docs-api/MeshSelection/examples/_Export_test_1.md
+++ b/docs/docs-api/MeshSelection/examples/_Export_test_1.md
@@ -1,53 +1,9 @@
-This example shows how to USE `MeshSelection` WITH `meshSelectionByID` option, and export it to `HDF5File_` format.
+This example shows how to USE `MeshSelection` WITH `meshSelectionByID` option,
+and export it to `HDF5File_` format.
-```fortran
-PROGRAM main
- USE easifemBase
- USE easifemClasses
- IMPLICIT NONE
- TYPE( MeshSelection_ ) :: obj
- TYPE( HDF5File_ ) :: hdf5file
-```
+import CodeBlock from '@theme/CodeBlock';
-Initiates an instance of `MeshSelection_` WITH selection by mesh ID.
+import CodeSnippet from '!!raw-loader!./_Export_test_1.F90';
-```fortran
-CALL obj%Initiate( isSelectionByMeshID=.TRUE. )
-```
+Click here to see the example
-
+```fortran
+MODULE SUBROUTINE GetElemNum4(obj, dom, ans, tsize)
+ CLASS(MeshSelection_), INTENT(IN) :: obj
+ CLASS(AbstractDomain_), INTENT(IN) :: dom
+ INTEGER(I4B), INTENT(INOUT) :: ans(:)
+ INTEGER(I4B), INTENT(OUT) :: tsize
+END SUBROUTINE GetElemNum4
+```
-import EXAMPLE67 from "./examples/_GetElemNum_test_1.md";
+Returns all element numbers across all dimensions using both selection by element number and selection by mesh ID.
-
-
-
diff --git a/docs/docs-api/QuadraturePoint/_Initiate_test_2c.md b/docs/docs-api/QuadraturePoint/_Initiate_test_2c.md
deleted file mode 100644
index bfe65854..00000000
--- a/docs/docs-api/QuadraturePoint/_Initiate_test_2c.md
+++ /dev/null
@@ -1,16 +0,0 @@
-```fortran
-PROGRAM main
-USE easifemBase
-IMPLICIT NONE
-TYPE(QuadraturePoint_) :: obj
-TYPE(ReferenceTriangle_) :: refelem
-INTEGER(I4B) :: order
-refelem = ReferenceTriangle(nsd=2_I4B)
-order = 4_I4B
-CALL initiate(obj=obj, &
- & refelem=refelem, &
- & order=order, &
- & quadratureType="GaussLegendre")
-CALL display(obj, "ans: ")
-END PROGRAM main
-```
diff --git a/docs/docs-api/QuadraturePoint/_Initiate_test_2d.md b/docs/docs-api/QuadraturePoint/_Initiate_test_2d.md
deleted file mode 100644
index 82237180..00000000
--- a/docs/docs-api/QuadraturePoint/_Initiate_test_2d.md
+++ /dev/null
@@ -1,16 +0,0 @@
-```fortran
-PROGRAM main
-USE easifemBase
-IMPLICIT NONE
-TYPE(QuadraturePoint_) :: obj
-TYPE(ReferenceTriangle_) :: refelem
-INTEGER(I4B) :: order
-refelem = ReferenceTriangle(nsd=2_I4B, xij=RefCoord_Triangle("BIUNIT"))
-order = 4_I4B
-CALL initiate(obj=obj, &
- & refelem=refelem, &
- & order=order, &
- & quadratureType="GaussLegendre")
-CALL display(obj, "ans: ")
-END PROGRAM main
-```
diff --git a/docs/docs-api/QuadraturePoint/_Initiate_test_3a.md b/docs/docs-api/QuadraturePoint/_Initiate_test_3a.md
deleted file mode 100644
index cd4a0d01..00000000
--- a/docs/docs-api/QuadraturePoint/_Initiate_test_3a.md
+++ /dev/null
@@ -1,29 +0,0 @@
-```fortran
-PROGRAM main
-USE easifemBase
-IMPLICIT NONE
-TYPE(QuadraturePoint_) :: obj
-TYPE(ReferenceQuadrangle_) :: refelem
-INTEGER(I4B) :: order
-refelem = ReferenceQuadrangle(nsd=2_I4B)
-order = 4_I4B
-CALL initiate(obj=obj, &
- & refelem=refelem, &
- & order=order, &
- & quadratureType=GaussLegendre)
-CALL display(mdencode(obj) , "")
-END PROGRAM main
-```
-
-See results
-
-
-| | | | | | | |
-| -- | -------- | -------- | -------- | -------- | ------- | -------- |
-| x1 | -0.81685 | 0.6337 | -0.81685 | -0.1081 | -0.1081 | -0.78379 |
-| x2 | -0.81685 | -0.81685 | 0.6337 | -0.78379 | -0.1081 | -0.1081 |
-| w | 0.2199 | 0.2199 | 0.2199 | 0.44676 | 0.44676 | 0.44676 |
-
-
-
-
diff --git a/docs/docs-api/QuadraturePoint/_Initiate_test_3b.md b/docs/docs-api/QuadraturePoint/_Initiate_test_3b.md
deleted file mode 100644
index f658f713..00000000
--- a/docs/docs-api/QuadraturePoint/_Initiate_test_3b.md
+++ /dev/null
@@ -1,31 +0,0 @@
-```fortran
-PROGRAM main
-USE easifemBase
-IMPLICIT NONE
-TYPE(QuadraturePoint_) :: obj
-TYPE(ReferenceQuadrangle_) :: refelem
-INTEGER(I4B) :: order
-
-refelem = ReferenceQuadrangle(nsd=2_I4B, xij=RefCoord_Quadrangle("UNIT"))
-order = 4_I4B
-CALL initiate(obj=obj, &
- & refelem=refelem, &
- & order=order, &
- & quadratureType=GaussLegendre)
-CALL display(mdencode(obj), "")
-
-END PROGRAM main
-```
-
-See results
-
-
-| | | | | | | | | | |
-| -- | ------- | ----------- | ------- | ---------- | ----------- | ----------- | ------- | ----------- | ------- |
-| x1 | -0.7746 | -0.7746 | -0.7746 | 4.3715E-16 | 3.88578E-16 | 4.44089E-16 | 0.7746 | 0.7746 | 0.7746 |
-| x2 | -0.7746 | 4.44089E-16 | 0.7746 | -0.7746 | 3.88578E-16 | 0.7746 | -0.7746 | 4.16334E-16 | 0.7746 |
-| w | 0.30864 | 0.49383 | 0.30864 | 0.49383 | 0.79012 | 0.49383 | 0.30864 | 0.49383 | 0.30864 |
-
-
-
-
diff --git a/docs/docs-api/QuadraturePoint/_Initiate_test_3c.md b/docs/docs-api/QuadraturePoint/_Initiate_test_3c.md
deleted file mode 100644
index 3cbd5026..00000000
--- a/docs/docs-api/QuadraturePoint/_Initiate_test_3c.md
+++ /dev/null
@@ -1,33 +0,0 @@
-```fortran
-PROGRAM main
-USE easifemBase
-IMPLICIT NONE
-TYPE(QuadraturePoint_) :: obj
-TYPE(ReferenceQuadrangle_) :: refelem
-INTEGER(I4B) :: order
-refelem = ReferenceQuadrangle(nsd=2_I4B)
-order = 4_I4B
-CALL initiate(obj=obj, &
- & refelem=refelem, &
- & p=4, &
- & q=3, &
- & r=1, &
- & quadratureType1=GaussLegendre, &
- & quadratureType2=GaussLegendre, &
- & quadratureType3=GaussLegendre )
-CALL display(mdencode(obj) , "")
-END PROGRAM main
-```
-
-See results
-
-
-| | | | | | | | | | |
-| -- | ----------- | ------- | ----------- | ------- | ------- | ------- | ----------- | ------- | ----------- |
-| x1 | 0.1127 | 0.1127 | 0.1127 | 0.5 | 0.5 | 0.5 | 0.8873 | 0.8873 | 0.8873 |
-| x2 | 0.1127 | 0.5 | 0.8873 | 0.1127 | 0.5 | 0.8873 | 0.1127 | 0.5 | 0.8873 |
-| w | 7.71605E-02 | 0.12346 | 7.71605E-02 | 0.12346 | 0.19753 | 0.12346 | 7.71605E-02 | 0.12346 | 7.71605E-02 |
-
-
-
-
diff --git a/docs/docs-api/QuadraturePoint/_Initiate_test_4a.md b/docs/docs-api/QuadraturePoint/_Initiate_test_4a.md
deleted file mode 100644
index 5b9431cd..00000000
--- a/docs/docs-api/QuadraturePoint/_Initiate_test_4a.md
+++ /dev/null
@@ -1,23 +0,0 @@
-```fortran
-PROGRAM main
-USE easifemBase
-IMPLICIT NONE
-TYPE(QuadraturePoint_) :: obj
-TYPE(ReferenceHexahedron_) :: refelem
-INTEGER(I4B) :: order
-refelem = ReferenceHexahedron(nsd=3_I4B)
-order = 2_I4B
-CALL initiate(obj=obj, &
- & refelem=refelem, &
- & order=order, &
- & quadratureType=GaussLegendre)
-CALL display(mdencode(obj), "ans: ")
-END PROGRAM main
-```
-
-| | | | | | | | | |
-| -- | -------- | -------- | -------- | -------- | -------- | -------- | -------- | ------- |
-| x1 | -0.57735 | -0.57735 | -0.57735 | -0.57735 | 0.57735 | 0.57735 | 0.57735 | 0.57735 |
-| x2 | -0.57735 | -0.57735 | 0.57735 | 0.57735 | -0.57735 | -0.57735 | 0.57735 | 0.57735 |
-| x3 | -0.57735 | 0.57735 | -0.57735 | 0.57735 | -0.57735 | 0.57735 | -0.57735 | 0.57735 |
-| w | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
diff --git a/docs/docs-api/QuadraturePoint/_Initiate_test_4b.md b/docs/docs-api/QuadraturePoint/_Initiate_test_4b.md
deleted file mode 100644
index 5c230b4b..00000000
--- a/docs/docs-api/QuadraturePoint/_Initiate_test_4b.md
+++ /dev/null
@@ -1,23 +0,0 @@
-```fortran
-PROGRAM main
-USE easifemBase
-IMPLICIT NONE
-TYPE(QuadraturePoint_) :: obj
-TYPE(ReferenceHexahedron_) :: refelem
-INTEGER(I4B) :: order
-refelem = ReferenceHexahedron(nsd=3_I4B, xij=RefCoord_Hexahedron("UNIT"))
-order = 2_I4B
-CALL initiate(obj=obj, &
- & refelem=refelem, &
- & order=order, &
- & quadratureType=GaussLegendre)
-CALL display(mdencode(obj) , "")
-END PROGRAM main
-```
-
-| | | | | | | | | |
-| -- | ------- | ------- | ------- | ------- | ------- | ------- | ------- | ------- |
-| x1 | 0.21132 | 0.21132 | 0.21132 | 0.21132 | 0.78868 | 0.78868 | 0.78868 | 0.78868 |
-| x2 | 0.21132 | 0.21132 | 0.78868 | 0.78868 | 0.21132 | 0.21132 | 0.78868 | 0.78868 |
-| x3 | 0.21132 | 0.78868 | 0.21132 | 0.78868 | 0.21132 | 0.78868 | 0.21132 | 0.78868 |
-| w | 0.125 | 0.125 | 0.125 | 0.125 | 0.125 | 0.125 | 0.125 | 0.125 |
diff --git a/docs/docs-api/QuadraturePoint/_Initiate_test_4c.md b/docs/docs-api/QuadraturePoint/_Initiate_test_4c.md
deleted file mode 100644
index 3cb7fecf..00000000
--- a/docs/docs-api/QuadraturePoint/_Initiate_test_4c.md
+++ /dev/null
@@ -1,27 +0,0 @@
-```fortran
-PROGRAM main
-USE easifemBase
-IMPLICIT NONE
-TYPE(QuadraturePoint_) :: obj
-TYPE(ReferenceHexahedron_) :: refelem
-INTEGER(I4B) :: order
-refelem = ReferenceHexahedron(nsd=3_I4B)
-CALL initiate(obj=obj, &
- & refelem=refelem, &
- & p=4, &
- & q=3, &
- & r=2, &
- & quadratureType1=GaussLegendre, &
- & quadratureType2=GaussLegendre, &
- & quadratureType3=GaussLegendre &
- & )
-CALL display(mdencode(obj) , "")
-END PROGRAM main
-```
-
-| | | | | | | | | | | | | |
-| -- | -------- | -------- | -------- | ------- | ----------- | ----------- | ----------- | ----------- | -------- | -------- | -------- | ------- |
-| x1 | -0.7746 | -0.7746 | -0.7746 | -0.7746 | 3.64292E-16 | 3.46945E-16 | 3.46945E-16 | 3.88578E-16 | 0.7746 | 0.7746 | 0.7746 | 0.7746 |
-| x2 | -0.57735 | -0.57735 | 0.57735 | 0.57735 | -0.57735 | -0.57735 | 0.57735 | 0.57735 | -0.57735 | -0.57735 | 0.57735 | 0.57735 |
-| x3 | -0.57735 | 0.57735 | -0.57735 | 0.57735 | -0.57735 | 0.57735 | -0.57735 | 0.57735 | -0.57735 | 0.57735 | -0.57735 | 0.57735 |
-| w | 0.55556 | 0.55556 | 0.55556 | 0.55556 | 0.88889 | 0.88889 | 0.88889 | 0.88889 | 0.55556 | 0.55556 | 0.55556 | 0.55556 |
diff --git a/docs/docs-api/QuadraturePoint/_MdEncode_test_1.md b/docs/docs-api/QuadraturePoint/_MdEncode_test_1.md
deleted file mode 100644
index 35452a19..00000000
--- a/docs/docs-api/QuadraturePoint/_MdEncode_test_1.md
+++ /dev/null
@@ -1,21 +0,0 @@
-```fortran
-PROGRAM main
-USE easifemBase
-IMPLICIT NONE
-TYPE(QuadraturePoint_) :: obj
-TYPE(ReferenceLine_) :: refelem
-INTEGER(I4B) :: order
-refelem = ReferenceLine(nsd=1_I4B)
-order = 4_I4B
-CALL initiate(obj=obj, &
- & refelem=refelem, &
- & order=order, &
- & quadratureType=GaussLegendre)
-CALL display(MdEncode(obj) , "ans: " // char_lf // char_lf)
-END PROGRAM main
-```
-
-| | | | |
-| -- | ------- | ----------- | ------- |
-| x1 | -0.7746 | 1.59632E-16 | 0.7746 |
-| w | 0.55556 | 0.88889 | 0.55556 |
diff --git a/docs/docs-api/QuadraturePoint/_Outerprod_test_1.md b/docs/docs-api/QuadraturePoint/_Outerprod_test_1.md
deleted file mode 100644
index af9fc5b5..00000000
--- a/docs/docs-api/QuadraturePoint/_Outerprod_test_1.md
+++ /dev/null
@@ -1,49 +0,0 @@
-In this module we test `Outerprod` method on quadrature point data type. This method can be used to construct quadrature point on quadrangle by performing tensor product of quadrature point on 1D.
-
-```fortran
-PROGRAM main
-USE easifemBase
-type( ReferenceLine_ ) :: refelem
-type( QuadraturePoint_ ) :: obj1, obj2, obj3
-!!
-call initiate( obj=refelem, nsd = 1 )
-!!
-obj1 = GaussLegendreQuadrature(refelem=refelem, nips=[2])
-obj2 = GaussLegendreQuadrature(refelem=refelem, nips=[2])
-obj3 = Outerprod(obj1, obj2)
-!!
-call display( obj1, "obj1, Line=")
-call display( obj2, "obj2, Line==")
-call display( obj3, "obj3, Line=")
-!!
-END PROGRAM main
-```
-
-See results
-
-
-| | | | | | | |
-| -- | -------- | ------- | ----------- | ----------- | -------- | ------- |
-| x1 | -0.7746 | -0.7746 | 3.60822E-16 | 3.33067E-16 | 0.7746 | 0.7746 |
-| x2 | -0.57735 | 0.57735 | -0.57735 | 0.57735 | -0.57735 | 0.57735 |
-| w | 0.55556 | 0.55556 | 0.88889 | 0.88889 | 0.55556 | 0.55556 |
-
-
-
-
diff --git a/docs/docs-api/QuadraturePoint/examples/_Initiate_test_1.F90 b/docs/docs-api/QuadraturePoint/examples/_Initiate_test_1.F90
index b7ccecad..65b68bca 100644
--- a/docs/docs-api/QuadraturePoint/examples/_Initiate_test_1.F90
+++ b/docs/docs-api/QuadraturePoint/examples/_Initiate_test_1.F90
@@ -1,3 +1,11 @@
+!> author: Vikas Sharma, Ph. D.
+! date: 2025-06-17
+! summary: This program tests the Initiate method of the QuadraturePoint_ class.
+! It runs five tests with different quadrature types and reference line domains:
+! GaussLegendre (BIUNIT, UNIT), GaussLegendreLobatto (BIUNIT),
+! GaussLegendreRadauLeft (BIUNIT), and GaussLegendreRadauRight (BIUNIT).
+! Only Line elements are tested in this example.
+
PROGRAM main
USE GlobalData
USE QuadraturePoint_Method
@@ -9,53 +17,138 @@ PROGRAM main
TYPE(QuadraturePoint_) :: obj
TYPE(ReferenceLine_) :: refelem
-INTEGER(I4B) :: order
-INTEGER(I4B) :: quadratureType
-CHARACTER(:), ALLOCATABLE :: test_name, domainName
-
-domainName = "BIUNIT"
-refelem = ReferenceLine(nsd=1_I4B, xij=RefCoord_Line(domainName))
-order = 4_I4B
-quadratureType = GaussLegendre
-test_name = "order="//tostring(order)//" quadratureType=GaussLegendre"// &
- " refelemDomain="//domainName
-CALL call_test
-
-domainName = "UNIT"
-refelem = ReferenceLine(nsd=1_I4B, xij=RefCoord_Line(domainName))
-order = 4_I4B
-quadratureType = GaussLegendre
-test_name = "order="//tostring(order)//" quadratureType=GaussLegendre"// &
- " refelemDomain="//domainName
-CALL call_test
-
-domainName = "BIUNIT"
-refelem = ReferenceLine(nsd=1_I4B, xij=RefCoord_Line(domainName))
-order = 4_I4B
-quadratureType = GaussLegendreLobatto
+INTEGER(I4B) :: order, nip(1), quadratureType
+CHARACTER(:), ALLOCATABLE :: test_name, domainName, quadratureTypeChar
+
+CALL test1
+CALL test2
+
+CONTAINS
+
+!----------------------------------------------------------------------------
+! test1
+!----------------------------------------------------------------------------
+
+! This subroutine tests the Initiate method with GaussLegendre quadrature
+! on a reference line in the BIUNIT domain.
+! It initializes the QuadraturePoint_ object and displays the results.
+
+SUBROUTINE test1
+ domainName = "BIUNIT"
+ refelem = ReferenceLine(nsd=1_I4B, xij=RefCoord_Line(domainName))
+ order = 4_I4B
+ quadratureType = GaussLegendre
+ quadratureTypeChar = "GaussLegendre"
+ nip(1) = 3
+ test_name = "order="//tostring(order)//" quadratureType=GaussLegendre"// &
+ " refelemDomain="//domainName
+
+ CALL Initiate(obj=obj, refelem=refelem, order=order, &
+ quadratureType=quadratureType)
+
+ CALL BlankLines()
+ CALL Display(obj, test_name)
+ CALL BlankLines()
+
+ ! In the above interface we are creating quadrature points of
+ ! given accuracy. We can also specify the number of quadrature point
+ ! as show below
+ CALL Initiate(obj=obj, refelem=refelem, nips=nip, &
+ quadratureType=quadratureType)
+
+ ! We can also specify quadratureType as string
+ CALL Initiate(obj=obj, refelem=refelem, order=order, &
+ quadratureType=quadratureTypeChar)
+
+ CALL Initiate(obj=obj, refelem=refelem, nips=nip, &
+ quadratureType=quadratureTypeChar)
+
+END SUBROUTINE test1
+
+!----------------------------------------------------------------------------
+!
+!----------------------------------------------------------------------------
+
+SUBROUTINE test2
+
+ domainName = "UNIT"
+ refelem = ReferenceLine(nsd=1_I4B, xij=RefCoord_Line(domainName))
+ order = 4_I4B
+ quadratureType = GaussLegendre
+ test_name = "order="//tostring(order)//" quadratureType=GaussLegendre"// &
+ " refelemDomain="//domainName
+
+ CALL Initiate(obj=obj, refelem=refelem, order=order, &
+ quadratureType=quadratureType)
+
+ CALL BlankLines()
+ CALL Display(obj, test_name)
+ CALL BlankLines()
+END SUBROUTINE test2
+
+!----------------------------------------------------------------------------
+! test3
+!----------------------------------------------------------------------------
+
+! This subroutine tests the Initiate method with GaussLegendre quadrature
+! on a reference line in the UNIT domain.
+! It initializes the QuadraturePoint_ object and displays the results.
+
+SUBROUTINE test3
+ domainName = "BIUNIT"
+ refelem = ReferenceLine(nsd=1_I4B, xij=RefCoord_Line(domainName))
+ order = 4_I4B
+ quadratureType = GaussLegendreLobatto
test_name = "order="//tostring(order)//" quadratureType=GaussLegendreLobatto"// &
- " refelemDomain="//domainName
-CALL call_test
+ " refelemDomain="//domainName
+
+ CALL Initiate(obj=obj, refelem=refelem, order=order, &
+ quadratureType=quadratureType)
+
+ CALL BlankLines()
+ CALL Display(obj, test_name)
+ CALL BlankLines()
+END SUBROUTINE test3
+
+!----------------------------------------------------------------------------
+! test4
+!----------------------------------------------------------------------------
-domainName = "BIUNIT"
-refelem = ReferenceLine(nsd=1_I4B, xij=RefCoord_Line(domainName))
-order = 4_I4B
-quadratureType = GaussLegendreRadauLeft
+! This subroutine tests the Initiate method with GaussLegendreRadauLeft quadrature
+! on a reference line in the BIUNIT domain.
+! It initializes the QuadraturePoint_ object and displays the results.
+
+SUBROUTINE test4
+ domainName = "BIUNIT"
+ refelem = ReferenceLine(nsd=1_I4B, xij=RefCoord_Line(domainName))
+ order = 4_I4B
+ quadratureType = GaussLegendreRadauLeft
test_name = "order="//tostring(order)//" quadratureType=GaussLegendreRadauLeft"// &
- " refelemDomain="//domainName
-CALL call_test
+ " refelemDomain="//domainName
-domainName = "BIUNIT"
-refelem = ReferenceLine(nsd=1_I4B, xij=RefCoord_Line(domainName))
-order = 4_I4B
-quadratureType = GaussLegendreRadauRight
-test_name = "order="//tostring(order)//" quadratureType=GaussLegendreRadauRight"// &
- " refelemDomain="//domainName
-CALL call_test
+ CALL Initiate(obj=obj, refelem=refelem, order=order, &
+ quadratureType=quadratureType)
-CONTAINS
+ CALL BlankLines()
+ CALL Display(obj, test_name)
+ CALL BlankLines()
+END SUBROUTINE test4
-SUBROUTINE call_test
+!----------------------------------------------------------------------------
+! test5
+!----------------------------------------------------------------------------
+
+! This subroutine tests the Initiate method with GaussLegendreRadauRight quadrature
+! on a reference line in the BIUNIT domain.
+! It initializes the QuadraturePoint_ object and displays the results.
+
+SUBROUTINE test5
+ domainName = "BIUNIT"
+ refelem = ReferenceLine(nsd=1_I4B, xij=RefCoord_Line(domainName))
+ order = 4_I4B
+ quadratureType = GaussLegendreRadauRight
+test_name = "order="//tostring(order)//" quadratureType=GaussLegendreRadauRight"// &
+ " refelemDomain="//domainName
CALL Initiate(obj=obj, refelem=refelem, order=order, &
quadratureType=quadratureType)
@@ -63,7 +156,10 @@ SUBROUTINE call_test
CALL BlankLines()
CALL Display(obj, test_name)
CALL BlankLines()
+END SUBROUTINE test5
-END SUBROUTINE call_test
+!----------------------------------------------------------------------------
+!
+!----------------------------------------------------------------------------
END PROGRAM main
diff --git a/docs/docs-api/QuadraturePoint/examples/_Initiate_test_1.md b/docs/docs-api/QuadraturePoint/examples/_Initiate_test_1.md
index 3b3306cf..781fb571 100644
--- a/docs/docs-api/QuadraturePoint/examples/_Initiate_test_1.md
+++ b/docs/docs-api/QuadraturePoint/examples/_Initiate_test_1.md
@@ -1,69 +1,5 @@
-PROGRAM main
-USE GlobalData
-USE QuadraturePoint_Method
-USE BaseType
-USE Display_Method
-USE ReferenceLine_Method
+import CodeBlock from '@theme/CodeBlock';
-IMPLICIT NONE
+import CodeSnippet from '!!raw-loader!./_Initiate_test_1.F90';
-TYPE(QuadraturePoint_) :: obj
-TYPE(ReferenceLine_) :: refelem
-INTEGER(I4B) :: order
-INTEGER(I4B) :: quadratureType
-CHARACTER(:), ALLOCATABLE :: test_name, domainName
-
-domainName = "BIUNIT"
-refelem = ReferenceLine(nsd=1_I4B, xij=RefCoord_Line(domainName))
-order = 4_I4B
-quadratureType = GaussLegendre
-test_name = "order="//tostring(order)//" quadratureType=GaussLegendre"// &
-" refelemDomain="//domainName
-CALL call_test
-
-domainName = "UNIT"
-refelem = ReferenceLine(nsd=1_I4B, xij=RefCoord_Line(domainName))
-order = 4_I4B
-quadratureType = GaussLegendre
-test_name = "order="//tostring(order)//" quadratureType=GaussLegendre"// &
-" refelemDomain="//domainName
-CALL call_test
-
-domainName = "BIUNIT"
-refelem = ReferenceLine(nsd=1_I4B, xij=RefCoord_Line(domainName))
-order = 4_I4B
-quadratureType = GaussLegendreLobatto
-test_name = "order="//tostring(order)//" quadratureType=GaussLegendreLobatto"// &
-" refelemDomain="//domainName
-CALL call_test
-
-domainName = "BIUNIT"
-refelem = ReferenceLine(nsd=1_I4B, xij=RefCoord_Line(domainName))
-order = 4_I4B
-quadratureType = GaussLegendreRadauLeft
-test_name = "order="//tostring(order)//" quadratureType=GaussLegendreRadauLeft"// &
-" refelemDomain="//domainName
-CALL call_test
-
-domainName = "BIUNIT"
-refelem = ReferenceLine(nsd=1_I4B, xij=RefCoord_Line(domainName))
-order = 4_I4B
-quadratureType = GaussLegendreRadauRight
-test_name = "order="//tostring(order)//" quadratureType=GaussLegendreRadauRight"// &
-" refelemDomain="//domainName
-CALL call_test
-
-CONTAINS
-
-SUBROUTINE call_test
-
-CALL Initiate(obj=obj, refelem=refelem, order=order, &
-quadratureType=quadratureType)
-
-CALL BlankLines()
-CALL Display(obj, test_name)
-CALL BlankLines()
-
-END SUBROUTINE call_test
-
-END PROGRAM main
+See results
-
-
-```txt
-obj1, Line=
- # points :
-------------------
--0.57735 0.57735
- 1.00000 1.00000
-# txi :1
-obj2, Line==
- # points :
-------------------
--0.57735 0.57735
- 1.00000 1.00000
-# txi :1
-obj3, Line=
- # points :
---------------------------------------
--0.57735 -0.57735 0.57735 0.57735
--0.57735 0.57735 -0.57735 0.57735
- 1.00000 1.00000 1.00000 1.00000
-# txi :2
-```
-
-
-
{blog && (
-
@@ -161,7 +158,7 @@ export default function GuidesAndSamples() {
to="https://github.com/vickysharma0812"
className="font-jakarta text-sm font-semibold"
>
- All apps