rizer.spice.backend.models.schemas#
Pydantic models for circuit simulation requests and responses.
Attributes#
Classes#
str(object='') -> str |
|
str(object='') -> str |
|
Constant plasma resistance model configuration. |
|
Rompe-Weizel resistance model configuration. |
|
Vlastos resistance model configuration. |
|
Braginskii resistance model configuration. |
|
Trapezoidal pulse generator configuration. |
|
Gaussian pulse generator configuration. |
|
Constant voltage generator configuration. |
|
Transmission line cable configuration. |
|
Simulation time configuration. |
|
RLLC circuit simulation parameters. |
|
Castera circuit simulation parameters. |
|
NRP circuit simulation parameters. |
|
Constant-mass LTE discharge simulation parameters. |
|
Simulation output with time-series data. |
|
Metadata about one available circuit type. |
|
List of available circuit metadata entries. |
Module Contents#
- class rizer.spice.backend.models.schemas.ResistanceModelType#
-
str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to ‘utf-8’. errors defaults to ‘strict’.
- constant = 'constant'#
- rompe_weizel = 'rompe_weizel'#
- vlastos = 'vlastos'#
- braginskii = 'braginskii'#
- class rizer.spice.backend.models.schemas.GeneratorType#
-
str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to ‘utf-8’. errors defaults to ‘strict’.
- trapezoidal = 'trapezoidal'#
- gaussian = 'gaussian'#
- constant = 'constant'#
- class rizer.spice.backend.models.schemas.ConstantResistanceConfig(/, **data: Any)#
Bases:
pydantic.BaseModelConstant plasma resistance model configuration.
- type: Literal['constant'] = 'constant'#
- class rizer.spice.backend.models.schemas.RompeWeizelConfig(/, **data: Any)#
Bases:
pydantic.BaseModelRompe-Weizel resistance model configuration.
- type: Literal['rompe_weizel'] = 'rompe_weizel'#
- class rizer.spice.backend.models.schemas.VlastosConfig(/, **data: Any)#
Bases:
pydantic.BaseModelVlastos resistance model configuration.
- type: Literal['vlastos'] = 'vlastos'#
- class rizer.spice.backend.models.schemas.BraginskiiConfig(/, **data: Any)#
Bases:
pydantic.BaseModelBraginskii resistance model configuration.
- type: Literal['braginskii'] = 'braginskii'#
- rizer.spice.backend.models.schemas.ResistanceModelConfig#
- class rizer.spice.backend.models.schemas.TrapezoidalGeneratorConfig(/, **data: Any)#
Bases:
pydantic.BaseModelTrapezoidal pulse generator configuration.
- type: Literal['trapezoidal'] = 'trapezoidal'#
- class rizer.spice.backend.models.schemas.GaussianGeneratorConfig(/, **data: Any)#
Bases:
pydantic.BaseModelGaussian pulse generator configuration.
- type: Literal['gaussian'] = 'gaussian'#
- class rizer.spice.backend.models.schemas.ConstantGeneratorConfig(/, **data: Any)#
Bases:
pydantic.BaseModelConstant voltage generator configuration.
- type: Literal['constant'] = 'constant'#
- rizer.spice.backend.models.schemas.GeneratorConfig#
- class rizer.spice.backend.models.schemas.CableConfig(/, **data: Any)#
Bases:
pydantic.BaseModelTransmission line cable configuration.
- class rizer.spice.backend.models.schemas.TimeConfig(/, **data: Any)#
Bases:
pydantic.BaseModelSimulation time configuration.
- class rizer.spice.backend.models.schemas.RLLCSimulationRequest(/, **data: Any)#
Bases:
pydantic.BaseModelRLLC circuit simulation parameters.
- circuit_type: Literal['rllc'] = 'rllc'#
- resistance_model: ResistanceModelConfig = None#
- time: TimeConfig = None#
- class rizer.spice.backend.models.schemas.CasteraSimulationRequest(/, **data: Any)#
Bases:
pydantic.BaseModelCastera circuit simulation parameters.
- circuit_type: Literal['castera'] = 'castera'#
- resistance_model: ResistanceModelConfig = None#
- time: TimeConfig = None#
- class rizer.spice.backend.models.schemas.NRPSimulationRequest(/, **data: Any)#
Bases:
pydantic.BaseModelNRP circuit simulation parameters.
- circuit_type: Literal['nrp'] = 'nrp'#
- generator: GeneratorConfig = None#
- cable: CableConfig = None#
- time: TimeConfig = None#
- class rizer.spice.backend.models.schemas.LTEDischargeSimulationRequest(/, **data: Any)#
Bases:
pydantic.BaseModelConstant-mass LTE discharge simulation parameters.
- circuit_type: Literal['lte_discharge'] = 'lte_discharge'#
- time: TimeConfig = None#
- rizer.spice.backend.models.schemas.SimulationRequest#
- class rizer.spice.backend.models.schemas.SimulationResult(/, **data: Any)#
Bases:
pydantic.BaseModelSimulation output with time-series data.
- class rizer.spice.backend.models.schemas.CircuitInfo(/, **data: Any)#
Bases:
pydantic.BaseModelMetadata about one available circuit type.
- class rizer.spice.backend.models.schemas.CircuitListResponse(/, **data: Any)#
Bases:
pydantic.BaseModelList of available circuit metadata entries.
- circuits: list[CircuitInfo]#