JSON Schema

Properties

• topology (array, required): A list of name/type map objects that define the system topology.
• Items (object): Cannot contain additional properties.
  • name (string, required): Length must be at least 1.
  • type (string, required): Length must be at least 1.
• fluid (object, required): A fluid definition object. Cannot contain additional properties.
• fluid_name (string, required): Circulation fluid type. Must be one of: "WATER", "ETHYLALCOHOL", "ETHYLENEGLYCOL", "METHYLALCOHOL", or "PROPYLENEGLYCOL".
• concentration_percent (number, format: Percent, required): Mass fraction concentration percent of circulation fluid. e.g.: '0' indicates pure water; '20' indicates 20% antifreeze, 80% pure water. Minimum: 0. Maximum: 60.
• temperature (number, format: Centigrade, required): Average design fluid temperature at peak conditions.
• building (object): A map of available building definition objects. Can contain additional properties.
• Additional properties (object): Cannot contain additional properties.
  • name (string, required)
  • loads (string, required)
  • cop (number, required)
  • capacity (string, required)
• ground_heat_exchanger (object, required): A collection of objects that define a ground heat exchanger system. Can contain additional properties.
• Additional properties (object): Cannot contain additional properties.
  • flow_rate (number, format: Liters/Second, required): Volumetric design flow rate. Value specified will be either the system or per-borehole flow rate depending on the 'flow_type' set. Minimum: 0.
  • flow_type (string, required): Indicates whether the design volumetric flow rate set on on a per-borehole or system basis. Must be one of: "BOREHOLE" or "SYSTEM".
  • grout (object, required): Cannot contain additional properties.
  • conductivity (required): Refer to #/$defs/conductivity.
  • rho_cp (required): Refer to #/$defs/rho_cp.
  • soil (object, required): Cannot contain additional properties.
  • conductivity (required): Refer to #/$defs/conductivity.
  • rho_cp (required): Refer to #/$defs/rho_cp.
  • undisturbed_temp (number, format: Centigrade, required): Undisturbed, far-field soil temperature.
  • pipe (object, required)
  • One of
    • : Cannot contain additional properties.
    • arrangement: Must be: "SINGLEUTUBE".
    • inner_diameter (required): Refer to #/$defs/inner_diameter.
    • outer_diameter (required): Refer to #/$defs/outer_diameter.
    • shank_spacing (required): Refer to #/$defs/shank_spacing.
    • roughness (required): Refer to #/$defs/roughness.
    • conductivity (required): Refer to #/$defs/conductivity.
    • rho_cp (required): Refer to #/$defs/rho_cp.
    • num_pipes (integer): Number of single U-tube pipes in the borehole. Default is 1. Minimum: 1. Default: 1.
    • : Cannot contain additional properties.
    • arrangement: Must be: "DOUBLEUTUBESERIES".
    • inner_diameter (required): Refer to #/$defs/inner_diameter.
    • outer_diameter (required): Refer to #/$defs/outer_diameter.
    • shank_spacing (required): Refer to #/$defs/shank_spacing.
    • roughness (required): Refer to #/$defs/roughness.
    • conductivity (required): Refer to #/$defs/conductivity.
    • rho_cp (required): Refer to #/$defs/rho_cp.
    • : Cannot contain additional properties.
    • arrangement: Must be: "DOUBLEUTUBEPARALLEL".
    • inner_diameter (required): Refer to #/$defs/inner_diameter.
    • outer_diameter (required): Refer to #/$defs/outer_diameter.
    • shank_spacing (required): Refer to #/$defs/shank_spacing.
    • roughness (required): Refer to #/$defs/roughness.
    • conductivity (required): Refer to #/$defs/conductivity.
    • rho_cp (required): Refer to #/$defs/rho_cp.
    • : Cannot contain additional properties.
    • arrangement: Must be: "COAXIAL".
    • inner_pipe_d_in (number, format: Meters, required): Inner pipe inner diameter. Minimum: 0.
    • inner_pipe_d_out (number, format: Meters, required): Inner pipe outer diameter. Minimum: 0.
    • outer_pipe_d_in (number, format: Meters, required): Outer pipe inner diameter. Minimum: 0.
    • outer_pipe_d_out (number, format: Meters, required): Outer pipe outer diameter. Minimum: 0.
    • roughness (required): Refer to #/$defs/roughness.
    • conductivity_inner (number, format: Watts/Meters-Kelvin, required): Thermal conductivity of inner pipe. Minimum: 0.
    • conductivity_outer (number, format: Watts/Meter-Kelvin, required): Thermal conductivity of outer pipe. Minimum: 0.
    • rho_cp (required): Refer to #/$defs/rho_cp.
  • arrangement (string): Pipe arrangement specified. Must be one of: "SINGLEUTUBE", "DOUBLEUTUBESERIES", "DOUBLEUTUBEPARALLEL", or "COAXIAL".
  • borehole (object, required): Cannot contain additional properties.
  • buried_depth (number, format: Meters, required): Depth of top of borehole below the ground surface. Minimum: 0.
  • diameter (number, format: Meters, required): Diameter of borehole.
  • pre_designed (object): Data related to a pre-designed borehole field, used in cases where the field arrangement is known ahead of time. GHEDesigner will provide a g-function calculation for the specified field.
  • One of
    • : Cannot contain additional properties.
    • arrangement: Must be: "MANUAL".
    • H (required): Refer to #/$defs/H.
    • x (array, required): For MANUAL arrangement, this provides an array of x coordinate positions, one for each borehole in the field.
      • Items (number)
    • y (array, required): For MANUAL arrangement, this provides an array of y coordinate positions, one for each borehole in the field.
      • Items (number)
    • : Cannot contain additional properties.
    • arrangement: Must be: "RECTANGLE".
    • H (required): Refer to #/$defs/H.
    • boreholes_in_x_dimension (integer, required): Number of boreholes in the x direction of the field, dimensionless. Minimum: 0.
    • boreholes_in_y_dimension (integer, required): Number of boreholes in the y direction of the field, dimensionless. Minimum: 0.
    • spacing_in_x_dimension (number, format: Meters, required): Borehole spacing in the x direction of the field, in meters (ignored if boreholes_in_x_dimension = 1). Minimum: 0.
    • spacing_in_y_dimension (number, format: Meters, required): Borehole spacing in the y direction of the field, in meters (ignored if boreholes_in_y_dimension = 1). Minimum: 0.
  • arrangement (string): Pipe arrangement specified. Must be one of: "MANUAL" or "RECTANGLE".
  • geometric_constraints (object)
  • One of
    • : Cannot contain additional properties.
    • method: Must be: "BIRECTANGLE".
    • length (required): Refer to #/$defs/length.
    • width (required): Refer to #/$defs/width.
    • b_min (required): Refer to #/$defs/b_min.
    • b_max_x (required): Refer to #/$defs/b_max_x.
    • b_max_y (required): Refer to #/$defs/b_max_y.
    • : Cannot contain additional properties.
    • method: Must be: "BIRECTANGLECONSTRAINED".
    • b_min (required): Refer to #/$defs/b_min.
    • b_max_x (required): Refer to #/$defs/b_max_x.
    • b_max_y (required): Refer to #/$defs/b_max_y.
    • property_boundary (required): Refer to #/$defs/property_boundary.
    • no_go_boundaries: Refer to #/$defs/no_go_boundaries.
    • : Cannot contain additional properties.
    • method: Must be: "BIZONEDRECTANGLE".
    • length (required): Refer to #/$defs/length.
    • width (required): Refer to #/$defs/width.
    • b_min (required): Refer to #/$defs/b_min.
    • b_max_x (required): Refer to #/$defs/b_max_x.
    • b_max_y (required): Refer to #/$defs/b_max_y.
    • : Cannot contain additional properties.
    • method: Must be: "NEARSQUARE".
    • length (required): Refer to #/$defs/length.
    • b (number, format: Meters, required): Borehole-to-borehole spacing. Minimum: 0.
    • : Cannot contain additional properties.
    • method: Must be: "RECTANGLE".
    • length (required): Refer to #/$defs/length.
    • width (required): Refer to #/$defs/width.
    • b_min (required): Refer to #/$defs/b_min.
    • b_max (required): Refer to #/$defs/b_max.
    • : Cannot contain additional properties.
    • method: Must be: "ROWWISE".
    • min_spacing (number, format: Meters, required): The smallest minimum spacing that will be used to generate a RowWise field. Minimum: 0.
    • max_spacing (number, format: Meters, required): The largest minimum spacing that will be used to generate a RowWise field. Minimum: 0.
    • spacing_step (number, format: Meters): The distance in spacing from the design found in the first part of first search to exhaustively check in the second part. Minimum: 0.
    • min_rotation (number, format: Degrees, required): The minimum rotation of the rows of each field relative to horizontal that will be used in the search. Minimum: -90. Maximum: 90.
    • max_rotation (number, format: Degrees, required): The maximum rotation of the rows of each field relative to horizontal that will be used in the search. Minimum: -90. Maximum: 90.
    • rotate_step (number, format: Degrees, required): Step size for field rotation search.
    • property_boundary (required): Refer to #/$defs/property_boundary.
    • no_go_boundaries: Refer to #/$defs/no_go_boundaries.
    • perimeter_spacing_ratio (number, format: fraction): The ratio between the minimum spacing between boreholes placed along the property and no-go zones and the standard borehole-to-borehole spacing used for internal boreholes. Minimum: 0.
  • method (string): Design algorithm specified. Must be one of: "BIRECTANGLE", "BIRECTANGLECONSTRAINED", "BIZONEDRECTANGLE", "NEARSQUARE", "RECTANGLE", or "ROWWISE".
  • design (object): Cannot contain additional properties.
  • max_eft (number, format: Centigrade, required): Maximum heat pump entering fluid temperature.
  • min_eft (number, format: Centigrade, required): Minimum heat pump entering fluid temperature.
  • max_boreholes (number): Maximum number of boreholes in search. Optional. Applies to rectangular and near-square design algorithms. If unspecified, the search space will be bounded by the size of the GHE boundary.
  • continue_if_design_unmet (boolean): Causes to return the best available borehole field configuration rather than fail if design conditions are unmet. Optional. Default False. Default: false.
  • max_height (number, format: Meters, required): Maximum height, or active length, of each borehole heat exchanger. Minimum: 0.
  • min_height (number, format: Meters, required): Minimum height, or active length, of each borehole heat exchanger. Minimum: 0.
  • loads: Refer to #/$defs/loads.
• simulation_control (object): . Cannot contain additional properties.
• sizing_run (boolean): Field enables or disables running sizing calculations.
• hourly_run (boolean): Field enables running hour simulation.
• sizing_months (number, format: Months, required): Number of months used in ground heat exchanger sizing. Minimum: 1.
• timestep (string): This field is currently unused. Simulation timestep used in ground heat exchanger sizing. 'HYBRID' is the only option currently available. Must be one of: "HYBRID" or "HOURLY". Default: "HYBRID".
• version (integer, required): An integer version ID for this input structure, for future-proofing.

Definitions

• b_max (number, format: Meters): Maximum borehole-to-borehole spacing. Minimum: 0.
• b_max_x (number, format: Meters): Maximum borehole-to-borehole spacing in x-direction. Minimum: 0.
• b_max_y (number, format: Meters): Maximum borehole-to-borehole spacing in y-direction. Minimum: 0.
• b_min (number, format: Meters): Minimum borehole-to-borehole spacing. Minimum: 0.
• column (string or integer)
• conductivity (number, format: Watts/Meter-Kelvin): Thermal conductivity. Minimum: 0.
• file_path (string)
• H (number, format: Meters): Length of each borehole. Minimum: 0.
• inner_diameter (number, format: Meters): Inner diameter of pipe. Minimum: 0.
• length (number, format: Meters): Horizontal length of property boundary defining surface area available for ground heat exchanger. Minimum: 0.
• load_values (array, format: Watts): Annual, hourly loads of the object. Positive value indicate heating/heat extraction, negative values indicate cooling/heat rejection. Length must be equal to 8760.
• Items (number)
• loads (object): Cannot contain additional properties.
• One of
  • : Cannot contain additional properties.
  • load_values (required): Refer to #/$defs/load_values.
  • : Cannot contain additional properties.
  • column (required): Refer to #/$defs/column.
  • file_path (required): Refer to #/$defs/file_path.
• column: Refer to #/$defs/column.
• file_path: Refer to #/$defs/file_path.
• load_values: Refer to #/$defs/load_values.
• no_go_boundaries (array, format: Meters): (x, y) coordinate points of closed polygon defining go/no-go boundaries. Go/no-go zones must lie within the area defined in 'property_boundary'. Points should be entered in a counter-clockwise fashion.
• Items (array)
  • Items (array): Length must be equal to 2.
  • Items (number): Minimum: 0.
• outer_diameter (number, format: Meters): Outer diameter of pipe. Minimum: 0.
• property_boundary (array, format: Meters): (x, y) coordinate points of closed polygon defining property boundary. Points should be entered in a counter-clockwise fashion.
• Items (array): Length must be equal to 2.
  • Items (number): Minimum: 0.
• rho_cp (number, format: Joules/Meter^3-Kelvin): Volumetric heat capacity. Minimum: 0.
• roughness (number, format: Meters): Surface roughness of pipe. Minimum: 0.
• shank_spacing (number, format: Meters): Spacing between up/down legs of u-tube pipe, as measured from nearest outer surfaces of each pipe (o<-- s -->o). Minimum: 0.
• width (number, format: Meters): Horizontal width of property boundary defining surface area available for ground heat exchanger. Minimum: 0.