pycanha_core.parameters — Parameters and Formulas

The parameters submodule provides the core parameter storage and formula binding types used by the thermal model.

Parameters

class Parameters(*args, **kwargs)

Bases: object

Parameters storage.

__init__

add_parameter

contains

property data

(self) -> dict

get_idx

get_memory_address

get_parameter

get_size_of_parameter

remove_parameter

set_parameter

size

Entities

class ThermalEntity

Bases: object

Reference to a value in the thermal network.

__init__(*args, **kwargs)

clone

get_value

get_value_pointer

property node_index_1

(self) -> int

property node_index_2

(self) -> int

set_value

string_representation

property type

(self) -> str

class AttributeEntity(*args, **kwargs)

Bases: ThermalEntity

Entity referencing a node attribute.

__init__

get_value

set_value

class ConductiveCouplingEntity(*args, **kwargs)

Bases: ThermalEntity

Entity referencing a conductive coupling value.

__init__

get_value

set_value

class RadiativeCouplingEntity(*args, **kwargs)

Bases: ThermalEntity

Entity referencing a radiative coupling value.

__init__

get_value

set_value

Formulas

class Formula

Bases: object

Base class for a formula.

__init__(*args, **kwargs)

apply_compiled_formula

apply_formula

clone

compile_formula

property entity

(self) -> pycanha_core.pycanha_core.parameters.ThermalEntity

get_derivative_values

get_value

property parameter_dependencies

(self) -> list[str]

class ParameterFormula(*args, **kwargs)

Bases: Formula

Formula that copies a parameter value to an entity.

__init__

apply_compiled_formula

apply_formula

compile_formula

get_derivative_values

get_value

class ValueFormula(*args, **kwargs)

Bases: Formula

Formula that assigns a constant value to an entity.

__init__

apply_compiled_formula

apply_formula

compile_formula

get_derivative_values

get_value

set_value

class Formulas(*args, **kwargs)

Bases: object

Collection of formulas linking parameters to entities.

__init__

add_formula

apply_formulas

associate

create_parameter_formula

property formulas

(self) -> list

property parameter_dependencies

(self) -> dict