diff --git a/docs/picvva/Makefile b/docs/picvva/Makefile new file mode 100644 index 0000000000000000000000000000000000000000..e7af19555098c16253f44b1a5c4e2d1dd8b62ad4 --- /dev/null +++ b/docs/picvva/Makefile @@ -0,0 +1,24 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +# move the generated html into webroot with the rest of the html +all: html + mv build/html ../webroot/picvva_html diff --git a/docs/picvva/source/_static/theme_overrides.css b/docs/picvva/source/_static/theme_overrides.css new file mode 100644 index 0000000000000000000000000000000000000000..7c1a5202231086af91e2bd4b388d8de4b064f27f --- /dev/null +++ b/docs/picvva/source/_static/theme_overrides.css @@ -0,0 +1,10 @@ +/* override table width restrictions */ +.wy-table-responsive table td, .wy-table-responsive table th { + white-space: normal; +} + +.wy-table-responsive { + margin-bottom: 24px; + max-width: 100%; + overflow: visible; +} diff --git a/docs/picvva/source/conf.py b/docs/picvva/source/conf.py new file mode 100644 index 0000000000000000000000000000000000000000..5d2da9b1bfe90398e262ce8d55251d7b88a62b1e --- /dev/null +++ b/docs/picvva/source/conf.py @@ -0,0 +1,175 @@ +# -*- coding: utf-8 -*- +# +# amrex documentation build configuration file, created by +# sphinx-quickstart on Thu Oct 19 14:30:08 2017. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + +import sphinx_rtd_theme + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['sphinx.ext.mathjax', + 'sphinx.ext.githubpages', + 'sphinx.ext.viewcode'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['ytemplates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'MFiX-Exa' +copyright = u'2017-2018, MFiX-Exa Team' +author = u'MFiX-Exa Team' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +#version = +# The full version, including alpha/beta/rc tags. +#release = + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + +# This is necessary to reference numbered figures +numfig = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] +html_css_files = ['theme_overrides.css'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +html_sidebars = { + '**': [ + 'about.html', + 'navigation.html', + 'relations.html', # needs 'show_related': True theme option to display + 'searchbox.html', + 'donate.html', + ] +} + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'amrexdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'mfix.tex', u'MFiX-Exa Documentation', + u'MFiX-Exa Team', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'mfix', u'MFiX-Exa Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'mfix', u'MFiX-Exa Documentation', + author, 'MFiX-Exa Term', "MFiX-Exa, it's MFiX... but now with more Exa!", + 'Miscellaneous Aardvark'), +] diff --git a/docs/picvva/source/index.rst b/docs/picvva/source/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..a527727727dec59baab26039dae7e5ec1474140b --- /dev/null +++ b/docs/picvva/source/index.rst @@ -0,0 +1,39 @@ +.. MFIX-Exa PIC VVA documentation master file, created by + sphinx-quickstart on Wed Jan 11 13:16:04 2023. + +Welcome to the MFIX-Exa PIC VVA Manual +====================================== + +.. toctree:: + :maxdepth: 1 + :caption: Contents: + + intro + +Notice +------ + +Neither the United States Government nor any agency thereof, nor any of +their employees, makes any warranty, expressed or implied, or assumes +any legal liability or responsibility for the accuracy, completeness, or +usefulness of any information, apparatus, product, or process disclosed +or represents that its use would not infringe privately owned rights. + +- MFIX-Exa is provided without any user support for applications in the + user's immediate organization. It should not be redistributed in + whole or in part. + +- The use of MFIX-Exa is to be acknowledged in any published paper based on + computations using this software by citing this MFIX-Exa site. + +- The authors would appreciate receiving any reports of bugs or other + difficulties with the software, enhancements to the software, and + accounts of practical applications of this software. + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/picvva/source/intro.rst b/docs/picvva/source/intro.rst new file mode 100644 index 0000000000000000000000000000000000000000..cab86ec711b8e51671c1abd4455394110205c1f5 --- /dev/null +++ b/docs/picvva/source/intro.rst @@ -0,0 +1,31 @@ +Introduction +============ + +MFiX-Exa is a new massively parallel code for computing multiphase +flow in which solid particles interact with the gas surrounding them. It is +built on top of `AMReX`_, a publicly available software framework designed for +building massively parallel block-structured adaptive mesh refinement (AMR) +applications. + +MFiX-Exa relies on the same fundamental physics as in MFiX but the spatial and +time discretizations differ. Specifically, + +- Fluid velocity is defined at cell centers; pressure is defined at nodes. +- The advection algorithm includes an intermediate MAC projection for + face-centered advection velocities +- Incompressibility of the fluid is imposed through the use of a projection at + the end of the time step +- The representation of the complex geometry includes mesh refinement around + the fluid-solid interface, which is represented used the embedded boundary, or + cut-cell approach +- Parallelization via flat MPI, OpenMP, hybrid MPI/OpenMP, or MPI/MPI. +- Porting of MFiX-Exa to GPUs is in progress. +- Parallel I/O using AMReX native I/O or HDF5. +- Plotfile format supported by AmrVis, VisIt, ParaView, and yt. + +MFiX-Exa is being developed at NETL and LBNL as part of the U.S. Department of +Energy's `Exascale Computing Project (ECP) `_ +MFiX-Exa heavily leverages `AMReX`_ which is also supported by ECP as part of +the AMReX Co-Design Center. + +.. _AMReX: https://amrex-codes.github.io/ diff --git a/docs/webroot/index.html b/docs/webroot/index.html index e44ce1e4d29aec45b1e1ce381211d4cffb5d46d8..e7d64919807f4adf97e02570efa83266a409322c 100644 --- a/docs/webroot/index.html +++ b/docs/webroot/index.html @@ -44,6 +44,9 @@
  • Gallery
  • +
  • + PIC VVA +