CoolProp.Plots.Common.BasePlot Class Reference

Detailed Description

The base class for all plots. It can be instantiated itself, but provides many
general facilities to be used in the different plots. 

Inheritance diagram for CoolProp.Plots.Common.BasePlot:

Collaboration diagram for CoolProp.Plots.Common.BasePlot:

Public Member Functions
def	__init__ (self, fluid_ref, graph_type, unit_system='KSI', tp_limits='DEF', kwargs)
def	system (self)
def	system (self, value)
def	limits (self)
def	limits (self, value)
def	figure (self)
def	figure (self, value)
def	axis (self)
def	axis (self, value)
def	props (self)
def	props (self, value)
def	title (self, title)
def	xlabel (self, xlabel)
def	ylabel (self, ylabel)
def	grid (self, b=None, kwargs)
def	set_Tp_limits (self, limits)
def	get_Tp_limits (self)
def	set_axis_limits (self, limits)
def	get_axis_limits (self, x_index=None, y_index=None)
def	inline_label (self, xv, yv, x=None, y=None)
def	show (self)
def	savefig (self, args, kwargs)
Public Member Functions inherited from CoolProp.Plots.Common.Base2DObject
def	__init__ (self, x_type, y_type, state=None, small=None)
def	x_index (self)
def	y_index (self)
def	critical_state (self)
def	state (self)
def	state (self, value)

Static Public Member Functions
def	generate_ranges (itype, imin, imax, num)
def	get_x_y_dydx (xv, yv, x)

Public Attributes
	system
	limits
	figure
	axis
	props
Public Attributes inherited from CoolProp.Plots.Common.Base2DObject
	state

Static Public Attributes
dictionary	PROPERTIES
dictionary	UNIT_SYSTEMS
dictionary	LINE_PROPS
float	ID_FACTOR = 10.0
float	HI_FACTOR = 2.25
float	LO_FACTOR = 1.01
dictionary	TP_LIMITS
Static Public Attributes inherited from CoolProp.Plots.Common.Base2DObject
int	TS = CoolProp.iT * 10 + CoolProp.iSmass
int	PH = CoolProp.iP * 10 + CoolProp.iHmass
int	HS = CoolProp.iHmass * 10 + CoolProp.iSmass
int	PS = CoolProp.iP * 10 + CoolProp.iSmass
int	PD = CoolProp.iP * 10 + CoolProp.iDmass
int	TD = CoolProp.iT * 10 + CoolProp.iDmass
int	PT = CoolProp.iP * 10 + CoolProp.iT
int	PU = CoolProp.iP * 10 + CoolProp.iUmass
dictionary	PLOTS
dictionary	PLOTS_INV = {v: k for k, v in PLOTS.items()}

Member Function Documentation

generate_ranges()

def CoolProp.Plots.Common.BasePlot.generate_ranges (   itype,   imin,   imax,   num  )

static

Generate a range for a certain property

get_axis_limits()

def CoolProp.Plots.Common.BasePlot.get_axis_limits	(		self,
			x_index = None,
			y_index = None
	)

Returns the previously set limits or generates them and
converts the default values to the selected unit system.
Returns a list containing [xmin, xmax, ymin, ymax]

get_Tp_limits()

def CoolProp.Plots.Common.BasePlot.get_Tp_limits

(

self

)

Get the limits for the graphs in temperature and pressure, based on
the active units: [Tmin, Tmax, pmin, pmax]

get_x_y_dydx()

def CoolProp.Plots.Common.BasePlot.get_x_y_dydx (   xv,   yv,   x  )

static

Get x and y coordinates and the linear interpolation derivative

inline_label()

def CoolProp.Plots.Common.BasePlot.inline_label	(		self,
			xv,
			yv,
			x = None,
			y = None
	)

This will give the coordinates and rotation required to align a label with
a line on a plot in axis units.

limits()

def CoolProp.Plots.Common.BasePlot.limits

(

self

)

Returns [Tmin,Tmax,pmin,pmax] as value or factors

set_axis_limits()

def CoolProp.Plots.Common.BasePlot.set_axis_limits	(		self,
			limits
	)

Set the limits of the internal axis object based on the active units,
takes [xmin, xmax, ymin, ymax]

set_Tp_limits()

def CoolProp.Plots.Common.BasePlot.set_Tp_limits	(		self,
			limits
	)

Set the limits for the graphs in temperature and pressure, based on
the active units: [Tmin, Tmax, pmin, pmax]

Member Data Documentation

LINE_PROPS

dictionary CoolProp.Plots.Common.BasePlot.LINE_PROPS

static

Initial value:

=  {
      CoolProp.iT: dict(color='Darkred', lw=0.25),
      CoolProp.iP: dict(color='DarkCyan', lw=0.25),
      CoolProp.iHmass: dict(color='DarkGreen', lw=0.25),
      CoolProp.iDmass: dict(color='DarkBlue', lw=0.25),
      CoolProp.iSmass: dict(color='DarkOrange', lw=0.25),
      CoolProp.iQ: dict(color='black', lw=0.25)
    }

PROPERTIES

dictionary CoolProp.Plots.Common.BasePlot.PROPERTIES

static

Initial value:

=  {
      CoolProp.iDmass: 'density',
      CoolProp.iHmass: 'specific enthalpy',
      CoolProp.iP: 'pressure',
      CoolProp.iSmass: 'specific entropy',
      CoolProp.iT: 'temperature',
      CoolProp.iUmass: 'specific internal energy'
    }

TP_LIMITS

dictionary CoolProp.Plots.Common.BasePlot.TP_LIMITS

static

Initial value:

=  {
      'NONE': [None, None, None, None],
      'DEF': [LO_FACTOR, HI_FACTOR, LO_FACTOR, HI_FACTOR],
      'ACHP': [173.15, 493.15, 0.25e5, HI_FACTOR],
      'ORC': [273.15, 673.15, 0.25e5, HI_FACTOR]
    }

UNIT_SYSTEMS

dictionary CoolProp.Plots.Common.BasePlot.UNIT_SYSTEMS

static

Initial value:

=  {
      'SI': SIunits(),
      'KSI': KSIunits(),
      'EUR': EURunits()
    }

---

The documentation for this class was generated from the following file:

• wrappers/Python/CoolProp/Plots/Common.py