Re: [EnergyPlus_Support] Is there any documentation for the examples in E+?

[Linda Lawrie <linda@xxxxxxxxxx>]

At 04:47 PM 1/7/2005, xiaobing liu wrote:
>I'm wondering whether there is any documentation for the examples provided 
>in the package of E+? I have a quick look in the contents of the package 
>and examples, but I cannot find any explanation or documentation for the 
>examples. Maybe I miss it somewhere? Any clue or suggestion is appreciated.
>

Basic documentation should be in comments at the start of each 
file.  Unfortunately, some are better than others.  We are working on a 
spreadsheet that will be distributed with the release, but only have some 
of the files represented in there.

Some of the files are very good (ref: 3zvent following):
    ! 3-zone building with natural ventilation modeled by COMIS/EnergyPlus 
link. 3zvent.idf.
    !
    ! See plan view of building, below, for location of air-flow openings 
and cracks.
    !
    ! Natural ventilation takes places through openable exterior windows in 
WEST_ZONE and NORTH_ZONE
    ! and an openable interior door between WEST_ZONE and NORTH_ZONE. The 
ventilation is temperature
    ! controlled. Window1 in WEST_ZONE and DoorInSurface_3 (defined in 
WEST_ZONE) are opened when
    ! (1) the previous time step air temperature in WEST_ZONE is greater 
than the ventilation setpoint
    ! schedule value (a fixed value of 21.1C in this run) and (2) the 
previous time step air temperature
    ! in WEST_ZONE is greater than the outside air temperature. Similarly, 
Window2 in NORTH_ZONE is
    ! opened when (1) the previous time step air temperature in NORTH_ZONE 
is greater than the
    ! ventilation setpoint schedule value and the previous time step air 
temperature in NORTH_ZONE is
    ! greater than the outside air temperature.
    !
    ! Controls to modulate the ventilation openings are applied to the 
WEST_ZONE but not the NORTH_ZONE
    ! (see the COMIS ZONE DATA inputs for these zones).
    !
    ! The EAST_ZONE has no natural ventilation (Ventilation Control Mode = 
NoVent in the COMIS ZONE DATA
    ! input for this zone).
    !
    ! In addition to natural ventilation in two of the zones, there are 
cracks in all exterior and
    ! interior walls. Cracks in the exterior walls allow infiltration of 
outside air into the zones.
    ! The interior doorway and cracks in the interior walls allow 
cross-mixing of air between zones
    ! (i.e., interzone air flow). There are no cracks in the roof surfaces.
    !
    !
    !                            * External Node NFacade
    !
    !                       Window2    Crack
    !            *********[         ]***//****************
    !            |                                       |
    !            |                                       |
    !            |                                       |
    !            / Crack                                 / Crack
    !            /               NORTH_ZONE              /
    !            |                                       |
    !            |                                       |
    ! * External |       DoorInSurface_3         Crack   |
    !   Node     *****//**]  [**********//********//******   * External 
Node EFacade
    !   WFacade  |  Crack            | Crack             |
    !            |                   |                   |
    !            |                   |                   |
    !            / Crack             / Crack             / Crack
    !            /                   /                   /
    !            |                   |                   |
    !            |    WEST_ZONE      |     EAST_ZONE     |
    !            |                   |                   |
    !            |                   |                   |
    !            **//*[         ]************//***********
    !                 Window1            Crack
    !
    !                             * External Node SFacade
    !
    !         Plan view of 3-zone building showing location of openable
    !         windows ([ ]), openable door (] [) and cracks (//).
    !         Not to scale.

But most do not have this level of detail.

All of the examples are there for a purpose -- mostly to highlight a 
particular feature.  We try to make it clear from the name of the file, if 
not the internal documentation.

For example:
PurchAir -- represents a basic "purchase air" (i.e. heating/cooling loads) 
example.
PurchAirAutoSize -- is similar with autosizing
PurchAirWithDoubleFacadeDaylighting - highlights Double Facade Daylighting 
capability.


Linda

EnergyPlus WebSite: http://www.energyplus.gov
Owner: EnergyPlus_Support list
Member: EnergyPlus Development Team



[Non-text portions of this message have been removed]



The primary EnergyPlus web site is found at:
http://www.energyplus.gov

The group web site is:
http://groups.yahoo.com/group/EnergyPlus_Support/

Attachments are not allowed -- please post any files to the appropriate folder in the Files area of the Support Web Site.
 
Yahoo! Groups Links

<*> To visit your group on the web, go to:
    http://groups.yahoo.com/group/EnergyPlus_Support/

<*> To unsubscribe from this group, send an email to:
    EnergyPlus_Support-unsubscribe@xxxxxxxxxxxxxxx

<*> Your use of Yahoo! Groups is subject to:
    http://docs.yahoo.com/info/terms/