SolidMaterial Base Class

class mcycle.bases.solidmaterial.SolidMaterial(double rho, dict data, int deg=-1, double T=298.15, unicode name=u'SolidMaterial instance', unicode notes=u'No material notes.')

Bases: mcycle.bases.mcabstractbase.MCAB

Essential properties for solid component materials.

Attributes

rho rho: ‘double’
k(self) float: Thermal conductivity [W/m.K].
name name: unicode
notes notes: unicode
config (Config, optional) Configuration parameters. Defaults to default Config object.
kwargs (optional) Arbitrary keyword arguments.

Methods

copy(self, dict kwargs={}) Return a new copy of a class object.
k(self) float: Thermal conductivity [W/m.K].
populate_c(self)
summary(self, bool printSummary=True[, …]) Returns (and prints) a summary of the component attributes/properties/flows.
update(self, dict kwargs) Update (multiple) class variables from a dictionary of keyword arguments.
T

T: ‘double’

copy(self, dict kwargs={})

Return a new copy of a class object. Kwargs (as dict) are passed to update() as a shortcut of simultaneously copying and updating.

Parameters:

kwargs : dict, optional

Dictionary of attributes and their updated value.

data

data: dict

deg

deg: ‘int’

k(self) → double

float: Thermal conductivity [W/m.K].

name

name: unicode

notes

notes: unicode

populate_c(self) → void
rho

rho: ‘double’

summary(self, bool printSummary=True, propertyKeys=u'all', unicode name=u'', int rstHeading=0)

Returns (and prints) a summary of the component attributes/properties/flows.

Parameters:

printSummary : bool, optional

If true, the summary string is printed as well as returned. Defaults to True.

propertyKeys : list, optional

Names of component properties to be included. The following strings are also accepted as inputs:

  • ‘all’: all properties in _properties are included,

  • ‘none’: no properties are included.

    Defaults to “all”.

rstHeading : int, optional

Level of reStructuredText heading to give the summary, 0 being the top heading. Heading style taken from mcycle.DEFAULTS.RSTHEADINGS. Defaults to 0.

update(self, dict kwargs) → void

Update (multiple) class variables from a dictionary of keyword arguments.

Parameters:

kwargs : dict

Dictionary of attributes and their updated value; kwargs={‘key’: value}.