.. AeroMOC documentation master file, created by
   sphinx-quickstart on Mon Jul  1 23:56:46 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to AeroMOC's documentation!
===================================

AeroMOC is a open-sourced Method of Characteristic program based on Python. Currently it is 2-D, and it is able to deal with non-isentropic flow. Below is functions available now:

- 2-D non-isentropic flowfield simulation via MOC
- nozzle profile design 
    - axisymmetric / 2-D planer maximum thrust nozzle (ideal nozzle)
    - nonsymmetric planer maximum thrust nozzle
    - axisymmetric / 2-D planer minimum length nozzle (Rao nozzle) (issued)
- boundary layer correction

The program is based on references below:

- `Three-Dimensional-Nozzle-Design-Code <https://github.com/nasa/Three-Dimensional-Nozzle-Design-Code>`_ by NASA
- `Rice, T., "2D and 3D Method of Characteristic Tools for Complex Nozzle Development," JHU/APL Report RTDC-TPS-481. 2003. <https://ntrs.nasa.gov/citations/20030067852>`_
- `莫建伟., "TBCC排气系统设计方法及流场特性研究", 南京航天航空大学博士学位论文. 2015. <https://xueshu.baidu.com/usercenter/paper/show?paperid=405d0a064724ac1e31c07aecd55e80dd>`_

The program is initially developed by Yunjia Yang (yyj980401@126.com). It is also a option of the assignment of Prof. Yufei Zhang's (zhangyufei@tsinghua.edu.cn) curriculum "Advanced Aerodynamics".

The program is open to further development. Please follow the instruction to fork and raise pull request.

Contents
==================

.. toctree::
   :maxdepth: 2
   :caption: Getting start

   simpleguide
   tutorials

.. toctree::
   :maxdepth: 2
   :caption: Theory

   methodofchar
   nozzledesign