gtopt::PlanningOptions struct

#include <gtopt/planning_options.hpp>

Public functions

auto merge(PlanningOptions&& opts) -> void

auto migrate_flat_to_model_options() -> void

Public variables

OptReal annual_discount_rate

Annual discount rate for multi-stage CAPEX calculations [p.u./year].

CascadeOptions cascade_options

Cascade solver configuration (sub-object)

std::optional<ConstraintMode> constraint_mode

OptReal demand_fail_cost

Penalty cost for unserved demand (load shedding) [$/MWh].

OptReal hydro_fail_cost

Default penalty cost for unmet hydro rights [$/m3]. Applied to FlowRight and VolumeRight deficit variables when the per-element fail_cost is not set. Default: 5.0 $/m3. For FlowRight, multiplied by block duration × flow_conversion_rate to convert from $/m3 to the flow variable's units.

OptReal hydro_use_value

Default value of exercising hydro rights [$/m3]. Applied as negative objective coefficient (benefit) on FlowRight and VolumeRight flow variables when the per-element use_value is not set. Default: 1.0 $/m3. For FlowRight, multiplied by block duration × flow_conversion_rate to convert from $/m3 to the flow variable's units.

OptName input_directory

Root directory for external input data files (CSV/Parquet)

std::optional<DataFormat> input_format

Preferred format for reading external files: parquet or csv.

OptReal kirchhoff_threshold

Minimum bus voltage [kV] below which Kirchhoff is not applied [kV].

OptName log_directory

Directory for log and trace files (default: "logs"). Used for error LP dumps (both monolithic and SDDP) and SDDP iteration logs.

OptInt loss_segments

Default number of piecewise-linear segments for quadratic line losses (default: 1, meaning linear model only)

std::optional<CompressionCodec> lp_compression

Compression codec for LP debug files.

OptBool lp_debug

When true, save LP debug files to the log directory. Monolithic solver: saves one LP file per (scene, phase) after building the model. SDDP solver: saves one LP file per (iteration, scene, phase) during the forward pass.

OptInt lp_debug_phase_max

Maximum phase UID for selective LP debug saving (inclusive).

OptInt lp_debug_phase_min

Minimum phase UID for selective LP debug saving (inclusive). When set together with lp_debug=true, only phases with uid >= lp_debug_phase_min are saved. Default: save all.

OptInt lp_debug_scene_max

Maximum scene UID for selective LP debug saving (inclusive).

OptInt lp_debug_scene_min

Minimum scene UID for selective LP debug saving (inclusive). When set together with lp_debug=true, only scenes with uid >= lp_debug_scene_min are saved. Default: save all.

LpMatrixOptions lp_matrix_options

LP matrix assembly configuration (epsilon, naming, stats, etc.)

OptBool lp_only

When true, build all scene/phase LP matrices but skip solving. Both the monolithic and SDDP solvers exit immediately after LP matrix assembly — no solving occurs at all. Combine with lp_debug=true to save every scene/phase LP file.

std::optional<MethodType> method

Planning solver type: monolithic (default), sddp, or cascade.

ModelOptions model_options

Power system model configuration (sub-object).

MonolithicOptions monolithic_options

Monolithic solver configuration (sub-object)

std::optional<CompressionCodec> output_compression

Compression codec for Parquet output: gzip (default), zstd, uncompressed.

OptName output_directory

Root directory for output result files.

std::optional<DataFormat> output_format

Format for output files: parquet (default) or csv.

OptReal reserve_fail_cost

Penalty cost for unserved spinning-reserve requirement [$/MWh].

OptReal scale_objective

Divisor applied to all objective coefficients for numerical stability [dimensionless].

OptReal scale_theta

Scaling factor for voltage-angle variables [dimensionless].

SddpOptions sddp_options

SDDP solver configuration (sub-object)

SolverOptions solver_options

LP solver configuration (algorithm, tolerances, threads, etc.)

OptBool use_kirchhoff

Whether to apply DC Kirchhoff voltage-law constraints (default: false)

OptBool use_line_losses

Whether to model resistive line losses (default: true)

OptBool use_single_bus

Whether to collapse the network to a single bus (copper-plate model)

OptBool use_uid_fname

Use element UIDs instead of names in output filenames.

Array<VariableScale> variable_scales

Per-class/variable LP scale overrides.

Function documentation

Variable documentation

{ "options": { "lp_matrix_options": { "eps": 1e-10,
                                     "compute_stats": true } } }

{ "options": { "method": "cascade" } }

{ "options": { "solver_options": { "algorithm": 3,
                                   "optimal_eps": 1e-8,
                                   "feasible_eps": 1e-8 } } }

{
  "options": {
    "variable_scales": [
      {"class_name": "Bus",       "variable": "theta",   "uid": -1,
       "scale": 0.001},
      {"class_name": "Reservoir",  "variable": "energy",  "uid": -1,
       "scale": 1000.0},
      {"class_name": "Battery",    "variable": "energy",  "uid": 1,
       "scale": 10.0}
    ]
  }
}