House.h

Go to the documentation of this file.

#ifndef Ajax_House_House_h_
#define Ajax_House_House_h_
/*-----------------------------------------------------------------------------
* This file is part of the Colony.Core Project.  The Colony.Core Project is an
* open source project with a BSD type of licensing agreement.  See the license
* agreement (license.txt) in the top/ directory or on the Internet at
* http://integerfox.com/colony.core/license.txt
*
* Copyright (c) 2014-2023  John T. Taylor
*
* Redistributions of the source code must retain the above copyright notice.
*----------------------------------------------------------------------------*/
/** @file */
 
#include "Ajax/SimHouse/System.h"
 
///
namespace Ajax
{
///
namespace SimHouse
{
 
 
/** This class provides a 'functional' simulation of house with respect to
    Outdoor temperature, Indoor temperature, and active HVAC capacity.  Essentially,
    this class provide functional feedback for a thermostat's control algorithm.
    The feedback is NOT representative of actual house/thermal dynamics, but is
    sufficient to functional test a control algorithm.  This class uses the
    System class as basis for the feedback.
 
    Some terminology, notes, design, etc.
 
    maxOdt                  = Maximum Outdoor temperature for the simulation in degrees Fahrenheit
    minOdt                  = Minimum Outdoor temperature for the simulation in degrees Fahrenheit
    System.maxPotenial      = maxOdt - minOdt;
    coolingCapacity         = -(System.maxPotenial * odtCoolingLoadRating), e.g. -(140' * 0.33)  = -46.2'
    heatingCapacity         =  System.maxPotenial * odtHeatingLoadRating,   e.g. 140' *1.0       = 140'
    percentActivityCapacity = Current active HVAC capacity. 0.0 = No active capacity, 1.0 = Full Capacity
    inPotOdt                = current outdoor temperature - minOdt
    InPotHVAC               = (coolingCapacity? coolingCapacity : heatingCapacity) * percentActivityCapacity
    System.InPot            = inPotOdt + InPotHVAC
    Indoor Temperature      = System.OutPot + minOdt
*/
class House
{
protected:
    /// System simulation
    System      m_sim;
 
    /// Maximum Outdoor temperature
    double      m_maxOdt;
 
    /// Minimum Outdoor temperature
    double      m_minOdt;
 
    /// Cooling capacity
    double      m_coolCap;
 
    /// Heating capacity
    double      m_heatCap;
 
    /// Environment resistance
    double      m_envResistance;
 
    /// Cooling resistance
    double      m_coolingEnvResistance;
 
    /// Heating resistance
    double      m_heatingEnvResistance;
 
public:
    /** Constructor.  See class description for argument semantics.
 
        Note: The systemXxxEnvResistance arguments determines the thermal transfer
              characteristics of the simulated house/system.  The larger the
              value, the slower the thermal transfer. See the System class
              for additional details for these arguments.
     */
    House( double tickPeriodInSeconds         = 1.0,    // i.e. how frequent the tick() method is called
           double initialOdt                  = 70.0,   // Initial outdoor temperature
           double maxOdt                      = 120.0,
           double minOdt                      = -20.0,
           double odtCoolingLoadRating        = 0.33,
           double odtHeatingLoadRating        = 1.0,
           double systemEnvResistance         = 10.0,    // Resistance used when NO active conditioning
           double systemHeatingEnvResistance  = 10.0,    // Resistance used when actively cooling
           double systemCoolingEnvResistance  = 35.0 );  // Resistance used when actively heating
 
public:
    /** This method is called every N seconds.  The call frequency MUST
        match the tickPeriodInSeconds argument specified in the instance's
        constructor.
 
        The method returns the newly calculated indoor temperature in degrees
        Fahrenheit.
     */
    double tick( double currentOdt, double percentActiveCapacity, bool coolingCapacity ) noexcept;
 
};
 
 
 
};      // end namespaces
};
#endif  // end header latch