Modelica.Media.Interfaces.TemplateMedium

Information

This package is a template for new medium models. For a new medium model just make a copy of this package, remove the "partial" keyword from the package and provide the information that is requested in the comments of the Modelica source.

Extends from Modelica.Media.Interfaces.PartialMedium (Partial medium properties (base package of all media packages)).

Package Content

Name	Description
cp_const=123456	Constant specific heat capacity at constant pressure
BaseProperties	Base properties of medium
ThermodynamicState	a selction of variables that uniquely defines the thermodynamic state
dynamicViscosity	Return dynamic viscosity
thermalConductivity	Return thermal conductivity
specificEntropy	Return specific entropy
specificHeatCapacityCp	Return specific heat capacity at constant pressure
specificHeatCapacityCv	Return specific heat capacity at constant volume
isentropicExponent	Return isentropic exponent
velocityOfSound	Return velocity of sound
Inherited
ThermoStates	Enumeration type for independent variables
mediumName="unusablePartialMedium"	Name of the medium
substanceNames={mediumName}	Names of the mixture substances. Set substanceNames={mediumName} if only one substance.
extraPropertiesNames=fill("", 0)	Names of the additional (extra) transported properties. Set extraPropertiesNames=fill("",0) if unused
singleState	= true, if u and d are not a function of pressure
reducedX=true	= true if medium contains the equation sum(X) = 1.0; set reducedX=true if only one substance (see docu for details)
fixedX=false	= true if medium contains the equation X = reference_X
reference_p=101325	Reference pressure of Medium: default 1 atmosphere
reference_T=298.15	Reference temperature of Medium: default 25 deg Celsius
reference_X=fill(1/nX, nX)	Default mass fractions of medium
p_default=101325	Default value for pressure of medium (for initialization)
T_default=Modelica.SIunits.Conversions.from_degC(20)	Default value for temperature of medium (for initialization)
h_default=specificEnthalpy_pTX(p_default, T_default, X_default)	Default value for specific enthalpy of medium (for initialization)
X_default=reference_X	Default value for mass fractions of medium (for initialization)
nS=size(substanceNames, 1)	Number of substances
nX=nS	Number of mass fractions
nXi=if fixedX then 0 else if reducedX then nS - 1 else nS	Number of structurally independent mass fractions (see docu for details)
nC=size(extraPropertiesNames, 1)	Number of extra (outside of standard mass-balance) transported properties
FluidConstants	critical, triple, molecular and other standard data of fluid
setState_pTX	Return thermodynamic state as function of p, T and composition X or Xi
setState_phX	Return thermodynamic state as function of p, h and composition X or Xi
setState_psX	Return thermodynamic state as function of p, s and composition X or Xi
setState_dTX	Return thermodynamic state as function of d, T and composition X or Xi
setSmoothState	Return thermodynamic state so that it smoothly approximates: if x > 0 then state_a else state_b
prandtlNumber	Return the Prandtl number
pressure	Return pressure
temperature	Return temperature
density	Return density
specificEnthalpy	Return specific enthalpy
specificInternalEnergy	Return specific internal energy
specificGibbsEnergy	Return specific Gibbs energy
specificHelmholtzEnergy	Return specific Helmholtz energy
heatCapacity_cp	alias for deprecated name
heatCapacity_cv	alias for deprecated name
isentropicEnthalpy	Return isentropic enthalpy
isobaricExpansionCoefficient	Return overall the isobaric expansion coefficient beta
beta	alias for isobaricExpansionCoefficient for user convenience
isothermalCompressibility	Return overall the isothermal compressibility factor
kappa	alias of isothermalCompressibility for user convenience
density_derp_h	Return density derivative wrt pressure at const specific enthalpy
density_derh_p	Return density derivative wrt specific enthalpy at constant pressure
density_derp_T	Return density derivative wrt pressure at const temperature
density_derT_p	Return density derivative wrt temperature at constant pressure
density_derX	Return density derivative wrt mass fraction
molarMass	Return the molar mass of the medium
specificEnthalpy_pTX	Return specific enthalpy from p, T, and X or Xi
density_pTX	Return density from p, T, and X or Xi
temperature_phX	Return temperature from p, h, and X or Xi
density_phX	Return density from p, h, and X or Xi
temperature_psX	Return temperature from p,s, and X or Xi
density_psX	Return density from p, s, and X or Xi
specificEnthalpy_psX	Return specific enthalpy from p, s, and X or Xi
AbsolutePressure	Type for absolute pressure with medium specific attributes
Density	Type for density with medium specific attributes
DynamicViscosity	Type for dynamic viscosity with medium specific attributes
EnthalpyFlowRate	Type for enthalpy flow rate with medium specific attributes
MassFlowRate	Type for mass flow rate with medium specific attributes
MassFraction	Type for mass fraction with medium specific attributes
MoleFraction	Type for mole fraction with medium specific attributes
MolarMass	Type for molar mass with medium specific attributes
MolarVolume	Type for molar volume with medium specific attributes
IsentropicExponent	Type for isentropic exponent with medium specific attributes
SpecificEnergy	Type for specific energy with medium specific attributes
SpecificInternalEnergy	Type for specific internal energy with medium specific attributes
SpecificEnthalpy	Type for specific enthalpy with medium specific attributes
SpecificEntropy	Type for specific entropy with medium specific attributes
SpecificHeatCapacity	Type for specific heat capacity with medium specific attributes
SurfaceTension	Type for surface tension with medium specific attributes
Temperature	Type for temperature with medium specific attributes
ThermalConductivity	Type for thermal conductivity with medium specific attributes
PrandtlNumber	Type for Prandtl number with medium specific attributes
VelocityOfSound	Type for velocity of sound with medium specific attributes
ExtraProperty	Type for unspecified, mass-specific property transported by flow
CumulativeExtraProperty	Type for conserved integral of unspecified, mass specific property
ExtraPropertyFlowRate	Type for flow rate of unspecified, mass-specific property
IsobaricExpansionCoefficient	Type for isobaric expansion coefficient with medium specific attributes
DipoleMoment	Type for dipole moment with medium specific attributes
DerDensityByPressure	Type for partial derivative of density with resect to pressure with medium specific attributes
DerDensityByEnthalpy	Type for partial derivative of density with resect to enthalpy with medium specific attributes
DerEnthalpyByPressure	Type for partial derivative of enthalpy with resect to pressure with medium specific attributes
DerDensityByTemperature	Type for partial derivative of density with resect to temperature with medium specific attributes
Choices	Types, constants to define menu choices

