pogona.MovementPredictor
- class pogona.MovementPredictor[source]
Bases:
Component
Attributes
Unique name of this component, unless it is "Generic component".
Methods
__init__
()finalize
(simulation_kernel)initialize
(simulation_kernel, init_stage)Use
InitStages
to initialize this Component instance.predict
(simulation_kernel, molecule, ...[, ...])process_new_time_step
(simulation_kernel, ...)set_arguments
(**kwargs)Read arguments as key value pairs and set this component's member variables accordingly.
- finalize(simulation_kernel: SimulationKernel)
- get_integration_method() Integration [source]
- initialize(simulation_kernel: SimulationKernel, init_stage: InitStages)[source]
Use
InitStages
to initialize this Component instance.
- predict(simulation_kernel: SimulationKernel, molecule: Molecule, sim_time: float, delta_time: float, update_molecule: bool = True) Tuple[Molecule, ndarray, float] [source]
- process_new_time_step(simulation_kernel: SimulationKernel, notification_stage: NotificationStages)
- set_arguments(**kwargs)
Read arguments as key value pairs and set this component’s member variables accordingly. Validity of the argument values will be checked in
initialize()
.
- component_name = 'movement_predictor'
Unique name of this component, unless it is “Generic component”.
- property embedded_integrator: Optional[EmbeddedRungeKuttaMethod]
- id
Unique integer component ID
- integration_method = 'RUNGE_KUTTA_4'