flownet.parameters._base_parameter module

class flownet.parameters._base_parameter.Parameter

Bases: abc.ABC

The abstract base class for any higher order parameter (permeability, relative permeability, contact depths, PVT etc.)

Every class inheriting this abstract base class needs to define an attribute _random_variables and implement the class method render_output.

_abc_impl = <_abc_data object>
get_dims() → Union[None, Dict[str, int]]

In case a parameter requires updates in runspec dimensions, a get_dims function will need to be implemented.

property mean_values: List[float]

List of all mean values for each distribution for the Parameter

property names: List[str]

List of all names for each distribution for the Parameter

property random_samples: List[float]

List of all random values for each distribution for the Parameter

property random_variables: List[flownet.parameters.probability_distributions.ProbabilityDistribution]

List of all Probability distributions for the Parameter

abstract render_output() → Dict
Returns a dictionary which defines content that should be included

in the simulation model. The keys are the different sections on where to append the corresponding dictionary value.

E.g:

{“GRID”: ‘PERMX

0.1……”, “SOLUTION”: “EQUIL …”}

property stddev_values: List[float]

List of all standard deviation values for each distribution for the Parameter

flownet.parameters._base_parameter.parameter_probability_distribution_class(row: pandas.core.series.Series, param: Optional[str] = None) → flownet.parameters.probability_distributions.ProbabilityDistribution
Parameters

  • row (pd.Series) –

    Information used to initialize a ProbabilityDistribution class. Different probability distributions require different amount of parameters to be defined. The columns should be:

    • ’minimum’: The minimum value of the distribution

    • ’mean’: The mean value of the distribution

    • ’mode’: The mode of the distribution

    • ’maximum’: The maximum value of the distribution

    • ’stddev’: The standard deviation of the distribution

    • ’distribution’: The type of probability distribution that shold be initialized

  • param (str) – The name of the parameter if the column names in ‘row’ contains the name (e.g. if the column name is ‘minimum_bulk_volume’, param should be ‘bulk_volume’)

Returns

ProbabilityDistribution class