Fixed docs

PeriHub · Mar 25, 2024 · 5362663 · 5362663
1 parent 491be3e
commit 5362663
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 23 deletions.
diff --git a/docs/src/man/physics/additive.md b/docs/src/man/physics/additive.md
@@ -2,7 +2,7 @@
 
 | Additive Model           | Simple |
 |------------------------|:----------------:|
-| Print Temperature         | :heavy_check_mark:|
+| Print Temperature         | ✔️|
 
 
 ## Simple
diff --git a/docs/src/man/physics/damage.md b/docs/src/man/physics/damage.md
@@ -2,9 +2,9 @@
 
 | Damage Model           | Critical Stretch | Critical Energy |
 |------------------------|:----------------:|:---------------:|
-| Critical Value         | :heavy_check_mark:| :heavy_check_mark:|
-| Interblock Damage      | (:heavy_check_mark:)| (:heavy_check_mark:)|
-| Anisotropic Damage     | (:heavy_check_mark:)| (:heavy_check_mark:)|
+| Critical Value         | ✔️| ✔️|
+| Interblock Damage      | (✔️)| (✔️)|
+| Anisotropic Damage     | (✔️)| (✔️)|
 
 ## Critical Stretch
 

diff --git a/docs/src/man/physics/materials.md b/docs/src/man/physics/materials.md
@@ -1,27 +1,26 @@
 # Material Models
 
 ## Existing Models
-The physics related functions can be found [here](
-https://perihub.github.io/PeriLab.jl/stable/lib/physics_functions/
-).
+The physics related functions can be found [here](@ref "Physics - Functions").
+
 | Method | Related Model in PeriLab |
 |---|---|
-| [Bond-based](theory/basics.md#Bond-based) | [Bond-based Elastic](https://gitlab.com/dlr-perihub/PeriLab.jl/-/blob/main/src/Physics/Material/BondBased/Bondbased_Elastic.jl) |
-| [Ordinary state-based](theory/basics.md#PD_Solind) | [PD Solid Elastic](https://gitlab.com/dlr-perihub/PeriLab.jl/-/blob/main/src/Physics/Material/Material_Models/PD_Solid_Elastic.jl) [PD Solid Plastic](https://gitlab.com/dlr-perihub/PeriLab.jl/-/blob/main/src/Physics/Material/Material_Models/PD_Solid_Plastic.jl) |
-|[Non-ordinary state-based](theory/basics.md#Correspondence)| [Correspondence Elastic](https://gitlab.com/dlr-perihub/PeriLab.jl/-/blob/main/src/Physics/Material/Material_Models/Correspondence_Elastic.jl) [Correspondence Plastic](https://gitlab.com/dlr-perihub/PeriLab.jl/-/blob/main/src/Physics/Material/Material_Models/Correspondence_Plastic.jl)|
+| [Bond-based](@ref "Theory Basics") | [Bond-based Elastic](https://github.com/PeriHub/PeriLab.jl/blob/main/src/Physics/Material/BondBased/Bondbased_Elastic.jl) |
+| [Ordinary state-based](@ref "Theory Basics") | [PD Solid Elastic](https://github.com/PeriHub/PeriLab.jl/blob/main/src/Physics/Material/Material_Models/PD_Solid_Elastic.jl), [PD Solid Plastic](https://github.com/PeriHub/PeriLab.jl/blob/main/src/Physics/Material/Material_Models/PD_Solid_Plastic.jl) |
+|[Non-ordinary state-based](@ref "Theory Basics")| [Correspondence Elastic](https://github.com/PeriHub/PeriLab.jl/blob/main/src/Physics/Material/Material_Models/Correspondence_Elastic.jl), [Correspondence Plastic](https://github.com/PeriHub/PeriLab.jl/blob/main/src/Physics/Material/Material_Models/Correspondence_Plastic.jl)|
 
 
 | Material Model             | Bond-based Elastic | PD Solid Elastic | PD Solid Plastic | Correspondence Elastic | Correspondence Plastic |
 |----------------------------|-------------------|------------------|------------------|------------------------|------------------------|
-| Symmetry                   | :heavy_check_mark:| :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark:     | :heavy_check_mark:     |
-| Poisson's/Young's/Bulk/Shear | :heavy_check_mark:| :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark:     | :heavy_check_mark:     |
-| Yield Stress               |                   |                  | :heavy_check_mark:|                        | :heavy_check_mark:     |
-| Zero Energy Control        |                   |                  |                  | :heavy_check_mark:     | :heavy_check_mark:     |
-| C11/C12/.../C66            | (:heavy_check_mark:)| (:heavy_check_mark:) | (:heavy_check_mark:) | (:heavy_check_mark:)     | (:heavy_check_mark:)     |
+| Symmetry                   | ✔️| ✔️ | ✔️ | ✔️     | ✔️     |
+| Poisson's/Young's/Bulk/Shear | ✔️| ✔️ | ✔️ | ✔️     | ✔️     |
+| Yield Stress               |                   |                  | ✔️|                        | ✔️     |
+| Zero Energy Control        |                   |                  |                  | ✔️     | ✔️     |
+| C11/C12/.../C66            | (✔️)| (✔️) | (✔️) | (✔️)     | (✔️)     |
 
 ## Bond-based Elastic
 
-The theory of the bond-based elastic material can be found [here](theory/basics.md#Bond-based)
+The theory of the bond-based elastic material can be found [here](@ref "Theory Basics")
 
 Material parameter
 tabelle

diff --git a/docs/src/man/physics/thermal.md b/docs/src/man/physics/thermal.md
@@ -2,13 +2,13 @@
 
 | Thermal Model                 | Thermal Expansion | Thermal Flow | Heat Transfer |
 |-------------------------------|-------------------|--------------|---------------|
-| Type                          | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
-| Heat Transfer Coefficient     | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
-| Environmental Temperature     | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
-| Thermal Conductivity          |                   |              | :heavy_check_mark: |
-| Thermal Expansion Coefficient | :heavy_check_mark: |              |               |
-| Thermal Conductivity Print Bed|                   |              | :heavy_check_mark: |
-| Print Bed Temperature         |                   |              | :heavy_check_mark: |
+| Type                          | ✔️ | ✔️ | ✔️ |
+| Heat Transfer Coefficient     | ✔️ | ✔️ | ✔️ |
+| Environmental Temperature     | ✔️ | ✔️ | ✔️ |
+| Thermal Conductivity          |                   |              | ✔️ |
+| Thermal Expansion Coefficient | ✔️ |              |               |
+| Thermal Conductivity Print Bed|                   |              | ✔️ |
+| Print Bed Temperature         |                   |              | ✔️ |
 
 
 ## Thermal Expansion

diff --git a/docs/src/theory/basics.md b/docs/src/theory/basics.md
@@ -1,3 +1,5 @@
+# Theory Basics
+
 Peridynamics is an integral continuum mechanics formulation. For a pure mechanical description it can be formulated as:
 
 $$\int_{\mathcal{H}}\underline{\mathbf{T}}\langle\mathbf{x},t\rangle-\underline{\mathbf{T}}\langle\mathbf{x}',t\rangle dV- \mathbf{b}=\rho\ddot{\mathbf{u}} $$