THIS IS AN AUTOMATED MESSAGE, DO NOT REPLY. The following task has a new comment added:
FS#180 - Inconsistent naming - special status of saturation User who did this - Benjamin Faigle (Benjamin) ---------- Todays DUMUX coffee agreed upon the final conclusion: 1. We use CamelCase. 2. If and only if a single letter that represents an abbreviation or index is followed by a single letter (abbreviation or index), CamelCase is _not_ used. pw vs. pressureW => because \"pressure\" is a word! srnw vs. sReg => because \"reg\" is not an abbreviation of a single letter! \"n\" abbreviates non, \"w\" wetting, so not CamelCase! pcgw vs dTauDPi => Both \"Tau\" and \"Pi\" are words, plus longer than a letter! 3. An inner-word underscore is only permitted if it symbolizes a fraction line. Afterwards, we continue with lower case, i.e. the common rules apply to both enumerator and denominator. __________________________________ List of its effects on all aforementioned examples, the asterix marks those that differ from the proposal afore: NumPrimaryEnergyVars -> numPrimaryEnergyVars NumPrimaryVars -> numPrimaryVars pressNW -> pressNw * pressW -> pressW * pressureW -> pressureW * pressureNW -> pressureNw * saturationNW -> saturationNw * saturationW -> saturationW * S0Idx -> s0Idx SnIdx -> snIdx SwIdx -> swIdx SOrX1Idx -> sOrX1Idx SOrX2Idx -> sOrX2Idx SnOrXidx -> snOrXIdx SwOrXIdx -> swOrXIdx velocityNW -> velocityNw * velocityW -> velocityW * pGlobalIdx -> pGlobalIdx pGlobalSn -> pGlobalSn pGlobalSw -> pGlobalSw pressureGlobal -> pressureGlobal velocityTotal -> velocityTotal contiWEqIdx -> contiWEqIdx * contiNEqIdx -> contiNEqIdx * Material law functions old/new: pC -> pc pCAlpha -> pcAlpha * pCGW -> pcgw pCNW -> pcnw pCGN -> pcgn pCHighSw -> pcHighSw pCLowSw -> pcLowSw Snr -> snr SnToSne -> snToSne Sreg -> sReg * Sw -> sw SwToSwe -> swToSwe SweToSw_ -> sweToSw_ Swr -> swr Swrx -> swrx I am not sure about the derivatives, especially since they contain a \\\\\\\"_\\\\\\\": dkrw_dSw -> dkrw_dsw dkrn_dSw -> dkrn_dsw dpC_dSw -> dpc_dsw dSw_dpC -> dsw_dpc other underscores: dkrn_dSw -> dkrn_dsw *, dkrw_dSw -> dkrw_dsw *, dpC_dSw -> dpc_dsw *, dSw_dpC -> dsw_dpc * implicit/2pdfm: dSM_dSF -> dsm_dsf * decoupled/2p2c: dv_dp -> dv_dp decoupled/common: getNTKNu_by_dF -> getNtkNu_df, getNTKrKNu_by_dF -> getNtkrkNu_df () iapws: ddgamma_ddpi -> ddGamma_ddPi *, ddgamma_ddtau -> ddGamma_ddTau * , ddgamma_dtaudpi -> ddGamma_dTauDPi *, dgamma_dpi -> dGamma_dPi *, dgamma_dtau -> dGamma_dTau *, dp_dpi -> dp_dPi *, dpi_dp -> dPi_dp *, dtau_dT -> dTau_dt * ************* Sidenode ************************************** By consistent naming, \"pressureNw\" or \"saturationNw\" should look terrible enough that everybody refrains from using it. Instead, one can always stick to the beautifully looking (and consistent with large parts of fully-implicit) \"pressureN\"! ---------- More information can be found at the following URL: http://www.dumux.org/flyspray/index.php?do=details&task_id=180#comment348 You are receiving this message because you have requested it from the Flyspray bugtracking system. If you did not expect this message or don't want to receive mails in future, you can change your notification settings at the URL shown above. _______________________________________________ Dumux mailing list [email protected] https://listserv.uni-stuttgart.de/mailman/listinfo/dumux
