fmdtools.define.container

The containers subpackage provides the elemental building puzzle pieces needed (i.e., containers for holding states, modes, etc.) to develop simulations, shown below.

fmdtools container classes

Container classes in fmdtools and their inheritance.

These classes are provided in the following modules:

fmdtools.define.container.base

fmdtools.define.container.mode

The following template shows the basic syntax to use to define modes:

Structure of a Mode Class

Mode class template/example.

fmdtools.define.container.state

State classes are used to represent mutables properties of the system that change over time.

State classes are extended and deployed by the user, as shown below:

example state class

Example of extending the State class to hold x/y fields.

The following template shows the basic syntax used to define states:

Structure of a State Class

State class template/example.

fmdtools.define.container.parameter

Parameter classes are used to represent immutable properties of the system. Parameter classes are extended and deployed by the user, as shown below:

example parameter class

Example of extending the Parameter class to hold x/y/z fields.

The following template shows the basic syntax to use to define parameters:

Structure of a Parameter Class

Parameter class template/example.

fmdtools.define.container.rand

fmdtools.define.container.time