Question-and-Answer Resource for the Building Energy Modeling Community
Get started with the Help page
Ask Your Question

Why measures are not applied to the model in openstudio?

asked 2023-05-30 08:20:58 -0500

Alosius Thomas's avatar

updated 2023-05-30 13:23:38 -0500

I have been working on adding measures like geothermal and co-generation systems for a project in OpenStudio application. However, after running the program, I understood that the measures are not effectively applied on the project model as the energy use values remained the same. Below is the ruby code for cogeneration:

# start the measure
class CogenerationMeasure < OpenStudio::Measure::ModelMeasure
  # Define the name and description of the measure
  def name
    return 'Cogeneration Measure'

  def description
    return 'Upon running the measure, the cogeneration system is created using a micro generator object within the OpenStudio model. The user-defined capacity and efficiency values are assigned to the cogeneration system. The measure then adds the cogeneration system to the primary plant loop of the model, ensuring it becomes part of the overall HVAC system.'

def modeler_description
  return "By applying the Cogeneration Measure, users can assess the impact of integrating a cogeneration system on their model's energy performance. This measure facilitates the evaluation of the combined electricity and heat generation potential, enabling users to analyze metrics such as energy consumption, demand, and cost savings. The measure serves as a valuable tool for energy efficiency analysis and decision-making regarding the implementation of cogeneration systems in OpenStudio models."

  # Define the measure inputs
  def arguments(model)
    args =

    # set capacity
    capacity = OpenStudio::Measure::OSArgument.makeDoubleArgument('capacity', true)
    capacity.setDisplayName('Cogeneration System Capacity')
    args << capacity

    # set efficiency
    efficiency = OpenStudio::Measure::OSArgument.makeDoubleArgument('efficiency', true)
    efficiency.setDisplayName('Cogeneration System Efficiency')
    args << efficiency

    return args

  # define what happens when the measure is run
  def run(model, runner, user_arguments)
    super(model, runner, user_arguments)

    # use the built-in error checking
    if !runner.validateUserArguments(arguments(model), user_arguments)
      return false

    # assign the user inputs to variables
    args = OsLib_HelperMethods.createRunVariables(runner, model, user_arguments, arguments(model))
    if !args then return false end

    # Get the user inputs
    capacity = runner.getDoubleArgumentValue('capacity', user_arguments)
    efficiency = runner.getDoubleArgumentValue('efficiency', user_arguments)

    # Check if the capacity is valid
    if capacity <= 0.0
      runner.registerError('Cogeneration system capacity must be a positive value.')
      return false

    # Check if the efficiency is valid
    if efficiency <= 0.0 || efficiency > 1.0
      runner.registerError('Cogeneration system efficiency must be between 0 and 1.')
      return false

    # Create a cogeneration system object
    cogeneration =
  cogen =, cogeneration)

    # Add the cogeneration system to the primary plant loop
    loop = model.getPlantLoopByName('Hot Water Plant Loop').get

   # Report the success of the measure
    runner.registerInfo('Cogeneration system has been added to the model.')

    return true

# Register the measure with the OpenStudio MeasureManager
edit retag flag offensive close merge delete


A few questions:

  • Why hardwire the plant loop identifier ('Hot Water Plant Loop')? Even if it were for internal use only, the measure could only modify a loop named as such (future projects). In any case, safer to check if get...ByName returns an .empty? (before .get)
  • Also safer to check the return Bool value of methods like setReference...; check if they return false.
  • Does the OSM hold the new cogen objects? The generated IDF as well? If so, any related errors in the eplusout.err file?
Denis Bourgeois's avatar Denis Bourgeois  ( 2023-05-30 09:25:51 -0500 )edit

1 Answer

Sort by ยป oldest newest most voted

answered 2023-05-30 09:56:30 -0500

updated 2023-05-30 10:03:38 -0500

You should make sure you're creating or connecting everything that EnergyPlus needs to have the Generator:MicroTurbine operate in the model. See, for instance, the part:

The ElectricLoadCenter:Generators and ElectricLoadCenter:Distribution objects are used to define the availability and control of all electric generators included in the simulation.

edit flag offensive delete link more


I definitely have a measure somewherethat does this. But anyways, you can find some good example code you can adapt in this regression test:

Julien Marrec's avatar Julien Marrec  ( 2023-05-30 13:28:44 -0500 )edit

Your Answer

Please start posting anonymously - your entry will be published after you log in or create a new account.

Add Answer

Training Workshops


Question Tools

1 follower


Asked: 2023-05-30 08:20:58 -0500

Seen: 69 times

Last updated: May 30 '23