README.md

adcirc-dgswem-coupling

Table of contents

• Introduction
• Status
• Setup
  • Dependencies
  • Compilation
  • Usage
• Methodology
• License

Introduction

This is a Fortran software for weakly coupling ADCIRC and DG-SWEM. You need access to the GitHub repositories of both ADCIRC and DG-SWEM in order to use this software.

Status

This project is in progress.

Setup

Dependencies

• ADCIRC - link to website, link to GitHub repository
• DG-SWEM - link to website, link to GitHub repository

Compilation

To be determined.

Usage

To be determined.

Methodology

We plan to couple ADCIRC and DG-SWEM over models that are non-overlapping, but may other wise share a boundary. For now, Gauss-Seidel-style weak coupling will be implemented, with the possibility of exploring Gauss-Jacobi-style weak coupling in the future.

License

This software is licensed under the terms of BSD 3-Clause "New" or "Revised" License; see the LICENSE file. Note that some or all of the dependencies of this software are not open source, and these should not be distributed with this software.