Framed wall panel schema.yaml

family: framed_wall_panel version: 1.0

description: >

 Parametric framed wall panel with selectable framed height, module width,
 stud lumber size, stud spacing, and exterior sheathing orientation.

dimension_convention:

 nominal_width_ft_means: framed_module_width
 nominal_height_ft_means: framed_panel_height
 description: >
   Module height refers to the framed panel height (bottom plate to top plate).
   Exterior OSB sheathing may extend above the framing and is not included in
   the nominal module height.

parameters:

 nominal_width_ft:
   type: float
   unit: ft
   min: 0.2708
   max: 8.0
   default: 4.0
   description: >
     Framed module width. The minimum value (0.2708 ft = 3.25 in) represents the
     smallest meaningful filler wall module that can be defined. This corresponds
     approximately to the width of two studs fastened together and represents an
     extreme lower bound used only for filler conditions between modules. Typical
     wall modules are significantly wider.

 nominal_height_ft:
   type: float
   unit: ft
   min: 4.0
   max: 20.0
   default: 9.0
   description: >
     Framed panel height measured from bottom plate to top plate.

 stud_lumber_nominal:
   type: enum
   allowed:
     - "2x2"
     - "2x3"
     - "2x4"
     - "2x6"
     - "2x8"
     - "2x10"
     - "2x12"
   default: "2x6"
   description: >
     Nominal stud and plate lumber size.

 stud_spacing_oc_in:
   type: enum
   allowed:
     - 16
     - 24
   default: 24
   description: >
     Stud spacing on center in inches.

 osb_thickness_in:
   type: enum
   allowed:
     - 0.4375
     - 0.5
     - 0.625
     - 0.75
   default: 0.4375
   description: >
     Exterior OSB sheathing thickness.

 exterior_face:
   type: enum
   allowed:
     - north
     - south
     - east
     - west
   default: south
   description: >
     Direction faced by the sheathed exterior side.

 reference_house_orientation:
   type: enum
   allowed:
     - faces_south
   default: faces_south
   description: >
     Global orientation convention.

design_rules:

 sheathing_layers:
   type: fixed
   value: 1
   description: >
     One layer of sheathing is used.

 sheathing_material:
   type: fixed
   value: OSB
   description: >
     Exterior sheathing material for this schema version.

 sheathing_side_rule:
   type: fixed
   value: exterior_only
   description: >
     OSB is applied only to the exterior face.

 standard_module_width_ft:
   type: fixed
   value: 4.0
   description: >
     Preferred standard module width.

 preferred_module_heights_ft:
   type: list
   values:
     - 8.0
     - 9.0
     - 10.0
   description: >
     Preferred standard framed panel heights.

interfaces:

 left_edge:
   type: wall_edge
   orientation: west
   description: >
     Left connection edge in local module coordinates.

 right_edge:
   type: wall_edge
   orientation: east
   description: >
     Right connection edge in local module coordinates.

 top_edge:
   type: wall_edge
   orientation: up
   description: >
     Top edge of module.

 bottom_edge:
   type: wall_edge
   orientation: down
   description: >
     Bottom edge of module.

derived_fields:

 stud_actual_thickness_in:
   source: stud_lumber_nominal
   description: >
     Actual lumber thickness derived from nominal stud size.

 stud_actual_depth_in:
   source: stud_lumber_nominal
   description: >
     Actual lumber depth derived from nominal stud size.

 framed_panel_thickness_in:
   formula: stud_actual_depth_in
   description: >
     Framed wall thickness before exterior sheathing.

 overall_panel_thickness_in:
   formula: stud_actual_depth_in + osb_thickness_in
   description: >
     Total panel thickness including exterior OSB.

 panel_family_id:
   formula: >
     wall_{nominal_width_ft}x{nominal_height_ft}_{stud_lumber_nominal}_{stud_spacing_oc_in}oc_osb{osb_thickness_in}_{exterior_face}
   description: >
     Deterministic identifier for compiled module variants.

constraints:

 - nominal_width_ft >= 0.2708
 - nominal_width_ft <= 8.0
 - nominal_height_ft >= 4.0
 - nominal_height_ft <= 20.0
 - stud_spacing_oc_in in [16,24]
 - stud_lumber_nominal in ["2x2","2x3","2x4","2x6","2x8","2x10","2x12"]
 - osb_thickness_in in [0.4375,0.5,0.625,0.75]
 - exterior_face in [north,south,east,west]