Skip to content
Snippets Groups Projects
Commit 0356e31f authored by Nils Kohl's avatar Nils Kohl :full_moon_with_face:
Browse files

Minor docstring improvement in integrand.py.

parent 3f9e0169
Branches
Tags
1 merge request!16Refactoring forms
...@@ -190,9 +190,13 @@ def process_integrand( ...@@ -190,9 +190,13 @@ def process_integrand(
.. code-block:: python .. code-block:: python
# The arguments of the function must begin with an asterisk (*), followed by keyword arguments, followed by the # The arguments of the function must begin with an asterisk (*), followed by
# unused keyword arguments (**_). All keyword arguments must be members of the IntegrandSymbols class. # keyword arguments, followed by the unused keyword arguments (**_). All
# The function must return the integrand. You can use functions from the module hog.math_helpers module. # keyword arguments must be members of the IntegrandSymbols class.
#
# The function must return the integrand. You can use functions from the
# module hog.math_helpers module.
#
# Many integrands are already implemented under hog/recipes/integrands/. # Many integrands are already implemented under hog/recipes/integrands/.
def my_diffusion_integrand( def my_diffusion_integrand(
...@@ -215,7 +219,12 @@ def process_integrand( ...@@ -215,7 +219,12 @@ def process_integrand(
* jac_b_abs_det * jac_b_abs_det
) )
The callable (here `my_diffusion_integrand`, not `my_diffusion_integrand()`) is then passed to this function. The callable (here `my_diffusion_integrand`, not `my_diffusion_integrand()`) is then passed to this function:
.. code-block:: python
form = process_integrand( my_diffusion_integrand, trial, test, ... )
:param integrand: an integrand callable :param integrand: an integrand callable
:param trial: the finite-element trial function space :param trial: the finite-element trial function space
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment