Module Reference
simframe.frame Package
This package contains the core infrastructure of simframe
.
Classes
This is an abstract class that serves as template for other classes. |
|
|
Class for storing simulation quantities. |
|
This is the parent object of type |
|
Class for grouping data. |
|
This class controls an update including |
|
Cclass for integration variables that behaves as |
|
Class that manages how a |
simframe.integration Package
This package contains infrastructure for solving differential equations within simframe
. The Integrator
class
is the basic class that advances the simulation from snapshot to snapshot by executing one integration Instruction
at
a time. Instructions contain a list of integration Scheme
. The schemes
package contains pre-defined integration
schemes that are ready to use in simframe
.
Classes
|
Integration |
|
|
|
Class for an integration |
simframe.integration.schemes Package
This package contains pre-defined instances of integration schemes that can be used in simframe
.
The naming convention is <expl/impl>_<order>_<name>(<_additonal>)
.
For example: The fifth-order adaptive Cash-Karp scheme is expl_5_cash_karp_adptv
, the 1st-order implicit Euler
scheme using a GMRES solver is impl_1_euler_gmres
.
Classes
|
Class for explicit 1st-order Euler method |
|
Class for explicit adaptive 2nd-order Fehlberg's method |
|
Class for explicit 2nd-order Heun's method |
|
Class for explicit adaptive 2nd-order Heun-Euler method |
|
Class for explicit 2nd-order midpoint method |
|
Class for explicit 2nd-order Ralston's method |
|
Class for explicit adaptive 3rd-order Bogacki-Shampine method |
|
Class for explicit adaptive 3rd-order Gottlieb-Shu method |
|
Class for explicit 3rd-order Heun's method |
|
Class for explicit 3rd-order Kutta's method |
|
Class for explicit 3rd-order Ralston's method |
|
Class for explicit 3rd-order Strong Stability Preserving Runge-Kutta method |
|
Class for explicit 4th-order 3/8 rule method |
|
Class for explicit 4th-order Ralston's method |
|
Class for explicit 4th-order classical Runge-Kutta method |
|
Class for explicit adaptive 5th-order Cash-Karp method |
|
Class for explicit adaptive 5th-order Dormand-Prince method |
|
Class for implicit 1st-order direct Euler method |
|
Class for implicit 1st-order Euler method with GMRES solver |
|
Class for implicit 2nd-order direct midpoint method |
|
Class to update a field after integration. |
simframe.io Package
This package is for input/output operations. It contains template Writer
and Reader
classes that can be used
to create customized writing and reading methods. The package writers
contains pre-defined Writer
instances for
writing and reading simframe
data. The package furthermore contains a method for reading dump files and for printing
a progress bar in an interactive shell.
Functions
|
Reads dumpfile and returns |
Classes
|
General class for reading output files. |
|
General class for writing output files. |
|
Class for printing progress bar to terminal. |
simframe.io.writers Package
This package contains pre-defined Writer
instances that can be used for writing and reading Frame
objects.
The hdf5writer
writes data files in the HDF5 file format. The namespacewriter
does not write output files
(except for dump files if required). The data is stored locally in the Writer
object itself.
Classes
|
Class for writing HDF5 output files. |
|
Class to write |
simframe.utils Package
Package contains utility classes that facilitate the use of simframe
Color
is a generic class that can be used to colorize text. colorize
is an instance of Color
, that can
be called to add decorators to a string for colored output.
Functions
|
Function returns a formatted string for given memory usage. |
Classes
|
Class to decorate strings with color tags. |
|
This is a modified version of types.SimpleNamespace that allows for the iteration over its members |