.. SPHinXsys documentation master file, created by
   sphinx-quickstart on Thu Apr  8 00:34:05 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to the SPHinXsys User Guide!
=====================================

SPHinXsys (pronunciation: s'finksis) is an acronym from Smoothed Particle Hydrodynamics for 
industrial compleX systems. It provides C++ APIs for physical accurate simulation and 
aims to model coupled industrial dynamic systems including fluid, solid, multi-body dynamics 
and beyond with SPH (smoothed particle hydrodynamics), a meshless computational method using 
particle discretization.
 
Please check the detailed documentation of the code also on `SPHinXsys's GitHub <https://xiangyu-hu.github.io/SPHinXsys/>`_, powered by Doxygen_.

.. _Doxygen: https://www.doxygen.nl/index.html

SPHinXsys is a multi-physics, multi-resolution SPH library. 
Although it is not a standalone application itself, 
many examples designated for the specific type of applications are provided.


************
Introduction
************

.. toctree::
   :maxdepth: 2

   introduction.rst

****************************
Theory and numerical schemes
****************************

.. toctree::
   :maxdepth: 2

   theory.rst

*******************************
SPHinXsys architecture overview
*******************************

.. toctree::
   :maxdepth: 2

   SPHinXsysArch.rst

******************************************
SPHinXsys academic publications
******************************************

.. toctree::
   :maxdepth: 2

   publication.rst

********************
Installing SPHinXsys
********************

.. toctree::
   :maxdepth: 2

   installation.rst


************************
Creating your own cases
************************

.. toctree::
   :maxdepth: 2

   user_cases.rst

***********************************
Set regression test for a new case
***********************************

.. toctree::
   :maxdepth: 2

   regression_test.rst


**********
Examples:
**********

.. toctree::
   :maxdepth: 2

   examples/example1_2D_dambreak.rst



.. toctree::
   :maxdepth: 2

   examples/example2_elasticGate.rst



.. toctree::
   :maxdepth: 2

   examples/example3_3D_multiResolutionParticleDistribution.rst



.. toctree::
   :maxdepth: 2

   examples/example4_2D_multiResolutionParticleDistribution.rst



.. toctree::
   :maxdepth: 2

   examples/example5_2D_tayloygreen.rst



.. toctree::
   :maxdepth: 2

   examples/example6_2D_heat_transfer.rst



.. toctree::
   :maxdepth: 2

   examples/example7_2D_diffusion.rst



.. toctree::
   :maxdepth: 2

   examples/example8_2D_hydrostatic_fsi.rst

  

.. toctree::
   :maxdepth: 2
   
   examples/example9_2D_staticConfinement.rst



.. toctree::
   :maxdepth: 2

   examples/example10_2D_thinPlate.rst



.. toctree::
   :maxdepth: 2

   examples/example11_3D_arch.rst



.. toctree::
   :maxdepth: 2

   examples/example12_2D_flowaroundcylinder.rst



.. toctree::
   :maxdepth: 2

   examples/example13_2D_oscillating_beam.rst



.. toctree::
   :maxdepth: 2

   examples/example14_2D_bifurcation_flow.rst



.. toctree::
   :maxdepth: 2

   examples/example15_2D_aortic_valve.rst



.. toctree::
   :maxdepth: 2

   examples/example16_2D_channel_flow.rst



.. toctree::
   :maxdepth: 2

   examples/example17_2D_throat.rst



.. toctree::
   :maxdepth: 2

   examples/example18_2D_wetting.rst

******************************************
Contribute to SPHinXsys
******************************************

.. toctree::
   :maxdepth: 2

   contribution.rst


******************************************
How to cite SPHinXsys?
******************************************

.. toctree::
   :maxdepth: 2

   HowToCiteSPHinXsys.rst