Skip to main content

PNNL

  • About
  • News & Media
  • Careers
  • Events
  • Research
    • Scientific Discovery
      • Biology
        • Chemical Biology
        • Computational Biology
        • Ecosystem Science
        • Human Health
          • Cancer Biology
          • Exposure Science & Pathogen Biology
        • Integrative Omics
          • Advanced Metabolomics
          • Chemical Biology
          • Mass Spectrometry-Based Measurement Technologies
          • Spatial and Single-Cell Proteomics
          • Structural Biology
        • Microbiome Science
          • Biofuels & Bioproducts
          • Human Microbiome
          • Soil Microbiome
          • Synthetic Biology
        • Predictive Phenomics
      • Chemistry
        • Computational Chemistry
        • Chemical Separations
        • Chemical Physics
        • Catalysis
      • Earth & Coastal Sciences
        • Global Change
        • Atmospheric Science
          • Atmospheric Aerosols
          • Human-Earth System Interactions
          • Modeling Earth Systems
        • Coastal Science
        • Ecosystem Science
        • Subsurface Science
        • Terrestrial Aquatics
      • Materials Sciences
        • Materials in Extreme Environments
        • Precision Materials by Design
        • Science of Interfaces
        • Solid Phase Processing
          • Cold Spray
          • Friction Stir Welding & Processing
          • ShAPE
      • Nuclear & Particle Physics
        • Dark Matter
        • Fusion Energy Science
        • Neutrino Physics
      • Quantum Information Sciences
    • Energy Resiliency
      • Electric Grid Modernization
        • Emergency Response
        • Grid Analytics
          • AGM Program
          • Tools and Capabilities
        • Grid Architecture
        • Grid Cybersecurity
        • Grid Energy Storage
        • Transmission
        • Distribution
      • Energy Efficiency
        • Appliance and Equipment Standards
        • Building Energy Codes
        • Building Technologies
          • Advanced Building Controls
          • Advanced Lighting
          • Building-Grid Integration
        • Building and Grid Modeling
        • Commercial Buildings
        • Federal Buildings
          • Federal Performance Optimization
          • Resilience and Security
        • Residential Buildings
          • Building America Solution Center
          • Energy Efficient Technology Integration
          • Home Energy Score
        • Energy Efficient Technology Integration
      • Energy Storage
        • Electrochemical Energy Storage
        • Flexible Loads and Generation
        • Grid Integration, Controls, and Architecture
        • Regulation, Policy, and Valuation
        • Science Supporting Energy Storage
        • Chemical Energy Storage
      • Fossil Energy
        • Subsurface Energy Systems
        • Carbon Management
          • Carbon Capture
          • Carbon Storage
          • Carbon Utilization
        • Advanced Hydrocarbon Conversion
      • Nuclear Energy
        • Fuel Cycle Research
        • Advanced Reactors
        • Reactor Operations
        • Reactor Licensing
      • Renewable Energy
        • Solar Energy
        • Wind Energy
          • Wind Resource Characterization
          • Wildlife and Wind
          • Community Values and Ocean Co-Use
          • Wind Systems Integration
          • Wind Data Management
          • Distributed Wind
        • Marine Energy
          • Environmental Monitoring for Marine Energy
          • Marine Biofouling and Corrosion
          • Marine Energy Resource Characterization
          • Testing for Marine Energy
          • The Blue Economy
        • Hydropower
          • Environmental Performance of Hydropower
          • Hydropower Cybersecurity and Digitalization
          • Hydropower and the Electric Grid
          • Materials Science for Hydropower
          • Pumped Storage Hydropower
          • Water + Hydropower Planning
        • Grid Integration of Renewable Energy
        • Geothermal Energy
      • Transportation
        • Bioenergy Technologies
          • Algal Biofuels
          • Aviation Biofuels
          • Waste-to-Energy and Products
        • Hydrogen & Fuel Cells
        • Vehicle Technologies
          • Emission Control
          • Energy-Efficient Mobility Systems
          • Lightweight Materials
          • Vehicle Electrification
          • Vehicle Grid Integration
      • Environmental Management
        • Waste Processing
        • Radiation Measurement
        • Environmental Remediation
    • National Security
      • Chemical & Biothreat Signatures
        • Contraband Detection
        • Pathogen Science & Detection
        • Explosives Detection
        • Threat-Agnostic Biodefense
      • Cybersecurity
        • Discovery and Insight
        • Proactive Defense
        • Trusted Systems
      • Nuclear Material Science
      • Nuclear Nonproliferation
        • Radiological & Nuclear Detection
        • Nuclear Forensics
        • Ultra-Sensitive Nuclear Measurements
        • Nuclear Explosion Monitoring
        • Global Nuclear & Radiological Security
      • Stakeholder Engagement
        • Disaster Recovery
        • Global Collaborations
        • Legislative and Regulatory Analysis
        • Technical Training
      • Systems Integration & Deployment
        • Additive Manufacturing
        • Deployed Technologies
        • Rapid Prototyping
        • Systems Engineering
      • Threat Analysis
        • Advanced Wireless Security
          • 5G Security
          • RF Signal Detection & Exploitation
        • Internet of Things
        • Maritime Security
        • Millimeter Wave
        • Mission Risk and Resilience
    • Data Science & Computing
      • Artificial Intelligence
      • Graph and Data Analytics
      • Software Engineering
      • Computational Mathematics & Statistics
      • Future Computing Technologies
        • Adaptive Autonomous Systems
    • Publications & Reports
    • Featured Research
  • People
    • Inventors
    • Lab Leadership
    • Lab Fellows
    • Staff Accomplishments
  • Partner with PNNL
    • Education
      • Undergraduate Students
      • Graduate Students
      • Post-graduate Students
      • University Faculty
      • University Partnerships
      • K-12 Educators and Students
      • STEM Education
        • STEM Workforce Development
        • STEM Outreach
        • Meet the Team
      • Internships
    • Community
      • Regional Impact
      • Philanthropy
      • Volunteering
    • Industry
      • Available Technologies
      • Industry
      • Industry Partnerships
      • Licensing & Technology Transfer
      • Entrepreneurial Leave
      • Visual Intellectual Property Search (VIPS)
  • Facilities & Centers
    • All Facilities
      • Atmospheric Radiation Measurement User Facility
      • Electricity Infrastructure Operations Center
      • Energy Sciences Center
      • Environmental Molecular Sciences Laboratory
      • Grid Storage Launchpad
      • Institute for Integrated Catalysis
      • Interdiction Technology and Integration Laboratory
      • PNNL Portland Research Center
      • PNNL Seattle Research Center
      • PNNL-Sequim (Marine and Coastal Research)
      • Radiochemical Processing Laboratory
      • Shallow Underground Laboratory

