Ajax::SimHouse::House Class Reference

This class provides a 'functional' simulation of house with respect to Outdoor temperature, Indoor temperature, and active HVAC capacity. More...

Detailed Description

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

#include <House.h>

Collaboration diagram for Ajax::SimHouse::House:

Public Member Functions
	House (double tickPeriodInSeconds=1.0, double initialOdt=70.0, double maxOdt=120.0, double minOdt=-20.0, double odtCoolingLoadRating=0.33, double odtHeatingLoadRating=1.0, double systemEnvResistance=10.0, double systemHeatingEnvResistance=10.0, double systemCoolingEnvResistance=35.0)
	Constructor.
double	tick (double currentOdt, double percentActiveCapacity, bool coolingCapacity) noexcept
	This method is called every N seconds.

Protected Attributes
System	m_sim
	System simulation.
double	m_maxOdt
	Maximum Outdoor temperature.
double	m_minOdt
	Minimum Outdoor temperature.
double	m_coolCap
	Cooling capacity.
double	m_heatCap
	Heating capacity.
double	m_envResistance
	Environment resistance.
double	m_coolingEnvResistance
	Cooling resistance.
double	m_heatingEnvResistance
	Heating resistance.

Constructor & Destructor Documentation

House()

Ajax::SimHouse::House::House	(	double	tickPeriodInSeconds = 1.0,
		double	initialOdt = 70.0,
		double	maxOdt = 120.0,
		double	minOdt = -20.0,
		double	odtCoolingLoadRating = 0.33,
		double	odtHeatingLoadRating = 1.0,
		double	systemEnvResistance = 10.0,
		double	systemHeatingEnvResistance = 10.0,
		double	systemCoolingEnvResistance = 35.0
	)

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.

Member Function Documentation

tick()

double Ajax::SimHouse::House::tick ( double  currentOdt, double  percentActiveCapacity, bool  coolingCapacity  )

noexcept

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.

Member Data Documentation

m_coolCap

double Ajax::SimHouse::House::m_coolCap

protected

Cooling capacity.

m_coolingEnvResistance

double Ajax::SimHouse::House::m_coolingEnvResistance

protected

Cooling resistance.

m_envResistance

double Ajax::SimHouse::House::m_envResistance

protected

Environment resistance.

m_heatCap

double Ajax::SimHouse::House::m_heatCap

protected

Heating capacity.

m_heatingEnvResistance

double Ajax::SimHouse::House::m_heatingEnvResistance

protected

Heating resistance.

m_maxOdt

double Ajax::SimHouse::House::m_maxOdt

protected

Maximum Outdoor temperature.

m_minOdt

double Ajax::SimHouse::House::m_minOdt

protected

Minimum Outdoor temperature.

m_sim

System Ajax::SimHouse::House::m_sim

protected

System simulation.

---

The documentation for this class was generated from the following file:

• Ajax/SimHouse/House.h