.. M-Star CFD Manual documentation master file, created by
   sphinx-quickstart on Tue Feb  6 13:32:32 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

#############################
The future is predictable.
#############################

Build advanced fluid models in minutes, predict real-time dynamics with precision, and solve complex fluid flow problems faster. M-Star is CFD software for the real world.

.. toctree::
	:caption: Getting Started
	:maxdepth: 2
	:hidden:

	1_Introduction/introduction
	2_Installation/txt-files/Installation-index
	3_Licensing/Licensing-index
	1a_Tutorials/index
	1b_HowToGuides/index
	KB/index


.. toctree::
	:caption: M-Star Pre
	:maxdepth: 2
	:hidden:

	4_Pre-Overview/txt-files/Pre-Overview-index
	4a_Model-Tree/Model-tree-index
	5_Fluid/txt-files/Fluid-index
	5a_Geometry/Geometry-index
	6_Create/Create-index
	7_Output/Output
	12_MStar_API/txt-files/MStar-api-index  
	
	
.. toctree::
	:caption: M-Star Solve
	:maxdepth: 2
	:hidden:

	10_Running_the_Solver/index
	11_Workflow_and_Integration/txt-files/Workflow-index  
	

.. toctree::
	:caption: M-Star Post
	:maxdepth: 2
	:hidden:	

	13_Post_Processing/txt-rst-files/Post-processing-index
	19_Scaling_Performance/txt-files/Scaling-performance-index
	
.. toctree::
	:caption: More Resources
	:maxdepth: 2
	:hidden:	

    
	15_Validation_Literature/txt-rst-files/Validation-literature-index	
	16_User_Defined_Functions/User-defined-functions-index
	17_Theory/Theory-index
	18_Architecture_Technical_Overview/txt-files/Architecture-index
	14_Webinars/txt-files/Webinars-index
	
			
.. topic:: Getting Started

	* What is :doc:`M-Star CFD <1_Introduction/introduction>`?
	* How do I :doc:`install M-Star CFD <2_Installation/txt-files/Installation-index>`? 
	* What do I need to know about :doc:`licensing <3_Licensing/Licensing-index>`? 
	* How do I :ref:`build, run, and process a simple model <modeling-first-process>`?
	* Do you have :ref:`step-by-step tutorials <tutorials>`?



|M-StarPre.png|	M-Star Pre: Creating Models
==============================================

.. |M-StarPre.png| image:: M-StarPre.png
  :height: 23	

*M-Star Pre is the graphical user interface (GUI) used to build models, define physics, and set simulation parameters. The GUI takes in user-defined geometry/operation conditions and generates input files for the solver.*

* :ref:`Overview <m-star-pre-overview>`: Learn features of the M-Star Pre graphical user interface. 
* :ref:`Model Tree <model-tree>` : Determine the basic components of your model.
* :ref:`Fluid <fluid-index>`: Select the foundational basis of your model.
* :ref:`Geometry <geometry-index>`: Use built-in geometry and import custom CAD files.
* :ref:`Create <create-index>`: Create the components of your model.

  :ref:`Fundamentals <create-fundamentals>` | :ref:`Particles <create-particles>` | :ref:`Lattice <create-lattice>` | :ref:`Scalar <create-scalar>` | :ref:`Variables <variables-index>` | :ref:`Runtime <runtime-index>` | :ref:`Thermal <thermal-index>` | :ref:`Output <create-output>` | :ref:`Analysis <create-control>`
* :ref:`Output <output>`: Control the types and frequency of data for visualization and analysis.
* :doc:`12_MStar_API/txt-files/MStar-api-index`: Use the M-Star Python module to embed M-Star CFD into other broader enterprise workflows.


|M-StarSolve| M-Star Solve: Running the Solver
===================================================

.. |M-StarSolve| image:: M-StarSolve.png
  :height: 23

*M-Star Solve is the compute engine that solves the numerical models to predict system dynamics. The solver reads input files created by M-Star Pre and generates post-processing data for visualization in M-Star Post or analysis elsewhere.*

* :doc:`10_Running_the_Solver/index`: Start and monitor simulations. 
* :doc:`11_Workflow_and_Integration/txt-files/Workflow-index`: Integrate with other libraries and third-party software.



|M-StarPost| M-Star Post: Analyzing Output Data
===================================================

.. |M-StarPost| image:: M-StarPost.png
  :height: 23
	

*M-Star Post is visualization software used to render, plot, and analyze simulation output data. The post processor reads files generated by M-Star Solve and allows users to inspect the simulation via 3D rendering, real-time animation, and custom statistical analysis.*

* :doc:`Post-Processing <13_Post_Processing/txt-rst-files/Post-processing-index>`: Post-process output data and leverage our Paraview scripts.
* :doc:`Scaling/Performance <19_Scaling_Performance/txt-files/Scaling-performance-index>`: Learn how different hardware architectures scale and best practices for multi-GPU setup.


--------------------------------------------------------------------------------

More Resources
====================

* :doc:`Webinars <14_Webinars/txt-files/Webinars-index>`: View the latest M-Star webinars.

* :doc:`Validation & Literature <15_Validation_Literature/txt-rst-files/Validation-literature-index>`: View M-Star cited in published literature and other validation cases.


.. rubric::  M-Star API: Integrating & Customizing

* :doc:`11_Workflow_and_Integration/txt-files/parameter-sweeps`: Find simplified execution of parameter sweeps.

* :doc:`11_Workflow_and_Integration/txt-files/global-scripts`: Add your own commands to the Solver GUI for streamlined workflow tasks.


.. rubric:: M-Star Utilities

* :doc:`M-Star Queue <../10_Running_the_Solver/m-star-queue>`: Build a queue of simulations. 
* :doc:`M-Star Optimizer <../10_Running_the_Solver/m-star-optimizer>`: Optimize a given quantity by changing an input property.
* :doc:`M-Star Resolver <../10_Running_the_Solver/m-star-resolver>`: Watch the output of a global variable, and stop when the global variable has converged.
* :doc:`M-Star License Utility <../3_Licensing/m-star-license-utility>`: Test and verify license options, set up licenses, and check out "roaming" licenses from a license server.


.. rubric:: Other Topics

* :doc:`Theoretical Background <17_Theory/theory-and-implementation>`: Learn about the underlying physics theory.
* :doc:`Large Eddy Simulation Review <17_Theory/theory-and-implementation>`: Catch a quick review of LES turbulence modeling.
* :ref:`Third-Party Licenses <thirdparty-licenses>`: See open source license and copyright statements.
* :doc:`18_Architecture_Technical_Overview/txt-files/Architecture-index`: Find an overview of software architecture and internal development practices.


.. rubric:: M-Star Links

* `M-Star Website <https://mstarcfd.com>`_
* `Download M-Star <https://download.mstarcfd.com>`_
* `M-Star Support Helpdesk <https://support.mstarcfd.com>`_

.. rubric:: Contact Information

* Sales: sales@mstarcfd.com
* Orders: orders@mstarcfd.com
* Support: support@mstarcfd.com


© 2014-|currentyear| | M-Star Simulations, LLC | All Rights Reserved 

8 The Green, Suite 8745,
Dover, DE 19901
USA

.. |currentyear| date:: %Y