Types and constants

    constant SpecificHeatCapacity cp_const = 123456 
  "Constant specific heat capacity at constant pressure";

Modelica.Media.Interfaces.TemplateMedium.BaseProperties

Information

Extends from (Base properties (p, d, T, h, u, R, MM and, if applicable, X and Xi) of a medium).

Parameters

Type	Name	Default	Description
Boolean	standardOrderComponents	true	if true, and reducedX = true, the last element of X will be computed from the other ones
Advanced
Boolean	preferredMediumStates	false	= true if StateSelect.prefer shall be used for the independent property variables of the medium

Modelica definition

redeclare model extends BaseProperties(final standardOrderComponents=true) 
  "Base properties of medium"

equation 
  d = 1;
  h = cp_const*T;
  u = h - p/d;
  MM = 0.024;
  R  = 8.3144/MM;
  state.p = p;
  state.T = T;
end BaseProperties;

Modelica.Media.Interfaces.TemplateMedium.ThermodynamicState

Information

Modelica definition

redeclare replaceable record ThermodynamicState 
  "a selction of variables that uniquely defines the thermodynamic state"
  AbsolutePressure p "Absolute pressure of medium";
  Temperature T "Temperature of medium";
end ThermodynamicState;

Modelica.Media.Interfaces.TemplateMedium.dynamicViscosity

Information

Extends from (Return dynamic viscosity).

Inputs

Type	Name	Default	Description
ThermodynamicState	state		thermodynamic state record

Outputs

Type	Name	Description
DynamicViscosity	eta	Dynamic viscosity [Pa.s]

Modelica definition

redeclare function extends dynamicViscosity 
  "Return dynamic viscosity"
algorithm 
  eta := 10 - state.T*0.3 + state.p*0.2;
end dynamicViscosity;

Modelica.Media.Interfaces.TemplateMedium.thermalConductivity

Information

Extends from (Return thermal conductivity).

Inputs

Type	Name	Default	Description
ThermodynamicState	state		thermodynamic state record

Outputs

Type	Name	Description
ThermalConductivity	lambda	Thermal conductivity [W/(m.K)]

Modelica definition

redeclare function extends thermalConductivity 
  "Return thermal conductivity"
algorithm 
  lambda := 0;
end thermalConductivity;

Modelica.Media.Interfaces.TemplateMedium.specificEntropy

Information

Extends from (Return specific entropy).

Inputs

Type	Name	Default	Description
ThermodynamicState	state		thermodynamic state record

Outputs

Type	Name	Description
SpecificEntropy	s	Specific entropy [J/(kg.K)]

Modelica definition

redeclare function extends specificEntropy "Return specific entropy"
algorithm 
  s := 0;
end specificEntropy;

Modelica.Media.Interfaces.TemplateMedium.specificHeatCapacityCp

Information

Extends from (Return specific heat capacity at constant pressure).

Inputs

Type	Name	Default	Description
ThermodynamicState	state		thermodynamic state record

Outputs

Type	Name	Description
SpecificHeatCapacity	cp	Specific heat capacity at constant pressure [J/(kg.K)]

Modelica definition

redeclare function extends specificHeatCapacityCp 
  "Return specific heat capacity at constant pressure"
algorithm 
  cp := 0;
end specificHeatCapacityCp;

Modelica.Media.Interfaces.TemplateMedium.specificHeatCapacityCv

Information

Extends from (Return specific heat capacity at constant volume).

Inputs

Type	Name	Default	Description
ThermodynamicState	state		thermodynamic state record

Outputs

Type	Name	Description
SpecificHeatCapacity	cv	Specific heat capacity at constant volume [J/(kg.K)]

Modelica definition

redeclare function extends specificHeatCapacityCv 
  "Return specific heat capacity at constant volume"
algorithm 
  cv := 0;
end specificHeatCapacityCv;

Modelica.Media.Interfaces.TemplateMedium.isentropicExponent

Information

Extends from Modelica.Icons.Function (Icon for a function), (Return isentropic exponent).

Inputs

Type	Name	Default	Description
ThermodynamicState	state		thermodynamic state record

Outputs

Type	Name	Description
IsentropicExponent	gamma	Isentropic exponent [1]

Modelica definition

redeclare function extends isentropicExponent 
  "Return isentropic exponent"
  extends Modelica.Icons.Function;
algorithm 
   gamma := 1;
end isentropicExponent;

Modelica.Media.Interfaces.TemplateMedium.velocityOfSound

Information

Extends from Modelica.Icons.Function (Icon for a function), (Return velocity of sound).

Inputs

Type	Name	Default	Description
ThermodynamicState	state		thermodynamic state record

Outputs

Type	Name	Description
VelocityOfSound	a	Velocity of sound [m/s]

Modelica definition

redeclare function extends velocityOfSound "Return velocity of sound"
  extends Modelica.Icons.Function;
algorithm 
  a := 0;
end velocityOfSound;