dipoleq.input

dipoleq input file schema using pydantic for validation

class dipoleq.input.CDipoleIntStableIn(**data)

Bases: PlasmaModelBaseModel

Parameters:

data (Any)

do_init(pl)

Initialize the plasma model with the input data.

Parameters:

pl (Plasma)

Return type:

None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class dipoleq.input.CDipoleStablePsiNIn(**data)

Bases: PlasmaModelBaseModel

Parameters:

data (Any)

do_init(pl)

Initialize the plasma model with the input data.

Parameters:

pl (Plasma)

Return type:

None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class dipoleq.input.CDipoleStdIn(**data)

Bases: PlasmaModelBaseModel

Parameters:

data (Any)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class dipoleq.input.CoilIn(**data)

Bases: BaseModel

Coil input data.

Parameters:

data (Any)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class dipoleq.input.LimiterIn(**data)

Bases: BaseModel

Parameters:

data (Any)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class dipoleq.input.MachineIn(**data)

Bases: BaseModel

Parameters:

data (Any)

check_numbers()

check that Num* fields match the number of items in the lists :param Self: the MachineIn object

Returns:

the MachineIn object, validated

Return type:

Self

initalize_machine(m)

Initializes a Machine object from the input data

Parameters:

m (Machine)

Return type:

None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class dipoleq.input.MeasureIn(**data)

Bases: BaseModel

Measurement input data.

Parameters:

data (Any)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class dipoleq.input.PlasmaIn(**data)

Bases: BaseModel

Parameters:

data (Any)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class dipoleq.input.PlasmaModelBaseModel(**data)

Bases: BaseModel

Base class for plasma models. This is not a real model, but a base class

Parameters:

data (Any)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class dipoleq.input.PlasmaModelOld(**data)

Bases: PlasmaModelBaseModel

Old plasma model data. Covers the standard polynomial models.

Parameters:

data (Any)

check_old_plasma_model()

Check for validation of the old plasma model data.

Return type:

Self

do_init(pm)

Initialize the plasma model with the input data.

Parameters:

pm (Plasma)

Return type:

None

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class dipoleq.input.PsiGridIn(**data)

Bases: BaseModel

Parameters:

data (Any)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class dipoleq.input.PyBindEnumAnnotation

Bases: Generic[_T]

Validation annotation for pybind11 enum classes.

class dipoleq.input.SeparatrixIn(**data)

Bases: BaseModel

Parameters:

data (Any)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class dipoleq.input.ShellIn(**data)

Bases: BaseModel

(Super) Conducting shell input.

Parameters:

data (Any)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class dipoleq.input.SubCoilIn(**data)

Bases: BaseModel

Subcoil input data.

Parameters:

data (Any)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class dipoleq.input.SubShellIn(**data)

Bases: BaseModel

Subshell data.

Parameters:

data (Any)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

dipoleq.input.model_type_literals(mts)

make a list of literals for the model types both name and value

Parameters:

mts (list[ModelType])

Return type:

TypeAlias