jaxrts.models.IonFeatModel

class jaxrts.models.IonFeatModel[source]

Abstract class of Model`s, describing the scattering by electrons tightly bound to the ions, causing quasi-elastic scattering. An `IonFeatModel has to define a method S_ii() which returns the static ion-ion structure factor. This quantity is used to calculate the Rayleigh_weight() by combining form-factors and screening models of the PlasmaState.

Methods

`Rayleigh_weight`(plasma_state, setup)	This is the result from Wünsch [Wünsch, 2011], to calculate the Rayleigh weight for a plasma from multiple species.
`S_ii`(plasma_state, setup)	Calculate the ion-ion static structure factor in the given `IonFeatModel`.
`S_ii_on_grid`(plasma_state)	For py:class:jaxrts.models.IonFeatModel that internally calculate S_ii a k-grid independently of the probe setup (e.g. HNC-based models) this method should return (k_grid, S_ab_grid).
`__init__`()
`check`(plasma_state)	Test if the model is applicable to the PlasmaState.
`check_supports_S_ii_grid`(plasma_state)	Whether `S_ii_on_grid()` can be used for this model, given the current plasma_state.
`citation`([style, comment])	Return bibliographic information for the Model used.
`evaluate`(plasma_state, setup)
`prepare`(plasma_state, key)	Modify the plasma_state in place.

Attributes

`allowed_keys`	A list of keywords where this model is adequate for
`cite_keys`	A list of bibtex keys.
`supports_S_ii_grid`	HNC type models calculate the SSF on a k grid, and then interpolate to the scattering vector of the setup class.