Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
hog
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
hyteg
hog
Commits
0356e31f
Commit
0356e31f
authored
10 months ago
by
Nils Kohl
Browse files
Options
Downloads
Patches
Plain Diff
Minor docstring improvement in integrand.py.
parent
3f9e0169
Branches
Branches containing commit
Tags
Tags containing commit
1 merge request
!16
Refactoring forms
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
hog/integrand.py
+13
-4
13 additions, 4 deletions
hog/integrand.py
with
13 additions
and
4 deletions
hog/integrand.py
+
13
−
4
View file @
0356e31f
...
@@ -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
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment