SMCResultPlotHub

Package for read and vizualize SMC simulations results.

🏠 Local installation

• Using pip:

pip install git+https://github.com/defreitasL/SMCResultPlotHub.git

---

⚡ Main methods

• MallaSMC:

# MallaSMC class represents a structured mesh for SMC (SistemadeModelado Costero) simulations.
MallaSMC(meshName, moplaPath)

Attributes:
    - name (str): The name of the mesh.
    - moplaPath (str): The path where Mopla files are located.
    - angMalla (float): The angle of the mesh in radians.
    - x0 (float): Minimum x-coordinate after rotation.
    - y0 (float): Minimum y-coordinate after rotation.
    - x0o (float): Original x-coordinate.
    - y0o (float): Original y-coordinate.
    - Ly (float): Length of the mesh in the y-direction.
    - Lx (float): Length of the mesh in the x-direction.
    - dy (float): Grid spacing in the y-direction.
    - dx (float): Grid spacing in the x-direction.
    - ny (int): Number of grid points in the y-direction.
    - nx (int): Number of grid points in the x-direction.
    - x (numpy.ndarray): X-coordinates of the mesh.
    - y (numpy.ndarray): Y-coordinates of the mesh.
    - z (numpy.ndarray): Bathymetry data of the mesh.

• readData:

# Reads and processes wave height and direction data for a given mesh and case.
hs, dd = readData(MallaSMC, caso)

Parameters:
    - malla (MallaSMC): The MallaSMC object representing the mesh.
    - caso (str): The case identifier.
Returns:
    - Tuple: Tuple containing wave height (hs) and direction (dd) data arrays.

• readDataCOPLA:

# Reads and processes velocity field data from COPLA simulations.
V, vx, vy = readDataCOPLA(MallaSMC, caso)

Parameters:
    - malla (MallaSMC): The MallaSMC object representing the mesh.
    - caso (str): The case identifier.

Returns:
    - Tuple: Tuple containing velocity (V), velocity x-component (vx), and velocity y-component (vy) data arrays

• readDataMC:

# Reads and processes data for monochromatic simulations.

eta, dd, hs, phase, phasez, rot, YY, XX = readDataMC(malla, caso, zoomFlag)

Parameters: 
    - malla (MallaSMC): The MallaSMC object representing the mesh.
    - caso (str): The case identifier.
    - zoomFlag (bool): Flag indicating whether the case was executed with zoom.

Returns:
    - Tuple: Tuple containing free surface elevation (eta), direction (dd), height (hs), phase, phase zoom (phasez), breaking points (rot), YY, and XX data arrays.

📦 Package structures

SMCResultPlotHub
|
├── LICENSE
├── README.md
├── build
├── dist
├── SMCResultPlotHub
│   ├── __init__.py
│   ├── EMD.py
│   ├── graphEMD.py
│   ├── MallasSMC.py
│   ├── perfRot.py
│   ├── poi.py
│   ├── readData.py
│   └── utils
│       ├── __init__.py
│       └── utils.py
└── .gitignore

---

📨 Contact us

🐍 For code-development issues contact 👨‍💻 Lucas de Freitas @ 🏢 IHCantabria

©️ Credits

Developed by 👨‍💻 Lucas de Freitas @ 🏢 IHCantabria.