Fix documentation strings for example side_user_objects in tests. (Is…

…sue idaholab#7980)
fdkong · Nov 23, 2016 · 3b412b5 · 3b412b5
1 parent cf421c4
commit 3b412b5
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 11 deletions.
diff --git a/framework/include/base/FEProblem.h b/framework/include/base/FEProblem.h
@@ -22,7 +22,6 @@
 class FEProblem;
 class NonlinearSystem;
 
-
 template<>
 InputParameters validParams<FEProblem>();
 

diff --git a/framework/include/base/FEProblemBase.h b/framework/include/base/FEProblemBase.h
@@ -70,7 +70,6 @@ class Function;
 class KernelBase;
 class IntegratedBC;
 
-
 // libMesh forward declarations
 namespace libMesh
 {

diff --git a/framework/src/base/FEProblem.C b/framework/src/base/FEProblem.C
@@ -15,7 +15,6 @@
 #include "FEProblem.h"
 #include "Assembly.h"
 
-
 template<>
 InputParameters validParams<FEProblem>()
 {

diff --git a/framework/src/base/FEProblemBase.C b/framework/src/base/FEProblemBase.C
@@ -74,6 +74,8 @@
 #include "XFEMInterface.h"
 #include "ConsoleUtils.h"
 #include "NonlocalKernel.h"
+#include "NonlocalIntegratedBC.h"
+#include "ShapeElementUserObject.h"
 #include "ShapeSideUserObject.h"
 
 #include "libmesh/exodusII_io.h"
@@ -697,7 +699,7 @@ FEProblemBase::checkNonlocalCoupling()
 {
   for (THREAD_ID tid = 0; tid < libMesh::n_threads(); tid++)
   {
-    const KernelWarehouse & all_kernels = _nl.getKernelWarehouse();
+    const KernelWarehouse & all_kernels = _nl->getKernelWarehouse();
     const std::vector<MooseSharedPointer<KernelBase> > & kernels = all_kernels.getObjects(tid);
     for (const auto & kernel : kernels)
     {
@@ -709,7 +711,7 @@ FEProblemBase::checkNonlocalCoupling()
         _nonlocal_kernels.addObject(kernel, tid);
       }
     }
-    const MooseObjectWarehouse<IntegratedBC> & all_integrated_bcs = _nl.getIntegratedBCWarehouse();
+    const MooseObjectWarehouse<IntegratedBC> & all_integrated_bcs = _nl->getIntegratedBCWarehouse();
     const std::vector<MooseSharedPointer<IntegratedBC> > & integrated_bcs = all_integrated_bcs.getObjects(tid);
     for (const auto & integrated_bc : integrated_bcs)
     {
@@ -724,9 +726,8 @@ FEProblemBase::checkNonlocalCoupling()
   }
 }
 
-
 void
-FEProblem::checkUserObjectJacobianRequirement(THREAD_ID tid)
+FEProblemBase::checkUserObjectJacobianRequirement(THREAD_ID tid)
 {
   std::set<MooseVariable *> uo_jacobian_moose_vars;
   const std::vector<MooseSharedPointer<ElementUserObject> > & e_objects = _elemental_user_objects.getActiveObjects(tid);
@@ -3096,9 +3097,9 @@ FEProblemBase::setCouplingMatrix(CouplingMatrix * cm)
 void
 FEProblemBase::setNonlocalCouplingMatrix()
 {
-  unsigned int n_vars = _nl.nVariables();
+  unsigned int n_vars = _nl->nVariables();
   _nonlocal_cm.resize(n_vars);
-  const std::vector<MooseVariable *> & vars = _nl.getVariables(0);
+  const std::vector<MooseVariable *> & vars = _nl->getVariables(0);
   const std::vector<MooseSharedPointer<KernelBase> > & nonlocal_kernel = _nonlocal_kernels.getObjects();
   const std::vector<MooseSharedPointer<IntegratedBC> > & nonlocal_integrated_bc = _nonlocal_integrated_bcs.getObjects();
   for (const auto & ivar : vars)

diff --git a/test/include/userobjects/DenomShapeSideUserObject.h b/test/include/userobjects/DenomShapeSideUserObject.h
@@ -26,7 +26,7 @@ InputParameters validParams<DenomShapeSideUserObject>();
 /**
  * Test and proof of concept class for computing UserObject Jacobians using the
  * ShapeSideUserObject base class. This object computes the integral
- * \f$ \int_\Omega u^2v dr \f$
+ * \f$ \int_\Omega u dr \f$
  * and builds a vector of all derivatives of the integral w.r.t. the DOFs of u and v.
  * These Jacobian terms can be utilized by a Kernel that uses the integral in the
  * calculation of its residual.

diff --git a/test/include/userobjects/NumShapeSideUserObject.h b/test/include/userobjects/NumShapeSideUserObject.h
@@ -26,7 +26,7 @@ InputParameters validParams<NumShapeSideUserObject>();
 /**
  * Test and proof of concept class for computing UserObject Jacobians using the
  * ShapeSideUserObject base class. This object computes the integral
- * \f$ \int_\Omega u^2v dr \f$
+ * \f$ \int_\Omega \nabla u * \hat n dr \f$
  * and builds a vector of all derivatives of the integral w.r.t. the DOFs of u and v.
  * These Jacobian terms can be utilized by a Kernel that uses the integral in the
  * calculation of its residual.