Skip to content

Commit

Permalink
docs: minor fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Revathyvenugopal162 committed Aug 30, 2023
1 parent d9376de commit 33db209
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 14 deletions.
3 changes: 1 addition & 2 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@
"sphinx_copybutton",
"sphinx_gallery.gen_gallery",
"jupyter_sphinx",
"notfound.extension",
"sphinx.ext.coverage",
"sphinx.ext.doctest",
"sphinx.ext.extlinks",
Expand All @@ -74,7 +73,7 @@

# Intersphinx mapping
intersphinx_mapping = {
"python": ("https://docs.python.org/dev", None),
"python": ("https://docs.python.org/3", None),
# kept here as an example
# "scipy": ("https://docs.scipy.org/doc/scipy/reference", None),
# "numpy": ("https://numpy.org/devdocs", None),
Expand Down
16 changes: 8 additions & 8 deletions examples/gallery/08_lucid_generic_f1_rear_wing.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@

###############################################################################
# Merge parts
# ~~~~~~~~~~~~~~~~~~~
# ~~~~~~~~~~~
# Establish the global size parameter to regulate mesh refinement.
# Merge all individual parts into a unified part named `f1_car_rear_wing`.

Expand All @@ -96,7 +96,7 @@

###############################################################################
# Mesh connect
# ~~~~~~~~~~~~~~~~~~~
# ~~~~~~~~~~~~
# In order to generate a volume mesh for a closed domain, it is necessary to ensure
# that the components of the rear wing are properly connected.
# To achieve this, perform a connect operation using labels to join the components of
Expand All @@ -119,7 +119,7 @@

###############################################################################
# Define local size-control and generate size-field
# ~~~~~~~~~~~~~~~~~~~
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
# In order to accurately represent the physics of the DRS wing, a limitation of 8 mm
# is imposed on the mesh size of the wing.
# This is accomplished by implementing curvature size control, which refines the
Expand Down Expand Up @@ -165,7 +165,7 @@

###############################################################################
# Generate surface mesh
# ~~~~~~~~~~~~~~~~~~~
# ~~~~~~~~~~~~~~~~~~~~~
# Create a surface mesh for the rear wing using the defined size controls.
# To facilitate the definition of boundary conditions on the surfaces in the solver,
# generate face zones by utilizing the existing labels found in the rear wing model.
Expand All @@ -180,14 +180,14 @@

###############################################################################
# Compute volumetric regions
# ~~~~~~~~~~~~~~~~~~~
# ~~~~~~~~~~~~~~~~~~~~~~~~~~
# Compute the volume zones.

mesh_util.compute_volumes(part_expression=part.name, create_zones_per_volume=True)

###############################################################################
# Define volume controls
# ~~~~~~~~~~~~~~~~~~~
# ~~~~~~~~~~~~~~~~~~~~~~
# In order to prevent the generation of a volume mesh within the solid wing,
# the type of a volume zone within the rear wing can be defined as "dead".
# To accomplish this, Volume Control is utilized to assign the type for the
Expand All @@ -211,7 +211,7 @@

###############################################################################
# Define prism controls
# ~~~~~~~~~~~~~~~~~~~
# ~~~~~~~~~~~~~~~~~~~~~
# A prism control can be used to define inflation layers on the external aero surfaces.
# Specify the aero surfaces using labels, here prism scope is defined on zones associated
# with labels ``*drs*`` and ``*plane*``.
Expand Down Expand Up @@ -247,7 +247,7 @@

###############################################################################
# Generate volume mesh
# ~~~~~~~~~~~~~~~~~~~
# ~~~~~~~~~~~~~~~~~~~~
# Volume mesh with hexcore polyhedral elements and boundary layer refinement.

volume_mesh = prime.AutoMesh(model)
Expand Down
6 changes: 3 additions & 3 deletions examples/misc/example_template.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,9 @@
# as ReStructured Text (RST).
#
# .. note::
# You only need to create the Python (PY) files for the example. The
# ``sphinx-gallery`` extension automatically generates the Jupyter
# notebook, the HTML files for the documentation, and the demo script.
# You only need to create the Python (PY) files for the example. The
# ``sphinx-gallery`` extension automatically generates the Jupyter
# notebook, the HTML files for the documentation, and the demo script.
#
# Sections can contain any information that you may have regarding the example,
# such as step-by-step comments and information on motivations. In the generated
Expand Down
1 change: 0 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ doc = [
"sphinx-autodoc-typehints==1.24.0",
"sphinx-copybutton==0.5.2",
"sphinx-gallery==0.14.0",
"sphinx-notfound-page==0.8.3",
"sphinxemoji==0.2.0",
]
all = [
Expand Down

0 comments on commit 33db209

Please sign in to comment.