diff --git a/docs/docs-api/AbstractMesh/AbstractMesh_.md b/docs/docs-api/AbstractMesh/AbstractMesh_.md index f6389e6a..7df38f03 100644 --- a/docs/docs-api/AbstractMesh/AbstractMesh_.md +++ b/docs/docs-api/AbstractMesh/AbstractMesh_.md @@ -18,7 +18,7 @@ This is an abstract class, which will be extended by `Mesh_` and `FEMesh_` class ::: -- You can learn about the structure of `FEMesh` [Here](./FEMesh_.md) +- You can learn about the structure of `FEMesh` [Here](../FEMesh/FEMesh_.md) - You can learn about the structure of `ElemData` [Here](./ElemData_.md) - You can learn about the structure of `NodeData` [Here](./NodeData_.md) - The information of `BoundaryFacetData` is given [Here](./BoundaryFacetData_.md) diff --git a/docs/docs-api/AbstractMesh/IsTotalInternalNodes.md b/docs/docs-api/AbstractMesh/GetTotalInternalNodes.md similarity index 100% rename from docs/docs-api/AbstractMesh/IsTotalInternalNodes.md rename to docs/docs-api/AbstractMesh/GetTotalInternalNodes.md diff --git a/docs/docs-api/AbstractMesh/InitiateFacetElements.md b/docs/docs-api/AbstractMesh/InitiateFacetElements.md index 4a413e0b..ae5ae0a5 100644 --- a/docs/docs-api/AbstractMesh/InitiateFacetElements.md +++ b/docs/docs-api/AbstractMesh/InitiateFacetElements.md @@ -2,43 +2,26 @@ title: InitiateFacetElements --- -This routine initiates the facet element data, such as [`BoundaryFacetData`](./BoundaryFacetData_.md) and [`InternalFacetData_`](./InternalFacetData_.md). +This routine needs following information: -This routine needs the following information: +- `ElementToElements` +- `BoundaryData` -- `ElementToElements`, if this information is not available, then it calls [InitiateElementToElements](./InitiateElementToElements.md). -- `BoundaryData`, if this information is not available, then it calls [InitiateBoundaryData](./InitiateBoundaryData.md). + It makes following data -It makes following data structures: +- `InternalFacetData` +- `BoundaryFacetData` +- `FacetElementType` -- [InternalFacetData_](./InternalFacetData_.md) -- [BoundaryFacetData_](./BoundaryFacetData_.md) -- `FacetElementType` field in [Mesh_](Mesh_.md) - -:::info - -- This method cannot differentiate between a `BOUNDARY_ELEMENT`, which is a boundary-facet-element at the mesh-boundary, and `DOMAIN_BOUNDARY_ELEMENT`, which is facet element at the domain’s boundary. -- This is because, at this point we only know that a boundary-facet-element is a domain-boundary-element, as we have no information about the neighboring mesh. -- Therefore, all `boundaryFacet` elements, at this level, are of type `DOMAIN_BOUNDARY_ELEMENT`. This is because every `DOMAIN_BOUNDARY_ELEMENT` is a `BOUNDARY_ELEMENT`. -- This information can be corrected only when we call [`SetDomainFacetElement`](../Domain/SetDomainFacetElement.md) from [Domain_](../Domain/Domain_.md) class. -::: - -:::note -If we call [`SetDomainFacetElement`](../Domain/SetDomainFacetElement.md) then we do not have to worry about the above point. -::: - -Please check documentation of following methods: - -- [`SetDomainFacetElement`](../Domain/SetDomainFacetElement.md) -- [`SetMeshFacetElement`](../Domain/SetMeshFacetElement.md) -- [`SetFacetElementType`](../Domain/SetFacetElementType.md) + Note that at this point all `boundaryFacet` element are of type `DOMAIN_BOUNDARY_ELEMENT`. This information can be corrected only when + we call `SetFacetElementType` from Domain_ class. This is because, at this point we only know that a boundary facet is a domain boundary element, as we have no information about the neighbouring mesh. ## Interface ```fortran INTERFACE MODULE SUBROUTINE InitiateFacetElements(obj) - CLASS(Mesh_), INTENT(INOUT) :: obj + CLASS(AbstractMesh_), INTENT(INOUT) :: obj END SUBROUTINE InitiateFacetElements END INTERFACE ``` diff --git a/docs/docs-api/FEMesh/Display.md b/docs/docs-api/FEMesh/Display.md index 39176e9d..3853fda6 100644 --- a/docs/docs-api/FEMesh/Display.md +++ b/docs/docs-api/FEMesh/Display.md @@ -1,7 +1,8 @@ # Display -Imported from the [AbstractMesh](../AbstractMesh/Display.md). - +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: import EXAMPLE5 from "../AbstractMesh/Display.md"; diff --git a/docs/docs-api/FEMesh/DisplayBoundaryFacetData.md b/docs/docs-api/FEMesh/DisplayBoundaryFacetData.md index e5548186..2a74909c 100644 --- a/docs/docs-api/FEMesh/DisplayBoundaryFacetData.md +++ b/docs/docs-api/FEMesh/DisplayBoundaryFacetData.md @@ -1,13 +1,11 @@ -# DisplayBoundaryFacetData +--- +title: DisplayBoundaryFacetData +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -```fortran -INTERFACE - MODULE SUBROUTINE mesh_DisplayBoundaryFacetData(obj, msg, unitno) - CLASS(Mesh_), INTENT(IN) :: obj - CHARACTER(*), INTENT(IN) :: msg - INTEGER(I4B), OPTIONAL, INTENT(IN) :: unitno - END SUBROUTINE mesh_DisplayBoundaryFacetData -END INTERFACE -``` +import EXAMPLE5 from "../AbstractMesh/DisplayBoundaryFacetData.md"; + + diff --git a/docs/docs-api/FEMesh/DisplayElementData.md b/docs/docs-api/FEMesh/DisplayElementData.md index 22b7ad6a..1e8fe337 100644 --- a/docs/docs-api/FEMesh/DisplayElementData.md +++ b/docs/docs-api/FEMesh/DisplayElementData.md @@ -1,13 +1,12 @@ -# DisplayElementData - -## Interface - -```fortran -INTERFACE - MODULE SUBROUTINE mesh_DisplayElementData(obj, msg, unitno) - CLASS(Mesh_), INTENT(IN) :: obj - CHARACTER(*), INTENT(IN) :: msg - INTEGER(I4B), OPTIONAL, INTENT(IN) :: unitno - END SUBROUTINE mesh_DisplayElementData -END INTERFACE -``` +--- +title: DisplayElementData +--- + +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: + +import EXAMPLE5 from "../AbstractMesh/DisplayElementData.md"; + + + diff --git a/docs/docs-api/FEMesh/DisplayFacetElemSD.md b/docs/docs-api/FEMesh/DisplayFacetElemSD.md index 7ebb5a9e..b06bbfc6 100644 --- a/docs/docs-api/FEMesh/DisplayFacetElemSD.md +++ b/docs/docs-api/FEMesh/DisplayFacetElemSD.md @@ -1,13 +1,12 @@ -# DisplayFacetElemSD - -## Interface - -```fortran -INTERFACE - MODULE SUBROUTINE mesh_DisplayFacetElements(obj, msg, unitno) - CLASS(Mesh_), INTENT(IN) :: obj - CHARACTER(*), INTENT(IN) :: msg - INTEGER(I4B), OPTIONAL, INTENT(IN) :: unitno - END SUBROUTINE mesh_DisplayFacetElements -END INTERFACE -``` +--- +title: DisplayFacetElemSD +--- + +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: + +import EXAMPLE5 from "../AbstractMesh/DisplayFacetElemSD.md"; + + + diff --git a/docs/docs-api/FEMesh/DisplayFacetElements.md b/docs/docs-api/FEMesh/DisplayFacetElements.md index f88e3b4e..51a302c3 100644 --- a/docs/docs-api/FEMesh/DisplayFacetElements.md +++ b/docs/docs-api/FEMesh/DisplayFacetElements.md @@ -1,13 +1,12 @@ -# DisplayFacetElements - -## Interface - -```fortran -INTERFACE - MODULE SUBROUTINE mesh_DisplayFacetElements(obj, msg, unitno) - CLASS(Mesh_), INTENT(IN) :: obj - CHARACTER(*), INTENT(IN) :: msg - INTEGER(I4B), OPTIONAL, INTENT(IN) :: unitno - END SUBROUTINE mesh_DisplayFacetElements -END INTERFACE -``` +--- +title: DisplayFacetElements +--- + +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: + +import EXAMPLE5 from "../AbstractMesh/DisplayFacetElements.md"; + + + diff --git a/docs/docs-api/FEMesh/DisplayInternalFacetData.md b/docs/docs-api/FEMesh/DisplayInternalFacetData.md index f4b66d68..6444a669 100644 --- a/docs/docs-api/FEMesh/DisplayInternalFacetData.md +++ b/docs/docs-api/FEMesh/DisplayInternalFacetData.md @@ -1,13 +1,11 @@ -# DisplayInternalFacetData +--- +title: DisplayInternalFacetData +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -```fortran -INTERFACE - MODULE SUBROUTINE mesh_DisplayInternalFacetData(obj, msg, unitno) - CLASS(Mesh_), INTENT(IN) :: obj - CHARACTER(*), INTENT(IN) :: msg - INTEGER(I4B), OPTIONAL, INTENT(IN) :: unitno - END SUBROUTINE mesh_DisplayInternalFacetData -END INTERFACE -``` +import EXAMPLE5 from "../AbstractMesh/DisplayInternalFacetData.md"; + + diff --git a/docs/docs-api/FEMesh/DisplayNodeData.md b/docs/docs-api/FEMesh/DisplayNodeData.md index 1ea1ab9a..8e69e602 100644 --- a/docs/docs-api/FEMesh/DisplayNodeData.md +++ b/docs/docs-api/FEMesh/DisplayNodeData.md @@ -1,13 +1,11 @@ -# DisplayNodeData +--- +title: DisplayNodeData +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -```fortran -INTERFACE - MODULE SUBROUTINE mesh_DisplayNodeData(obj, msg, unitno) - CLASS(Mesh_), INTENT(IN) :: obj - CHARACTER(*), INTENT(IN) :: msg - INTEGER(I4B), OPTIONAL, INTENT(IN) :: unitno - END SUBROUTINE mesh_DisplayNodeData -END INTERFACE -``` +import EXAMPLE5 from "../AbstractMesh/DisplayNodeData.md"; + + diff --git a/docs/docs-api/FEMesh/GetBoundaryElementData.md b/docs/docs-api/FEMesh/GetBoundaryElementData.md index 90e563d1..5781fbae 100644 --- a/docs/docs-api/FEMesh/GetBoundaryElementData.md +++ b/docs/docs-api/FEMesh/GetBoundaryElementData.md @@ -1,32 +1,27 @@ -# GetBoundaryElementData +--- +title: GetBoundaryElementData +--- -Returns the boundary element data. +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -## Interface +import EXAMPLE5 from "../AbstractMesh/GetBoundaryElementData.md"; - - + -```fortran -MODULE PURE FUNCTION getBoundaryElementData(obj, globalElement) & - & RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - INTEGER(I4B), INTENT(IN) :: globalElement - INTEGER(I4B), ALLOCATABLE :: ans(:) -END FUNCTION getBoundaryElementData -``` - +## Examples - +
+Example 1 +
-import EXAMPLE5 from "./examples/_GetBoundaryElementData_test_1.md"; - +import EXAMPLE6 from "./examples/_GetBoundaryElementData_test_1.md"; - + - +
+
-
-
diff --git a/docs/docs-api/FEMesh/GetBoundaryNptrs.md b/docs/docs-api/FEMesh/GetBoundaryNptrs.md index 33066f82..a61fa4fb 100644 --- a/docs/docs-api/FEMesh/GetBoundaryNptrs.md +++ b/docs/docs-api/FEMesh/GetBoundaryNptrs.md @@ -1,10 +1,12 @@ -# GetBoundaryNptrs +--- +title: GetBoundaryNptrs +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: + +import EXAMPLE5 from "../AbstractMesh/GetBoundaryNptrs.md"; + + -```fortran - MODULE PURE FUNCTION getBoundaryNptrs(obj) RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - INTEGER(I4B), ALLOCATABLE :: ans(:) - END FUNCTION getBoundaryNptrs -``` diff --git a/docs/docs-api/FEMesh/GetBoundingBox.md b/docs/docs-api/FEMesh/GetBoundingBox.md index 346c34e2..9e8f2081 100644 --- a/docs/docs-api/FEMesh/GetBoundingBox.md +++ b/docs/docs-api/FEMesh/GetBoundingBox.md @@ -1,21 +1,12 @@ -# GetBoundingBox +--- +title: GetBoundingBox +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -```fortran - MODULE PURE FUNCTION getBoundingBox(obj) RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - TYPE(BoundingBox_) :: ans - END FUNCTION getBoundingBox -``` +import EXAMPLE5 from "../AbstractMesh/GetBoundingBox.md"; + + -```fortran - MODULE PURE FUNCTION getBoundingBox(obj, nodes, local_nptrs) & - & RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - REAL(DFP), INTENT(IN) :: nodes(:, :) - !! Nodal coordinates in XiJ format - INTEGER(I4B), OPTIONAL, INTENT(IN) :: local_nptrs(:) - TYPE(BoundingBox_) :: ans - END FUNCTION getBoundingBox -``` diff --git a/docs/docs-api/FEMesh/GetBoundingEntity.md b/docs/docs-api/FEMesh/GetBoundingEntity.md index 79df25d0..b15908db 100644 --- a/docs/docs-api/FEMesh/GetBoundingEntity.md +++ b/docs/docs-api/FEMesh/GetBoundingEntity.md @@ -1,10 +1,11 @@ -# GetBoundingEntity +--- +title: GetBoundingEntity +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -```fortran - MODULE PURE FUNCTION getBoundingEntity(obj) RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - INTEGER(I4B), ALLOCATABLE :: ans(:) - END FUNCTION getBoundingEntity -``` +import EXAMPLE5 from "../AbstractMesh/GetBoundingEntity.md"; + + diff --git a/docs/docs-api/FEMesh/GetCellNumber.md b/docs/docs-api/FEMesh/GetCellNumber.md index 4999f68a..794c8b68 100644 --- a/docs/docs-api/FEMesh/GetCellNumber.md +++ b/docs/docs-api/FEMesh/GetCellNumber.md @@ -1,14 +1,13 @@ -# GetCellNumber - -## Interface - -```fortran - MODULE PURE FUNCTION getCellNumber( obj, facetElement, & - & elementType, facetBoundary ) RESULT( ans ) - CLASS( Mesh_ ), INTENT( IN ) :: obj - INTEGER( I4B ), INTENT( IN ) :: facetElement - INTEGER( I4B ), INTENT( IN ) :: elementType - INTEGER( I4B ), OPTIONAL, INTENT( IN ) :: facetBoundary - INTEGER( I4B ) :: ans( 2 ) - END FUNCTION getCellNumber -``` +--- +title: GetCellNumber +--- + +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: + +import EXAMPLE5 from "../AbstractMesh/GetCellNumber.md"; + + + + diff --git a/docs/docs-api/FEMesh/GetConnectivity.md b/docs/docs-api/FEMesh/GetConnectivity.md index 62517693..ddec5a88 100644 --- a/docs/docs-api/FEMesh/GetConnectivity.md +++ b/docs/docs-api/FEMesh/GetConnectivity.md @@ -1,11 +1,11 @@ -# GetConnectivity +--- +title: GetConnectivity +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -```fortran - MODULE PURE FUNCTION getConnectivity(obj, globalElement) RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - INTEGER(I4B), INTENT(IN) :: globalElement - INTEGER(I4B), ALLOCATABLE :: ans(:) - END FUNCTION getConnectivity -``` +import EXAMPLE5 from "../AbstractMesh/GetConnectivity.md"; + + diff --git a/docs/docs-api/FEMesh/GetElemNum.md b/docs/docs-api/FEMesh/GetElemNum.md index 3b426591..674df0c0 100644 --- a/docs/docs-api/FEMesh/GetElemNum.md +++ b/docs/docs-api/FEMesh/GetElemNum.md @@ -1,10 +1,12 @@ -# GetElemNum +--- +title: GetElemNum +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: + +import EXAMPLE5 from "../AbstractMesh/GetElemNum.md"; + + -```fortran - MODULE FUNCTION getElemNum(obj) RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - INTEGER(I4B), ALLOCATABLE :: ans(:) - END FUNCTION getElemNum -``` diff --git a/docs/docs-api/FEMesh/GetElementToElements.md b/docs/docs-api/FEMesh/GetElementToElements.md index 559abc7e..036ec4f5 100644 --- a/docs/docs-api/FEMesh/GetElementToElements.md +++ b/docs/docs-api/FEMesh/GetElementToElements.md @@ -1,40 +1,26 @@ -# GetElementToElements +--- +title: GetElementToElements +--- -Get element to elements connectivity information. +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -## Interface +import EXAMPLE5 from "../AbstractMesh/GetElementToElements.md"; - - - -```fortran -MODULE PURE FUNCTION getElementToElements(obj, globalElement, & - & onlyElements) RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - !! mesh data - INTEGER(I4B), INTENT(IN) :: globalElement - !! Global element number - LOGICAL(LGT), OPTIONAL, INTENT(IN) :: onlyElements - !! If onlyElements is absent or it is FALSE then full information - !! about the elements connected to element iel is given - !! If onlyElements is present and it is TRUE then only the - !! information about the elements connected to element iel is given - INTEGER(I4B), ALLOCATABLE :: ans(:, :) - !! list of elements surrounding elements -END FUNCTION getElementToElements -``` + - +## Examples - +
+Example 1 +
-import EXAMPLE5 from "./examples/_GetElementToElements_test_1.md"; +import EXAMPLE6 from "./examples/_GetElementToElements_test_1.md"; - + - - +
+
-
-
diff --git a/docs/docs-api/FEMesh/GetFacetConnectivity.md b/docs/docs-api/FEMesh/GetFacetConnectivity.md index 0230d074..fd70f6d2 100644 --- a/docs/docs-api/FEMesh/GetFacetConnectivity.md +++ b/docs/docs-api/FEMesh/GetFacetConnectivity.md @@ -1,31 +1,12 @@ -# GetFacetConnectivity +--- +title: GetFacetConnectivity +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -```fortran - MODULE PURE FUNCTION getFacetConnectivity( obj, facetElement, & - & elementType, isMaster, facetBoundary ) RESULT( ans ) - CLASS( Mesh_ ), INTENT( IN ) :: obj - INTEGER( I4B ), INTENT( IN ) :: facetElement - INTEGER( I4B ), INTENT( IN ) :: elementType - LOGICAL( LGT ), INTENT( IN ) :: isMaster - !! if isMaster is true then connectivity of facet in master-cell - !! is returned, otherwise connectivity of facet in slave-cell - !! is returned. This is only applicable for internal facet element - !! because for domain facet we do not have slave-cell. - !! Currently, we do not support slave-cell for meshFacet because - !! the slave of meshFacet lives in different instance of - INTEGER( I4B ), OPTIONAL, INTENT( IN ) :: facetBoundary - INTEGER( I4B ), ALLOCATABLE :: ans( : ) - END FUNCTION getFacetConnectivity -``` +import EXAMPLE5 from "../AbstractMesh/GetFacetConnectivity.md"; + + -```fortran - MODULE PURE FUNCTION getFacetConnectivity( obj, globalElement, & - & iface ) RESULT( ans ) - CLASS( Mesh_ ), INTENT( IN ) :: obj - INTEGER( I4B ), INTENT( IN ) :: globalElement - INTEGER( I4B ), INTENT( IN ) :: iface - INTEGER( I4B ), ALLOCATABLE :: ans( : ) - END FUNCTION getFacetConnectivity -``` diff --git a/docs/docs-api/FEMesh/GetFacetElementType.md b/docs/docs-api/FEMesh/GetFacetElementType.md index fae6cee9..dd3133b4 100644 --- a/docs/docs-api/FEMesh/GetFacetElementType.md +++ b/docs/docs-api/FEMesh/GetFacetElementType.md @@ -1,12 +1,11 @@ -# GetFacetElementType +--- +title: GetFacetElementType +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -```fortran - MODULE PURE FUNCTION getFacetElementType( obj, globalElement ) & - & RESULT( ans ) - CLASS( Mesh_ ), INTENT( IN ) :: obj - INTEGER( I4B ), INTENT( IN ) :: globalElement - INTEGER( I4B ), ALLOCATABLE :: ans( : ) - END FUNCTION getFacetElementType -``` +import EXAMPLE5 from "../AbstractMesh/GetFacetElementType.md"; + + diff --git a/docs/docs-api/FEMesh/GetGlobalElemNumber.md b/docs/docs-api/FEMesh/GetGlobalElemNumber.md index 9c50f4d6..8a30cfd1 100644 --- a/docs/docs-api/FEMesh/GetGlobalElemNumber.md +++ b/docs/docs-api/FEMesh/GetGlobalElemNumber.md @@ -1,20 +1,12 @@ -# GetGlobalElemNumber +--- +title: GetGlobalElemNumber +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -```fortran - MODULE PURE FUNCTION getGlobalElemNumber(obj, LocalElement) & - & RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - INTEGER(I4B), INTENT(IN) :: LocalElement(:) - INTEGER(I4B) :: ans(SIZE(LocalElement)) - END FUNCTION getGlobalElemNumber -``` +import EXAMPLE5 from "../AbstractMesh/GetGlobalElemNumber.md"; + + -```fortran - MODULE PURE FUNCTION getGlobalElemNumber(obj, LocalElement) RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - INTEGER(I4B), INTENT(IN) :: LocalElement - INTEGER(I4B) :: ans - END FUNCTION getGlobalElemNumber -``` diff --git a/docs/docs-api/FEMesh/GetGlobalNodeNumber.md b/docs/docs-api/FEMesh/GetGlobalNodeNumber.md index 5544b193..9c17eaad 100644 --- a/docs/docs-api/FEMesh/GetGlobalNodeNumber.md +++ b/docs/docs-api/FEMesh/GetGlobalNodeNumber.md @@ -1,19 +1,14 @@ -# GetGlobalNodeNumber +--- +title: GetGlobalNodeNumber +--- + +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: + +import EXAMPLE5 from "../AbstractMesh/GetGlobalNodeNumber.md"; + + -## Interface -```fortran - MODULE PURE FUNCTION getGlobalNodeNumber(obj, localNode) RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - INTEGER(I4B), INTENT(IN) :: localNode(:) - INTEGER(I4B) :: ans(SIZE(localNode)) - END FUNCTION getGlobalNodeNumber -``` -```fortran - MODULE PURE FUNCTION getGlobalNodeNumber(obj, localNode) RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - INTEGER(I4B), INTENT(IN) :: localNode - INTEGER(I4B) :: ans - END FUNCTION getGlobalNodeNumber -``` diff --git a/docs/docs-api/FEMesh/GetInternalNptrs.md b/docs/docs-api/FEMesh/GetInternalNptrs.md index 1c513583..9dbf74c1 100644 --- a/docs/docs-api/FEMesh/GetInternalNptrs.md +++ b/docs/docs-api/FEMesh/GetInternalNptrs.md @@ -1,10 +1,11 @@ -# GetInternalNptrs +--- +title: GetInternalNptrs +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -```fortran - MODULE PURE FUNCTION getInternalNptrs(obj) RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - INTEGER(I4B), ALLOCATABLE :: ans(:) - END FUNCTION getInternalNptrs -``` +import EXAMPLE5 from "../AbstractMesh/GetInternalNptrs.md"; + + diff --git a/docs/docs-api/FEMesh/GetLocalElemNumber.md b/docs/docs-api/FEMesh/GetLocalElemNumber.md index ca8f534a..4a48480c 100644 --- a/docs/docs-api/FEMesh/GetLocalElemNumber.md +++ b/docs/docs-api/FEMesh/GetLocalElemNumber.md @@ -1,19 +1,11 @@ -# GetLocalElemNumber +--- +title: GetLocalElemNumber +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -```fortran - MODULE PURE FUNCTION getLocalElemNumber(obj, GlobalElement) RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - INTEGER(I4B), INTENT(IN) :: GlobalElement(:) - INTEGER(I4B) :: ans(SIZE(GlobalElement)) - END FUNCTION getLocalElemNumber -``` +import EXAMPLE5 from "../AbstractMesh/GetLocalElemNumber.md"; -```fortran - MODULE PURE FUNCTION getLocalElemNumber(obj, GlobalElement) RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - INTEGER(I4B), INTENT(IN) :: GlobalElement - INTEGER(I4B) :: ans - END FUNCTION getLocalElemNumber -``` + diff --git a/docs/docs-api/FEMesh/GetLocalFacetID.md b/docs/docs-api/FEMesh/GetLocalFacetID.md index ac258cbd..cc869b15 100644 --- a/docs/docs-api/FEMesh/GetLocalFacetID.md +++ b/docs/docs-api/FEMesh/GetLocalFacetID.md @@ -1,15 +1,11 @@ -# GetLocalFacetID +--- +title: GetLocalFacetID +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -```fortran - MODULE PURE FUNCTION getLocalFacetID( obj, facetElement, & - & elementType, isMaster, facetBoundary ) RESULT( ans ) - CLASS( Mesh_ ), INTENT( IN ) :: obj - INTEGER( I4B ), INTENT( IN ) :: facetElement - INTEGER( I4B ), INTENT( IN ) :: elementType - LOGICAL( LGT ), INTENT( IN ) :: isMaster - INTEGER( I4B ), OPTIONAL, INTENT( IN ) :: facetBoundary - INTEGER( I4B ) :: ans - END FUNCTION getLocalFacetID -``` +import EXAMPLE5 from "../AbstractMesh/GetLocalFacetID.md"; + + diff --git a/docs/docs-api/FEMesh/GetLocalNodeNumber.md b/docs/docs-api/FEMesh/GetLocalNodeNumber.md index a3c5fa1d..ac84cfaa 100644 --- a/docs/docs-api/FEMesh/GetLocalNodeNumber.md +++ b/docs/docs-api/FEMesh/GetLocalNodeNumber.md @@ -1,19 +1,12 @@ -# GetLocalNodeNumber +--- +title: GetLocalNodeNumber +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -```fortran - MODULE PURE FUNCTION getLocalNodeNumber(obj, globalNode) RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - INTEGER(I4B), INTENT(IN) :: globalNode(:) - INTEGER(I4B) :: ans(SIZE(globalNode)) - END FUNCTION getLocalNodeNumber -``` +import EXAMPLE5 from "../AbstractMesh/GetLocalNodeNumber.md"; + + -```fortran - MODULE PURE FUNCTION getLocalNodeNumber(obj, globalNode) RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - INTEGER(I4B), INTENT(IN) :: globalNode - INTEGER(I4B) :: ans - END FUNCTION getLocalNodeNumber -``` diff --git a/docs/docs-api/FEMesh/GetMasterCellNumber.md b/docs/docs-api/FEMesh/GetMasterCellNumber.md index 939c6858..c3f44384 100644 --- a/docs/docs-api/FEMesh/GetMasterCellNumber.md +++ b/docs/docs-api/FEMesh/GetMasterCellNumber.md @@ -1,15 +1,12 @@ -# GetMasterCellNumber - -## Interface - -```fortran - MODULE PURE FUNCTION getMasterCellNumber( obj, facetElement, & - & elementType, facetBoundary )& - & RESULT( ans ) - CLASS( Mesh_ ), INTENT( IN ) :: obj - INTEGER( I4B ), INTENT( IN ) :: facetElement - INTEGER( I4B ), INTENT( IN ) :: elementType - INTEGER( I4B ), OPTIONAL, INTENT( IN ) :: facetBoundary - INTEGER( I4B ) :: ans - END FUNCTION getMasterCellNumber -``` +--- +title: GetMasterCellNumber +--- + +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: + +import EXAMPLE5 from "../AbstractMesh/GetMasterCellNumber.md"; + + + diff --git a/docs/docs-api/FEMesh/GetNodeToElements.md b/docs/docs-api/FEMesh/GetNodeToElements.md index 33552373..14efaab5 100644 --- a/docs/docs-api/FEMesh/GetNodeToElements.md +++ b/docs/docs-api/FEMesh/GetNodeToElements.md @@ -1,51 +1,25 @@ -# GetNodeToElements +--- +title: GetNodeToElements +--- -Get node to elements connectivity. +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -There are two interfaces to this method. - -## Interface - -### Interface 1 - - - - -```fortran -MODULE PURE FUNCTION getNodeToElements(obj, globalNode) RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - !! mesh data - INTEGER(I4B), INTENT(IN) :: globalNode - !! global node number - INTEGER(I4B), ALLOCATABLE :: ans(:) - !! A vector of local element number -END FUNCTION getNodeToElements -``` - - - - - -import EXAMPLE5 from "./examples/_GetNodeToElements_test_1.md"; +import EXAMPLE5 from "../AbstractMesh/GetNodeToNodes.md"; - +## Examples + +
+Example 1 +
- +import EXAMPLE6 from "./examples/_GetNodeToElements_test_1.md"; - - + -### Interface 2 +
+
-```fortran -MODULE PURE FUNCTION getNodeToElements(obj, globalNode) RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - !! mesh data - INTEGER(I4B), INTENT(IN) :: globalNode(:) - !! global node number - INTEGER(I4B), ALLOCATABLE :: ans(:) - !! A vector of local element number -END FUNCTION getNodeToElements -``` diff --git a/docs/docs-api/FEMesh/GetNodeToNodes.md b/docs/docs-api/FEMesh/GetNodeToNodes.md index 03ff9155..392e240d 100644 --- a/docs/docs-api/FEMesh/GetNodeToNodes.md +++ b/docs/docs-api/FEMesh/GetNodeToNodes.md @@ -1,51 +1,26 @@ -# GetNodeToNodes +--- +title: GetNodeToNodes +--- -Returns node to node connectivity in the mess. +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -## Interface +import EXAMPLE5 from "../AbstractMesh/GetNodeToNodes.md"; -There are two interfaces to this method + -### Interface 1 +## Examples - - - -```fortran -MODULE PURE FUNCTION getNodeToNodes(obj, globalNode, IncludeSelf) & - & RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - INTEGER(I4B), INTENT(IN) :: globalNode - LOGICAL(LGT), INTENT(IN) :: IncludeSelf - INTEGER(I4B), ALLOCATABLE :: ans(:) -END FUNCTION getNodeToNodes -``` - - - - - -```fortran -MODULE PURE FUNCTION getNodeToNodes(obj, globalNode, IncludeSelf) & - & RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - INTEGER(I4B), INTENT(IN) :: globalNode( : ) - LOGICAL(LGT), INTENT(IN) :: IncludeSelf - INTEGER(I4B), ALLOCATABLE :: ans(:) -END FUNCTION getNodeToNodes -``` - - - - +
+Example 1 +
import EXAMPLE11 from "./examples/_GetNodeToNodes_test_1.md"; - +
+
- - -
diff --git a/docs/docs-api/FEMesh/GetNptrs.md b/docs/docs-api/FEMesh/GetNptrs.md index 2a524c86..7f72b9fe 100644 --- a/docs/docs-api/FEMesh/GetNptrs.md +++ b/docs/docs-api/FEMesh/GetNptrs.md @@ -1,10 +1,12 @@ -# GetNptrs +--- +title: GetNptrs +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: + +import EXAMPLE5 from "../AbstractMesh/GetNptrs.md"; + + -```fortran - MODULE PURE FUNCTION getNptrs(obj) RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - INTEGER(I4B), ALLOCATABLE :: ans(:) - END FUNCTION getNptrs -``` diff --git a/docs/docs-api/FEMesh/GetRefElemPointer.md b/docs/docs-api/FEMesh/GetRefElemPointer.md index 42c05dd9..97811afb 100644 --- a/docs/docs-api/FEMesh/GetRefElemPointer.md +++ b/docs/docs-api/FEMesh/GetRefElemPointer.md @@ -1,10 +1,13 @@ -# GetRefElemPointer +--- +title: GetRefElemPointer +--- + +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: + +import EXAMPLE5 from "../AbstractMesh/GetRefElemPointer.md"; + + -## Interface -```fortran - MODULE FUNCTION getRefElemPointer(obj) RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - CLASS(ReferenceElement_), POINTER :: ans - END FUNCTION getRefElemPointer -``` diff --git a/docs/docs-api/FEMesh/GetSlaveCellNumber.md b/docs/docs-api/FEMesh/GetSlaveCellNumber.md index 8796abc6..77016fe9 100644 --- a/docs/docs-api/FEMesh/GetSlaveCellNumber.md +++ b/docs/docs-api/FEMesh/GetSlaveCellNumber.md @@ -1,14 +1,11 @@ -# GetSlaveCellNumber +--- +title: GetSlaveCellNumber +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -```fortran - MODULE PURE FUNCTION getSlaveCellNumber( obj, facetElement, & - & elementType, facetBoundary ) RESULT( ans ) - CLASS( Mesh_ ), INTENT( IN ) :: obj - INTEGER( I4B ), INTENT( IN ) :: facetElement - INTEGER( I4B ), INTENT( IN ) :: elementType - INTEGER( I4B ), OPTIONAL, INTENT( IN ) :: facetBoundary - INTEGER( I4B ) :: ans - END FUNCTION getSlaveCellNumber -``` +import EXAMPLE5 from "../AbstractMesh/GetSlaveCellNumber.md"; + + diff --git a/docs/docs-api/FEMesh/GetTotalBoundaryElements.md b/docs/docs-api/FEMesh/GetTotalBoundaryElements.md index c695323f..f33f1606 100644 --- a/docs/docs-api/FEMesh/GetTotalBoundaryElements.md +++ b/docs/docs-api/FEMesh/GetTotalBoundaryElements.md @@ -1,10 +1,12 @@ -# GetTotalBoundaryElements +--- +title: GetTotalBoundaryElements +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: + +import EXAMPLE5 from "../AbstractMesh/GetTotalBoundaryElements.md"; + + -```fortran - MODULE PURE FUNCTION getTotalBoundaryElements(obj) RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - INTEGER(I4B) :: ans - END FUNCTION getTotalBoundaryElements -``` diff --git a/docs/docs-api/FEMesh/GetTotalBoundaryFacetElements.md b/docs/docs-api/FEMesh/GetTotalBoundaryFacetElements.md index 1b2d9d9e..4202decf 100644 --- a/docs/docs-api/FEMesh/GetTotalBoundaryFacetElements.md +++ b/docs/docs-api/FEMesh/GetTotalBoundaryFacetElements.md @@ -1,10 +1,11 @@ -# GetTotalBoundaryFacetElements +--- +title: GetTotalBoundaryFacetElements +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -```fortran - MODULE PURE FUNCTION getTotalBoundaryFacetElements( obj ) RESULT(ans) - CLASS(Mesh_), INTENT( IN ) :: obj - INTEGER( I4B ) :: ans - END FUNCTION getTotalBoundaryFacetElements -``` +import EXAMPLE5 from "../AbstractMesh/GetTotalBoundaryFacetElements.md"; + + diff --git a/docs/docs-api/FEMesh/GetTotalBoundaryNodes.md b/docs/docs-api/FEMesh/GetTotalBoundaryNodes.md index ff1eab32..170c4d4d 100644 --- a/docs/docs-api/FEMesh/GetTotalBoundaryNodes.md +++ b/docs/docs-api/FEMesh/GetTotalBoundaryNodes.md @@ -1,10 +1,11 @@ -# GetTotalBoundaryNodes +--- +title: GetTotalBoundaryNodes +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -```fortran - MODULE PURE FUNCTION getTotalBoundaryNodes(obj) RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - INTEGER(I4B) :: ans - END FUNCTION getTotalBoundaryNodes -``` +improt EXAMPLE5 from "../AbstractMesh/GetTotalBoundaryNodes.md"; + + diff --git a/docs/docs-api/FEMesh/GetTotalFacetElements.md b/docs/docs-api/FEMesh/GetTotalFacetElements.md index e1375d5e..f4fb5297 100644 --- a/docs/docs-api/FEMesh/GetTotalFacetElements.md +++ b/docs/docs-api/FEMesh/GetTotalFacetElements.md @@ -1,10 +1,12 @@ -# GetTotalFacetElements +--- +title: GetTotalFacetElements +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: + +import EXAMPLE5 from "../AbstractMesh/GetTotalFacetElements.md"; + + -```fortran - MODULE PURE FUNCTION getTotalFacetElements( obj ) RESULT( ans ) - CLASS(Mesh_), INTENT( IN ) :: obj - INTEGER( I4B ) :: ans - END FUNCTION getTotalFacetElements -``` diff --git a/docs/docs-api/FEMesh/GetTotalInternalFacetElements.md b/docs/docs-api/FEMesh/GetTotalInternalFacetElements.md index c05e987a..03c28410 100644 --- a/docs/docs-api/FEMesh/GetTotalInternalFacetElements.md +++ b/docs/docs-api/FEMesh/GetTotalInternalFacetElements.md @@ -1,10 +1,12 @@ -# GetTotalInternalFacetElements +--- +title: GetTotalInternalFacetElements +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: + +import EXAMPLE5 from "../AbstractMesh/GetTotalInternalFacetElements.md"; + + -```fortran - MODULE PURE FUNCTION getTotalInternalFacetElements( obj ) RESULT(ans) - CLASS(Mesh_), INTENT( IN ) :: obj - INTEGER( I4B ) :: ans - END FUNCTION getTotalInternalFacetElements -``` diff --git a/docs/docs-api/FEMesh/GetTotalInternalNodes.md b/docs/docs-api/FEMesh/GetTotalInternalNodes.md new file mode 100644 index 00000000..aac6ba47 --- /dev/null +++ b/docs/docs-api/FEMesh/GetTotalInternalNodes.md @@ -0,0 +1,12 @@ +--- +title: GetTotalInternalNodes +--- + +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: + + +import EXAMPLE5 from "../AbstractMesh/GetTotalInternalNodes.md"; + + diff --git a/docs/docs-api/FEMesh/GetTotalNodes.md b/docs/docs-api/FEMesh/GetTotalNodes.md index 214d6776..c204d085 100644 --- a/docs/docs-api/FEMesh/GetTotalNodes.md +++ b/docs/docs-api/FEMesh/GetTotalNodes.md @@ -1,10 +1,11 @@ -# GetTotalNodes +--- +title: GetTotalNodes +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -```fortran - MODULE PURE FUNCTION getTotalNodes(obj) RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - INTEGER(I4B) :: ans - END FUNCTION getTotalNodes -``` +import EXAMPLE5 from "../AbstractMesh/GetTotalNodes.md"; + + diff --git a/docs/docs-api/FEMesh/Initiate.md b/docs/docs-api/FEMesh/Initiate.md index f1558db4..a99e3611 100644 --- a/docs/docs-api/FEMesh/Initiate.md +++ b/docs/docs-api/FEMesh/Initiate.md @@ -3,14 +3,15 @@ sidebar_position: 3 title: Initiate --- + +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: + import EXAMPLE9 from "../AbstractMesh/Initiate.md"; -:::note Inheritence -Initiate method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. -::: - ## Examples ### Converting mesh from Gmsh to easifem format diff --git a/docs/docs-api/FEMesh/InitiateBoundaryData.md b/docs/docs-api/FEMesh/InitiateBoundaryData.md index 6eda0b31..0e8fd1d0 100644 --- a/docs/docs-api/FEMesh/InitiateBoundaryData.md +++ b/docs/docs-api/FEMesh/InitiateBoundaryData.md @@ -1,30 +1,11 @@ -# InitiateBoundaryData +--- +title: InitiateBoundaryData +--- -This method construct the boundary-element data. - -- It marks elements of mesh as `DOMAIN_BOUNDARY_ELEMENT` and `INTERNAL_ELEMENT`. -- In this case boundary elements are those which contains the boundary node. -- Boundary-node information is available by reading the mesh file, see mesh import method. -- It also forms `obj%elementData(ii)%boundaryData`. - -:::note -This subroutine treats all boundary element as `DOMAIN_BOUNDARY_ELEMENT` because it does not have information of surrouding mesh. However, this is not correct. This is because, not all mesh boundary elements are domain boundary elements. For example, some mesh-boundary element may be interface element between two mesh regions. This information can be corrected by calling [SetFacetElementType](../Domain/SetFacetElementType.md) method from [Domain_](../Domain/Domain_.md). +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. ::: -:::info -If we call [InitiateBoundaryData](../Domain/InitiateBoundaryData.md), then we do not have to call [SetFacetElementType](../Domain/SetFacetElementType.md) because the former routine makes an internal call to the latter. -::: - -This method needs following information: - -- `ElementToElements` -- `refelem` to construct the FacetElements +import EXAMPLE5 from "../AbstractMesh/InitiateBoundaryData.md"; -```fortran -INTERFACE - MODULE SUBROUTINE InitiateBoundaryData(obj) - CLASS(Mesh_), INTENT(INOUT) :: obj - !! mesh data - END SUBROUTINE InitiateBoundaryData -END INTERFACE -``` + diff --git a/docs/docs-api/FEMesh/InitiateElemSD.md b/docs/docs-api/FEMesh/InitiateElemSD.md index 49118b54..17745254 100644 --- a/docs/docs-api/FEMesh/InitiateElemSD.md +++ b/docs/docs-api/FEMesh/InitiateElemSD.md @@ -1,111 +1,11 @@ -# InitiateElemSD +--- +title: InitiateElemSD +--- -```fortran - MODULE SUBROUTINE InitiateElemSD(obj, & - & orderSpace, & - & linSpaceElem, & - & spaceElem, & - & quadTypeForSpace, & - & continuityTypeForSpace, & - & interpolTypeForSpace ) - CLASS(Mesh_), INTENT(INOUT) :: obj - INTEGER(I4B), INTENT(IN) :: orderSpace - !! integrand order in space - CLASS(ReferenceElement_), TARGET, INTENT(IN) :: linSpaceElem - !! linear (simplex) space element - CLASS(ReferenceElement_), TARGET, INTENT(IN) :: spaceElem - !! space element - CHARACTER(LEN=*), INTENT(IN) :: quadTypeForSpace - !! quadrature for space - CHARACTER(LEN=*), INTENT(IN) :: continuityTypeForSpace - !! continuity for base in space - CHARACTER(LEN=*), INTENT(IN) :: interpolTypeForSpace - !! interpolation type for base in space - END SUBROUTINE InitiateElemSD -``` +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -```fortran - MODULE SUBROUTINE mesh_initiateElemSD2(obj, & - & orderSpace, & - & linSpaceElem, & - & spaceElem, & - & quadTypeForSpace, & - & continuityTypeForSpace, & - & interpolTypeForSpace, & - & orderTime, & - & linTimeElem, & - & timeElem, & - & quadTypeForTime, & - & continuityTypeForTime, & - & interpolTypeForTime, & - & tvec) - CLASS(Mesh_), INTENT(INOUT) :: obj - INTEGER(I4B), INTENT(IN) :: orderSpace - !! integrand order in space - CLASS(ReferenceElement_), TARGET, INTENT(IN) :: linSpaceElem - !! linear space element - CLASS(ReferenceElement_), TARGET, INTENT(IN) :: spaceElem - !! space element - CHARACTER(LEN=*), INTENT(IN) :: quadTypeForSpace - !! quadrature type for space - CHARACTER(LEN=*), INTENT(IN) :: continuityTypeForSpace - !! continuity type of base in space - CHARACTER(LEN=*), INTENT(IN) :: interpolTypeForSpace - !! interpol type of base in space - INTEGER(I4B), INTENT(IN) :: orderTime - !! integrand order in time - TYPE(ReferenceLine_), INTENT(IN) :: linTimeElem - !! linear time element - TYPE(ReferenceLine_), INTENT(IN) :: timeElem - !! time element - CHARACTER(LEN=*), INTENT(IN) :: quadTypeForTime - !! quadrature type of base in time - CHARACTER(LEN=*), INTENT(IN) :: continuityTypeForTime - !! continuity type of base in time - CHARACTER(LEN=*), INTENT(IN) :: interpolTypeForTime - !! interpol type of base in time - REAL(DFP), INTENT(IN) :: tvec(:) - END SUBROUTINE mesh_initiateElemSD2 -``` +import EXAMPLE5 from "../AbstractMesh/InitiateElemSD.md"; -```fortran - MODULE SUBROUTINE mesh_initiateElemSD3(obj, & - & orderSpace, & - & linSpaceElem, & - & spaceElem, & - & quadTypeForSpace, & - & continuityTypeForSpace, & - & interpolTypeForSpace, & - & orderTime, & - & linTimeElem, & - & timeElem, & - & quadTypeForTime, & - & continuityTypeForTime, & - & interpolTypeForTime ) - CLASS(Mesh_), INTENT(INOUT) :: obj - INTEGER(I4B), INTENT(IN) :: orderSpace - !! integrand order in space - CLASS(ReferenceElement_), TARGET, INTENT(IN) :: linSpaceElem - !! linear space element - CLASS(ReferenceElement_), TARGET, INTENT(IN) :: spaceElem - !! space element - CHARACTER(LEN=*), INTENT(IN) :: quadTypeForSpace - !! quadrature type of base in space - CHARACTER(LEN=*), INTENT(IN) :: continuityTypeForSpace - !! continuity type of base in space - CHARACTER(LEN=*), INTENT(IN) :: interpolTypeForSpace - !! interpolation type of base in space - INTEGER(I4B), INTENT(IN) :: orderTime - !! integrand order in time - TYPE(ReferenceLine_), INTENT(IN) :: linTimeElem - !! linear time element - TYPE(ReferenceLine_), INTENT(IN) :: timeElem - !! time element - CHARACTER(LEN=*), INTENT(IN) :: quadTypeForTime - !! quadrature type of base in time - CHARACTER(LEN=*), INTENT(IN) :: continuityTypeForTime - !! continuity type of base in time - CHARACTER(LEN=*), INTENT(IN) :: interpolTypeForTime - !! interpolation type of base in time - END SUBROUTINE mesh_initiateElemSD3 -``` + diff --git a/docs/docs-api/FEMesh/InitiateElementToElements.md b/docs/docs-api/FEMesh/InitiateElementToElements.md index 03640493..b524ff7c 100644 --- a/docs/docs-api/FEMesh/InitiateElementToElements.md +++ b/docs/docs-api/FEMesh/InitiateElementToElements.md @@ -1,22 +1,12 @@ -# InitiateElementToElements +--- +title: InitiateElementToElements +--- -This routine creates the element surrounding a given element data +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -- Before calling this routine, make sure the `refelem` in mesh is allocated. -- By using `refelem`, this routine forms the FacetElements. -- This routine needs `nodeToElements` information, therefore, if `nodeToElements` is not initiated then it calls `initiateNodeToelements` method. +import EXAMPLE5 from "../AbstractMesh/InitiateElementToElements.md"; -- This method forms following data: -- `obj%elementData(ielem)%globalElements` -- It also identifies those elements which are boundary element of mesh, and set `obj%elementData(ielem)%elementType=BOUNDARY_ELEMENT` for those elements. -- Note that at this point these boundary-elements can be interface element - between two meshs, or domain-boundary element. + -```fortran -INTERFACE - MODULE SUBROUTINE InitiateElementToElements(obj) - CLASS(Mesh_), INTENT(INOUT) :: obj - !! mesh data - END SUBROUTINE InitiateElementToElements -END INTERFACE -``` diff --git a/docs/docs-api/FEMesh/InitiateExtraNodeToNodes.md b/docs/docs-api/FEMesh/InitiateExtraNodeToNodes.md index 189df003..2e79cfd2 100644 --- a/docs/docs-api/FEMesh/InitiateExtraNodeToNodes.md +++ b/docs/docs-api/FEMesh/InitiateExtraNodeToNodes.md @@ -1,20 +1,11 @@ -# InitiateExtraNodetoNodes +--- +title: InitiateExtraNodetoNodes +--- -This routine generate the node to nodes mapping +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -- This mapping is stored inside `obj%nodeData%extraGlobalNodeNum` -- For a local node number i, `obj%nodeData(i)%ExtraGlobalNodeNum` denotes the global node data surrounding the local node number used for edge-based stabilization. This list does not include self node. +import EXAMPLE5 from "../AbstractMesh/InitiateExtraNodeToNodes.md"; -- It needs information about `nodeToNodes`, `nodeToElements`, and `elementToElements`. Therefore, -- If `nodeToNodes` is not initiated, then this method initiates it. -- If `nodeToElements` is not initiated, then this method initiates it. -- If `elementToElements` is not initiated, then this method initiates it. - -```fortran -INTERFACE - MODULE SUBROUTINE InitiateExtraNodetoNodes(obj) - CLASS(Mesh_), INTENT(INOUT) :: obj - !! mesh data - END SUBROUTINE InitiateExtraNodetoNodes -END INTERFACE -``` + diff --git a/docs/docs-api/FEMesh/InitiateFacetElements.md b/docs/docs-api/FEMesh/InitiateFacetElements.md index 4a413e0b..fd1c82ec 100644 --- a/docs/docs-api/FEMesh/InitiateFacetElements.md +++ b/docs/docs-api/FEMesh/InitiateFacetElements.md @@ -2,43 +2,11 @@ title: InitiateFacetElements --- -This routine initiates the facet element data, such as [`BoundaryFacetData`](./BoundaryFacetData_.md) and [`InternalFacetData_`](./InternalFacetData_.md). -This routine needs the following information: - -- `ElementToElements`, if this information is not available, then it calls [InitiateElementToElements](./InitiateElementToElements.md). -- `BoundaryData`, if this information is not available, then it calls [InitiateBoundaryData](./InitiateBoundaryData.md). - -It makes following data structures: - -- [InternalFacetData_](./InternalFacetData_.md) -- [BoundaryFacetData_](./BoundaryFacetData_.md) -- `FacetElementType` field in [Mesh_](Mesh_.md) - -:::info - -- This method cannot differentiate between a `BOUNDARY_ELEMENT`, which is a boundary-facet-element at the mesh-boundary, and `DOMAIN_BOUNDARY_ELEMENT`, which is facet element at the domain’s boundary. -- This is because, at this point we only know that a boundary-facet-element is a domain-boundary-element, as we have no information about the neighboring mesh. -- Therefore, all `boundaryFacet` elements, at this level, are of type `DOMAIN_BOUNDARY_ELEMENT`. This is because every `DOMAIN_BOUNDARY_ELEMENT` is a `BOUNDARY_ELEMENT`. -- This information can be corrected only when we call [`SetDomainFacetElement`](../Domain/SetDomainFacetElement.md) from [Domain_](../Domain/Domain_.md) class. +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. ::: -:::note -If we call [`SetDomainFacetElement`](../Domain/SetDomainFacetElement.md) then we do not have to worry about the above point. -::: - -Please check documentation of following methods: - -- [`SetDomainFacetElement`](../Domain/SetDomainFacetElement.md) -- [`SetMeshFacetElement`](../Domain/SetMeshFacetElement.md) -- [`SetFacetElementType`](../Domain/SetFacetElementType.md) - -## Interface +import EXAMPLE5 from "../AbstractMesh/InitiateFacetElements.md"; -```fortran -INTERFACE - MODULE SUBROUTINE InitiateFacetElements(obj) - CLASS(Mesh_), INTENT(INOUT) :: obj - END SUBROUTINE InitiateFacetElements -END INTERFACE -``` + diff --git a/docs/docs-api/FEMesh/InitiateNodeToElements.md b/docs/docs-api/FEMesh/InitiateNodeToElements.md index 1b7474a1..1682ac8a 100644 --- a/docs/docs-api/FEMesh/InitiateNodeToElements.md +++ b/docs/docs-api/FEMesh/InitiateNodeToElements.md @@ -1,24 +1,11 @@ -# InitiateNodeToElements +--- +title: InitiateNodeToElements +--- -- This subroutine generates elements surrounding a node mapping, in other words it generates node to element. -- Element numbers returned by this routine are global element number. -- This mapping is stored inside `obj%nodeData` array -- For a local node number `ii`, `obj%nodeData(ii)%globalElements(:)` contains the global element numbers. - -:::note -Always use method called `getNodeToElements()` to access this information. -This method requires global Node number +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. ::: -:::caution -Always use the mapping between global node number and local node number to -avoid segmentation fault -::: +import EXAMPLE5 from "../AbstractMesh/InitiateNodeToElements.md"; -```fortran -INTERFACE - MODULE SUBROUTINE InitiateNodeToElements(obj) - CLASS(Mesh_), INTENT(INOUT) :: obj - END SUBROUTINE InitiateNodeToElements -END INTERFACE -``` + diff --git a/docs/docs-api/FEMesh/InitiateNodeToNodes.md b/docs/docs-api/FEMesh/InitiateNodeToNodes.md index e01a32db..8aa215ee 100644 --- a/docs/docs-api/FEMesh/InitiateNodeToNodes.md +++ b/docs/docs-api/FEMesh/InitiateNodeToNodes.md @@ -1,18 +1,11 @@ -# InitiateNodeToNodes +--- +title: InitiateNodeToNodes +--- -This routine generate the node to nodes mapping +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -- In other words, it generates info of node-numbers in mesh surrounding a node number -- This mapping is stored inside `obj%nodeData%globalNodeNum` -- For a local node number i, obj%nodeData(i)%globalNodeNum denotes the global node data surrounding the local node number. -- This list does not include self node. -- The method needs node-to-elements data, therefore if this data is not initiated, then this method calls `InitiateNodeToElements()`. +import EXAMPLE5 from "../AbstractMesh/InitiateNodeToNodes.md"; -```fortran -INTERFACE - MODULE SUBROUTINE InitiateNodetoNodes(obj) - CLASS(Mesh_), INTENT(INOUT) :: obj - !! mesh data - END SUBROUTINE InitiateNodetoNodes -END INTERFACE -``` + diff --git a/docs/docs-api/FEMesh/IsAllNodePresent.md b/docs/docs-api/FEMesh/IsAllNodePresent.md index a8311b33..afb38d3c 100644 --- a/docs/docs-api/FEMesh/IsAllNodePresent.md +++ b/docs/docs-api/FEMesh/IsAllNodePresent.md @@ -1,11 +1,11 @@ -# IsAllNodePresent +--- +title: IsAllNodePresent +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -```fortran - MODULE PURE FUNCTION isAllNodePresent(obj, globalNode) RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - INTEGER(I4B), INTENT(IN) :: globalNode( : ) - LOGICAL(LGT) :: ans - END FUNCTION isAllNodePresent -``` +import EXAMPLE5 from "../AbstractMesh/IsAllNodePresent.md"; + + diff --git a/docs/docs-api/FEMesh/IsAnyNodePresent.md b/docs/docs-api/FEMesh/IsAnyNodePresent.md index 13e4f999..6aa26c2a 100644 --- a/docs/docs-api/FEMesh/IsAnyNodePresent.md +++ b/docs/docs-api/FEMesh/IsAnyNodePresent.md @@ -1,11 +1,11 @@ -# IsAnyNodePresent +--- +title: IsAnyNodePresent +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -```fortran - MODULE PURE FUNCTION isAnyNodePresent(obj, globalNode) RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - INTEGER(I4B), INTENT(IN) :: globalNode( : ) - LOGICAL(LGT) :: ans - END FUNCTION isAnyNodePresent -``` +import EXAMPLE5 from "../AbstractMesh/IsAnyNodePresent.md"; + + diff --git a/docs/docs-api/FEMesh/IsBoundaryElement.md b/docs/docs-api/FEMesh/IsBoundaryElement.md index eaa1ca27..8372944d 100644 --- a/docs/docs-api/FEMesh/IsBoundaryElement.md +++ b/docs/docs-api/FEMesh/IsBoundaryElement.md @@ -1,12 +1,11 @@ -# IsBoundaryElement +--- +title: IsBoundaryElement +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -```fortran - MODULE PURE FUNCTION isBoundaryElement(obj, globalElement) & - & RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - INTEGER(I4B), INTENT(IN) :: globalElement - LOGICAL(LGT) :: ans - END FUNCTION isBoundaryElement -``` +import EXAMPLE5 from "../AbstractMesh/IsBoundaryElement.md"; + + diff --git a/docs/docs-api/FEMesh/IsBoundaryNode.md b/docs/docs-api/FEMesh/IsBoundaryNode.md index 3649415a..bbde7767 100644 --- a/docs/docs-api/FEMesh/IsBoundaryNode.md +++ b/docs/docs-api/FEMesh/IsBoundaryNode.md @@ -1,11 +1,12 @@ -# IsBoundaryNode +--- +title: IsBoundaryNode +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: + +import EXAMPLE5 from "../AbstractMesh/IsBoundaryNode.md"; + + -```fortran - MODULE PURE FUNCTION isBoundaryNode(obj, globalNode) RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - INTEGER(I4B), INTENT(IN) :: globalNode - LOGICAL(LGT) :: ans - END FUNCTION isBoundaryNode -``` diff --git a/docs/docs-api/FEMesh/IsDomainBoundaryElement.md b/docs/docs-api/FEMesh/IsDomainBoundaryElement.md index b283dfc0..977fcf97 100644 --- a/docs/docs-api/FEMesh/IsDomainBoundaryElement.md +++ b/docs/docs-api/FEMesh/IsDomainBoundaryElement.md @@ -1,12 +1,11 @@ -# IsDomainBoundaryElement +--- +title: IsDomainBoundaryElement +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -```fortran - MODULE PURE FUNCTION isDomainBoundaryElement(obj, globalElement) & - & RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - INTEGER(I4B), INTENT(IN) :: globalElement - LOGICAL(LGT) :: ans - END FUNCTION isDomainBoundaryElement -``` +import EXAMPLE5 from "../AbstractMesh/IsDomainBoundaryElement.md"; + + diff --git a/docs/docs-api/FEMesh/IsElementPresent.md b/docs/docs-api/FEMesh/IsElementPresent.md index d742df22..1e2ee794 100644 --- a/docs/docs-api/FEMesh/IsElementPresent.md +++ b/docs/docs-api/FEMesh/IsElementPresent.md @@ -1,11 +1,11 @@ -# IsElementPresent +--- +title: IsElementPresent +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -```fortran - MODULE PURE FUNCTION isElementPresent(obj, GlobalElement) RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - INTEGER(I4B), INTENT(IN) :: GlobalElement - LOGICAL(LGT) :: ans - END FUNCTION isElementPresent -``` +import EXAMPLE5 from "../AbstractMesh/IsElementPresent.md"; + + diff --git a/docs/docs-api/FEMesh/IsNodePresent.md b/docs/docs-api/FEMesh/IsNodePresent.md index 82b515ce..0c3927d8 100644 --- a/docs/docs-api/FEMesh/IsNodePresent.md +++ b/docs/docs-api/FEMesh/IsNodePresent.md @@ -1,11 +1,11 @@ -# IsNodePresent +--- +title: IsNodePresent +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -```fortran - MODULE PURE FUNCTION isNodePresent(obj, globalNode) RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - INTEGER(I4B), INTENT(IN) :: globalNode - LOGICAL(LGT) :: ans - END FUNCTION isNodePresent -``` +import EXAMPLE5 from "../AbstractMesh/IsNodePresent.md"; + + diff --git a/docs/docs-api/FEMesh/IsTotalInternalNodes.md b/docs/docs-api/FEMesh/IsTotalInternalNodes.md deleted file mode 100644 index e49a09bf..00000000 --- a/docs/docs-api/FEMesh/IsTotalInternalNodes.md +++ /dev/null @@ -1,10 +0,0 @@ -# GetTotalInternalNodes - -## Interface - -```fortran - MODULE PURE FUNCTION getTotalInternalNodes(obj) RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - INTEGER(I4B) :: ans - END FUNCTION getTotalInternalNodes -``` diff --git a/docs/docs-api/FEMesh/SetSparsity.md b/docs/docs-api/FEMesh/SetSparsity.md index 5ee98896..fafa43bf 100644 --- a/docs/docs-api/FEMesh/SetSparsity.md +++ b/docs/docs-api/FEMesh/SetSparsity.md @@ -1,97 +1,11 @@ -# SetSparsity +--- +title: SetSparsity +---- -This method sets the sparsity in the `CSRMatrix`. +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: - +import EXAMPLE5 from "../AbstractMesh/SetSparsity.md"; -## Interface 1 - -```fortran -INTERFACE - MODULE SUBROUTINE obj_SetSparsity1(obj, mat, localNodeNumber, lbound, & - & ubound) - CLASS(AbstractMesh_), INTENT(INOUT) :: obj - !! [[Mesh_]] class - TYPE(CSRMatrix_), INTENT(INOUT) :: mat - !! [[CSRMatrix_]] object - INTEGER(I4B), INTENT(IN) :: lbound - INTEGER(I4B), INTENT(IN) :: ubound - INTEGER(I4B), INTENT(IN) :: localNodeNumber(lbound:ubound) - !! Global to local node number map - END SUBROUTINE obj_SetSparsity1 -END INTERFACE -``` - -- `localNodeNumber` is used to convert the global node numbers of mesh to local node number in `mat` -- `lbound` and `ubound` are bounds of `localNodeNumber` - -The algorithm is as follows: - -1. Start loop of node numbers in mesh -2. Get the global node number of mesh -3. Get the global node numbers around this node -4. Use `localNodeNumber` to get the local node number of global node number (from step 3) -5. Call `SetSparsity` on `mat` from `base` lib. - -## Interface 2 - -```fortran -INTERFACE - MODULE SUBROUTINE obj_SetSparsity2(obj, mat) - CLASS(AbstractMesh_), INTENT(INOUT) :: obj - !! Mesh_ class - TYPE(CSRMatrix_), INTENT(INOUT) :: mat - !! CSRMatrix object - END SUBROUTINE obj_SetSparsity2 -END INTERFACE -``` - -## Inteface 3 - -```fortran -INTERFACE - MODULE SUBROUTINE obj_SetSparsity3(obj, colMesh, nodeToNode, mat, & - & ivar, jvar) - CLASS(AbstractMesh_), INTENT(INOUT) :: obj - !! Abstract mesh class - CLASS(AbstractMesh_), INTENT(INOUT) :: colMesh - !! Abstract mesh class - INTEGER(I4B), INTENT(IN) :: nodeToNode(:) - !! Node to node connectivity between obj and colMesh - TYPE(CSRMatrix_), INTENT(INOUT) :: mat - !! [[CSRMatrix_]] object - INTEGER(I4B), INTENT(IN) :: ivar - INTEGER(I4B), INTENT(IN) :: jvar - END SUBROUTINE obj_SetSparsity3 -END INTERFACE -``` - -## Interface 4 - -```fortran -INTERFACE - MODULE SUBROUTINE obj_SetSparsity4(obj, colMesh, nodeToNode, mat, & - rowGlobalToLocalNodeNum, rowLBOUND, rowUBOUND, & - colGlobalToLocalNodeNum, colLBOUND, colUBOUND, ivar, jvar) - CLASS(AbstractMesh_), INTENT(INOUT) :: obj - !! [[Mesh_]] class - CLASS(AbstractMesh_), INTENT(INOUT) :: colMesh - !! [[Mesh_]] class - INTEGER(I4B), INTENT(IN) :: nodeToNode(:) - !! node to node connectivity between obj and colMesh - TYPE(CSRMatrix_), INTENT(INOUT) :: mat - !! [[CSRMatrix_]] object - INTEGER(I4B), INTENT(IN) :: rowLBOUND - INTEGER(I4B), INTENT(IN) :: rowUBOUND - INTEGER(I4B), INTENT(IN) :: rowGlobalToLocalNodeNum( & - & rowLBOUND:rowUBOUND) - !! Global to local node number map - INTEGER(I4B), INTENT(IN) :: colLBOUND - INTEGER(I4B), INTENT(IN) :: colUBOUND - INTEGER(I4B), INTENT(IN) :: colGlobalToLocalNodeNum( & - & colLBOUND:colUBOUND) - INTEGER(I4B), INTENT(IN) :: ivar - INTEGER(I4B), INTENT(IN) :: jvar - END SUBROUTINE obj_SetSparsity4 -END INTERFACE -``` + diff --git a/docs/docs-api/FEMesh/Size.md b/docs/docs-api/FEMesh/Size.md index 23e512e6..e8133eb0 100644 --- a/docs/docs-api/FEMesh/Size.md +++ b/docs/docs-api/FEMesh/Size.md @@ -1,11 +1,11 @@ -# Size +--- +title: Size +--- -## Interface +:::tip Inheritence +This method is inherited from the [AbstractMesh](../AbstractMesh/AbstractMesh_.md) class. +::: -```fortran - MODULE PURE FUNCTION size(obj) RESULT(ans) - CLASS(Mesh_), INTENT(IN) :: obj - !! mesh object - INTEGER(I4B) :: ans - END FUNCTION size -``` +import EXAMPLE5 from "../AbstractMesh/Size.md"; + + diff --git a/docs/docs-api/ScalarField/examples/_ScalarField_test_12.md b/docs/docs-api/ScalarField/examples/_ScalarField_test_12.md index 3ce9d922..59125834 100644 --- a/docs/docs-api/ScalarField/examples/_ScalarField_test_12.md +++ b/docs/docs-api/ScalarField/examples/_ScalarField_test_12.md @@ -1,5 +1,3 @@ -In this example we test [Get](./Set.md) method. - ```fortran PROGRAM main USE easifemBase @@ -21,7 +19,7 @@ PROGRAM main CALL resultFile%open() ``` -```fortran title="read domain" +```fortran title="read domain" !> start creating domain CALL meshfile%initiate( filename="./mesh.h5", mode="READ" ) CALL meshfile%open() diff --git a/docs/docs-api/ScalarField/examples/_ScalarField_test_13.md b/docs/docs-api/ScalarField/examples/_ScalarField_test_13.md index b8a626bc..fa0311ca 100644 --- a/docs/docs-api/ScalarField/examples/_ScalarField_test_13.md +++ b/docs/docs-api/ScalarField/examples/_ScalarField_test_13.md @@ -1,5 +1,3 @@ -In this example we test [Get](./Set.md) method. - ```fortran PROGRAM main USE easifemBase diff --git a/docs/docs-api/ScalarField/examples/_ScalarField_test_14.md b/docs/docs-api/ScalarField/examples/_ScalarField_test_14.md index b333b541..17033933 100644 --- a/docs/docs-api/ScalarField/examples/_ScalarField_test_14.md +++ b/docs/docs-api/ScalarField/examples/_ScalarField_test_14.md @@ -1,5 +1,3 @@ -In this example we test [Get](./Set.md) method. - ```fortran PROGRAM main USE easifemBase diff --git a/docs/docs-api/ScalarField/examples/_ScalarField_test_15.md b/docs/docs-api/ScalarField/examples/_ScalarField_test_15.md index 88b0747f..d7fab14e 100644 --- a/docs/docs-api/ScalarField/examples/_ScalarField_test_15.md +++ b/docs/docs-api/ScalarField/examples/_ScalarField_test_15.md @@ -1,5 +1,3 @@ -In this example we test [Get](./Set.md) method. - ```fortran PROGRAM main USE easifemBase