closures_registry

Registry of available closures.

This module only contains a constant variable which lists all the available closures. It can be obtained by the prefix tunax.closures_registry. or directly by tunax..

CLOSURES_REGISTRY

This variable is a dictionnary whose keys are the name of the closures (they must be exaclty the same than name), and whose values are the corresponding Closure instance of the closure. The closure can be used by the forward model and the fitter thanks to this constant. When the user add a the code for a closure in closures/ they must

import here the parameters and state classes (child of ClosureParametersAbstract and of ClosureStateAbstract) and the step function of the closure,
from these objects, create the Closure instance of the closure,
add an entry at this dictionnary

The current available closures are :

k-epsilon for \(k-\varepsilon\) closure cf. closures.k_epsilon

Type:: Dict[str, Closure]