Vlasov1D Configuration Options

Each of these items is actually a dictionary. These dictionaries, once initialized, need to be compiled into a megadictionary that is passed to the solver. This is basically the contents of the yaml files that are in the repo.

class adept.vlasov1d.datamodel.SpaceProfileModel(*, baseline: float, bump_or_trough: str, center: float, rise: float, slope: float, bump_height: float, width: float)Source

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'baseline': FieldInfo(annotation=float, required=True), 'bump_height': FieldInfo(annotation=float, required=True), 'bump_or_trough': FieldInfo(annotation=str, required=True), 'center': FieldInfo(annotation=float, required=True), 'rise': FieldInfo(annotation=float, required=True), 'slope': FieldInfo(annotation=float, required=True), 'width': FieldInfo(annotation=float, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class adept.vlasov1d.datamodel.SpeciesBackgroundModel(*, noise_seed: int, noise_type: str, noise_val: float, v0: float, T0: float, m: float, basis: str, space_profile: SpaceProfileModel)Source

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'T0': FieldInfo(annotation=float, required=True), 'basis': FieldInfo(annotation=str, required=True), 'm': FieldInfo(annotation=float, required=True), 'noise_seed': FieldInfo(annotation=int, required=True), 'noise_type': FieldInfo(annotation=str, required=True), 'noise_val': FieldInfo(annotation=float, required=True), 'space_profile': FieldInfo(annotation=SpaceProfileModel, required=True), 'v0': FieldInfo(annotation=float, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class adept.vlasov1d.datamodel.DensityModel(*, quasineutrality: bool, species_background: SpeciesBackgroundModel)Source

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'quasineutrality': FieldInfo(annotation=bool, required=True), 'species_background': FieldInfo(annotation=SpeciesBackgroundModel, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class adept.vlasov1d.datamodel.UnitsModel(*, laser_wavelength: str, normalizing_temperature: str, normalizing_density: str, Z: int, Zp: int)Source

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'Z': FieldInfo(annotation=int, required=True), 'Zp': FieldInfo(annotation=int, required=True), 'laser_wavelength': FieldInfo(annotation=str, required=True), 'normalizing_density': FieldInfo(annotation=str, required=True), 'normalizing_temperature': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class adept.vlasov1d.datamodel.GridModel(*, dt: float, nv: int, nx: int, tmin: float, tmax: float, vmax: float, xmax: float, xmin: float)Source

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'dt': FieldInfo(annotation=float, required=True), 'nv': FieldInfo(annotation=int, required=True), 'nx': FieldInfo(annotation=int, required=True), 'tmax': FieldInfo(annotation=float, required=True), 'tmin': FieldInfo(annotation=float, required=True), 'vmax': FieldInfo(annotation=float, required=True), 'xmax': FieldInfo(annotation=float, required=True), 'xmin': FieldInfo(annotation=float, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class adept.vlasov1d.datamodel.TimeSaveModel(*, tmin: float, tmax: float, nt: int)Source

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'nt': FieldInfo(annotation=int, required=True), 'tmax': FieldInfo(annotation=float, required=True), 'tmin': FieldInfo(annotation=float, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class adept.vlasov1d.datamodel.SaveModel(*, fields: Dict[str, TimeSaveModel], electron: Dict[str, TimeSaveModel])Source

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'electron': FieldInfo(annotation=Dict[str, TimeSaveModel], required=True), 'fields': FieldInfo(annotation=Dict[str, TimeSaveModel], required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class adept.vlasov1d.datamodel.ExDriverModel(*, a0: float, k0: float, t_center: float, t_rise: float, t_width: float, w0: float, dw0: float, x_center: float, x_rise: float, x_width: float)Source

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'a0': FieldInfo(annotation=float, required=True), 'dw0': FieldInfo(annotation=float, required=True), 'k0': FieldInfo(annotation=float, required=True), 't_center': FieldInfo(annotation=float, required=True), 't_rise': FieldInfo(annotation=float, required=True), 't_width': FieldInfo(annotation=float, required=True), 'w0': FieldInfo(annotation=float, required=True), 'x_center': FieldInfo(annotation=float, required=True), 'x_rise': FieldInfo(annotation=float, required=True), 'x_width': FieldInfo(annotation=float, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class adept.vlasov1d.datamodel.EyDriverModelSource

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class adept.vlasov1d.datamodel.DriversModel(*, ex: Dict[str, ExDriverModel], ey: EyDriverModel)Source

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'ex': FieldInfo(annotation=Dict[str, ExDriverModel], required=True), 'ey': FieldInfo(annotation=EyDriverModel, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class adept.vlasov1d.datamodel.TimeTermModel(*, baseline: float, bump_or_trough: str, center: float, rise: float, slope: float, bump_height: float, width: float)Source

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'baseline': FieldInfo(annotation=float, required=True), 'bump_height': FieldInfo(annotation=float, required=True), 'bump_or_trough': FieldInfo(annotation=str, required=True), 'center': FieldInfo(annotation=float, required=True), 'rise': FieldInfo(annotation=float, required=True), 'slope': FieldInfo(annotation=float, required=True), 'width': FieldInfo(annotation=float, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class adept.vlasov1d.datamodel.SpaceTermModel(*, baseline: float, bump_or_trough: str, center: float, rise: float, slope: float, bump_height: float, width: float)Source

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'baseline': FieldInfo(annotation=float, required=True), 'bump_height': FieldInfo(annotation=float, required=True), 'bump_or_trough': FieldInfo(annotation=str, required=True), 'center': FieldInfo(annotation=float, required=True), 'rise': FieldInfo(annotation=float, required=True), 'slope': FieldInfo(annotation=float, required=True), 'width': FieldInfo(annotation=float, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class adept.vlasov1d.datamodel.FokkerPlanckModel(*, is_on: bool, type: str, time: TimeTermModel, space: SpaceTermModel)Source

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'is_on': FieldInfo(annotation=bool, required=True), 'space': FieldInfo(annotation=SpaceTermModel, required=True), 'time': FieldInfo(annotation=TimeTermModel, required=True), 'type': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class adept.vlasov1d.datamodel.KrookModel(*, is_on: bool, time: TimeTermModel, space: SpaceTermModel)Source

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'is_on': FieldInfo(annotation=bool, required=True), 'space': FieldInfo(annotation=SpaceTermModel, required=True), 'time': FieldInfo(annotation=TimeTermModel, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class adept.vlasov1d.datamodel.TermsModel(*, field: str, edfdv: str, time: str, fokker_planck: FokkerPlanckModel, krook: KrookModel)Source

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'edfdv': FieldInfo(annotation=str, required=True), 'field': FieldInfo(annotation=str, required=True), 'fokker_planck': FieldInfo(annotation=FokkerPlanckModel, required=True), 'krook': FieldInfo(annotation=KrookModel, required=True), 'time': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class adept.vlasov1d.datamodel.MLFlowModel(*, experiment: str, run: str)Source

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'experiment': FieldInfo(annotation=str, required=True), 'run': FieldInfo(annotation=str, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.

class adept.vlasov1d.datamodel.ConfigModel(*, units: UnitsModel, density: DensityModel, grid: GridModel, save: SaveModel, solver: str, mlflow: MLFlowModel, drivers: DriversModel, terms: TermsModel)Source

model_computed_fields: ClassVar[Dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {}

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

model_fields: ClassVar[Dict[str, FieldInfo]] = {'density': FieldInfo(annotation=DensityModel, required=True), 'drivers': FieldInfo(annotation=DriversModel, required=True), 'grid': FieldInfo(annotation=GridModel, required=True), 'mlflow': FieldInfo(annotation=MLFlowModel, required=True), 'save': FieldInfo(annotation=SaveModel, required=True), 'solver': FieldInfo(annotation=str, required=True), 'terms': FieldInfo(annotation=TermsModel, required=True), 'units': FieldInfo(annotation=UnitsModel, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo] objects.

This replaces Model.__fields__ from Pydantic V1.