MCycle Defaults¶
Attributes¶
-
mcycle.DEFAULTS.TOLABS¶ double : General absolute tolerance used for convergence of component and cycle functions. Defaults to 1e-7.
-
mcycle.DEFAULTS.TOLREL¶ double : General relative tolerance used for convergence of component and cycle functions. Defaults to 1e-7.
-
mcycle.DEFAULTS.TOLABS_X¶ double : Absolute tolerance used for the quality of fluids, particularly determining if a fluid is a saturated liquid or vapour. Defaults to 1e-10.
-
mcycle.DEFAULTS.MAXITER_CYCLE¶ int : Maximum iterations for convergence of run and size methods of Cycle objects. Defaults to 50.
-
mcycle.DEFAULTS.MAXITER_COMPONENT¶ int : Maximum iterations for convergence of run and size methods of Component objects. Defaults to 50.
-
mcycle.DEFAULTS.MAX_WALLS¶ int : Maximum number of walls for a Component (eg; heat exchangers). Defaults to 200.
-
mcycle.DEFAULTS.RUN_BRACKET_MIN_H¶ double : Lower bound of relative bounds for specific enthalpy (h) used in run methods. Must be in range (0, 1). Defaults to 0.001.
-
mcycle.DEFAULTS.RUN_BRACKET_MAX_H¶ double : Upper bound of relative bounds for specific enthalpy (h) used in run methods. Must be in range (0, 1). Defaults to 0.9.
-
mcycle.DEFAULTS.GRAVITY¶ double : Vertical cceleration due to gravity. Defaults to 9.80665 [m/s^2].
-
mcycle.DEFAULTS.COOLPROP_EOS¶ str : CoolProp Equation of State backend. Must be ‘HEOS’ or ‘REFPROP’, depending on whether RefProp backend has been configured (see using RefProp, primary backends). Defaults to ‘HEOS’.
-
mcycle.DEFAULTS.MPL_BACKEND¶ str : Matplotlib backend (see documentation). Defaults to ‘TkAgg’.
-
mcycle.DEFAULTS.PLOT_DIR¶ str : Directory to save plots in. Will be created if it doesn’t already exist. Defaults to ‘plots’.
-
mcycle.DEFAULTS.PLOT_DPI¶ int : DPI of plots (see explanation). Defaults to 600.
-
mcycle.DEFAULTS.PLOT_FORMAT¶ str : File format for plots. Must be ‘png’ or ‘jpg’. Defaults to ‘png’.
-
mcycle.DEFAULTS.UNITS_SEPARATOR_NUMERATOR¶ str : Separator style for the numerator of units; ie: ‘kW.h’ compared to ‘kW-h’, or ‘kW h’. Defaults to ‘.’.
-
mcycle.DEFAULTS.UNITS_SEPARATOR_DENOMINATOR¶ str : Separator style for the denominator of units; ie: ‘J/kg.K’ compared to ‘J/kg-K’, or ‘J/kg/K’.Defaults to ‘.’.
-
mcycle.DEFAULTS.PRINT_FORMAT_FLOAT¶ str : Format for printing floats, used with Python strings’ format() method (see documentation). Defaults to ‘{:.4e}’.
-
mcycle.DEFAULTS.RST_HEADINGS¶ list : Characters used for successive levels of reStructuredText headings. Defaults to [‘=’, ‘-‘, ‘^’, ‘”’].
-
mcycle.DEFAULTS.METHODS¶ dict : Dictionary of methods set to Config.method attribute. Defaults to {‘HxPlateCorrChevronHeatWf’: {
“sp”: “chisholmWannairachchi_sp”, “liq”: “chisholmWannairachchi_sp”, “vap”: “chisholmWannairachchi_sp”, “tpEvap”: “yanLin_tpEvap”, “tpCond”: “hanLeeKim_tpCond”}, ‘HxPlateCorrChevronFrictionWf’: {
“sp”: “chisholmWannairachchi_sp”, “liq”: “chisholmWannairachchi_sp”, “vap”: “chisholmWannairachchi_sp”, “tpEvap”: “yanLin_tpEvap”, “tpCond”: “hanLeeKim_tpCond”}, ‘HxPlateCorrChevronHeatSf’: {
“sp”: “chisholmWannairachchi_sp”, “liq”: “chisholmWannairachchi_sp”, “vap”: “chisholmWannairachchi_sp”}, ‘HxPlateCorrChevronFrictionSf’: {
“sp”: “chisholmWannairachchi_sp”, “liq”: “chisholmWannairachchi_sp”, “vap”: “chisholmWannairachchi_sp”}, ‘HxPlateFinOffsetHeatWf’: {
“sp”: “manglikBergles_offset_sp”, “liq”: “manglikBergles_offset_sp”, “vap”: “manglikBergles_offset_sp”, “tpEvap”: “”, “tpCond”: “”}, ‘HxPlateFinOffsetFrictionWf’: {
“sp”: “manglikBergles_offset_sp”, “liq”: “manglikBergles_offset_sp”, “vap”: “manglikBergles_offset_sp”, “tpEvap”: “”, “tpCond”: “”}, ‘HxPlateFinOffsetHeatSf’: {
“sp”: “manglikBergles_offset_sp”, “liq”: “manglikBergles_offset_sp”, “vap”: “manglikBergles_offset_sp”}, ‘HxPlateFinOffsetFrictionSf’: {
“sp”: “manglikBergles_offset_sp”, “liq”: “manglikBergles_offset_sp”, “vap”: “manglikBergles_offset_sp”}, ‘HxPlateSmoothHeatWf’: {
“sp”: “gnielinski_sp”, “liq”: “gnielinski_sp”, “vap”: “gnielinski_sp”, “tpEvap”: “shah_tpEvap”, “tpCond”: “shah_tpCond”}, ‘HxPlateSmoothFrictionWf’: {
“sp”: “gnielinski_sp”, “liq”: “gnielinski_sp”, “vap”: “gnielinski_sp”, “tpEvap”: ‘’, “tpCond”: ‘’}, ‘HxPlateSmoothHeatSf’: {
“sp”: “gnielinski_sp”, “liq”: “gnielinski_sp”, “vap”: “gnielinski_sp”}, ‘HxPlateSmoothFrictionSf’: {
“sp”: “gnielinski_sp”, “liq”: “gnielinski_sp”, “vap”: “gnielinski_sp”}}
Methods¶
-
mcycle.DEFAULTS.getPlotDir(plotDir=u'default')¶ str: Return string of plots directory. Creates the directory if it does not yet exist.
-
mcycle.DEFAULTS.getUnits(unicode dimension) → unicode¶ str : Returns formatted units for desired unit type which may either be a single dimension (eg. “length”), a composite dimension (eg. “power/length-temperature”) or an equivalent dimension (eg. “density”).
-
mcycle.DEFAULTS.timeThis(func)¶ Basic decorator to time runs.
-
mcycle.DEFAULTS.updateDefaults() → void¶ Checks all defaults are valid and updates any that have changed, called when mcycle is imported.