Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature Req] k/mu conversion from kperp/kpara #40

Open
steven-murray opened this issue Sep 13, 2022 · 0 comments
Open

[Feature Req] k/mu conversion from kperp/kpara #40

steven-murray opened this issue Sep 13, 2022 · 0 comments

Comments

@steven-murray
Copy link
Collaborator

Description

Theorists sometimes use |k|, \mu instead of k_perp, k_par in computing the theory. It might be nice to have convenience methods to support this.

The Solution I'd Like

I think the best solution might be to provide a @property for mu that can be used if desired. Then have a flag that tells the DataModelInterface whether the theory function uses k/mu or kperp/kpar. Something like theory_uses_mu=True.

Alternatives Considered

The conversion between the two is obviously very easy, and we could just leave it up to the theorist to write their function in such a way as to do the conversion. Whether providing a convenience method is a good idea would be dependent on how likely it is for a theorist to want to use the k/mu basis.

Additional context

The downside of providing the convenience is essentially that there is another parameter, and more documentation. We should balance this against the utility of it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant