Skip to main content

A Python package for matched eigenfunctions methods

Project description

meem

matlab: see hydro/matlab/run_MEEM.m for the symbolic and numeric code, see test/matlab/ for some scripts to get results.

python: see package/src/ for some helper functions.

test/time_comparison for time comparisons of BEM (Capytaine), and dev/ for various matlab experiments.

About The Matched Eigenfunctions Project (MEEM)

The Matched Eigenfunctions Project (MEEM) is a Python package designed for solving boundary value problems using eigenfunction expansion methods. It provides a modular framework for defining complex geometries, setting up multi-domain problems, performing numerical computations, and analyzing results, particularly in fields like fluid dynamics and acoustics.

When referencing this work, please reference our docs/citations.rst

License:

This project is licensed under the MIT License. See the LICENSE file for details.

How to Run the Python Code:

  1. Install the package:
    pip install git+[https://github.com/symbiotic-engineering/semi-analytical-hydro.git](https://github.com/symbiotic-engineering/semi-analytical-hydro.git)
    
  2. Install dependencies: Navigate to the project directory (if you cloned it) and run:
    pip install -r requirements.txt
    
  3. Explore the docs/ and package/test directory: These directories contain scripts and notebooks demonstrating how to use the MEEM framework for different problems. Run these examples to understand the workflow.
  4. Refer to the documentation in the docs/ directory: The documentation provides detailed information on the different modules and classes within the meem package.

References

The following publications are relevant to this package:

  1. I. K. Chatjigeorgiou, Analytical Methods in Marine Hydrodynamics. Cambridge: Cambridge University Press, 2018. doi: 10.1017/9781316838983.
  2. F. P. Chau and R. W. Yeung, “Inertia and Damping of Heaving Compound Cylinders,” presented at the 25th International Workshop on Water Waves and Floating Bodies, Harbin, China, Jan. 2010. Accessed: Sep. 27, 2023. [Online]. Available: https://www.academia.edu/73219479/Inertia_and_Damping_of_Heaving_Compound_Cylinders_Fun
  3. F. P. Chau and R. W. Yeung, “Inertia, Damping, and Wave Excitation of Heaving Coaxial Cylinders,” presented at the ASME 2012 31st International Conference on Ocean, Offshore and Arctic Engineering, American Society of Mechanical Engineers Digital Collection, Aug. 2013, pp. 803–813. doi: 10.1115/OMAE2012-83987.
  4. R. W. Yeung, “Added mass and damping of a vertical cylinder in finite-depth waters,” Appl. Ocean Res., vol. 3, no. 3, pp. 119–133, Jul. 1981, doi: 10.1016/0141-1187(81)90101-2.
  5. D. Son, V. Belissen, and R. W. Yeung, “Performance validation and optimization of a dual coaxial-cylinder ocean-wave energy extractor,” Renew. Energy, vol. 92, pp. 192–201, Jul. 2016, doi: 10.1016/j.renene.2016.01.032.
  6. K. Kokkinowrachos, S. Mavrakos, and S. Asorakos, “Behaviour of vertical bodies of revolution in waves,” Ocean Eng., vol. 13, no. 6, pp. 505–538, Jan. 1986, doi: 10.1016/0029-8018(86)90037-5.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

meem-0.1.1.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

meem-0.1.1-py3-none-any.whl (3.2 kB view details)

Uploaded Python 3

File details

Details for the file meem-0.1.1.tar.gz.

File metadata

  • Download URL: meem-0.1.1.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.19

File hashes

Hashes for meem-0.1.1.tar.gz
Algorithm Hash digest
SHA256 5260258ca12cecd7fc7282b99e96dc5e13e1ebaa71debab4cac7c05352448db6
MD5 18415c0264fe2d3530794d2ccdf79f19
BLAKE2b-256 bef0f797ebb01ed6e231fdb1695888a473fe8ed3aaf8c0b24a6fca394e7fbe9b

See more details on using hashes here.

File details

Details for the file meem-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: meem-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 3.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.19

File hashes

Hashes for meem-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4693901439de91bc21f804de7de278bb3931d7cf69c0adec8c39d0f3e4edbba0
MD5 96651806bca2bfa482adfaccb9618a15
BLAKE2b-256 b414b83cea76605213e8f4c562d33b99c955eea9bb81f8f5dceab91abbf02b9a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page