Show
Ignore:
Timestamp:
10/03/2007 06:11:34 PM (15 months ago)
Author:
fcasella
Message:

Corrected errors in the documentation of PartialMedium.BaseProperties

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • Modelica/branches/maintenance/2.2.2/Modelica/Media/package.mo

    r607 r650  
    39083908        "= true if StateSelect.prefer shall be used for the independent property variables of the medium" 
    39093909        annotation (Hide=true, Evaluate=true, Dialog(tab="Advanced")); 
    3910       annotation (structurallyIncomplete); 
    3911       SI.Conversions.NonSIunits.Temperature_degC T_degC= 
    3912           Modelica.SIunits.Conversions.to_degC(T)  
    3913         "Temperature of medium in [degC]"; 
    3914       SI.Conversions.NonSIunits.Pressure_bar p_bar= 
    3915        Modelica.SIunits.Conversions.to_bar(p)  
    3916         "Absolute pressure of medium in [bar]"; 
    3917       parameter Boolean standardOrderComponents = true  
    3918         "if true, last element in components is computed from 1-sum(Xi)"; 
    3919       annotation (Documentation(info="<html> 
     3910      annotation (structurallyIncomplete, Documentation(info="<html> 
    39203911<p> 
    39213912Model <b>BaseProperties</b> is a model within package <b>PartialMedium</b> 
     
    39233914variables that every medium model is supposed to support. 
    39243915A specific medium inherits from model <b>BaseProperties</b> and provides 
    3925 the equations for the basic properties. Note, that in package 
    3926 PartialMedium the following constants are defined: 
    3927 </p> 
    3928 <table border=1 cellspacing=0 cellpadding=2> 
    3929   <tr><td valign=\"top\"><b>Type</b></td> 
    3930       <td valign=\"top\"><b>Name</b></td> 
    3931       <td valign=\"top\"><b>Description</b></td></tr> 
    3932   <tr><td valign=\"top\">String</td><td valign=\"top\">mediumName</td> 
    3933       <td valign=\"top\">Unique name of the medium (used to check whether two media in a model 
    3934           are the same)</td></tr> 
    3935   <tr><td valign=\"top\">String</td><td valign=\"top\">substanceNames</td> 
    3936       <td valign=\"top\">Names of the mixture substances that are treated 
    3937           as independent. 
    3938           If medium consists of a single substance, set substanceNames=fill(\"\",0). 
    3939           If medium consists of n substances, provide either n-1 or n 
    3940           substance names, depending whether mass fractions 
    3941           PartialMedium.BaseProperties.X shall have 
    3942           dimension PartialMedium.nX = n-1 or PartialMedium.nX = n</td></tr> 
    3943   <tr><td valign=\"top\">Boolean</td><td valign=\"top\">incompressible</td> 
    3944       <td valign=\"top\">= true, if density is constant; otherwise set it to false</td></tr> 
    3945 </table> 
    3946 <p> 
    3947 In every medium <b>3+nX equations</b> have to be defined that 
    3948 provide relations between the following <b>5+nX variables</b>, declared 
    3949 in model BaseProperties, where nX is the number of independent 
    3950 mass fractions defined in package PartialMedium: 
     3916the equations for the basic properties. </p> 
     3917<p> 
     3918The BaseProperties model contains the following <b>7+nXi variables</b> 
     3919(nXi is the number of independent mass fractions defined in package 
     3920PartialMedium): 
    39513921</p> 
    39523922<table border=1 cellspacing=0 cellpadding=2> 
     
    39693939      <td valign=\"top\">J/kg</td> 
    39703940      <td valign=\"top\">specific internal energy</td></tr> 
    3971   <tr><td valign=\"top\">X[nX]</td> 
     3941  <tr><td valign=\"top\">Xi[nXi]</td> 
    39723942      <td valign=\"top\">kg/kg</td> 
    39733943      <td valign=\"top\">independent mass fractions m_i/m</td></tr> 
     3944  <tr><td valign=\"top\">R</td> 
     3945      <td valign=\"top\">J/kg.K</td> 
     3946      <td valign=\"top\">gas constant</td></tr> 
     3947  <tr><td valign=\"top\">M</td> 
     3948      <td valign=\"top\">kg/mol</td> 
     3949      <td valign=\"top\">molar mass</td></tr> 
    39743950</table> 
    39753951<p> 
    3976 In some components, such as \"Ambient\", explicit equations for 
    3977 medium variables are provided as \"boundary conditions\". 
    3978 For example, the \"Ambient\" component may define a temperature 
    3979 T_ambient. 
    3980 </html>"),   Icon(Rectangle(extent=[-100,100; 100,-100], style(fillColor=7)), Text(extent= 
     3952In order to implement an actual medium model, one can extend from this 
     3953base model and add <b>5 equations</b> that provide relations among  
     3954these variables. Equations will also have to be added in order to 
     3955set all the variables within the ThermodynamicState record state.</p> 
     3956<p> 
     3957If standardOrderComponents=true, the full composition vector X[nX]  
     3958is determined by the equations contained in this base class, depending  
     3959on the independent mass fraction vector Xi[nXi]. </p> 
     3960<p>Additional <b>2 + nXi</b> equations will have to be provided  
     3961when using the BaseProperties model, in order to fully specify the  
     3962thermodynamic conditions.</p> 
     3963</html>")); 
     3964      SI.Conversions.NonSIunits.Temperature_degC T_degC= 
     3965          Modelica.SIunits.Conversions.to_degC(T)  
     3966        "Temperature of medium in [degC]"; 
     3967      SI.Conversions.NonSIunits.Pressure_bar p_bar= 
     3968       Modelica.SIunits.Conversions.to_bar(p)  
     3969        "Absolute pressure of medium in [bar]"; 
     3970      parameter Boolean standardOrderComponents = true  
     3971        "if true, and reducedX = true, the last element of X will be computed from the other ones"; 
     3972      annotation (Icon(Rectangle(extent=[-100,100; 100,-100], style(fillColor=7)), Text(extent= 
    39813973               [-152,164; 152,102], string="%name"))); 
    39823974    equation