celeritas-project / celeritas

Celeritas is a new Monte Carlo transport code designed to accelerate scientific discovery in high energy physics by improving detector simulation throughput and energy efficiency using GPUs.
https://celeritas-project.github.io/celeritas/user/index.html
Other
58 stars 32 forks source link

Standardize nomenclature #721

Open sethrj opened 1 year ago

sethrj commented 1 year ago

Singular/plural names for variables/accessors

Add to the documentation (after assuming the team agrees):

This means a couple of changes:

Weird cases to consider:

Single-item data retrieval

Let's make OpaqueId look like std::optional: value for checked access, operator* for unchecked. Same for Quantity and Initialized_value. I think obj is fine for JSON because it's a json object.

Note that some C++ facade classes have base() indicating the single value that the class wraps, so maybe that's a better word too.

ID-based accessors

should probably be at() and size() like std containers? But some of these store multiple types (and maybe they shouldn't?)

Environment variables

Class names

Other stuff

sethrj commented 1 year ago

Also I regret insisting on using Vecgeom instead of following their styling as VecGeom.