pogona.MovementPredictor

class pogona.MovementPredictor[source]

Bases: pogona.component.Component

Attributes

component_name

Unique name of this component, unless it is "Generic component".

embedded_integrator

integration_method

__init__()[source]

Methods

__init__()

finalize(simulation_kernel)

get_integration_method()

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.

__init__()[source]
finalize(simulation_kernel: pogona.simulation_kernel.SimulationKernel)
get_integration_method() pogona.integration.Integration[source]
initialize(simulation_kernel: pogona.simulation_kernel.SimulationKernel, init_stage: pogona.component.InitStages)[source]

Use InitStages to initialize this Component instance.

predict(simulation_kernel: pogona.simulation_kernel.SimulationKernel, molecule: pogona.molecule.Molecule, sim_time: float, delta_time: float, update_molecule: bool = True) Tuple[pogona.molecule.Molecule, numpy.ndarray, float][source]
process_new_time_step(simulation_kernel: pogona.simulation_kernel.SimulationKernel, notification_stage: pogona.component.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[pogona.movement_predictor.EmbeddedRungeKuttaMethod]
id

Unique integer component ID

integration_method = 'RUNGE_KUTTA_4'