pyrtid.forward.models.FlowParameters#

class pyrtid.forward.models.FlowParameters(permeability: float = 0.0001, storage_coefficient: float = 1.0, crank_nicolson: float = 1.0, regime: FlowRegime = FlowRegime.STATIONARY, is_gravity: bool = False, vertical_axis: VerticalAxis = VerticalAxis.Z, rtol: float = 1e-08)[source]#

Bases: object

Class defining the time parameters used in the simulation.

Attributes

  • k0 (float, optional) – Default permeability in the grid (m/s). The default is 1.e-4 m/s.

  • storage_coefficient (float, optional) – The default storage coefficient in the grid ($m^{-1}$). The default is 1e-3 $m^{-1}$.

  • crank_nicolson (float) – The Crank-Nicolson parameter allows to set the temporal resolution scheme to explicit, fully implicit or somewhere in between these two extremes. The value must be comprised between 0.0 and 1.0, 0.0 being a full explicit scheme and 1.0 fully implicit. The default is 1.0.

  • is_gravity (bool, optional) – Whether the gravity is taken into account, i.e. density driven flow.

  • vertical_axis (VerticalAxis) – Define which axis is the vertical one. It only affects if the gravity is enabled. The default is the z axis.

  • tolerance (float, optional) – The tolerance on the flow. The default is 1e-8.

__init__(permeability: float = 0.0001, storage_coefficient: float = 1.0, crank_nicolson: float = 1.0, regime: FlowRegime = FlowRegime.STATIONARY, is_gravity: bool = False, vertical_axis: VerticalAxis = VerticalAxis.Z, rtol: float = 1e-08) → None[source]#

Initialize the instance.

Methods definition