Skip to content

Commit f36961d

Browse files
committed
Clean up docs
1 parent ccb961d commit f36961d

File tree

8 files changed

+19
-53
lines changed

8 files changed

+19
-53
lines changed

docs/benchmarks/index.md

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,3 @@
11
# Introduction to the benchmarks
22

3-
## TODO
4-
5-
* [ ] What format should the benchmark data be stored in?
6-
* Full fields? -> VMAP or scripting interfaces to solvers ([Abaqus scripting](https://classes.engineering.wustl.edu/2009/spring/mase5513/abaqus/docs/v6.5/books/cmd/default.htm?startat=pt02ch04s05.html), [PyAnsys postprocessing](https://post.docs.pyansys.com/version/stable/), [pybaqus](https://github.com/cristobaltapia/pybaqus/tree/master))
7-
* Only scalar values from sensors?
8-
* Ontology for benchmark results? [NFDI4Ing Metadata Profile service](https://profiles.nfdi4ing.de/#/editor)
9-
* [ ] How do we deal with quadrature values like stresses?
10-
* Mapping to nodes? -> [Discussion on fenics forum](https://fenicsproject.discourse.group/t/comparative-analysis-ansys-vs-fenicsx-displacement-in-linear-elasticity/13398)
11-
* Can we export quadrature values and do the mapping ourselves?
12-
* [ ] What is a good result?
13-
* Should we always do mesh-convergence? Cauchy series, if analytical solution is not known?
14-
* [ ] Which element types? Linear, quadratic? underintegrated?
15-
* [ ] What is a sufficient format do describe an algorithm?
16-
* Are algorithm boxes with noting more complicated than a matrix-vector product enough?
17-
* Do we always need a reference implementation?
18-
* [x] Is it _easy_ to link a umat/usermat?
19-
* We think so. Both Abaqus and Ansys can link dynamically at runtime. You can also compile a new `ansys.exe`, but it is not required and mainly recommended for shipping the model.
3+
**todo**

docs/benchmarks/linear elasticity/mms_elasticity.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@
255255
"name": "python",
256256
"nbconvert_exporter": "python",
257257
"pygments_lexer": "ipython3",
258-
"version": "3.12.4"
258+
"version": "3.13.1"
259259
},
260260
"orig_nbformat": 4
261261
},

docs/benchmarks/linear elasticity/one-element-tests.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

docs/benchmarks/linear elasticity/patch-test.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/benchmarks/linear elasticity/plate_with_hole_Kratos.ipynb

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
{
22
"cells": [
3+
{
4+
"cell_type": "markdown",
5+
"metadata": {},
6+
"source": [
7+
"\n",
8+
"# Postprocessing for Kratos example\n",
9+
"\n",
10+
"[![Jupyter4NFDI](https://nfdi-jupyter.de/images/jupyter4nfdi_badge.svg)](https://hub.nfdi-jupyter.de/v2/gh/BAMresearch/NFDI4IngModelValidationPlatform/HEAD?labpath=docs%2Fbenchmarks%2Flinear%20elasticity%2Fplate_with_hole_Kratos.ipynb)"
11+
]
12+
},
313
{
414
"cell_type": "code",
515
"execution_count": 1,

docs/benchmarks/plasticity/mms_plasticity.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@
202202
"name": "python",
203203
"nbconvert_exporter": "python",
204204
"pygments_lexer": "ipython3",
205-
"version": "3.12.4"
205+
"version": "3.13.1"
206206
},
207207
"orig_nbformat": 4
208208
},

docs/index.md

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,3 @@
1-
# Welcome the NFDI4Ing Model Validation Platform
2-
3-
This platform aims to validate implementations of mechanical constitutive models.
4-
5-
## Current goals (Wonderpill)
6-
7-
1. Create a generalized interface design for user-defined material model (e.g. UMATs in Abaqus) such that
8-
1. you can easily convert a constitutive model from any commercial or non-commercial FEM solver to this interface such that interoperability between solvers is possible,
9-
2. the implemented models can be any small-strain, large-deformation model.
10-
2. Establish a comprehensive set of numerical benchmarks for:
11-
1. Linear elasticity
12-
* Critical factors include element order, mapping stresses to nodes, combined rotation and stretch
13-
2. Mises plasticity with linear isotropinc hardening
14-
* Critical factors include loading, unloading, reloading
15-
3. Dynamic test case for linear elasticity (some form of wave propagation)
16-
3. Parts of the platform
17-
1. A website for the visualization of benchmark results in the form of interactive jupyter notebooks
18-
2. GitHub repository with the validation workflows
19-
3. Excecution platform for the workflows (optional goal because of licensing issues)
20-
4. Database platform for benchmark results
1+
# Welcome the NFDI4Ing Model Validation/Verification Platform
212

3+
**todo**

mkdocs.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,12 @@ markdown_extensions:
3434

3535
nav:
3636
- index.md
37-
- conventions.md
38-
- data.md
39-
- interface.md
37+
#- conventions.md
38+
#- data.md
39+
#- interface.md
4040
- Benchmarks:
4141
- Introduction: "benchmarks/index.md"
4242
- Linear Elasticity: "benchmarks/linear elasticity"
43-
- Plasticity: benchmarks/plasticity
43+
#- Plasticity: benchmarks/plasticity
4444
- "zz_bibliography.md"
4545

0 commit comments

Comments
 (0)