jerbaroo / bridge-sim

Python library for concrete slab bridge simulation.
MIT License
1 stars 0 forks source link

Clean up variable naming #174

Open rozsasarpi opened 3 years ago

rozsasarpi commented 3 years ago

The code is relatively easy to read but there are some internal inconsistencies and inconsistencies in comparison with the structural engineering/finite element modelling terminology.

I'm collecting them here as I read and try to understand the source code.

jerbaroo commented 3 years ago

I'm very happy to rename anything as you see fit :) Would you have any recommendation as to the naming approach i.e. structural engineering/finite element modelling terminology ?

rozsasarpi commented 3 years ago

I would suggest just to be very pragmatic and focus on the first point in my issue description.

From a structural engineering and finite element modelling perspective (the two match pretty much in terms of terminology):

Section and Material

I think a Section and a Material class are justified but the current code is mixing the two above described categories. So sorting this out would be a bit more than just refactoring the code, it requires disentangling some classes to correspond to the above conceptual classes.

Maybe I should give it a try and make a PR but as you can see in my second PR I would need some briefing on some parts of the code..