diff --git a/README.md b/README.md index 7a915ab6..b89cefc6 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ pip install "engibench[all]" ```python -from engibench.problems.beams2d.v0 import Beams2D +from engibench.problems.beams2d.v1 import Beams2D # Create a problem problem = Beams2D(seed=0) diff --git a/docs/index.md b/docs/index.md index 0afdeb7f..1330d40c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -54,8 +54,7 @@ introduction/api problems/airfoil problems/beams2d -problems/thermoelastic2d -problems/thermoelastic3d +problems/thermoelastic problems/photonics2d problems/power_electronics problems/heatconduction diff --git a/docs/introduction/basic_usage.md b/docs/introduction/basic_usage.md index f914343d..98d93214 100644 --- a/docs/introduction/basic_usage.md +++ b/docs/introduction/basic_usage.md @@ -3,7 +3,7 @@ Our API is designed to be simple and easy to use. Here is a basic example of how to use EngiBench to create a problem, get the dataset, and evaluate a design. ```python -from engibench.problems.beams2d.v0 import Beams2D +from engibench.problems.beams2d.v1 import Beams2D # Create a problem problem = Beams2D(seed=0) diff --git a/docs/problems/heatconduction.md b/docs/problems/heatconduction.md index f5d4066e..206eafac 100644 --- a/docs/problems/heatconduction.md +++ b/docs/problems/heatconduction.md @@ -1,4 +1,4 @@ -# Heat Conduction +# HeatConduction These problems represent typical topology optimization problems where the goal is to decide where to place material in the design domain. @@ -13,8 +13,8 @@ These problems represent typical topology optimization problems where the goal i We provide two versions for this problem: -- [Heat Conduction 2D](./heatconduction2d.md) In this problem, we optimize a 2D slice of an object. -- [Heat Conduction 3D](./heatconduction3d.md) This version is heavier, we optimize a 3D object. +- [HeatConduction2D](./heatconduction2d.md) In this problem, we optimize a 2D slice of an object. +- [HeatConduction3D](./heatconduction3d.md) This version is heavier, we optimize a 3D object. ```{toctree} :hidden: diff --git a/docs/problems/heatconduction2d.md b/docs/problems/heatconduction2d.md index d6b99b8a..bd5064ee 100644 --- a/docs/problems/heatconduction2d.md +++ b/docs/problems/heatconduction2d.md @@ -1,4 +1,4 @@ -# Heat Conduction 2D +# HeatConduction2D ``` {problem:table} :lead: Milad Habibi @MIladHB diff --git a/docs/problems/heatconduction3d.md b/docs/problems/heatconduction3d.md index 91ab0207..a3f62e8e 100644 --- a/docs/problems/heatconduction3d.md +++ b/docs/problems/heatconduction3d.md @@ -1,4 +1,4 @@ -# Heat Conduction 3D +# HeatConduction3D ``` {problem:table} :lead: Milad Habibi @MIladHB diff --git a/docs/problems/thermoelastic.md b/docs/problems/thermoelastic.md new file mode 100644 index 00000000..acc9e694 --- /dev/null +++ b/docs/problems/thermoelastic.md @@ -0,0 +1,24 @@ +# Thermoelastic + +These problems represent multi-physics topology optimization problems that capture the coupling between structural and thermal domains. + + +
+
+ Thermoelastic 2D problem setup + Thermoelastic 3D problem setup +
+
Left: 2D version, Right: 3D version
+
+ + +We provide two versions for this problem: +- [Thermoelastic2D](./thermoelastic2d.md) A 2D multi-physics topology optimization problem. +- [Thermoelastic3D](./thermoelastic3d.md) The 3D extension of the thermoelastic problem. + +```{toctree} +:hidden: + +./thermoelastic2d +./thermoelastic3d +``` diff --git a/tutorial.ipynb b/tutorial.ipynb index e257cb30..24977ce2 100644 --- a/tutorial.ipynb +++ b/tutorial.ipynb @@ -109,7 +109,7 @@ "metadata": {}, "outputs": [], "source": [ - "from engibench.problems.beams2d.v0 import Beams2D" + "from engibench.problems.beams2d.v1 import Beams2D" ] }, {