#355 Added menard equations 2.21 and 2.22 of CUR 228 #356

johan-tuls · 2024-10-16T10:53:37Z

Description

Added Menard equations CUR 228

Please delete options that are not relevant.

[X ] New feature (non-breaking change which adds functionality)
[ X] This change requires a documentation update

Checklist:

[ X] I have added tests that prove my fix is effective or that my feature works
[ X] I have commented my code, particularly in hard-to-understand areas
[ X] I have made corresponding changes to the documentation
[ X] New and existing unit tests pass locally with my changes

github-actions · 2024-10-16T10:53:49Z

Thank you so much for contributing to Blueprints! This is your Pull Request # 2 to this project.
Your contributions help thousands of engineers work more efficiently and accurately.

Now that you've created your pull request, please don't go away; take a look at the bottom of this page for the automated checks that should already be running. If they pass, great! If not, please click on 'Details' and see if you can fix the problem they've identified. A maintainer should be along shortly to review your pull request and help get it added!

blueprints/codes/cur/cur_228/formula_2_22.py

Co-authored-by: PabloVasconez <[email protected]>

rickdegoeij

bit nitpicky sometimes, so feel free to interpret the comments :)

Comments that need address:

Latex equations don't match implementation
unittests for negative values
add negative value checks in 2.22
unittest for correctness of latex equations

rickdegoeij · 2024-10-16T12:41:12Z

blueprints/codes/cur/cur_228/formula_2_22.py

+    @staticmethod
+    def _evaluate(r: M, e_p: KPA, alpha: float) -> KN_M3:
+        """Return the Menard stiffness k_h when r >= 0.3 m [kN/m3]."""
+        if r < 0.3:


Here 0.3 is hardcoded, but in 2.21 it's a static value. Maybe refer to the same constant in a constant file

rickdegoeij · 2024-10-16T12:41:53Z

blueprints/codes/cur/cur_228/formula_2_22.py

+        """Return the Menard stiffness k_h when r >= 0.3 m [kN/m3]."""
+        if r < 0.3:
+            return e_p / 2 / r / ((4 * 2.65**alpha + 3 * alpha) / 18)
+        msg = "Radius is equal to- or larger than 0.3m, use: Eq2Dot21MenardStiffness"


if using constant maybe change this to a f-string and then put the r_0 in there

rickdegoeij · 2024-10-16T12:44:33Z

blueprints/codes/cur/cur_228/formula_2_22.py

+        return LatexFormula(
+            return_symbol=r"k_{h}",
+            result=f"{self:.{n}f} kN/m3",
+            equation=r"\frac{2 \cdot R}{E_{p}} \cdot \frac{4 \cdot 2.65^{\alpha} + 3 \alpha}{18}",


this is the original equation, but the return symbol is k_h

the original 2.22 returns 1 / k_h

rickdegoeij · 2024-10-16T12:46:29Z

blueprints/codes/cur/cur_228/formula_2_21.py

+
+        return LatexFormula(
+            return_symbol="k_{h}",
+            equation=r"\frac{1}{3 \cdot E_{p}} \cdot "


this is the original equation, but the return symbol is k_h

the original 2.21 returns 1 / k_h

rickdegoeij · 2024-10-16T12:54:37Z

blueprints/codes/cur/cur_228/formula_2_21.py

+            rf"\left[1.3 \cdot {self.r_0 :.{n}} "
+            rf"\left( 2.65 \cdot \frac{{{self.r :.{n}}}}{{{self.r_0 :.{n}}}}\right)^{{{self.alpha :.{n}f}}}"
+            rf"+ {self.alpha :.{n}} \cdot {self.r :.{n}}\right]",
+            result=f"{self.result :.{n_decimals}f}",


n_decimals used instead of n. (doesn't change result)

rickdegoeij · 2024-10-16T13:01:31Z

tests/codes/cur/cur_228/test_formula_2_21.py

+from blueprints.codes.cur.cur_228.formula_2_21 import Form2Dot21MenardStiffness
+
+
+class TestForm2Dot21MenardStiffness:


add test with invalid values for e_p

rickdegoeij · 2024-10-16T13:13:15Z

blueprints/codes/cur/cur_228/formula_2_22.py

+
+    @staticmethod
+    def _evaluate(r: M, e_p: KPA, alpha: float) -> KN_M3:
+        """Return the Menard stiffness k_h when r >= 0.3 m [kN/m3]."""


add checks for negative numbers

Suggested change

"""Return the Menard stiffness k_h when r >= 0.3 m [kN/m3]."""

"""Return the Menard stiffness k_h when r >= 0.3 m [kN/m3]."""

raise_if_negative(r=r, e_p=e_p, alpha=alpha)

rickdegoeij · 2024-10-16T13:14:16Z

tests/codes/cur/cur_228/test_formula_2_22.py

+from blueprints.codes.cur.cur_228.formula_2_22 import Form2Dot22MenardStiffness
+
+
+class TestForm2Dot22MenardStiffness:


I would probably add some tests for the raise if negative checks. To make sure it's captured

rickdegoeij · 2024-10-16T13:18:27Z

blueprints/codes/cur/cur_228/formula_2_22.py

+from blueprints.type_alias import KN_M3, KPA, M
+
+
+class Form2Dot22MenardStiffness(Formula):
+    """Representation of equation 2.22 CUR 228."""
+
+    source_document = CUR_228
+    label = "2.22"
+
+    def __init__(self, r: M, e_p: KPA, alpha: float) -> None:


Use dimensionless instead of float

Suggested change

from blueprints.type_alias import KN_M3, KPA, M

class Form2Dot22MenardStiffness(Formula):

"""Representation of equation 2.22 CUR 228."""

source_document = CUR_228

label = "2.22"

def __init__(self, r: M, e_p: KPA, alpha: float) -> None:

from blueprints.type_alias import KN_M3, KPA, M, DIMENSIONLESS

class Form2Dot22MenardStiffness(Formula):

"""Representation of equation 2.22 CUR 228."""

source_document = CUR_228

label = "2.22"

def __init__(self, r: M, e_p: KPA, alpha: DIMENSIONLESS) -> None:

rickdegoeij · 2024-10-16T13:19:22Z

blueprints/codes/cur/cur_228/formula_2_21.py

+from blueprints.type_alias import KN_M3, KPA, M
+from blueprints.validations import raise_if_negative
+
+
+class Form2Dot21MenardStiffness(Formula):
+    """Representation of equation 2.21 CUR 228."""
+
+    source_document = CUR_228
+    label = "2.21"
+    r_0: M = 0.3
+
+    def __init__(self, r: M, e_p: KPA, alpha: float) -> None:


Use DIMENSIONLESS instead of float

Suggested change

from blueprints.type_alias import KN_M3, KPA, M

from blueprints.validations import raise_if_negative

class Form2Dot21MenardStiffness(Formula):

"""Representation of equation 2.21 CUR 228."""

source_document = CUR_228

label = "2.21"

r_0: M = 0.3

def __init__(self, r: M, e_p: KPA, alpha: float) -> None:

from blueprints.type_alias import KN_M3, KPA, M, DIMENSIONLESS

from blueprints.validations import raise_if_negative

class Form2Dot21MenardStiffness(Formula):

"""Representation of equation 2.21 CUR 228."""

source_document = CUR_228

label = "2.21"

r_0: M = 0.3

def __init__(self, r: M, e_p: KPA, alpha: DIMENSIONLESS) -> None:

#355 Added menard equations 2.21 and 2.22 of CUR 288

068cefd

johan-tuls linked an issue Oct 16, 2024 that may be closed by this pull request

[✨ Feature request]: Menard stiffness cur 228 #355

Open

2 tasks

johan-tuls requested a review from SZeltaat October 16, 2024 10:54

#355 Feedback naming ModulusHorizontalSubgrade

418df4a

PabloVasconez reviewed Oct 16, 2024

View reviewed changes

blueprints/codes/cur/cur_228/formula_2_22.py Outdated Show resolved Hide resolved

johan-tuls changed the title ~~#355 Added menard equations 2.21 and 2.22 of CUR 288~~ #355 Added menard equations 2.21 and 2.22 of CUR 228 Oct 16, 2024

Update blueprints/codes/cur/cur_228/formula_2_22.py

05ee0a2

Co-authored-by: PabloVasconez <[email protected]>

rickdegoeij requested changes Oct 16, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#355 Added menard equations 2.21 and 2.22 of CUR 228 #356

#355 Added menard equations 2.21 and 2.22 of CUR 228 #356

johan-tuls commented Oct 16, 2024

github-actions bot commented Oct 16, 2024

rickdegoeij left a comment

rickdegoeij Oct 16, 2024

rickdegoeij Oct 16, 2024

rickdegoeij Oct 16, 2024

rickdegoeij Oct 16, 2024

rickdegoeij Oct 16, 2024

rickdegoeij Oct 16, 2024

rickdegoeij Oct 16, 2024

rickdegoeij Oct 16, 2024

rickdegoeij Oct 16, 2024

rickdegoeij Oct 16, 2024

		from blueprints.codes.cur.cur_228.formula_2_21 import Form2Dot21MenardStiffness


		class TestForm2Dot21MenardStiffness:

	"""Return the Menard stiffness k_h when r >= 0.3 m [kN/m3]."""
	"""Return the Menard stiffness k_h when r >= 0.3 m [kN/m3]."""
	raise_if_negative(r=r, e_p=e_p, alpha=alpha)

		from blueprints.codes.cur.cur_228.formula_2_22 import Form2Dot22MenardStiffness


		class TestForm2Dot22MenardStiffness:

#355 Added menard equations 2.21 and 2.22 of CUR 228 #356

Are you sure you want to change the base?

#355 Added menard equations 2.21 and 2.22 of CUR 228 #356

Conversation

johan-tuls commented Oct 16, 2024

Description

Checklist:

github-actions bot commented Oct 16, 2024

rickdegoeij left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment