From 82c68486e3d9614e12c2fb38a463e1f75b102a6a Mon Sep 17 00:00:00 2001
From: Isuru Fernando <isuruf@gmail.com>
Date: Tue, 9 Apr 2019 04:10:18 -0500
Subject: [PATCH] Document PDE class
---
sumpy/expansion/__init__.py | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/sumpy/expansion/__init__.py b/sumpy/expansion/__init__.py
index 871c5b81..a0abecfb 100644
--- a/sumpy/expansion/__init__.py
+++ b/sumpy/expansion/__init__.py
@@ -506,7 +506,24 @@ class LinearPDEBasedExpansionTermsWrangler(ExpansionTermsWrangler):
class PDE(object):
+ r"""
+ Represents a system of PDEs of dimension `dim`. It is represented by a
+ list of dictionaries with each dictionary representing a single PDE.
+ Each dictionary maps a :class:`CoeffIdentifier` object to a value,
+
+ .. math::
+
+ \sum_{(mi, ident), c \text{pde\_dict}}
+ \frac{\partial^{\sum(mi)}}{\partial u^mi} c = 0,
+
+ where :math:`u` is the solution vector of the PDE.
+ """
def __init__(self, dim, eqs):
+ """
+ :arg dim: dimension of the PDE
+ :arg eqs: list of dictionaries mapping a :class:`CoeffIdentifier` to a
+ value.
+ """
self.dim = dim
self.eqs = eqs
--
GitLab