Skip to content

Commit

Permalink
highlight the utility module/ the mesh properties
Browse files Browse the repository at this point in the history
  • Loading branch information
schuhmaj committed Mar 26, 2024
1 parent 5c52ed8 commit 26102a9
Show file tree
Hide file tree
Showing 6 changed files with 36 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/api/calculation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ GravityModel
.. doxygennamespace:: polyhedralGravity::GravityModel


.. _mesh-checking-cpp:

MeshChecking
------------

Expand Down
2 changes: 2 additions & 0 deletions docs/api/python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,8 @@ vertices and triangular faces at given computation points
:return: A string representation of the polyhedron


.. _mesh-checking-python:

utility
~~~~~~~

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ And for more details, refer to the **Python API** or **C++ API**.
:caption: QUICK START & INSTALLATION
:maxdepth: 2

quickstart/build
quickstart/installation
quickstart/quick_start_python
quickstart/quick_start_cpp
quickstart/supported_input
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ The python interface can be easily installed with `conda <https://anaconda.org/c
conda install -c conda-forge polyhedral-gravity-model
The python package on conda is parallelized with OpenMP.
It is currently available for all operating systems (macOS, Linux, Windows), but
only for :code:`x86_64` systems.
Have a look at the :ref:`installation-pip`. It also provides wheels for :code:`aarch64`.


.. _installation-pip:

Installation with pip
---------------------

Expand Down
11 changes: 11 additions & 0 deletions docs/quickstart/quick_start_cpp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,17 @@ Hence, if e.g. your mesh is in :math:`km`, the density must match. Further, outp
| Vxx, Vyy, Vzz, Vxy, Vxz, Vyz | :math:`\frac{1}{s^2}` |The spatial rate of change of the gravitational acceleration |
+------------------------------+----------------------------------------------------------------------------+-----------------------------------------------------------------+


.. note::

The plane unit normals of every face of the polyhedral mesh must point **outwards**
of the polyhedron!
You can check this property via :ref:`mesh-checking-cpp` in C++ or
via the :ref:`mesh-checking-python` submodule in Python.
If the vertex order of the faces is inverted, i.e. the plane unit normals point
inwards, then the sign of the output will be inverted.


As Library
----------

Expand Down
12 changes: 12 additions & 0 deletions docs/quickstart/quick_start_python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,18 @@ Have a look at :ref:`evaluable-vs-eval` for further
details about the difference.
If you strive for maximal performance, use the the class :code:`GravityEvaluable`.
If you quickly want to try out something, use :code:`evaluate(..)`.
The polyhedral source can either be a tuple of vertices and faces, or
a list of polyhedral mesh files (see :ref:`supported-polyhedron-source-files`).

.. note::

The plane unit normals of every face of the polyhedral mesh must point **outwards**
of the polyhedron!
You can check this property via :ref:`mesh-checking-cpp` in C++ or
via the :ref:`mesh-checking-python` submodule in Python.
If the vertex order of the faces is inverted, i.e. the plane unit normals point
inwards, then the sign of the output will be inverted.


The method calls follow the same pattern as the C++ interface. Thus it is always:

Expand Down

0 comments on commit 26102a9

Please sign in to comment.