Skip to content

Improvements to README #32

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

Merged
mikeingold merged 7 commits into from
Mar 26, 2024
Merged

Improvements to README #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4bdb440
Consolidate support matrix
mikeingold Mar 26, 2024
5605e83
Add type specs
mikeingold Mar 26, 2024
af8370c
Add unsupportable types to matrix
mikeingold Mar 26, 2024
439439f
Change symbol
mikeingold Mar 26, 2024
e0f820b
Remove unused symbol
mikeingold Mar 26, 2024
dccfca1
Reorganize tests to match new consolidated table
mikeingold Mar 26, 2024
be23172
Add placeholders to ease comparison with README
mikeingold Mar 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 31 additions & 36 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ unit_circle_bz = BezierCurve(
)

# A Real-valued function
f(x,y,z) = abs(x + y)
f(x, y, z) = abs(x + y)
f(p) = f(p.coords...)

integral(f, unit_circle_xy, GaussKronrod())
Expand All @@ -54,42 +54,37 @@ integral(f, unit_circle_bz, GaussKronrod())
| Symbol | Meaning |
|--------|---------|
| :white_check_mark: | Implemented, passes tests |
| :yellow_square: | Implemented, not yet validated |
| :x: | Not yet implemented |
| :x: | Planned but not yet implemented |
| :warning: | Unable to implement until parameterization not available (see [Issue #28](https://github.com/mikeingold/MeshIntegrals.jl/issues/28)) |

### Integral
| Geometry | Gauss-Legendre | Gauss-Kronrod | H-Adaptive Cubature |
|----------|----------------|---------------|---------------------|
| `Meshes.Box{Dim>3,T}` | :x: | :x: | :x: |

### Line Integral
| Geometry | Gauss-Legendre | Gauss-Kronrod | H-Adaptive Cubature |
|----------|----------------|---------------|---------------------|
| `Meshes.BezierCurve` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `Meshes.Box{1,T}` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `Meshes.Circle` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `Meshes.Line` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `Meshes.Ring` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `Meshes.Rope` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `Meshes.Segment` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `Meshes.Sphere{2,T}` | :white_check_mark: | :white_check_mark: | :white_check_mark: |

### Surface Integral
| Geometry | Gauss-Legendre | Gauss-Kronrod | H-Adaptive Cubature |
|----------|----------------|---------------|-------------------|
| `Meshes.Ball{2,T}` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `Meshes.Box{2,T}` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `Meshes.CylinderSurface` | :x: | :white_check_mark: | :x: |
| `Meshes.Disk` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `Meshes.ParaboloidSurface` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `Meshes.Sphere{3,T}` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `Meshes.Triangle` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `Meshes.Torus` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `Meshes.SimpleMesh` | :x: | :x: | :x: |

### Volume Integral
| Geometry | Gauss-Legendre | H-Adaptive Cubature |
|----------|----------------|---------------|
| `Meshes.Ball{3,T}` | :white_check_mark: | :white_check_mark: |
| `Meshes.Box{3,T}` | :white_check_mark: | :white_check_mark: |
| `Meshes.Cylinder{T}` | :white_check_mark: | :white_check_mark: |
| `Ball{2,T}` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `Ball{3,T}` | :white_check_mark: | :x: | :white_check_mark: |
| `Ball{Dim,T}` | :warning: | :warning: | :warning: |
| `BezierCurve{Dim,T,V}` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `Box{1,T}` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `Box{2,T}` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `Box{3,T}` | :white_check_mark: | :x: | :white_check_mark: |
| `Box{Dim,T}` | :x: | :x: | :x: |
| `Circle{Dim,T}` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `Cone{T}` | :warning: | :warning: | :warning: |
| `ConeSurface{T}` | :x: | :x: | :x: |
| `Cylinder{T}` | :white_check_mark: | :x: | :white_check_mark: |
| `CylinderSurface{T}` | :x: | :white_check_mark: | :x: |
| `Disk{T}` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `Frustum{T}` | :warning: | :warning: | :warning: |
| `FrustumSurface{T}` | :warning: | :warning: | :warning: |
| `Line{Dim,T}` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `ParaboloidSurface{T}` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `Plane{T}` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `Ray{Dim,T}` | :x: | :x: | :x: |
| `Ring{Dim,T,V}` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `Rope{Dim,T,V}` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `Segment{Dim,T}` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `SimpleMesh{Dim,T,V}` | :x: | :x: | :x: |
| `Sphere{2,T}` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `Sphere{3,T}` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `Triangle{T}` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `Torus{T}` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
54 changes: 28 additions & 26 deletions test/runtests.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@ using MeshIntegrals
using Meshes
using Test

#using DynamicQuantities
#using Unitful

################################################################################
# Infrastructure
################################################################################
Expand Down Expand Up @@ -98,29 +95,34 @@ end

SUPPORT_MATRIX = [
# Name, example, integral,line,surface,volume, GaussLegendre,GaussKronrod,HAdaptiveCubature
SupportItem("BezierCurve", bezier, 1, 1, 0, 0, 1, 1, 1),
SupportItem("Box{1,T}", box1d, 1, 1, 0, 0, 1, 1, 1),
SupportItem("Circle", circle, 1, 1, 0, 0, 1, 1, 1),
# Line -- custom test
SupportItem("Ring", ring_rect, 1, 1, 0, 0, 1, 1, 1),
SupportItem("Rope", rope_rect, 1, 1, 0, 0, 1, 1, 1),
SupportItem("Segment", seg_ne, 1, 1, 0, 0, 1, 1, 1),
SupportItem("Sphere{2,T}", sphere2d, 1, 1, 0, 0, 1, 1, 1),

SupportItem("Ball{2,T}", ball2d, 1, 0, 1, 0, 1, 1, 1),
SupportItem("Box{2,T}", box2d, 1, 0, 1, 0, 1, 1, 1),
SupportItem("CylinderSurface", cylsurf, 1, 0, 1, 0, 0, 1, 0),
SupportItem("Disk", disk, 1, 0, 1, 0, 1, 1, 1),
SupportItem("ParaboloidSurface{T}", parab, 1, 0, 1, 0, 1, 1, 1),
# Plane -- custom test
SupportItem("Sphere{3,T}", sphere3d, 1, 0, 1, 0, 1, 1, 1),
SupportItem("Triangle", triangle, 1, 0, 1, 0, 1, 1, 1),
SupportItem("Torus{T}", torus, 1, 0, 1, 0, 1, 1, 1),
# SimpleMesh -- not yet supported

SupportItem("Ball{3,T}", ball3d, 1, 0, 0, 1, 1, 0, 1),
SupportItem("Box{3,T}", box3d, 1, 0, 0, 1, 1, 0, 1),
SupportItem("Cylinder{T}", cyl, 1, 0, 0, 1, 1, 0, 1)
SupportItem("Ball{2,T}", ball2d, 1, 0, 1, 0, 1, 1, 1),
SupportItem("Ball{3,T}", ball3d, 1, 0, 0, 1, 1, 0, 1),
# Ball{Dim,T}
SupportItem("BezierCurve", bezier, 1, 1, 0, 0, 1, 1, 1),
SupportItem("Box{1,T}", box1d, 1, 1, 0, 0, 1, 1, 1),
SupportItem("Box{2,T}", box2d, 1, 0, 1, 0, 1, 1, 1),
SupportItem("Box{3,T}", box3d, 1, 0, 0, 1, 1, 0, 1),
# Box{Dim,T}
SupportItem("Circle", circle, 1, 1, 0, 0, 1, 1, 1),
# Cone
# ConeSurface
SupportItem("Cylinder", cyl, 1, 0, 0, 1, 1, 0, 1),
SupportItem("CylinderSurface", cylsurf, 1, 0, 1, 0, 0, 1, 0),
SupportItem("Disk", disk, 1, 0, 1, 0, 1, 1, 1),
# Frustum
# FrustumSurface
# Line -- custom tests below
SupportItem("ParaboloidSurface", parab, 1, 0, 1, 0, 1, 1, 1),
# Plane -- custom tests below
# Ray
SupportItem("Ring", ring_rect, 1, 1, 0, 0, 1, 1, 1),
SupportItem("Rope", rope_rect, 1, 1, 0, 0, 1, 1, 1),
SupportItem("Segment", seg_ne, 1, 1, 0, 0, 1, 1, 1),
# SimpleMesh
SupportItem("Sphere{2,T}", sphere2d, 1, 1, 0, 0, 1, 1, 1),
SupportItem("Sphere{3,T}", sphere3d, 1, 0, 1, 0, 1, 1, 1),
SupportItem("Triangle", triangle, 1, 0, 1, 0, 1, 1, 1),
SupportItem("Torus", torus, 1, 0, 1, 0, 1, 1, 1),
]

# Run all integral tests
Expand Down