jaxrts.experimental.SiiNN.NNSiiModel

class jaxrts.experimental.SiiNN.NNSiiModel(checkpoint_dir: Path)

A jaxrts.model.IonFeatModel to use a neural network to obtain ion-ion static structure factors.

Note

This is a parent class that, in itself, has no practical application, as it defines no jaxrts.models.IonFeatModel.S_ii() method. This class only handles loading the neural network from an orbax checkpoint.

Initialize the NNSiiModel.

Parameters:

checkpoint_dir (Path) – The Path to the checkpoint directory.

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)
__init__(checkpoint_dir)	Initialize the NNSiiModel.
check(plasma_state)	Test if the model is applicable to the PlasmaState.
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.