Integrator

class simframe.integration.Integrator(var, instructions=[], failop=None, preparator=None, finalizer=None, maxit=500, description='')[source]

Bases: object

Integrator class that manages the integration instructions

Attributes:

description: Description of integrator
failop: Heartbeat objects that is called if any integration Instruction returned False
finalizer: Heartbeat object that is called after the integration was successful.
instructions: List of integration Instructions that will be executed in that order.
maxit: Maximum number of integration tries until program will be aborted.
preparator: Heartbeat object that is called before the integration instructions will be executed.
var: The integration variable IntVar that is associated with this Integrator.

Methods

integrate()

Method that executes one integration step.

Attributes Summary

`description`	Description of integrator
`failop`	`Heartbeat` objects that is called if any integration `Instruction` returned `False`
`finalizer`	`Heartbeat` object that is called after the integration was successful.
`instructions`	List of integration `Instructions` that will be executed in that order.
`maxit`	Maximum number of integration tries until program will be aborted.
`preparator`	`Heartbeat` object that is called before the integration instructions will be executed.
`var`	The integration variable `IntVar` that is associated with this `Integrator`.

Methods Summary

integrate()

Method that executes one integration step.

Attributes Documentation

description: Description of integrator

failop: Heartbeat objects that is called if any integration Instruction returned False

finalizer: Heartbeat object that is called after the integration was successful.

instructions: List of integration Instructions that will be executed in that order.

maxit: Maximum number of integration tries until program will be aborted.

preparator: Heartbeat object that is called before the integration instructions will be executed.

var: The integration variable IntVar that is associated with this Integrator.

Methods Documentation

integrate()[source]: Method that executes one integration step.