Eval funcs docs

.gitignore

@@ -16,7 +16,7 @@ src/adjoint/temp*
 *.mod
 doc/_build/*
 doc/_static/doxydoc/*
-doc/tmp.rst
+doc/tmp*.rst
 *.fmt
 *.bak
 src/build/adflow_project.dep

adflow/pyADflow.py

@@ -5971,7 +5971,7 @@ def _getObjectivesAndDVs(self):
         for key in iDV:
             iDV[key] = iDV[key] - 1
 
-            # Extra DVs for the Boundary condition variables
+        # Extra DVs for the boundary condition variables
         BCDV = ["pressure", "pressurestagnation", "temperaturestagnation", "thrust", "heat"]
 
         # This is ADflow's internal mapping for cost functions

doc/citations.bib

@@ -1,32 +1,58 @@
 @incollection{Coder2017a,
-    author    = {Coder, James G. and Pulliam, Thomas H. and Hue, David and Kenway, Gaetan K. W. and Sclafani, Anthony J.},
-    booktitle = {AIAA SciTech Forum},
-    doi       = {10.2514/6.2017-0960},
-    month     = {January},
-    publisher = {American Institute of Aeronautics and Astronautics},
-    title     = {Contributions to the 6th {AIAA} {CFD} {Drag Prediction Workshop} Using Structured Grid Methods},
-    year      = {2017}
+  author    = {Coder, James G. and Pulliam, Thomas H. and Hue, David and Kenway, Gaetan K. W. and Sclafani, Anthony J.},
+  booktitle = {AIAA SciTech Forum},
+  doi       = {10.2514/6.2017-0960},
+  month     = {January},
+  publisher = {American Institute of Aeronautics and Astronautics},
+  title     = {Contributions to the 6th {AIAA} {CFD} {Drag Prediction Workshop} Using Structured Grid Methods},
+  year      = {2017}
 }
 
 @article{Garg2017a,
-    author  = {Nitin Garg and Gaetan K. W. Kenway and Joaquim R. R. A. Martins and Yin Lu Young},
-    doi     = {10.1016/j.jfluidstructs.2017.02.001},
-    journal = {Journal of Fluids and Structures},
-    month   = {May},
-    pages   = {15--39},
-    title   = {High-fidelity Multipoint Hydrostructural Optimization of a {3-D} Hydrofoil},
-    volume  = {71},
-    year    = {2017}
+  author  = {Nitin Garg and Gaetan K. W. Kenway and Joaquim R. R. A. Martins and Yin Lu Young},
+  doi     = {10.1016/j.jfluidstructs.2017.02.001},
+  journal = {Journal of Fluids and Structures},
+  month   = {May},
+  pages   = {15--39},
+  title   = {High-fidelity Multipoint Hydrostructural Optimization of a {3-D} Hydrofoil},
+  volume  = {71},
+  year    = {2017}
 }
 
 @article{Madsen2019a,
-    author   = {Mads H. Aa. Madsen and Frederik Zahle and Niels N. S{\o}rensen and Joaquim R. R. A. Martins},
-    doi      = {10.5194/wes-4-163-2019},
-    journal  = {Wind Energy Science},
-    keywords = {ank},
-    month    = {April},
-    pages    = {163--192},
-    title    = {Multipoint high-fidelity {CFD}-based aerodynamic shape optimization of a 10 {MW} wind turbine},
-    volume   = {4},
-    year     = {2019}
-}
+  author   = {Mads H. Aa. Madsen and Frederik Zahle and Niels N. S{\o}rensen and Joaquim R. R. A. Martins},
+  doi      = {10.5194/wes-4-163-2019},
+  journal  = {Wind Energy Science},
+  keywords = {ank},
+  month    = {April},
+  pages    = {163--192},
+  title    = {Multipoint high-fidelity {CFD}-based aerodynamic shape optimization of a 10 {MW} wind turbine},
+  volume   = {4},
+  year     = {2019}
+}
+
+@article{Liao2021a,
+  author  = {Yingqian Liao and Joaquim R. R. A. Martins and Yin Lu Young},
+  title   = {3-{D} High-Fidelity Hydrostructural Optimization of Cavitation-Free Composite Lifting Surfaces},
+  doi     = {10.1016/j.compstruct.2021.113937},
+  journal = {Composite Structures},
+  month   = {July},
+  pages   = {113937},
+  volume  = {268},
+  year    = {2021}
+}
+
+@article{Kenway2017b,
+  author   = {Gaetan K. W. Kenway and Joaquim R. R. A. Martins},
+  title    = {Buffet-Onset Constraint Formulation for Aerodynamic Shape Optimization},
+  doi      = {10.2514/1.J055172},
+  journal  = {AIAA Journal},
+  keywords = {xsede},
+  month    = {June},
+  number   = {6},
+  pages    = {1930--1947},
+  volume   = {55},
+  year     = {2017}
+}
+}
+

doc/conf.py

@@ -10,6 +10,9 @@
 import sys
 
 sys.path.insert(0, os.path.abspath("../"))
+sys.path.insert(0, os.path.abspath("./"))  # to import custom Sphinx extension
+
+from ext.costfunctionslist import TEMP_FILE
 
 # build doxygen
 read_the_docs_build = os.environ.get("READTHEDOCS", None) == "True"
@@ -23,16 +26,13 @@
 # Built-in Sphinx extensions are already contained in the imported variable
 # here we add external extensions, which must also be added to requirements.txt
 # so that RTD can import and use them
-extensions.extend(["numpydoc"])
+extensions.extend(["numpydoc", "ext.costfunctionslist"])
 
 # mock import for autodoc
 autodoc_mock_imports = ["numpy", "mpi4py", "baseclasses"]
 
 # bibtex sources
 bibtex_bibfiles.extend(["citations.bib"])
 
-# intersphinx
-intersphinx_mapping = {
-    "mach-aero": ("https://mdolab-mach-aero.readthedocs-hosted.com/en/latest", None),
-    "pygeo": ("https://mdolab-pygeo.readthedocs-hosted.com/en/latest", None),
-}
+# Ignore the temp file from the cost functions list extension
+exclude_patterns.extend([TEMP_FILE])

doc/costFunctions.rst

@@ -0,0 +1,21 @@
+.. _adflow_costFunctions:
+
+Cost Functions
+==============
+
+ADflow works in three dimensions (x,y,z) and application of angles such as alpha and beta change the inflow angles, not the mesh itself.
+So for example a high lift airfoil at 20 degrees has the same mesh as that same airfoil at 0 degrees.
+Another example is a moth T-foil at a 10 degree beta (leeway) angle versus zero.
+
+The relevant source code file for the evaluation of cost functions is ``surfaceIntegrations.F90``.
+Cost functions are added to the ``adflowCostFunctions`` dictionary in ``pyADflow.py``.
+The following list is in the same order as how it currently is in the source code.
+
+.. costfunctionslist:: adflow.pyADflow.ADFLOW
+
+
+References
+==========
+
+.. bibliography::
+    :style: unsrt