Merge pull request #1 from symbiotic-engineering/backup

Backup
symbiotic-engineering · Sep 10, 2024 · 1d1b813 · 1d1b813
2 parents eb4e493 + 3d35c5f
commit 1d1b813
Show file tree

Hide file tree

Showing 204 changed files with 23,756 additions and 18,068 deletions.
diff --git a/.ipynb_checkpoints/Morisons_equation-checkpoint.ipynb b/.ipynb_checkpoints/Morisons_equation-checkpoint.ipynb
diff --git a/README.md b/README.md
@@ -1 +1,17 @@
-This code finds the transmission (KT) and reflection coefficients (KR) for different wave energy converter archetypes. The folder titled "coeff" finds KT and KR from the body's hydrodynamic and hydrostatic coefficients, radiation potential of the wave field, and exciting force on the body. The folder titled "hydro" finds KT and KR based on wave height ratios and the disturbance coefficient.
+To use this repository, it is recommended to create an environment using the "requirements.txt" file provided. If not, you will need to install Capytaine (https://capytaine.github.io/stable/) and potentially other python packages. Regardless, you will need to install SWAN software (https://gitlab.tudelft.nl/citg/wavemodels/swan) if you want to run the SWAN files (in "swan" folder and "run_all" folder).
+
+This code finds the transmission (Kt) and reflection coefficients (Kr) for different wave energy converter archetypes and computes wave height reduction as a function of distance from the device. The devices modeled in this code are:
+
+1. Heaving Point Absorber Wave Energy Converter
+2. Oscillating Surge Wave Energy Converter
+3. Attenuator Wave Energy Converter
+4. Floating Breakwater
+
+The transmission and reflection coefficients are calculated in the "hydro" folder using the "run_coeffs.py" script. More details are found in the folder README.md file. The SWAN command file is generated in the "swan" folder. To alter the input commands, see the SWAN documentation (linked above) for details on their functions. The using the "big_run.py" script in the "run_all" folder will do all of the following:
+
+1. Generate the floating body of your choice
+2. Solve the hydrodynamics of the floating body and the surrounding wave elevation
+3. Compute the transmission and reflection coefficients for each body
+4. Input those coefficients as obstacles in a SWAN simulation
+5. Compute the wave height on the computational grid due to said obstacles
+6. Save the wave height data as a .csv file and generate a contour plot
diff --git a/coeff/OSWEC.py b/coeff/OSWEC.py
diff --git a/coeff/PA.py b/coeff/PA.py
diff --git a/coeff/__pycache__/OSWEC.cpython-39.pyc b/coeff/__pycache__/OSWEC.cpython-39.pyc
diff --git a/coeff/__pycache__/PA.cpython-36.pyc b/coeff/__pycache__/PA.cpython-36.pyc
diff --git a/coeff/__pycache__/PA.cpython-39.pyc b/coeff/__pycache__/PA.cpython-39.pyc
diff --git a/coeff/__pycache__/antisol.cpython-39.pyc b/coeff/__pycache__/antisol.cpython-39.pyc
diff --git a/coeff/__pycache__/attenuator.cpython-39.pyc b/coeff/__pycache__/attenuator.cpython-39.pyc
diff --git a/coeff/__pycache__/solution.cpython-39.pyc b/coeff/__pycache__/solution.cpython-39.pyc
diff --git a/coeff/__pycache__/symsol.cpython-39.pyc b/coeff/__pycache__/symsol.cpython-39.pyc
diff --git a/coeff/antisol.py b/coeff/antisol.py
diff --git a/coeff/attenuator.py b/coeff/attenuator.py
diff --git a/coeff/main.py b/coeff/main.py