From 7bcbd3b1635521745599a5574ead13e55c884f1b Mon Sep 17 00:00:00 2001
From: Andreas Kloeckner <inform@tiker.net>
Date: Mon, 3 Jul 2017 22:05:29 +0200
Subject: [PATCH] Clarify what grudge.sym.Variable is for
---
grudge/symbolic/primitives.py | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/grudge/symbolic/primitives.py b/grudge/symbolic/primitives.py
index b1cf4a54..11d5ae8a 100644
--- a/grudge/symbolic/primitives.py
+++ b/grudge/symbolic/primitives.py
@@ -73,9 +73,9 @@ Symbols
^^^^^^^
.. autoclass:: Variable
+.. autoclass:: ScalarVariable
.. autoclass:: make_sym_array
.. autoclass:: make_sym_mv
-.. autoclass:: ScalarParameter
.. autoclass:: CFunction
Helpers
@@ -300,6 +300,9 @@ class cse_scope(cse_scope_base): # noqa
class Variable(HasDOFDesc, ExpressionBase, pymbolic.primitives.Variable):
+ """A user-supplied input variable with a known :class:`DOFDesc`.
+ """
+
def __init__(self, name, dd=None):
if dd is None:
dd = DD_VOLUME
--
GitLab