auxi.tools.materialphysicalproperties.core module¶

This module provides tools for calculating material physical properties.

class auxi.tools.materialphysicalproperties.core.DataSet(csvfilepath)¶

Bases: object

Contains a data set used to create and/or test a material physical property model.

Parameters:	csvfilepath – path to the csv file that contains the data

create_template(material, path, show=False)¶

Create a template csv file for a data set.

Parameters:	material – the name of the material path – the path of the directory where the file must be written show – a boolean indicating whether the created file should be displayed after creation

class auxi.tools.materialphysicalproperties.core.Model(material, proprty, symbol, display_symbol, units, state_schema, references, datasets)¶

Bases: auxi.core.objects.Object

Base class of models that describe the variation of a specific material physical property.

param material: the name of the material being described, e.g. “Air”

param proprty: the name of the property being described, e.g. “density”

param symbol: the symbol of the property being described, e.g. “rho”

param display symbol:

the display symbol of the property being described, e.g. “

ho”

param references:
param units:	the units used to express the property, e.g. “kg/m3”
	a list of literature references on which this model implementation is based, e.g. [‘lienhard2015’, ‘smith2006’]
param datasets:	a list of data sets on which this model implementation is based, e.g. [‘dataset-air-lienhard2015.csv’]

calculate(**state)¶

Base calculate method for models. Validates the material state parameter(s).

Parameters:	**state – The material state

class auxi.tools.materialphysicalproperties.core.StateOfMatter¶

Bases: enum.Enum

gas = <StateOfMatter.gas: 4>¶

gas_plasma = <StateOfMatter.gas_plasma: 12>¶

liquid = <StateOfMatter.liquid: 2>¶

liquid_gas_plasma = <StateOfMatter.liquid_gas_plasma: 14>¶

liquid_plasma = <StateOfMatter.liquid_plasma: 10>¶

plasma = <StateOfMatter.plasma: 8>¶

solid = <StateOfMatter.solid: 1>¶

solid_gas = <StateOfMatter.solid_gas: 5>¶

solid_liquid = <StateOfMatter.solid_liquid: 3>¶

solid_liquid_gas = <StateOfMatter.solid_liquid_gas: 7>¶

solid_liquid_gas_plasma = <StateOfMatter.solid_liquid_gas_plasma: 15>¶

solid_liquid_plasma = <StateOfMatter.solid_liquid_plasma: 11>¶

solid_plasma = <StateOfMatter.solid_plasma: 9>¶

unknown = <StateOfMatter.unknown: 0>¶