JuliaWaveScattering / JuliaWaveScattering/MultipleScattering.jl

FrequencySimulationResult, FrequencySimulation, and basis order

Open
#29 4 comments 0 reactions 0 assignees View on GitHub
Dominant language
Julia
Stars
56
Forks
13
PR merge metrics
No merged PRs in 30d

Description

This is just to debate out current types.

Am not sure how useful is the type `FrequencySimulation` now. Essentially it is not just an added step were the user always has to call:
```julia
sim = FrequencySimulation(particles, source)
result = run(sim, x, ω)
```
Why not just have:
```julia
result = run(particles, source, x, ω)
```
how is `FrequencySimulation` useful?

Also for debate, I think `FrequencySimulationResult` should have a field `basis_order::Vector{Int}`. I think by having the field `basis_order` it makes it easier for new users to discover this option, rather than just being keyword of `run`. Second, even if the used doesn't specify `basis_order` it can still be very important to know and keep a record of what the basis order was. On the other hand, if `FrequencySimulationResult` didn't have the field `basis_order` that would allow us more freedom to, for example, have a different basis order for each particle, depending on it's radius....

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.