AdvancedOptions

class AdvancedOptions(absolute_error=None, relative_error=None, coallescing_wells=None, well_separation=None, jet_model_version=None, plume_model_version=None, temperature_model_version=None, dissolution_factor=None, max_brine_sg=None, solid_density=None, entrainment_coeff=None, molecular_diffusion=None, eddy_coefficient=None, diffusion_beta=None)

Bases: object

Advanced configuration options. Most of these can and should be left as None which will use the default C++ library values.

Summary

from_dict(opts)	Create a new object from a dictionary of options.
to_dict([keep_empty])	Convert the object's data to a dictionary of options.
absolute_error	ODE solver absolute error tolerance; CScenario default is 0.01
coallescing_wells	The number of wells for multi-well cavern construction; CScenario default is 1
diffusion_beta	Diffusion beta coefficient; default is 0.147
dissolution_factor	Dissolution factor; CScenario default is 1.0 - this should not be changed unless you are sure you know the effects
eddy_coefficient	Eddy coefficient; CScenario default is 1.142e5
entrainment_coeff	Dissolution entrainment coefficient; CScenario default is 0.09
jet_model_version	Jet model version; CScenario default is 1
max_brine_sg	Maximum brine specific gravity; CSalt default is 1.2019
molecular_diffusion	Molecular diffusion coefficient; CScenario default is 5.03e-5
plume_model_version	Plume model version; CScenario default is 1
relative_error	ODE solver absolute error tolerance; CScenario default is 0.0001
solid_density	Rock density in solid form; CSalt default is 2.16 g/cc
temperature_model_version	Temperature model version; CScenario default is 0
well_separation	The separation distance for multi-well cavern construction; CScenario default is 0.0

Details

classmethod from_dict(opts)

Create a new object from a dictionary of options.

This method differs from the __init__ constructor by automatically converting non-underscore characters - e.g., - or . or `` `` to underscores and changing keys to lower-case prior to creating the object.

See also: to_dict()

Parameters:

opts (dict) – The initialization values

Returns:

the new stage

Return type:

StageDefinition

to_dict(keep_empty=False)

Convert the object’s data to a dictionary of options.

This method differs from the asdict() method by automatically converting underscore characters to hyphens for a more readable dictionary. Specifically used when creating TOML, JSON and YAML files.

See also: from_dict()

Parameters:

keep_empty (bool) – Keep values set to None and set them to ""

Returns:

the options dictionary

Return type:

dict

absolute_error: float = None

ODE solver absolute error tolerance; CScenario default is 0.01

coallescing_wells: int = None

The number of wells for multi-well cavern construction; CScenario default is 1

diffusion_beta: float = None

Diffusion beta coefficient; default is 0.147

dissolution_factor: float = None

Dissolution factor; CScenario default is 1.0 - this should not be changed unless you are sure you know the effects

eddy_coefficient: float = None

Eddy coefficient; CScenario default is 1.142e5

entrainment_coeff: float = None

Dissolution entrainment coefficient; CScenario default is 0.09

jet_model_version: int = None

Jet model version; CScenario default is 1

max_brine_sg: float = None

Maximum brine specific gravity; CSalt default is 1.2019

molecular_diffusion: float = None

Molecular diffusion coefficient; CScenario default is 5.03e-5

plume_model_version: int = None

Plume model version; CScenario default is 1

relative_error: float = None

ODE solver absolute error tolerance; CScenario default is 0.0001

solid_density: float = None

Rock density in solid form; CSalt default is 2.16 g/cc

temperature_model_version: int = None

Temperature model version; CScenario default is 0

well_separation: float = None

The separation distance for multi-well cavern construction; CScenario default is 0.0