FS#180 Inconsistent naming - special status of saturation
Metadata
Property | Value |
---|---|
Project | dumux |
Category | General |
Reported by | Anonymous (Id=0) |
Reported at | Jan 24, 2013 11:13 |
Type | Bug Report |
Version | Git |
Last edited by | Anonymous (Id=4) |
Last edited at | Sep 6, 2013 09:47 |
Closed by | Anonymous (Id=4) |
Closed at | Sep 6, 2013 09:47 |
Closed in version | 2.4 |
Resolution | Implemented |
Description
We have already discussed this topic, but it feels like years ago...
I think the naming of variables, types, functions, etc. is pretty much in agreement with the naming guidelines formulated in the handbook.
However, whenever saturation is abbreviated by the letter S, it is written as capital letter independent of the position. E.g. Sw(), Sw, SwIdx, etc.
I suggest to change this and write e.g. sw(), sn, snIdx, etc.
It would be even nicer to use a capital phase index like sW(), sW, sWIdx, etc. but this would include even more changes as we mostly us small phase indices like pnIdx, krw(), krn(), etc. The capillary pressure function on the other hand is named pC()...
Anyway, we should get this consistent!