yt-project / libyt

In-situ analysis with yt
https://libyt.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
9 stars 3 forks source link

Naming in `libyt` Fields #30

Open cindytsai opened 2 years ago

cindytsai commented 2 years ago

Naming in libyt Fields

Frontend Native Fields: Fields defined in XXXFieldInfo in yt frontends. They can be fields derived from other existing fields with function defined inside XXXFieldInfo.

Things Should be Aware of

Field defined in XXXFieldInfo might not have the same name used inside libyt. For example, MagX and CCMagX in gamer. The first one is used inside inline-analysis, while the second one used in post-processing, even though both of them represent the same field. Function defined inside XXXFieldInfo which derived these added fields don't know they are the same, and it should get MagX instead of CCMagX in inline-analysis. So it ends up an error.

Enhancement

Should add another data member in yt_field to match to an already exist definition inside XXXFieldInfo.