Reference

Main Classes

statement.Constant

CONSTANTS Statement.

statement.Equation

EQUATION Statement.

controlcards.ControlCards

ControlCards class.

deck.Deck

Deck class.

TrnsysModel

TrnsysModel class.

typevariable.Parameter

A subclass of TypeVariable specific to parameters.

typevariable.Input

A subclass of TypeVariable specific to inputs.

typevariable.Output

A subclass of TypeVariable specific to outputs.

typevariable.Derivative

Derivatives class.

Trnsys Statements

Statement

Statement class.

Version

VERSION Statement.

NaNCheck

NaNCheck Statement.

OverwriteCheck

OverwriteCheck Statement.

TimeReport

TIME_REPORT Statement.

List

LIST Statement.

Simulation

SIMULATION Statement.

Tolerances

TOLERANCES Statement.

Limits

LIMITS Statement.

DFQ

DFQ Statement.

NoCheck

NoCheck Statement.

NoList

NOLIST Statement.

Map

MAP Statement.

EqSolver

EqSolver Statement.

End

END Statement.

Solver

SOLVER Statement.

Helper Classes

trnsysmodel.MetaData

General information that is associated with a TrnsysModel.

component.Component

Component class.

externalfile.ExternalFile

ExternalFile class.

typevariable.TypeVariable

TypeVariable class.

typecycle.TypeCycle

TypeCycle class.

studio.StudioHeader

StudioHeader class.

linkstyle.LinkStyle

LinkStyle class.

anchorpoint.AnchorPoint

Handles the anchor point.

Collections

ConstantCollection

A class that behaves like a dict and collects one or more Constants.

EquationCollection

Behaves like a dict and collects one or more Equations.

ComponentCollection

A class that handles collections of components.

ExternalFileCollection

A collection of ExternalFile objects.

CycleCollection

Collection of trnsystor.typecycle.TypeCycle.

VariableCollection

A collection of VariableType as a dict.

InputCollection

Subclass of VariableCollection specific to Inputs.

OutputCollection

Subclass of VariableCollection specific to Outputs.

ParameterCollection

Subclass of VariableCollection specific to Parameters.

Utils

affine_transform

Apply affine transformation to geometry.

get_int_from_rgb

Convert an RBG color to its TRNSYS Studio compatible int color.

get_rgb_from_int

Convert an rgb int color to its red, green and blue colors.

DeckFilePrinter

Print derivative of a function of symbols in deck file form.

print_my_latex

Most of the printers define their own wrappers for print().

TypeVariableSymbol

This is a subclass of the sympy Symbol class.