New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

62 documentation #67

Merged

srosenbu merged 37 commits into main from 62-documentation

Feb 12, 2025

Member

srosenbu commented Feb 3, 2025 •

edited

Loading

This PR introduces:

A better README
Documentation
Python constitutive models are now importable

The docs are currently built for this branch and will update automatically when we push to it https://fenics-constitutive.readthedocs.io/en/62-documentation/

Removing the name mandel_stress since Mandel stress is something different than the Cauchy stress in Mandel notation -- This does not affect anything. Its just a different name for a positional parameter and some docstrings
Remove IncrSmallStrainModel.update() -- This was needed in the first versions when we did not have $t,\Delta t$ in the IncrSmallStrainModel.evaluate(), but is basically useless now.
TODO: Include paper examples in examples directory

srosenbu added 4 commits

January 28, 2025 16:41


          Rewrite README

dc5ba38


          Start docs

5343caf


          readthedocs

ae7cfc9


          models in docs

14cd51a

srosenbu linked an issue

that may be closed by this pull request

Documentation #62

Closed


          small changes

d4377c9

aradermacher reviewed

View reviewed changes

README.md Outdated Show resolved Hide resolved

aradermacher reviewed

View reviewed changes

src/fenics_constitutive/models/__init__.py Outdated Show resolved Hide resolved

aradermacher added 2 commits

February 5, 2025 12:58


          Update spring_kelvin_model.py

863b985

add args


          Update spring_maxwell_model.py

3cb8ddd

add args

aradermacher reviewed

View reviewed changes

src/fenics_constitutive/models/spring_kelvin_model.py Outdated Show resolved Hide resolved

aradermacher reviewed

View reviewed changes

src/fenics_constitutive/models/spring_kelvin_model.py Outdated Show resolved Hide resolved

aradermacher reviewed

View reviewed changes

src/fenics_constitutive/models/spring_maxwell_model.py Outdated Show resolved Hide resolved

aradermacher reviewed

View reviewed changes

src/fenics_constitutive/models/spring_maxwell_model.py Outdated Show resolved Hide resolved

srosenbu and others added 4 commits

February 5, 2025 13:14


          Update src/fenics_constitutive/models/spring_maxwell_model.py

ce6b9c4

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


          Update src/fenics_constitutive/models/spring_kelvin_model.py

b0495a5

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


          Update src/fenics_constitutive/models/spring_maxwell_model.py

2f1e0bd

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


          Update src/fenics_constitutive/models/spring_kelvin_model.py

c5271f5

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

saifr68 reviewed

View reviewed changes

src/fenics_constitutive/models/mises_plasticity_isotropic_hardening.py Outdated Show resolved Hide resolved


          Update src/fenics_constitutive/models/mises_plasticity_isotropic_hard…

ae59529

…ening.py

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

saifr68 reviewed

View reviewed changes

src/fenics_constitutive/models/mises_plasticity_isotropic_hardening.py Outdated Show resolved Hide resolved

srosenbu and others added 2 commits

February 5, 2025 15:17


          Update src/fenics_constitutive/models/mises_plasticity_isotropic_hard…

10877e6

…ening.py

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


          fix docstring

5a76332

saifr68 reviewed

View reviewed changes

src/fenics_constitutive/models/mises_plasticity_isotropic_hardening.py Outdated Show resolved Hide resolved

srosenbu and others added 6 commits

February 5, 2025 15:49


          Update src/fenics_constitutive/models/mises_plasticity_isotropic_hard…

a43f69d

…ening.py

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


          CI badge

3080a76


          Remove the name mandel_stress due to ambiguity

50b35b9


          Merge branch '62-documentation' of https://github.com/BAMresearch/fen…

de8310a

…ics-constitutive into 62-documentation


          Rename Constraint and make all "dims" properties

c8a337a


          furhter renaming

226aaa3

srosenbu added 6 commits

February 10, 2025 15:13


          Move model tests to tests directory

4add709


          remove models from examples


          Citing section in the readme

1617af7


          add parameters

7c89070


          name models in readme

9a9759e


          Remove update() in IncrSmallStrainModel

35016f4

srosenbu requested review from pdiercks, aradermacher and saifr68

February 11, 2025 15:55

srosenbu marked this pull request as ready for review

February 11, 2025 15:55

pdiercks approved these changes

View reviewed changes

Collaborator

pdiercks left a comment

Hi @srosenbu ,
I just have a few suggestions to fix typos. Looks good to me!

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

docs/index.md Outdated Show resolved Hide resolved

docs/index.md Outdated Show resolved Hide resolved

srosenbu and others added 11 commits

February 12, 2025 09:30


          Update README.md

605b8b1

Co-authored-by: Philipp Diercks <[email protected]>


          Update README.md

a6e3b0e

Co-authored-by: Philipp Diercks <[email protected]>


          Update docs/index.md

defc5e8

Co-authored-by: Philipp Diercks <[email protected]>


          Update docs/index.md

8dc1fb3

Co-authored-by: Philipp Diercks <[email protected]>


          Update README.md

eb5c639

Co-authored-by: Philipp Diercks <[email protected]>


          Fix basic usage

8bd3c5c


          Merge branch '62-documentation' of https://github.com/BAMresearch/fen…

1298bf3

…ics-constitutive into 62-documentation


          Improve citing section


          small change

56e8272


          problem update in basic usage

056cc0f


          fix docstring

66ab7ed

srosenbu merged commit c3c583c into main

1 of 2 checks passed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet