From 8c29e53b814832f5b587db3604ffb9783928d25e Mon Sep 17 00:00:00 2001 From: Thomas Gibson <gibsonthomas1120@hotmail.com> Date: Fri, 4 Jun 2021 00:41:53 -0500 Subject: [PATCH] Keep operations in grudge.op and clean headers --- grudge/interpolation.py | 2 ++ grudge/projection.py | 2 ++ grudge/reductions.py | 3 +-- grudge/trace_pair.py | 45 ++++++++++++++++++++--------------------- 4 files changed, 27 insertions(+), 25 deletions(-) diff --git a/grudge/interpolation.py b/grudge/interpolation.py index e494c3d3..61bdf1a1 100644 --- a/grudge/interpolation.py +++ b/grudge/interpolation.py @@ -1,4 +1,6 @@ """ +.. currentmodule:: grudge.op + Interpolation ------------- diff --git a/grudge/projection.py b/grudge/projection.py index 880340db..3129253c 100644 --- a/grudge/projection.py +++ b/grudge/projection.py @@ -1,4 +1,6 @@ """ +.. currentmodule:: grudge.op + Projections ----------- diff --git a/grudge/reductions.py b/grudge/reductions.py index 78162d65..b8a8a868 100644 --- a/grudge/reductions.py +++ b/grudge/reductions.py @@ -1,6 +1,5 @@ """ -Reduction operations -^^^^^^^^^^^^^^^^^^^^ +.. currentmodule:: grudge.op Nodal reductions ---------------- diff --git a/grudge/trace_pair.py b/grudge/trace_pair.py index ad2e9c81..a0667d05 100644 --- a/grudge/trace_pair.py +++ b/grudge/trace_pair.py @@ -1,3 +1,25 @@ +""" +Trace Pairs +^^^^^^^^^^^ + +Container class +--------------- + +.. autoclass:: TracePair + +Boundary trace functions +------------------------ + +.. autofunction:: bdry_trace_pair +.. autofunction:: bv_trace_pair + +Interior and cross-rank trace functions +--------------------------------------- + +.. autofunction:: interior_trace_pairs +.. autofunction:: cross_rank_trace_pairs +""" + __copyright__ = """ Copyright (C) 2021 University of Illinois Board of Trustees """ @@ -45,29 +67,6 @@ import numpy as np import grudge.dof_desc as dof_desc -__doc__ = """ -Trace Pairs -^^^^^^^^^^^ - -Container class ---------------- - -.. autoclass:: TracePair - -Boundary trace functions ------------------------- - -.. autofunction:: bdry_trace_pair -.. autofunction:: bv_trace_pair - -Interior and cross-rank trace functions ---------------------------------------- - -.. autofunction:: interior_trace_pairs -.. autofunction:: cross_rank_trace_pairs -""" - - # {{{ Trace pair container class @with_container_arithmetic( -- GitLab