Config reference¶
Every key a TANGO config accepts, generated from the code
(tools/gen_reference.py reads the pydantic schemas and their
docstrings). How the blocks become objects is described in
Config to objects; start a new config from an
template.
title and description¶
| Key | Type | Default | Meaning |
|---|---|---|---|
summary |
str |
required | undocumented |
author |
str \| None |
None |
undocumented |
date |
str \| None |
None |
undocumented |
description |
str |
'' |
undocumented |
common¶
Fluid and rock properties shared by every component.
| Key | Type | Default | Meaning |
|---|---|---|---|
fluid_name |
str |
required | undocumented |
rock_density |
float |
required | undocumented |
rock_cp |
float |
required | undocumented |
rock_k |
float |
required | undocumented |
thermal_gradient |
float |
required | undocumented |
surface_temperature |
float |
required | undocumented |
surface_pressure |
float |
required | undocumented |
coolprop_backend |
CoolPropBackend |
<CoolPropBackend.HEOS: 'HEOS'> |
undocumented |
saturation_margin |
float |
0.05 |
undocumented |
layout¶
| Key | Type | Default | Meaning |
|---|---|---|---|
well_pattern_dimens |
list[int] \| None |
None |
undocumented |
Filled in automatically, not set in this block: well_spacing from layout.well_spacing, well_pattern from layout.well_pattern.
sim_config¶
| Key | Type | Default | Meaning |
|---|---|---|---|
num_tsteps |
int \| None |
None |
undocumented |
dt_years |
float \| None |
None |
undocumented |
time_stepping |
TimeStepping \| None |
None |
undocumented |
injection_mode |
InjectionPolicy \| None |
None |
undocumented |
mass_rate |
float \| None |
None |
undocumented |
bc_checkpoint_idx |
int \| None |
None |
undocumented |
Filled in automatically, not set in this block: target_extraction_pressure from sim_config.target_extraction_pressure.
components: well¶
horizontal_well · numerical → NumericalWell¶
| Key | Type | Default | Meaning |
|---|---|---|---|
component_idx |
int |
required | undocumented |
save_interval |
int \| None |
1 |
undocumented |
prev |
int |
required | undocumented |
next |
int |
required | undocumented |
well_length |
float |
required | undocumented |
diameter |
float |
required | undocumented |
pipe_roughness |
float |
required | undocumented |
gravity |
float |
9.81 |
undocumented |
angle_from_vert_deg |
float |
0.0 |
undocumented |
num_cells |
int |
required | undocumented |
discretization_given |
tuple[str, ...] |
() |
undocumented |
cell_length |
float |
required | undocumented |
wellhead_depth |
float |
0.0 |
undocumented |
gravity_scale_factor |
float |
1.0 |
undocumented |
friction_model |
FrictionModel |
<FrictionModel.HAALAND: 'haaland'> |
undocumented |
heat_transfer_model |
HeatTransferModel |
<HeatTransferModel.ZHANG_2011: 'zhang-2011'> |
undocumented |
Filled in automatically, not set in this block: common from the common: block.
injection_well · lumped → LumpedInjectionWell¶
| Key | Type | Default | Meaning |
|---|---|---|---|
component_idx |
int |
required | undocumented |
save_interval |
int \| None |
1 |
undocumented |
prev |
int |
required | undocumented |
next |
int |
required | undocumented |
well_length |
float |
required | undocumented |
diameter |
float |
required | undocumented |
pipe_roughness |
float |
required | undocumented |
gravity |
float |
9.81 |
undocumented |
Filled in automatically, not set in this block: common from the common: block.
injection_well · numerical → NumericalInjectionWell¶
| Key | Type | Default | Meaning |
|---|---|---|---|
component_idx |
int |
required | undocumented |
save_interval |
int \| None |
1 |
undocumented |
prev |
int |
required | undocumented |
next |
int |
required | undocumented |
well_length |
float |
required | undocumented |
diameter |
float |
required | undocumented |
pipe_roughness |
float |
required | undocumented |
gravity |
float |
9.81 |
undocumented |
num_cells |
int |
required | undocumented |
discretization_given |
tuple[str, ...] |
() |
undocumented |
cell_length |
float |
required | undocumented |
wellhead_depth |
float |
0.0 |
undocumented |
gravity_scale_factor |
float |
1.0 |
undocumented |
friction_model |
FrictionModel |
<FrictionModel.HAALAND: 'haaland'> |
undocumented |
heat_transfer_model |
HeatTransferModel |
<HeatTransferModel.ZHANG_2011: 'zhang-2011'> |
undocumented |
Filled in automatically, not set in this block: common from the common: block.
production_well · lumped → LumpedProductionWell¶
| Key | Type | Default | Meaning |
|---|---|---|---|
component_idx |
int |
required | undocumented |
save_interval |
int \| None |
1 |
undocumented |
prev |
int |
required | undocumented |
next |
int |
required | undocumented |
well_length |
float |
required | undocumented |
diameter |
float |
required | undocumented |
pipe_roughness |
float |
required | undocumented |
gravity |
float |
9.81 |
undocumented |
Filled in automatically, not set in this block: common from the common: block.
production_well · numerical → NumericalProductionWell¶
| Key | Type | Default | Meaning |
|---|---|---|---|
component_idx |
int |
required | undocumented |
save_interval |
int \| None |
1 |
undocumented |
prev |
int |
required | undocumented |
next |
int |
required | undocumented |
well_length |
float |
required | undocumented |
diameter |
float |
required | undocumented |
pipe_roughness |
float |
required | undocumented |
gravity |
float |
9.81 |
undocumented |
num_cells |
int |
required | undocumented |
discretization_given |
tuple[str, ...] |
() |
undocumented |
cell_length |
float |
required | undocumented |
wellhead_depth |
float |
0.0 |
undocumented |
gravity_scale_factor |
float |
1.0 |
undocumented |
friction_model |
FrictionModel |
<FrictionModel.HAALAND: 'haaland'> |
undocumented |
heat_transfer_model |
HeatTransferModel |
<HeatTransferModel.ZHANG_2011: 'zhang-2011'> |
undocumented |
Filled in automatically, not set in this block: common from the common: block.
production_well_with_pump · lumped → LumpedProductionWellWithPump¶
| Key | Type | Default | Meaning |
|---|---|---|---|
component_idx |
int |
required | undocumented |
save_interval |
int \| None |
1 |
undocumented |
prev |
int |
required | undocumented |
next |
int |
required | undocumented |
well_length |
float |
required | undocumented |
diameter |
float |
required | undocumented |
pipe_roughness |
float |
required | undocumented |
gravity |
float |
9.81 |
undocumented |
pump_efficiency |
float |
1.0 |
undocumented |
Filled in automatically, not set in this block: common from the common: block, target_extraction_pressure from sim_config.target_extraction_pressure.
production_well_with_pump · numerical → NumericalProductionWellWithPump¶
| Key | Type | Default | Meaning |
|---|---|---|---|
component_idx |
int |
required | undocumented |
save_interval |
int \| None |
1 |
undocumented |
prev |
int |
required | undocumented |
next |
int |
required | undocumented |
well_length |
float |
required | undocumented |
diameter |
float |
required | undocumented |
pipe_roughness |
float |
required | undocumented |
gravity |
float |
9.81 |
undocumented |
num_cells |
int |
required | undocumented |
discretization_given |
tuple[str, ...] |
() |
undocumented |
cell_length |
float |
required | undocumented |
wellhead_depth |
float |
0.0 |
undocumented |
gravity_scale_factor |
float |
1.0 |
undocumented |
friction_model |
FrictionModel |
<FrictionModel.HAALAND: 'haaland'> |
undocumented |
heat_transfer_model |
HeatTransferModel |
<HeatTransferModel.ZHANG_2011: 'zhang-2011'> |
undocumented |
Filled in automatically, not set in this block: common from the common: block.
components: well grouped subsurface¶
grouped_subsurface · numerical → NumericalGroupedSubsurface¶
| Key | Type | Default | Meaning |
|---|---|---|---|
component_idx |
int |
required | undocumented |
save_interval |
int \| None |
1 |
undocumented |
prev |
int |
required | undocumented |
next |
int |
required | undocumented |
Filled in automatically, not set in this block: common from the common: block, target_extraction_pressure from sim_config.target_extraction_pressure.
Nested blocks:
| Block | Keys | Meaning |
|---|---|---|
injection_well: |
the keys of injection_well · numerical |
undocumented |
horizontal_well: |
the keys of horizontal_well · numerical |
undocumented |
production_well: |
the keys of production_well · numerical |
undocumented |
grouped_subsurface · raft → RaftGroupedSubsurface¶
| Key | Type | Default | Meaning |
|---|---|---|---|
component_idx |
int |
required | undocumented |
save_interval |
int \| None |
1 |
undocumented |
prev |
int |
required | undocumented |
next |
int |
required | undocumented |
Filled in automatically, not set in this block: common from the common: block, target_extraction_pressure from sim_config.target_extraction_pressure.
Nested blocks:
| Block | Keys | Meaning |
|---|---|---|
injection_well: |
WellSegment keys, below |
undocumented |
horizontal_well: |
WellSegment keys, below |
undocumented |
production_well: |
WellSegment keys, below |
undocumented |
raft: |
RaftWrapper keys, below |
undocumented |
WellSegment (injection_well:, horizontal_well:, production_well:):
| Key | Type | Default | Meaning |
|---|---|---|---|
well_length |
float |
required | undocumented |
diameter |
float |
required | undocumented |
pipe_roughness |
float |
required | undocumented |
wellhead_depth |
float |
0.0 |
undocumented |
RaftWrapper (raft:):
| Key | Type | Default | Meaning |
|---|---|---|---|
template |
str |
required | undocumented |
verbosity |
Literal['quiet', 'lite', 'full'] |
'quiet' |
undocumented |
components: reservoir¶
reservoir · lumped → LumpedReservoir¶
| Key | Type | Default | Meaning |
|---|---|---|---|
component_idx |
int |
required | undocumented |
save_interval |
int \| None |
1 |
undocumented |
prev |
int |
required | undocumented |
next |
int |
required | undocumented |
reservoir_depth |
float |
required | undocumented |
thickness |
float |
required | undocumented |
permeability |
float |
required | undocumented |
porosity |
float |
required | undocumented |
hydro_static_pressure |
float |
required | undocumented |
over_pressure_percentage |
float |
required | undocumented |
brine_density |
float |
1000.0 |
undocumented |
gravity |
float |
9.81 |
undocumented |
well_eff_diameter |
float |
0.41 |
undocumented |
net_to_gross_ratio |
float |
1.0 |
undocumented |
Filled in automatically, not set in this block: common from the common: block, well_spacing from layout.well_spacing, well_pattern from layout.well_pattern.
components: surface¶
surface · graph → GraphSurface¶
| Key | Type | Default | Meaning |
|---|---|---|---|
component_idx |
int |
required | undocumented |
save_interval |
int \| None |
1 |
undocumented |
prev |
int |
required | undocumented |
next |
int |
required | undocumented |
pipe_diameter |
float |
required | undocumented |
pipe_roughness |
float |
required | undocumented |
approach_temperature |
float |
required | undocumented |
power_plant |
dict[str, Any] |
computed | undocumented |
record_node_detail |
bool |
True |
undocumented |
Filled in automatically, not set in this block: common from the common: block, target_extraction_pressure from sim_config.target_extraction_pressure, well_spacing from layout.well_spacing.
Plant graph nodes:
Node type |
TESPy class |
|---|---|
Compressor |
tespy.components.Compressor |
CycleCloser |
tespy.components.CycleCloser |
DropletSeparator |
tespy.components.DropletSeparator |
HeatExchanger |
tespy.components.HeatExchanger |
Merge |
tespy.components.Merge |
SimpleHeatExchanger |
tespy.components.SimpleHeatExchanger |
Sink |
tespy.components.Sink |
Source |
tespy.components.Source |
Turbine |
tespy.components.Turbine |
Valve |
tespy.components.Valve |
PumpOrValve |
resolved to a valve or a compressor at solve time |
Node role (optional): net_electric, net_thermal.
economic economic¶
economic · doublet → DoubletEconomicComponent¶
| Key | Type | Default | Meaning |
|---|---|---|---|
component_idx |
int |
required | undocumented |
save_interval |
int \| None |
1 |
undocumented |
project_maturity |
ProjectMaturity |
required | undocumented |
discount_rate |
float |
required | undocumented |
main_product |
MainProduct |
<MainProduct.ELECTRICITY: 'electricity'> |
undocumented |
capacity_factor |
float |
0.9 |
undocumented |
opex_cost_fraction |
float |
0.045 |
undocumented |
electricity_price |
float |
0.25 |
undocumented |
heat_price |
float |
0.05 |
undocumented |
gengeo_quadratic_length_coeff |
float |
0.105 |
undocumented |
gengeo_diameter_length_coeff |
float |
1776.0 |
undocumented |
gengeo_mobilization_cost_usd |
float |
275300.0 |
undocumented |