Results#

class Results(data)[source]#

Bases: object

Python container for the results of a sansmic simulation.

Parameters:: data (CResults) – results object from the C++ library

Summary

`from_dict`(d)	Create a new object from a tight dictionary representation.
`from_hdf`(filename)	Read results from an HDF5 file.
`to_dict`()	Convert the results object to a dictionary format.
`to_hdf`(filename, *[, compression, ...])	Write results to an HDF5 file.
`brine_production_rate`	Instantaneous brine production rate, by timestep
`brine_production_sg`	Instantaneous brine production cell sg, by timestep
`cavern_average_brine_sg`	Instantaneous average cavern brine sg, by timestep
`cavern_total_depth`	The depth to the new cavern TD, by timestep
`cavern_volume`	Total cavern volume, by timestep
`cell_injection_rate`	Injection rate within cell above node, by node and timestep
`cell_sg`	Concentration(sg) in cell above node, by node and timestep
`cell_volume`	Cell volume above node, by node and timestep
`change_in_radius`	Change in cavern radius since previous time, by node and timestep
`cumulative_fill_volume`	Total product fill volume, by timestep
`cumulative_injection_volume`	Total injected water/brine volume, by timestep
`cumulative_insoluble_material_vented`	Total volume of insoluble materials vented, by timestep
`cumulative_insoluble_material_volume`	Total volume of insoluble materials deposited, by timestep
`depths`	depths, by node
`effective_diffusion_coefficient`	Effective diffusion coefficient at node, by node and timestep
`effective_dissolution_factor`	Effective dissolution factor at node, by node and timestep
`hours`	time in hours, by timestep
`injection_cell`	The injection cell, by timestep
`injection_depth`	The water/brine injection depth, by timestep
`injection_phase`	Simulation injection(1) or static(0) phase, by timestep
`insoluble_material_height`	The height of the insoluble materials deposited, by timestep
`interface_cell`	The brine interface cell, by timestep
`interface_depth`	The brine interface depth, by timestep
`jet_length`	The length of the injection fluid jet's penetration below EOT, by timestep
`jet_radius`	The radius of the injection fluid jet and starting plume radius, by timestep
`jet_velocity`	The velocity of the injection fluid, by timestep
`node_heights`	heights above initial TD, by node
`ode_convergence`	The ODE convergence factor, by timestep
`plume_radius`	Plume radius at node depth, by node and timestep
`plume_sg`	Plume concentration(sg) at node depth, by node and timestep
`plume_stagnation_cell`	The plume stagnation cell, by timestep
`plume_stagnation_depth`	The plume stagnation depth, by timestep
`plume_velocity`	Plume velocity at node depth, by node and timestep
`production_cell`	The production cell, by timestep
`production_depth`	The depth of brine production, by timestep
`radius`	Cavern radius, by node and timestep
`rate_of_change_in_radius`	Rate of change in cavern radius, by node and timestep
`rate_of_change_in_sg`	Rate of change in concentration in cell above node, by node and timestep
`stage_number`	Simulation stage number, by timestep
`state_indicator`	Dissolution state flag, by node and timestep
`step_number`	Simulation step number, by timestep
`step_size`	Simulation step size, by timestep
`time`	time in days, by timestep
`vertical_diffusion_rate`	Vertical change in concentration across node, by node and timestep
`wall_angle`	Dissolution wall angle, by node and timestep
`wall_factor`	Dissolution wall factor, by node and timestep
`df_t_1D`	Results that are 1D indexed in the D(time) domain.
`df_z_1D`	Results that are 1D indexed in the D(space) domain.
`df_t_z_2D`	Results that are 2D indexed in the D(time, space) domain.

Details

classmethod from_dict(d)[source]#

Create a new object from a tight dictionary representation.

classmethod from_hdf(filename)[source]#

Read results from an HDF5 file.

Parameters:: filename (str) – A filename with extension “.h5”, or filename prefix without extension, to read from.

to_dict()[source]#

Convert the results object to a dictionary format.

to_hdf(filename, *, compression='gzip', compression_opts=9, shuffle=True, fletcher32=True, **kwargs)[source]#

Write results to an HDF5 file.

Parameters:

filename (str) – A filename with extension “.h5”, or filename prefix without extension, to write to

Keyword Arguments:

compression (str) – The HDF5 compression filter library to use, by default ‘gzip’
compression_opts (int) – The compression level to use, by default 9 (highest)
shuffle (bool) – Whether to use the shuffle filter, by default True
fletcher32 (bool) – Whether to use checksum filter, by default True
kwargs (additional keyword arguments) – Any additional arguments to be passed to the h5py module create_dataset call.

property brine_production_rate: Series#: Instantaneous brine production rate, by timestep

property brine_production_sg: Series#: Instantaneous brine production cell sg, by timestep

property cavern_average_brine_sg: Series#: Instantaneous average cavern brine sg, by timestep

property cavern_total_depth: Series#: The depth to the new cavern TD, by timestep

property cavern_volume: Series#: Total cavern volume, by timestep

property cell_injection_rate: DataFrame#: Injection rate within cell above node, by node and timestep

property cell_sg: DataFrame#: Concentration(sg) in cell above node, by node and timestep

property cell_volume: DataFrame#: Cell volume above node, by node and timestep

property change_in_radius: DataFrame#: Change in cavern radius since previous time, by node and timestep

property cumulative_fill_volume: Series#: Total product fill volume, by timestep

property cumulative_injection_volume: Series#: Total injected water/brine volume, by timestep

property cumulative_insoluble_material_vented: Series#: Total volume of insoluble materials vented, by timestep

property cumulative_insoluble_material_volume: Series#: Total volume of insoluble materials deposited, by timestep

property depths: Series#

depths, by node

Type:: Vertical domain

df_t_1D: DataFrame#: Results that are 1D indexed in the D(time) domain.

df_t_z_2D: DataFrame#: Results that are 2D indexed in the D(time, space) domain.

df_z_1D: DataFrame#: Results that are 1D indexed in the D(space) domain.

property effective_diffusion_coefficient: DataFrame#: Effective diffusion coefficient at node, by node and timestep

property effective_dissolution_factor: DataFrame#: Effective dissolution factor at node, by node and timestep

property hours: Series#

time in hours, by timestep

Type:: Time domain

property injection_cell: Series#: The injection cell, by timestep

property injection_depth: Series#: The water/brine injection depth, by timestep

property injection_phase: Series#: Simulation injection(1) or static(0) phase, by timestep

property insoluble_material_height: Series#: The height of the insoluble materials deposited, by timestep

property interface_cell: Series#: The brine interface cell, by timestep

property interface_depth: Series#: The brine interface depth, by timestep

property jet_length: Series#: The length of the injection fluid jet’s penetration below EOT, by timestep

property jet_radius: Series#: The radius of the injection fluid jet and starting plume radius, by timestep

property jet_velocity: Series#: The velocity of the injection fluid, by timestep

property node_heights: Series#

heights above initial TD, by node

Type:: Vertical domain

property ode_convergence: Series#: The ODE convergence factor, by timestep

property plume_radius: DataFrame#: Plume radius at node depth, by node and timestep

property plume_sg: DataFrame#: Plume concentration(sg) at node depth, by node and timestep

property plume_stagnation_cell: Series#: The plume stagnation cell, by timestep

property plume_stagnation_depth: Series#: The plume stagnation depth, by timestep

property plume_velocity: DataFrame#: Plume velocity at node depth, by node and timestep

property production_cell: Series#: The production cell, by timestep

property production_depth: Series#: The depth of brine production, by timestep

property radius: DataFrame#: Cavern radius, by node and timestep

property rate_of_change_in_radius: DataFrame#: Rate of change in cavern radius, by node and timestep

property rate_of_change_in_sg: DataFrame#: Rate of change in concentration in cell above node, by node and timestep

property stage_number: Series#: Simulation stage number, by timestep

property state_indicator: DataFrame#: Dissolution state flag, by node and timestep

property step_number: Series#: Simulation step number, by timestep

property step_size: Series#: Simulation step size, by timestep

property time: Series#

time in days, by timestep

Type:: Time domain

property vertical_diffusion_rate: DataFrame#: Vertical change in concentration across node, by node and timestep

property wall_angle: DataFrame#: Dissolution wall angle, by node and timestep

property wall_factor: DataFrame#: Dissolution wall factor, by node and timestep