ut-chg / adcirc_nn

An attempt at physics-based machine learning with pyADCIRC

Computational Hydraulics Group at The Oden Institute for Computational Engineering and Sciences Official Website

This website is developed from the template Alembic. Thank you!

Live at https://ut-chg.github.io.

development guide

Update Website Content: commit to the main branch.

Basic writing and formatting syntax

How to add news?

1. Create a new markdown file under /_post folder, name it in the date-title.md format (e.g. 2023-01-01-firstpost.md)
2. In the markdown file, include the follow content.

---
title: your title
categories:
- Workshop(or any other categories)
feature_image: "https://flodismod.github.io/assets/cover_photo.png" (the image on the top of the page)
---

On the News & Outreach page, there is a list of posts. Here you put the preview text, which will be shown below the title of this post.
<!-- more -->

Maintext
<br>

{% include button.html text="Back" link="/news/" %} (this is the button to take you back to news & outreach page)

How to add new group member?

1. Go to /_includes, find profile_card.html.
2. Add the following block after the last card:

<div class="card">
    <div class="box2"><img src="/assets/team_profile/new_member.png" alt="Avatar" style="width:100%"></div>
    <div>
        <h4><b>FirstName  LastName</b></h4> 
        <p></p>
        <p class="d">role, Institute</p>
        </div>

    <div class="bottomWrapper">      
        <p ><a href="../ourteam/profile_NewMember">view bio</a></p>
    </div>
</div>
    

To avoid error, make sure you don't put ".md" in the href of <p ><a href="../ourteam/profile_NewMember">view bio</a></p>.

3. Go to /ourteam, create a new markdown file profile_NewMember.md, and put the following information down:

---
feature_text: |
  ## Team

feature_image: "/assets/cover_photo.png"
---
{% include profile-short.html name="" extra="" position="" position2=""  bio="" link="/assets/team_profile/"%}

[name of the web link](the actual link)

{% include button.html text="Back" link="/groups/" %}

How to add new research topic?

1. Go to /_includes, find display_research.html.
2. Add the following block after the last card following the example:

<div class="card">
  <a href="/project/adaptive_mesh"><img src="/assets/project/melioidosis.png" alt="Avatar" style="width:100%"></a>
    <div class="bottomWrapper">
      <a href="/project/adaptive_mesh"><h6><b>Improving the Efficiency of Wave and Surge Models via Adaptive Mesh Resolution</b></h6></a> 
    </div>
</div>

3. Go to /project, create a new markdown file adaptive_mesh.md. In the markdown file, put the following information down:

---
title: Title of your project
feature_text: |
  Research

feature_image: "/assets/cover_photo/pier.png" (save the project cover photo in the same directory and quote it here)
feature_credit: Photo by someone (leave it blank if no photographers)

---
<br />

maintext



{% include button.html text="Back" link="/research_page/" %}

How to edit the navigation bar?

1. Go to _config.yml and edit section under # 9. Site navigation.

adcirc_nn's Issues

Need a data structure for time series input to the NN model

I think we should create a data structure for time series input to the NN model to separate out time-stepping from input series. We must account for two things in that:

• The input series time stamps may not coincide with the NN model's time-stamps (especially when coupling to ADCIRC). Therefore, we need to allow for (linear) interpolation from input series onto the current time stamp of the NN model.
• The rainfall input and the water surface elevation are currently stored in a single variable in the code (created through pandas.read_csv() call). The rainfall and elevation input variables must be separated because when coupling with ADCIRC, the values as well as the time stamps of the elevation input to the NN model must be modified, whereas those of the rainfall input remain unchanged.

Therefore, I propose we have something like the following:

class InputTS():
    def __init__(self, times, values):
        '''InputTS class constructor.'''
        self.times = times
        self.values = values
        self.current_index = 0

    def _getTimeInterval(self, t):
        '''Get the time interval of the current time stamp.'''
        return index

    def updateTimeInterval(self, t):
        '''Update the time interval by updating current_index.'''
        return None

    def interpolate(self, time):
        '''Interpolate input series onto NN model's current time.'''
        return value

Fix fort.19 I/O to allow multiple ADCIRC open boundaries

Currently, only 1 "open boundary", i.e., an ADCIRC boundary with water elevation specified, works correctly. This is because ADCIRC reads in data from fort.19 as it marches in time. I had planned to replace fort.19 with a fort.19.new file which would contain correct values. However, the values in fort.19.new are currently only correct for the coupled boundary. We need to either read in correct values from fort.19 and write them in fort.19.new, or read in values from fort.19 inside Python, and then replace the values at coupled boundary with the correct values and increment the BC timestamp so that ADCIRC skips reading fort.19.

Add a method to allow ADCIRC to drive the NN model

We need add a coupler_run_adcirc_driving_nn() method to the AdcircNN class to allow ADCIRC to drive the neural network. This is needed to enable one-way Adn and AdndA coupling. Likewise, nn_init_bc* and nn_set_bc_* functions must be also be added for the same. I am addressing these in PR #5.