Skip to content

docs(api): state c_m in Wh/(m²K), the unit the pipeline uses #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jravani merged 1 commit into from
Oct 1, 2026
Merged

docs(api): state c_m in Wh/(m²K), the unit the pipeline uses #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/openapi/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -543,10 +543,10 @@ components:
type: number
format: double
description: >
Overrides HeatTransfer.C_m (J/(m²K)), the internal heat capacity per m²
Overrides HeatTransfer.C_m (Wh/(m²K)), the internal heat capacity per m²
of useful floor area. Feeds the gain-utilization time constant
(calc_level_12.go). Must be greater than 0.
example: 165000
example: 45
surfaces:
type: array
description: >
Expand Down
2 changes: 1 addition & 1 deletion internal/models/field_metadata.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ var AllFieldMetadata = []FieldMetadata{
Key: "c_m",
Group: "HeatTransfer",
Path: "AdvancedParameters.HeatTransfer.c_m",
Unit: "J/(m²K)",
Unit: "Wh/(m²K)",
Label: "Thermal mass",
SimpleDescription: "How much heat the building's structure (walls, floors) can store — heavier, denser buildings store more.",
ExpertDescription: "Internal heat capacity per m² of useful floor area.",
Expand Down
2 changes: 1 addition & 1 deletion schemas/example_request.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"n_Storey": 3,
"n_air_infiltration": 0.15,
"n_air_use": 0.4,
"c_m": 165000,
"c_m": 45,
"surfaces": [
{"id": "wall-1", "type": "wall", "area": 60.0, "u_value": 0.8, "azimuth": 180},
{"id": "wall-2", "type": "wall", "area": 45.0, "u_value": 0.8, "azimuth": 90},
Expand Down
2 changes: 1 addition & 1 deletion schemas/request_schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
"c_m": {
"type": "number",
"exclusiveMinimum": 0,
"description": "Overrides the effective heat capacity, J/K."
"description": "Overrides the internal heat capacity per m² of reference floor area, Wh/(m²K)."
},
"surfaces": {
"type": "array",
Expand Down
Loading