fairyfly_therm.properties.boundary module¶

Boundary Therm Properties.

class fairyfly_therm.properties.boundary.BoundaryThermProperties(host, condition=None)[source]¶

Bases: object

Therm Properties for Fairyfly Boundary.

Parameters:

host – A fairyfly_core Boundary object that hosts these properties.
condition – An optional Condition object to set the conductive properties of the Boundary. The default is set to a generic concrete condition.

Properties:

apply_properties_from_dict(abridged_data, conditions)[source]¶

Apply properties from a BoundaryThermPropertiesAbridged dictionary.

Parameters:

abridged_data – A BoundaryThermPropertiesAbridged dictionary (typically coming from a Model).
conditions – A dictionary of conditions with condition identifiers as keys, which will be used to re-assign conditions.

duplicate(new_host=None)[source]¶

Get a copy of this object.

Parameters:: new_host – A new Boundary object that hosts these properties. If None, the properties will be duplicated with the same host.

classmethod from_dict(data, host)[source]¶

Create BoundaryThermProperties from a dictionary.

Note that the dictionary must be a non-abridged version for this classmethod to work.

Parameters:

data – A dictionary representation of BoundaryThermProperties with the format below.
host – A Boundary object that hosts these properties.

{
"type": 'BoundaryThermProperties',
"condition": {},  # A SteadyState dictionary
}

is_equivalent(other)[source]¶

Check to see if these therm properties are equivalent to another object.

This will only be True if all properties match (except for the host) and will otherwise be False.

to_dict(abridged=False)[source]¶

Return therm properties as a dictionary.

Parameters:: abridged – Boolean to note whether the full dictionary describing the object should be returned (False) or just an abridged version (True). Default: False.