Skip to content
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.

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

Subdirectories for same equation, different spatial dimension #1839

Open
DanielDoehring opened this issue Feb 7, 2024 · 2 comments
Open
Labels
discussion low-priority refactoring Refactoring code without functional changes

Comments

@DanielDoehring
Copy link
Contributor

The equations directory keeps filling up, what do you think about adding directories for e.g. compressible_euler_equations which contains the implementations of the respective dimensions?

@SimonCan
Copy link
Contributor

SimonCan commented Feb 7, 2024

Sounds like a good idea.
Should we have derived equations, like compressible_euler_multicomponent_1d.jl, separate or in the same directory with the equations they derive from? I would slightly tend to the latter.

@DanielDoehring DanielDoehring added the refactoring Refactoring code without functional changes label Feb 7, 2024
@sloede
Copy link
Member

sloede commented Feb 7, 2024

The equations directory keeps filling up

Haha, you should meet some other scientific codes (200+ files is not uncommon) 😬

But on a more serious note: Personally I think the current number of files is still acceptable (<40). IMHO, I would not add subdirectories lightly here, and there's a reason for it:

Right now, we do not consistently document all the features that Trixi.jl has (or does not have). More specifically, which system of equations for which dimensionality is available is only derived from "the corresponding file exists". Thus, the one directory approach has the advantage that it is easy for both novice and experienced users to figure out what is available.

To summarize, I think keeping the files in one folder is preferable, at least for the time being. Once we get closer to, say, 50 files, I would definitely be open to reconsider this decision. However, I am not dead-set on not adding subdirectories, thus if there is strong support from the community for more subdirectories, I wouldn't stand in the way.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion low-priority refactoring Refactoring code without functional changes
Projects
None yet
Development

No branches or pull requests

3 participants