zoomy-core 0.1.0__py3-none-any.whl → 0.1.2__py3-none-any.whl

zoomy_core/model/models/shallow_water.py

@@ -0,0 +1,266 @@
+import numpy as np
+import os
+import logging
+
+import sympy
+from sympy import Symbol, Matrix, lambdify, transpose, Abs, sqrt
+
+from sympy import zeros, ones
+
+from attr import define, field
+from typing import Optional
+from types import SimpleNamespace
+
+from library.zoomy_core.model.boundary_conditions import BoundaryConditions, Extrapolation
+from library.zoomy_core.model.initial_conditions import InitialConditions, Constant
+from library.zoomy_core.misc.custom_types import FArray
+from library.zoomy_core.model.basemodel import Model
+
+from library.zoomy_core.misc.misc import Zstruct
+
+@define(frozen=True, slots=True, kw_only=True)
+class ShallowWaterEquations(Model):
+    dimension: int = 1
+
+@define(frozen=True, slots=True, kw_only=True)
+class ShallowWaterEquations(Model):
+    dimension: int=1
+    variables: Zstruct = field(default=3)
+    aux_variables: Zstruct = field(default=2)
+    _default_parameters: dict = field(
+        init=False,
+        factory=lambda: {"g": 9.81, "ex": 0.0, "ey": 0.0, "ez": 1.0}
+        )
+    
+    def __attrs_post_init__(self):
+        if type(self.variables)==int:
+            object.__setattr__(self, "variables",self.dimension+1)
+        super().__attrs_post_init__()
+
+
+    def project_2d_to_3d(self):
+        out = Matrix([0 for i in range(5)])
+        dim = self.dimension
+        x = self.position[0]
+        y = self.position[1]
+        z = self.position[2]
+        h = self.variables[0]
+        U = [hu / h for hu in self.variables[1:1+dim]]
+        rho_w = 1000.
+        g = 9.81
+        out[0] = h
+        out[1] = U[0]
+        out[2] = 0 if dim == 1 else U[1]
+        out[3] = 0
+        out[4] = rho_w * g * h * (1-z)
+        return out
+
+        
+
+    def flux(self):
+        dim = self.dimension
+        h = self.variables[0]
+        U = Matrix([hu / h for hu in self.variables[1:1+dim]])
+        g = self.parameters.g
+        I = Matrix.eye(dim)
+        F = Matrix.zeros(self.variables.length(), dim)
+        F[0, :] = (h * U).T
+        F[1:, :] = h * U * U.T + g/2 * h**2 * I
+        return [F[:, d] for d in range(dim)]
+    
+    def source(self):
+        out = Matrix([0 for i in range(self.n_variables)])
+        return out
+    
+    def chezy(self):
+        assert "C" in vars(self.parameters)
+        dim = self.dimension
+        out = Matrix([0 for i in range(self.n_variables)])
+        h = self.variables[0]
+        hU = self.variables[1:1+dim]
+        U = Matrix([hu / h for hu in hU])
+        p = self.parameters
+        u_sq = sqrt(U.dot(U))
+        out[1:1+dim, 0] = -1.0 / p.C**2 * U * u_sq
+        return out
+
+
+@define(slots=True, frozen=False, kw_only=True)
+class ShallowWater(Model):
+    """
+    :gui:
+    { 'parameters': { 'g': {'type': 'float', 'value': 9.81, 'step': 0.01}, 'ex': {'type': 'float', 'value': 0., 'step':0.1}, 'ez': {'type': 'float', 'value': 1., 'step': 0.1}, },}
+    """
+
+    def __init__(
+        self,
+        boundary_conditions,
+        initial_conditions,
+        dimension=1,
+        fields=2,
+        aux_variables=0,
+        parameters={},
+        _default_parameters={"g": 1.0, "ex": 0.0, "ez": 1.0},
+        settings={},
+        settings_default={"topography": False, "friction": []},
+    ):
+        super().__init__(
+            dimension=dimension,
+            fields=fields,
+            aux_variables=aux_variables,
+            parameters=parameters,
+            _default_parameters=_default_parameters,
+            boundary_conditions=boundary_conditions,
+            initial_conditions=initial_conditions,
+            settings={**settings_default, **settings},
+        )
+
+    def flux(self):
+        flux = Matrix([0 for i in range(self.n_variables)])
+        h = self.variables[0]
+        hu = self.variables[1]
+        p = self.parameters
+        flux[0] = hu
+        flux[1] = hu**2 / h + p.g * p.ez * h * h / 2
+        return [flux]
+
+    def source(self):
+        out = Matrix([0 for i in range(self.n_variables)])
+        return out
+
+    def topography(self):
+        assert "dhdx" in vars(self.aux_variables)
+        out = Matrix([0 for i in range(self.n_variables)])
+        h = self.variables[0]
+        hu = self.variables[1]
+        p = self.parameters
+        dhdx = self.aux_variables.dhdx
+        out[1] = h * p.g * (p.ex - p.ez * dhdx)
+        return out
+
+    def newtonian(self):
+        assert "nu" in vars(self.parameters)
+        out = Matrix([0 for i in range(self.n_variables)])
+        h = self.variables[0]
+        hu = self.variables[1]
+        p = self.parameters
+        out[1] = -p.nu * hu / h
+        return out
+
+    def manning(self):
+        assert "nm" in vars(self.parameters)
+        out = Matrix([0 for i in range(self.n_variables)])
+        h = self.variables[0]
+        hu = self.variables[1]
+        u = hu / h
+        p = self.parameters
+        out[1] = -p.g * (p.nm**2) * u * Abs(u) / h ** (7 / 3)
+        return out
+
+    def chezy(self):
+        assert "C" in vars(self.parameters)
+        out = Matrix([0 for i in range(self.n_variables)])
+        h = self.variables[0]
+        hu = self.variables[1]
+        u = hu / h
+        p = self.parameters
+        out[1] = -1.0 / p.C**2 * u * Abs(u)
+        return out
+
+
+class ShallowWater2d(ShallowWater):
+    """
+    :gui:
+    { 'parameters': { 'g': {'type': 'float', 'value': 9.81, 'step': 0.01}, 'ex': {'type': 'float', 'value': 0., 'step':0.1}, 'ey': {'type': 'float', 'value': 0., 'step':0.1}, 'ez': {'type': 'float', 'value': 1., 'step': 0.1}, },}
+    """
+
+    def __init__(
+        self,
+        boundary_conditions,
+        initial_conditions,
+        dimension=2,
+        fields=3,
+        aux_variables=0,
+        parameters={},
+        _default_parameters={"g": 1.0, "ex": 0.0, "ey": 0.0, "ez": 1.0},
+        settings={},
+        settings_default={"topography": False, "friction": []},
+    ):
+        # combine settings_default of current class with settings such that the default settings of super() does not get overwritten.
+        super().__init__(
+            dimension=dimension,
+            fields=fields,
+            aux_variables=aux_variables,
+            parameters=parameters,
+            _default_parameters=_default_parameters,
+            boundary_conditions=boundary_conditions,
+            initial_conditions=initial_conditions,
+            settings={**settings_default, **settings},
+        )
+
+    def flux(self):
+        fx = Matrix([0 for i in range(self.n_variables)])
+        fy = Matrix([0 for i in range(self.n_variables)])
+        h = self.variables[0]
+        hu = self.variables[1]
+        hv = self.variables[2]
+        p = self.parameters
+        fx[0] = hu
+        fx[1] = hu**2 / h + p.g * p.ez * h * h / 2
+        fx[2] = hu * hv / h
+        fy[0] = hv
+        fy[1] = hu * hv / h
+        fy[2] = hv**2 / h + p.g * p.ez * h * h / 2
+        return [fx, fy]
+
+    def topography(self):
+        assert "dhdx" in vars(self.aux_variables)
+        assert "dhdy" in vars(self.aux_variables)
+        out = Matrix([0 for i in range(self.n_variables)])
+        h = self.variables[0]
+        hu = self.variables[1]
+        hv = self.variables[2]
+        p = self.parameters
+        dhdx = self.aux_variables.dhdx
+        dhdy = self.aux_variables.dhdy
+        out[1] = h * p.g * (p.ex - p.ez * dhdx)
+        out[2] = h * p.g * (p.ey - p.ez * dhdy)
+        return out
+
+    def newtonian(self):
+        assert "nu" in vars(self.parameters)
+        out = Matrix([0 for i in range(self.n_variables)])
+        h = self.variables[0]
+        hu = self.variables[1]
+        hv = self.variables[2]
+        p = self.parameters
+        out[1] = -p.nu * hu / h
+        out[2] = -p.nu * hv / h
+        return out
+
+    def manning(self):
+        assert "nu" in vars(self.parameters)
+        out = Matrix([0 for i in range(self.n_variables)])
+        h = self.variables[0]
+        hu = self.variables[1]
+        hv = self.variables[2]
+        u = hu / h
+        v = hv / h
+        p = self.parameters
+        out[1] = -p.g * (p.nu**2) * hu * Abs(u) ** (7 / 3)
+        out[2] = -p.g * (p.nu**2) * hv * Abs(v) ** (7 / 3)
+        return out
+
+    def chezy(self):
+        assert "C" in vars(self.parameters)
+        out = Matrix([0 for i in range(self.n_variables)])
+        h = self.variables[0]
+        hu = self.variables[1]
+        hv = self.variables[2]
+        u = hu / h
+        v = hv / h
+        p = self.parameters
+        u_sq = sqrt(u**2 + v**2)
+        out[1] = -1.0 / p.C**2 * u * u_sq
+        out[2] = -1.0 / p.C**2 * v * u_sq
+        return out

