Skip to content

Updated docstrings for automatic documentation generation - #227

Merged
miguelmaso merged 8 commits into
mainfrom
docstrings
Aug 26, 2026
Merged

miguelmaso merged 8 commits into
mainfrom
docstrings

Conversation

@miguelmaso

Copy link
Copy Markdown
Collaborator
  • Added titles for better searching
  • Added explicit import Gridap.CellData.update_state!

@github-actions

github-actions Bot commented Aug 26, 2026 •

Copy link
Copy Markdown

Benchmark Results (Julia v1)

Time benchmarks
main 5cb3141... main / 5cb3141...
Constitutive models/Visco-elastic Ψ 0.0439 ± 0.019 ms 29.2 ± 19 μs 1.5 ± 1.2
Constitutive models/Visco-elastic ∂Ψ∂F 0.0353 ± 0.018 ms 0.0344 ± 0.019 ms 1.03 ± 0.78
Constitutive models/Visco-elastic ∂∂Ψ∂FF 0.0819 ± 0.036 ms 0.0696 ± 0.038 ms 1.18 ± 0.82
Constitutive models/Visco-polyconvex Ψ 0.18 ± 0.001 μs 0.18 ± 0.001 μs 1 ± 0.0079
Constitutive models/Visco-polyconvex ∂Ψ∂F 0.19 ± 0.001 μs 0.19 ± 0.001 μs 1 ± 0.0074
Constitutive models/Visco-polyconvex ∂∂Ψ∂FF 8.67 ± 5.6 μs 8.58 ± 6.8 μs 1.01 ± 1
Simulations/StaticMechanicalDirichlet 0.143 ± 0.015 s 0.138 ± 0.015 s 1.04 ± 0.15
Simulations/StaticMechanicalNeumann 0.12 ± 0.021 s 0.119 ± 0.02 s 1.01 ± 0.24
Simulations/ViscoElastic 13.5 s 13.1 s 1.04
Tensor algebra/Cofactor 0.08 ± 0.001 μs 0.08 ± 0.01 μs 1 ± 0.13
Tensor algebra/Det(A)Inv(A') 0.11 ± 0.01 μs 0.12 ± 0.02 μs 0.917 ± 0.17
Tensor algebra/IIsym 0.07 ± 0 μs 0.07 ± 0 μs 1 ± 0
Tensor algebra/push_forward_C_to_F 0.24 ± 0.001 μs 0.241 ± 0.23 μs 0.996 ± 0.95
Tensor algebra/×ᵢ⁴ 0.07 ± 0 μs 0.07 ± 0 μs 1 ± 0
Tensor algebra/δδ_λ_2d 30 ± 0 ns 30 ± 0 ns 1 ± 0
Tensor algebra/δδ_μ_2d 30 ± 0 ns 30 ± 0 ns 1 ± 0
time_to_load 2.73 ± 0.027 s 2.65 ± 0.01 s 1.03 ± 0.011
Memory benchmarks
main 5cb3141... main / 5cb3141...
Constitutive models/Visco-elastic Ψ 0.542 k allocs: 0.0443 MB 0.542 k allocs: 0.0443 MB 1
Constitutive models/Visco-elastic ∂Ψ∂F 0.593 k allocs: 0.0492 MB 0.593 k allocs: 0.0492 MB 1
Constitutive models/Visco-elastic ∂∂Ψ∂FF 1.05 k allocs: 0.0853 MB 1.05 k allocs: 0.0853 MB 1
Constitutive models/Visco-polyconvex Ψ 0 allocs: 0 B 0 allocs: 0 B
Constitutive models/Visco-polyconvex ∂Ψ∂F 0 allocs: 0 B 0 allocs: 0 B
Constitutive models/Visco-polyconvex ∂∂Ψ∂FF 0.187 k allocs: 15.2 kB 0.187 k allocs: 15.2 kB 1
Simulations/StaticMechanicalDirichlet 1.51 M allocs: 0.108 GB 1.51 M allocs: 0.108 GB 1
Simulations/StaticMechanicalNeumann 1.48 M allocs: 0.0927 GB 1.48 M allocs: 0.0927 GB 1
Simulations/ViscoElastic 0.162 G allocs: 12.8 GB 0.162 G allocs: 12.8 GB 1
Tensor algebra/Cofactor 2 allocs: 0.156 kB 2 allocs: 0.156 kB 1
Tensor algebra/Det(A)Inv(A') 4 allocs: 0.25 kB 4 allocs: 0.25 kB 1
Tensor algebra/IIsym 1 allocs: 0.656 kB 1 allocs: 0.656 kB 1
Tensor algebra/push_forward_C_to_F 1 allocs: 0.656 kB 1 allocs: 0.656 kB 1
Tensor algebra/×ᵢ⁴ 1 allocs: 0.656 kB 1 allocs: 0.656 kB 1
Tensor algebra/δδ_λ_2d 0 allocs: 0 B 0 allocs: 0 B
Tensor algebra/δδ_μ_2d 0 allocs: 0 B 0 allocs: 0 B
time_to_load 0.149 k allocs: 11.1 kB 0.149 k allocs: 11.1 kB 1

@miguelmaso
miguelmaso merged commit 7db27d3 into main Aug 26, 2026
@miguelmaso
miguelmaso deleted the docstrings branch August 26, 2026 15:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant