flownet.parameters._equilibration module

class flownet.parameters._equilibration.Equilibration(distribution_values: pandas.core.frame.DataFrame, network: flownet.network_model._network_model.NetworkModel, ti2ci: pandas.core.frame.DataFrame, eqlnum: pandas.core.frame.DataFrame, datum_depth: Optional[List[float]] = None, rsvd: Optional[pandas.core.frame.DataFrame] = None)

Bases: flownet.parameters._base_parameter.Parameter

Parameter type which takes care of stochastically drawn Equilibration parameters.

Args
distribution_values:

A dataframe with eight columns (“parameter”, “minimum”, “maximum”, “mean”, “base”, “stddev”, “distribution”, “eqlnum”) which state:

  • The name of the parameter,

  • The minimum value of the parameter (set to None if not applicable),

  • The maximum value of the parameter (set to None if not applicable),

  • The mean value of the parameter,

  • The mode of the parameter distribution (set to None if not applicable),

  • The standard deviation of the parameter,

  • The type of probability distribution,

  • To which EQLNUM this applies.

network: FlowNet network instance. ti2ci: A dataframe with index equal to tube model index, and one column which equals cell indices. eqlnum: A dataframe defining the EQLNUM for each flow tube. datum_depth: Depth of the datum(s) (m). rsvd: Pandas dataframe with a single rsvd table.

_abc_impl = <_abc_data object>
get_dims() → Dict

Function to export the table dimensions used for memory allocation in Flow.

Returns

Dictionary containing all dimensions to set.

render_output() → Dict

Creates EQUIL and EQLNUM include content - which are given to the PROPS and GRID section.

Returns

Dictionary with EQUIL and EQLNUM include content.