zoomy_core/model/models/shallow_water_topo.py

@@ -0,0 +1,111 @@
+import numpy as np
+import os
+import logging
+
+import sympy
+from sympy import Symbol, Matrix, lambdify, transpose, Abs, sqrt
+
+from sympy import zeros, ones
+
+from attr import define, field
+from typing import Optional
+from types import SimpleNamespace
+
+from library.zoomy_core.model.boundary_conditions import BoundaryConditions, Extrapolation
+from library.zoomy_core.model.initial_conditions import InitialConditions, Constant
+from library.zoomy_core.misc.custom_types import FArray
+from library.zoomy_core.model.basemodel import Model, eigenvalue_dict_to_matrix
+
+from library.zoomy_core.misc.misc import Zstruct
+
+@define(frozen=True, slots=True, kw_only=True)
+class ShallowWaterEquationsWithTopo1D(Model):
+    dimension: int = 1
+    variables: Zstruct = field(default=3)
+    aux_variables: Zstruct = field(default=0)
+
+@define(frozen=True, slots=True, kw_only=True)
+class ShallowWaterEquationsWithTopo(Model):
+    dimension: int=2
+    variables: Zstruct = field(default=4)
+    aux_variables: Zstruct = field(default=0)
+    _default_parameters: dict = field(
+        init=False,
+        factory=lambda: {"g": 9.81, "ex": 0.0, "ey": 0.0, "ez": 1.0}
+        )
+    
+    def __attrs_post_init__(self):
+        if type(self.variables)==int:
+            object.__setattr__(self, "variables",self.dimension+2)
+        super().__attrs_post_init__()
+        
+    def compute_hinv(self):
+        h = self.variables[1]
+        return 1 / h
+        
+    def get_primitives(self):
+        dim = self.dimension
+        b = self.variables[0]
+        h = self.variables[1]
+        hinv = self.compute_hinv()
+        U = [self.variables[2 + i] * hinv for i in range(dim)]
+        return b, h, U, hinv
+
+
+    def project_2d_to_3d(self):
+        out = Matrix([0 for i in range(5)])
+        dim = self.dimension
+        x = self.position[0]
+        y = self.position[1]
+        z = self.position[2]
+        b, h, U, hinv = self.get_primitives()
+        rho_w = 1000.
+        g = 9.81
+        out[0] = h
+        out[1] = U[0]
+        out[2] = 0 if dim == 1 else U[1]
+        out[3] = 0
+        out[4] = rho_w * g * h * (1-z)
+        return out
+
+        
+
+    def flux(self):
+        dim = self.dimension
+        h = self.variables[1]
+        U = Matrix([hu / h for hu in self.variables[2:2+dim]])
+        g = self.parameters.g
+        I = Matrix.eye(dim)
+        F = Matrix.zeros(self.variables.length(), dim)
+        F[1, :] = (h * U).T
+        F[2:, :] = h * U * U.T + g/2 * h**2 * I
+        return [F[:, d] for d in range(dim)]
+    
+    def nonconservative_matrix(self):
+        nc_x = Matrix([[0 for i in range(self.n_variables)] for j in range(self.n_variables)])
+        nc_y = Matrix([[0 for i in range(self.n_variables)] for j in range(self.n_variables)])
+        b, h, U, hinv = self.get_primitives()
+        p = self.parameters
+        nc_x[1, 0] = p.g * h 
+        nc_y[1, 0] = p.g * h
+        return [nc_x, nc_y][:self.dimension]
+
+    
+    def source(self):
+        out = Matrix([0 for i in range(self.n_variables)])
+        return out
+    
+    def chezy(self):
+        assert "C" in vars(self.parameters)
+        dim = self.dimension
+        out = Matrix([0 for i in range(self.n_variables)])
+        h = self.variables[0]
+        hU = self.variables[1:1+dim]
+        U = Matrix([hu / h for hu in hU])
+        p = self.parameters
+        u_sq = sqrt(U.dot(U))
+        out[2:2+dim] = -1.0 / p.C**2 * U * u_sq
+        return out
+    
+        return self._simplify(eigenvalue_dict_to_matrix(A.eigenvals()))
+