Module Description File (.DES)

The DES file is the mechanism that informs the FUI the who, what, where, and how to integrate and run a module.

The following outline is a description of the basic information provided in the DES. A link to an example DES file is included after the outline. Comparing the line-by-line description in the outline to the example should clarify and help locate data contained in the WFF file. Lines beginning with ';' are descriptive comments only and will not appear in the actual DES.

A line with: 
  Modeling Framework Check - [Const STRING] - "mf" 
  Modeling Framework Version - [Const STRING] "Version 2.1" 
End Line 
A line with: 
  Model Icon Type - [STRING] 
    ;[Model:|Database:|System:|Viewer:| ...] ... is assume to behave as a model 
  Model Icon Category - [STRING] 
    ;Any user supplied category label 
  Model Icon Category Prefix - [STRING] 
    ;unique three character string to identify the category 
  Module Name - [STRING] 
  Module UI executable or batch path - [STRING] 
    ;Extra command line parameters are also to be included space separated 
  Module Model executable or batch path - [STRING] 
    ;Extra command line parameters are also to be included space separated 
    ;Not used in the Viewer and optional for Database 
End Line 
Multi-Line text enclosed in double quotes with 
  ;Description of model - [STRING] 
  ;It is recommended that the Description editor be used to complete this section 
  ;The text should contain 
  ;  Description of the model 
  ;  Typical uses 
  ;  Limiting assumptions 
  ;  Typical time scale of runs 
  ;  Reference to formulation documents 
  ;  Reference to verification documents if they exist 
  ;  Reference to validation documents if they exist 
  ;  Hardware requirements 
  ;  Contact point for question regarding the model 
End Multi-Line 
A line with: 
  Number of Input Schemes - [INTEGER] 
  [Const STRING] - "Reads" 
End Line 
For each 'Input Scheme' 
  A line with: 
    Number of Input Boundary Conditions - [INTEGER] 
    For each Input Boundary Condition 
      Boundary Condition File Extension - [STRING] 
      Boundary Condition Qualifier - [STRING] 
      Minimum number of this file type required 
      Maximum number of this file type allowed 
    Next Input Boundary Condition 
  End Line 
Next 'Input Scheme' 
A line with: 
  Number of Outputs - [INTEGER] 
  [Const STRING] - "Writes" 
End Line 
For each 'Output' 
  A line with: 
    Boundary Condition File Extension - [STRING] 
    Boundary Condition Qualifier - [STRING] 
  End Line 
Next 'Output' 
A line with: 
  Number of Module Input Variables 
  [Const STRING] - "Variables" 
End Line 
For each 'Module Input Variable' 
  A line with: 
    Variable Name - [STRING] 
    Stochastic Flag - [STRING] 
      ;One of ["NOT STOCHASTIC"|"CONTINUOUS"] 
    Variable Units - [STRING] 
    If a minimum is defined then 
      [Const STRING] - "Min" 
      Minimum value - (float) 
    EndIf 
    If a maximum is defined then 
      [Const STRING] - "Max" 
      Maximum value - (float) 
    EndIf 
    Variable Description - [STRING] 
    Number of Label Ques 
    Datatype - [STRING] 
      ;One of ["String"|"Logical"|"Integer"|"Float"] 
  End Line 
  For each 'Label Que' 
    A line with: 
      If Label Que then 
        [Const STRING] - "Label" 
        Label - [STRING] 
        Index 1-6 - [STRING] 
          ;Indicate which variable indice is to be used for this label 
          ;"Site" is a reserved indice that represents site being assessed 
          ;"Index1" - "Index6" represent the different indices of the variable 
      Else 
        [Const STRING] - "Variable" 
        Variable Name - [STRING] 
          ;Name must be a variable from the FUI or Modules gid section 
        Index 1-6 - [STRING] 
          ;Indicate which variable indice is to be used for this label 
          ;"Site" is a reserved indice that represents site being assessed 
          ;"Index1" - "Index6" represent the different indices of the variable 
          ;An assumption is made that the order of the given indexing 
          ;variable arrays must match this variables order 
      EndIf 
    End Line 
  Next 'Label Que' 
Next 'Module Input Variable'

This DES example is a part of the case_01 test case. 

PNNL

  • Get in Touch
    • Contact
    • Careers
    • Doing Business
    • Environmental Reports
    • Security & Privacy
    • Vulnerability Disclosure Policy
  • Research
    • Scientific Discovery
    • Energy Resiliency
    • National Security
Subscribe to PNNL News
Department of Energy Logo Battelle Logo
Pacific Northwest National Laboratory (PNNL) is managed and operated by Battelle for the Department of Energy
  • YouTube
  • Facebook
  • X (formerly Twitter)
  • Instagram
  • LinkedIn