Skip to content

Porous flow models

frontx.models

BrooksAndCorey

Bases: _RichardsModel

Source code in frontx/models.py 
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
class BrooksAndCorey(_RichardsModel):
    n: float  # type: ignore[misc]
    l: float = 1  # noqa: E741
    Ks: float | None = None
    k: float | None = None
    g: float = 9.81
    rho: float = 1e3
    mu: float = 1e-3
    alpha: float = 1
    theta_range: tuple[float, float] = (0, 1)

    def _h(
        self,
        theta: float | jax.Array | np.ndarray[Any, Any],
        /,
    ) -> float | jax.Array | np.ndarray[Any, Any]:
        Se = self._Se(theta)  # noqa: N806
        return -1 / (self.alpha * Se ** (1 / self.n))

    def _kr(
        self,
        theta: float | jax.Array | np.ndarray[Any, Any],
        /,
    ) -> float | jax.Array | np.ndarray[Any, Any]:
        Se = self._Se(theta)  # noqa: N806
        return Se ** (2 / self.n + self.l + 2)

Ks: float | None = None class-attribute instance-attribute

alpha: float = 1 class-attribute instance-attribute

g: float = 9.81 class-attribute instance-attribute

k: float | None = None class-attribute instance-attribute

l: float = 1 class-attribute instance-attribute

mu: float = 0.001 class-attribute instance-attribute

n: float instance-attribute

rho: float = 1000.0 class-attribute instance-attribute

theta_range: tuple[float, float] = (0, 1) class-attribute instance-attribute

LETd

Bases: _MoistureDiffusivityModel

Source code in frontx/models.py 
32
33
34
35
36
37
38
39
40
41
42
43
class LETd(_MoistureDiffusivityModel):
    L: float  # type: ignore[misc]
    E: float  # type: ignore[misc]
    T: float  # type: ignore[misc]
    Dwt: float = 1
    theta_range: tuple[float, float] = (0, 1)

    def __call__(
        self, theta: float | jax.Array | np.ndarray[Any, Any]
    ) -> float | jax.Array | np.ndarray[Any, Any]:
        Se = (theta - self.theta_range[0]) / (self.theta_range[1] - self.theta_range[0])  # noqa: N806
        return self.Dwt * Se**self.L / (Se**self.L + self.E * (1 - Se) ** self.T)

Dwt: float = 1 class-attribute instance-attribute

E: float instance-attribute

L: float instance-attribute

T: float instance-attribute

theta_range: tuple[float, float] = (0, 1) class-attribute instance-attribute

__call__(theta: float | jax.Array | np.ndarray[Any, Any]) -> float | jax.Array | np.ndarray[Any, Any]

Source code in frontx/models.py 
39
40
41
42
43
def __call__(
    self, theta: float | jax.Array | np.ndarray[Any, Any]
) -> float | jax.Array | np.ndarray[Any, Any]:
    Se = (theta - self.theta_range[0]) / (self.theta_range[1] - self.theta_range[0])  # noqa: N806
    return self.Dwt * Se**self.L / (Se**self.L + self.E * (1 - Se) ** self.T)

LETxs

Bases: _RichardsModel

Source code in frontx/models.py 
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
class LETxs(_RichardsModel):
    Lw: float  # type: ignore[misc]
    Ew: float  # type: ignore[misc]
    Tw: float  # type: ignore[misc]
    Ls: float  # type: ignore[misc]
    Es: float  # type: ignore[misc]
    Ts: float  # type: ignore[misc]
    Ks: float | None = None
    k: float | None = None
    g: float = 9.81
    rho: float = 1e3
    mu: float = 1e-3
    alpha: float = 1
    theta_range: tuple[float, float] = (0, 1)

    def _kr(
        self,
        theta: float | jax.Array | np.ndarray[Any, Any],
        /,
    ) -> float | jax.Array | np.ndarray[Any, Any]:
        Se = self._Se(theta)  # noqa: N806
        return Se**self.Lw / (Se**self.Lw + self.Ew * (1 - Se) ** self.Tw)

    def _h(
        self,
        theta: float | jax.Array | np.ndarray[Any, Any],
        /,
    ) -> float | jax.Array | np.ndarray[Any, Any]:
        Se = self._Se(theta)  # noqa: N806
        return (
            -((1 - Se) ** self.Ls / ((1 - Se) ** self.Ls + self.Es * Se**self.Ts))
            / self.alpha
        )

Es: float instance-attribute

Ew: float instance-attribute

Ks: float | None = None class-attribute instance-attribute

Ls: float instance-attribute

Lw: float instance-attribute

Ts: float instance-attribute

Tw: float instance-attribute

alpha: float = 1 class-attribute instance-attribute

g: float = 9.81 class-attribute instance-attribute

k: float | None = None class-attribute instance-attribute

mu: float = 0.001 class-attribute instance-attribute

rho: float = 1000.0 class-attribute instance-attribute

theta_range: tuple[float, float] = (0, 1) class-attribute instance-attribute

VanGenuchten

Bases: _RichardsModel

Source code in frontx/models.py 
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
class VanGenuchten(_RichardsModel):
    n: float | None = None
    m: float | None = None
    l: float = 0.5  # noqa: E741
    Ks: float | None = None
    k: float | None = None
    g: float = 9.81
    rho: float = 1e3
    mu: float = 1e-3
    alpha: float = 1
    theta_range: tuple[float, float] = (0, 1)

    @property
    def _n(self) -> float | jax.Array:
        if self.n is not None:
            return self.n

        if self.m is None:
            msg = "Either n or m must be set"
            raise ValueError(msg)

        return 1 / (1 - self.m)

    @property
    def _m(self) -> float | jax.Array:
        if self.m is not None:
            return self.m

        if self.n is None:
            msg = "Either n or m must be set"
            raise ValueError(msg)

        return 1 - 1 / self.n

    def _h(
        self,
        theta: float | jax.Array | np.ndarray[Any, Any],
        /,
    ) -> float | jax.Array | np.ndarray[Any, Any]:
        Se = self._Se(theta)  # noqa: N806
        return -((1 / (Se ** (1 / self._m)) - 1) ** (1 / self._n)) / self.alpha

    def _kr(
        self,
        theta: float | jax.Array | np.ndarray[Any, Any],
        /,
    ) -> float | jax.Array | np.ndarray[Any, Any]:
        Se = self._Se(theta)  # noqa: N806
        return Se**self.l * (1 - (1 - Se ** (1 / self._m)) ** self._m) ** 2

Ks: float | None = None class-attribute instance-attribute

alpha: float = 1 class-attribute instance-attribute

g: float = 9.81 class-attribute instance-attribute

k: float | None = None class-attribute instance-attribute

l: float = 0.5 class-attribute instance-attribute

m: float | None = None class-attribute instance-attribute

mu: float = 0.001 class-attribute instance-attribute

n: float | None = None class-attribute instance-attribute

rho: float = 1000.0 class-attribute instance-attribute

theta_range: tuple[float, float] = (0, 1) class-attribute instance-attribute