Missing some generic classes and a lot of typing - Githubissues

lettucecfd / lettuce

Computational Fluid Dynamics based on PyTorch and the Lattice Boltzmann Method

MIT License

223 stars 39 forks source link

Missing some generic classes and a lot of typing #166

Closed PhiSpel closed 4 months ago

PhiSpel commented 4 months ago

We should define a generic flow and boundary class for proper typing - e.g., the boundaries-list of a flow should only contain lt.Boundary-type objects. And lt.Flow should always contain a shape deduced from resolution.

[ ] lt.Flow (shape [Tuple], units [lt.UnitConversion], boundaries [list: lt.Boundary])
[ ] lt.Boundary (call(self, f))
[ ] ...

Also, most functions do not contain typing restrictions

[ ] f: lt.DistributionFunction
[ ] lattice: lt.Lattice
[ ] mask: np.Array (or later: torch.Tensor)
[ ] ...