Metadata-Version: 2.1
Name: KratosShallowWaterApplication
Version: 9.1.3
Summary: KRATOS Multiphysics ("Kratos") is a framework for building parallel, multi-disciplinary simulation software, aiming at modularity, extensibility, and high performance. Kratos is written in C++, and counts with an extensive Python interface.
Home-page: https://github.com/KratosMultiphysics/
Author: Kratos Team
Author-email: kratos@listas.cimne.upc.edu
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: C++
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Other Audience
Classifier: Intended Audience :: Developers
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: KratosMultiphysics (==9.1.3)

## Shallow water application

This is a research application that provides a set of tools for oceanographic and hydrographic simulations over shallow domains.

### Implemented models

|               | BDF                | Crank-Nicolson     | Adams-Moulton      |
|---------------|:------------------:|:------------------:|:------------------:|
| Gravity waves | :heavy_check_mark: | :heavy_check_mark: |                    |
| Boussinesq    |                    |                    | :heavy_check_mark: |
| Saint-Venant  | :heavy_check_mark: |                    |                    |

### Dependencies

This application does not have other application dependencies at compile time.

If the coupling with a Navier-Stokes is required, add the following applications to compilation:
- PfemFluidDynamicsApplication
- HDF5Application
- MappingApplication

The following Python libraries may be required:
- `numpy` is used by the wave generator, the benchmarks and other auxiliary processes
- `scipy` is used by the benchmarks
- `mpmath` is used by the solitary wave benchmark
- `h5py` is used in the convergence output
- `pandas` is used in some post process tools


### References

- M. Masó, I. De-Pouplana, E. Oñate. A FIC-FEM stabilized formulation for the shallow water equations over partially dry domains. Computer Methods in Applied Mechanics and Engineering, 389C (2022) 114362.


