Instruction

class simframe.integration.Instruction(scheme, Y, fstep=1.0, controller={}, description='')[source]

Bases: simframe.integration.scheme.Scheme

Integration Instruction that controls the execution of an integration Scheme.

Attributes
Y

The Field to be integrated

controller

Dictionary with keyword arguments that is passed to the integration Scheme.

description

Description of the Scheme.

fstep

Fraction of step size the Scheme will be applied to Field

scheme

Integration Scheme.

Methods

__call__([dx])

Execution of the integration instruction

Attributes Summary

Y

The Field to be integrated

fstep

Fraction of step size the Scheme will be applied to Field

Methods Summary

__call__([dx])

Execution of the integration instruction

Attributes Documentation

Y

The Field to be integrated

fstep

Fraction of step size the Scheme will be applied to Field

Methods Documentation

__call__(dx=None)[source]

Execution of the integration instruction

Parameters

dx (IntVar, optional, default : None) – Stepsize of the integration variable

Returns

Y1 – New value of the variable to be integrated

Return type

Field