Todo

Improve autoapi module

`circadapt.components.solver`

Solver objects.

Module Contents

Classes

Component object with no locations.

Objects

class circadapt.components.solver.Solver(model)

Bases: circadapt.components.General

Component object with no locations.

Parameters

dt [s]: float: Numerical timestep used for calculation
dt_export [s]: float: Numerical timestep used for export data
max_beats [-]: int: Maximum number of beats allowed to run stable
store_beats [-]: int: Number of beats stored

Signals

t [s]: float: Time starting at zero
t_real [s]: float: Time, real time of the solver. Starts at zero when model is created.
stable_beats_needed [-]: int: Number of beats runned to get to stable situation.

parameters

signals

parameter_on_set

__getitem__(arg: any) → any

Get data.

This function is called when self[arg].

Parameters

arg: slice or string: If slice, return a components object with locs obtained from slice. If str, return the parameter or signal for all locs

__repr__(): Object representation in string format.

__setitem__(arg, value)

Set data.

Set data of the parameter for locs given in arg. Only parameter names can be used.

Parameters

arg: slice: Locations to be changed.
val: float/int/bool: Value will automatically be translated to type of the parameter.

__iter__(): Iterate over object, used for dict(self).

build()

add_object(o)