Skip to content

Commit

Permalink
updated some docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
gawng committed May 24, 2023
1 parent 881949b commit 40fd2ca
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 22 deletions.
39 changes: 18 additions & 21 deletions doc/costFunctions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -51,48 +51,42 @@ cdm:
cofxx:
desc: >
Coefficient of component of normal forces on wall boundaries in ``x`` direction.
Units: None
The following center of force cost functions first list the force component (e.g., Fx) and then the coordinate (e.g., x coordinate).
These cost functions look at the sum of all forces.
Center of ``x`` force, ``x`` coordinate.
Units: ``Meter``
cofxy:
desc: >
Coefficient of component of shear forces on face of ``x`` in ``y`` direction.
Units: None
See ``cofxx`` description.
cofxz:
desc: >
Coefficient of component of shear forces on face of ``x`` in ``z`` direction.
Units: None
See ``cofxx`` description.
cofyx:
desc: >
Coefficient of component of shear forces on face of ``y`` in ``x`` direction.
Units: None
See ``cofxx`` description.
cofyy:
desc: >
Coefficient of component of normal forces on wall boundaries in ``y`` direction.
Units: None
See ``cofxx`` description.
cofyz:
desc: >
Coefficient of component of shear forces on face of ``y`` in ``z`` direction.
Units: None
See ``cofxx`` description.
cofzx:
desc: >
Coefficient of component of shear forces on face of ``z`` in ``x`` direction.
Units: None
See ``cofxx`` description.
cofzy:
desc: >
Coefficient of component of shear forces on face of ``z`` in ``y`` direction.
Units: None
See ``cofxx`` description.
cofzz:
desc: >
Coefficient of component of normal forces on wall boundaries in ``z`` direction.
Units: None
See ``cofxx`` description.
fx:
desc: >
Expand Down Expand Up @@ -462,15 +456,18 @@ mavgvi:
mavgvx:
desc: >
Averaged mass flow in the x direction.
Mass-averaged ``x`` velocity (i.e., :math:`\Sigma \dot{m}_x / \Sigma \dot{m}`).
Units: ``m / s``
mavgvy:
desc: >
Averaged mass flow in the y direction.
Mass-averaged ``y`` velocity.
Units: ``m / s``
mavgvz:
desc: >
Averaged mass flow in the z direction.
Mass-averaged ``z`` velocity.
Units: ``m / s``
cperror2:
desc: >
Expand Down
2 changes: 1 addition & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ ADflow -- Automatic Differentation Flow Solver -- is a structured
multi-block and overset 3D CFD solver.

.. toctree::
:maxdepth: 2
:maxdepth: 1

introduction
install
Expand Down

0 comments on commit 40fd2ca

Please sign in to comment.