archetypal.template.GasMaterial

class archetypal.template.GasMaterial(Name, Conductivity=None, Density=None, Category='Gases', **kwargs)[source]

Gas Materials.

Initialize object with parameters.

Parameters

Name (str) – The name of the GasMaterial.
Conductivity (float) – Thermal conductivity (W/m-K).
Density (float) – A number representing the density of the material in kg/m3. This is essentially the mass of one cubic meter of the material.
Category (str) – Category is set as “Gases” for GasMaterial.
**kwargs – keywords passed to the MaterialBase constructor.

property Type

Get or set the gas type.

Choices are (“Air”, “Argon”, “Krypton”, “Xenon”).

property Conductivity: Get or set the conductivity of the gas at 0C [W/m-K].

property Density: Get or set the density of the gas.

property molecular_weight: Get the molecular weight [kg/mol].

property specific_heat: Get the material layer’s specific heat at 0C [J/kg-K].

duplicate()[source]: Get copy of self.

classmethod from_dict(data, **kwargs)[source]

Create a GasMaterial from a dictionary.

Parameters

data (dict) – A python dictionary.
**kwargs – keywords passed the MaterialBase constructor.

to_dict()[source]: Return GasMaterial dictionary representation.

to_epbunch(idf, thickness)[source]

Convert self to an epbunch given an idf model and a thickness.

Parameters

idf (IDF) – An IDF model.
thickness (float) – the thickness of the material.

WindowMaterial:Gas,
    AIR_0.006_B_Dbl_Air_Cl,    !- Name
    AIR,                      !- Gas Type
    0.006;                    !- Thickness

Returns: The EpBunch object added to the idf model.
Return type: EpBunch

mapping(validate=True)[source]

Get a dict based on the object properties, useful for dict repr.

Parameters: validate (bool) – If True, try to validate object before returning the mapping.

density_at_temperature(t_kelvin, pressure=101325)[source]

Get the density of the gas [kg/m3] at a given temperature and pressure.

This method uses CoolProp to get the density.

Parameters

t_kelvin (float) – The average temperature of the gas cavity in Kelvin.
pressure (float) – The average pressure of the gas cavity in Pa. Default is 101325 Pa for standard pressure at sea level.

property Category: Get or set the Category attribute.

property Comments: Get or set the object comments.

property Cost: Get or set the cost of the material [$].

property DataSource: Get or set the datasource of the object.

property EmbodiedCarbon: Get or set the embodied carbon of the material [kgCO2/kg].

property EmbodiedEnergy: Get or set the embodied energy of the material [MJ/kg].

property Name: Get or set the name of the object.

property SubstitutionRatePattern: Get or set the substitution rate pattern of the material.

property SubstitutionTimestep: Get or set the substitution timestep of the material.

property TransportCarbon: Get or set the transportation carbon of the material [kgCO2/kg/km].

property TransportDistance: Get or set the transportation distance of the material [km].

property TransportEnergy: Get or set the transporation energy of the material [MJ/kg/km].

property allow_duplicates: Get or set the use of duplicates [bool].

extend(other, allow_duplicates)

Append other to self. Modify and return self.

Parameters: other (UmiBase) –
Returns: self
Return type: UmiBase

float_mean(other, attr, weights=None)

Calculates the average attribute value of two floats. Can provide weights.

Parameters

other (UmiBase) – The other UmiBase object to calculate average value with.
attr (str) – The attribute of the UmiBase object.
weights (iterable, optional) – Weights of [self, other] to calculate weighted average.

get_unique(): Return first object matching equality in the list of instantiated objects.

property id: Get or set the id.

property predecessors

Get or set the predecessors of self.

Of which objects is self made of. If from nothing else then self, return self.

rename(name)

renames self as well as the cached object

Parameters: name (str) – the name.

specific_heat_at_temperature(t_kelvin, pressure=101325)[source]

Get the specific heat of the gas [J/(kg-K)] at a given Kelvin temperature.

This method uses CoolProp to get the density.

Parameters

t_kelvin (float) – The average temperature of the gas cavity in Kelvin.
pressure (float) – The average pressure of the gas cavity in Pa. Default is 101325 Pa for standard pressure at sea level.

to_ref(): Return a ref pointer to self.

validate(): Validate object and fill in missing values.

viscosity_at_temperature(t_kelvin, pressure=101325)[source]

Get the viscosity of the gas [kg/m-s] at a given Kelvin temperature.

This method uses CoolProp to get the density.

Parameters

t_kelvin (float) – The average temperature of the gas cavity in Kelvin.
pressure (float) – The average pressure of the gas cavity in Pa. Default is 101325 Pa for standard pressure at sea level.

conductivity_at_temperature(t_kelvin, pressure=101325)[source]

Get the conductivity of the gas [W/(m-K)] at a given Kelvin temperature.

This method uses CoolProp to get the density. Note that the thermal conductivity model is not available for Krypton, Xenon gases. Values from the literature are used instead.

Parameters

t_kelvin (float) – The average temperature of the gas cavity in Kelvin.
pressure (float) – The average pressure of the gas cavity in Pa. Default is 101325 Pa for standard pressure at sea level.