Table of Contents: Guide for Module Developers

EnergyPlus^TM Documentation, v8.4.0
Guide for Module Developers
- Everything You Need to Know about Developing Modules and Modifying EnergyPlus
Introduction
Modules in EnergyPlus
- What is a module anyway?
  - Program Modules
  - Data Only Modules
- What is a module developer?
- Adding new features
Input Concepts
- Input Data Dictionary
- Data Dictionary Naming Conventions
- Input Data File
- Input Considerations
- Advanced Input Considerations
- DataSets
Module Structure
- Module Outline
- Module Example
- Changing existing code
- Considerations for Legacy Codes
- Code Readability vs. Speed of Execution
  - Speed of Execution
- How it fits together
EnergyPlus Calling Structure
- Top Level Calling Tree
- High Level HVAC Calling Tree (schematic – not all routines are shown)
- Air System Calling Tree (schematic – not all routines are shown)
- Plant Calling Tree (schematic – not all routines are shown)
- Zone Equipment Calling Tree (schematic – not all routines are shown)
- Inserting the New Module into the Program
HVAC Network
- Branches, Connectors, and Nodes
- Nodes in the simulation
- Getting Nodes
- Data Flow in an HVAC Component Module
- Interfacing with Plant
- Node Mass Flow Variables
EnergyPlus Services
- Utility Routines/Functions
- Input Services
- Object Services
- Branch & Node Checking and Services
- Schedule Services
- Data Services
- Other Useful Utilities
- Error Messages
- Display Strings
- Performance Curve Services
- Fluid Property Services
- Weather Services
- Global Data: Flags and Parameters
  - Parameters
  - Simulation Flags
- Psychrometric services
- Tabular Output Utilities
- Internal Zone Gains Services
Output
- How Do I Output My Variables?
- Output Variable Dos and Don’ts
Energy Management System
- EMS Actuator Interface
Running/Testing EnergyPlus – for Developers
- Environment Variables to Assist Running
  - DDOnly: Design Days Only
- Air Loop Simulation Environment Variables
  - TRACK_AIRLOOP: Runtime performance tracker for air loop simulation
    - TRACE_AIRLOOP: Air loop simulation tracer
    - TRACE_HVACCONTROLLER: Individual HVAC controller tracer
Quick Procedure Outline For Making Code Changes to EnergyPlus
Important Rules for Module Developers
Appendix A. DataGlobals and DataEnvironments Modules
- DataGlobals
- DataEnvironment
Appendix B. Submissions and Check-ins
Appendix C. Documentation Specifics
Appendix D. Module, Subroutine, Function Templates
Appendix E. Test File Documentation
Appendix F. New or Changed Proposal Feature Template

Table of Contents: Guide for Module Developers — EnergyPlus 8.4