From: kanschat <kanschat@0785d39b-7218-0410-832d-ea1e28bc413d>
Date: Fri, 20 Jun 2014 14:44:39 +0000 (+0000)
Subject: improve documentation and add a missing const
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=61355532988e0a0996c4c0a5290e9a64ffac4a16;p=dealii-svn.git

improve documentation and add a missing const

git-svn-id: https://svn.dealii.org/trunk@33065 0785d39b-7218-0410-832d-ea1e28bc413d
---

diff --git a/deal.II/include/deal.II/algorithms/theta_timestepping.h b/deal.II/include/deal.II/algorithms/theta_timestepping.h
index d6fafbb8ba..b8a90611ec 100644
--- a/deal.II/include/deal.II/algorithms/theta_timestepping.h
+++ b/deal.II/include/deal.II/algorithms/theta_timestepping.h
@@ -334,10 +334,10 @@ namespace Algorithms
      * with name "Current time solution". It should obtain the current
      * time and time step size from explicit_data().
      *
-     * Its return value is <i>Mu+cAu</i>, where <i>u</i> is the
-     * current state vector, <i>M</i> the mass matrix, <i>A</i> the
-     * operator in space and <i>c</i> is the time step size in
-     * explicit_data().
+     * Its return value is <i>Mu+cF(u)</i>, where <i>u</i> is the
+     * current state vector, <i>M</i> the mass matrix, <i>F</i> the
+     * operator in space and <i>c</i> is the adjusted
+     * time step size \f$ (1-\theta) \Delta t\f$.
      */
     SmartPointer<Operator<VECTOR>, ThetaTimestepping<VECTOR> > op_explicit;
 
@@ -347,11 +347,11 @@ namespace Algorithms
      * time". Information on the timestep should be obtained from
      * implicit_data().
      *
-     * Its return value is the solution <i>u</i> of <i>Mu-cAu=f</i>,
+     * Its return value is the solution <i>u</i> of <i>Mu-cF(u)=f</i>,
      * where <i>f</i> is the dual space vector found in the "Previous
      * time" entry of the input data, <i>M</i> the mass matrix,
-     * <i>A</i> the operator in space and <i>c</i> is the time step
-     * size in explicit_data().
+     * <i>F</i> the operator in space and <i>c</i> is the adjusted
+     * time step size \f$ \theta \Delta t\f$
      */
     SmartPointer<Operator<VECTOR>, ThetaTimestepping<VECTOR> > op_implicit;
 
diff --git a/deal.II/include/deal.II/numerics/dof_output_operator.h b/deal.II/include/deal.II/numerics/dof_output_operator.h
index ed4bf51c14..052f6cb5bd 100644
--- a/deal.II/include/deal.II/numerics/dof_output_operator.h
+++ b/deal.II/include/deal.II/numerics/dof_output_operator.h
@@ -54,13 +54,13 @@ namespace Algorithms
                        const unsigned int digits = 3);
 
     void parse_parameters(ParameterHandler &param);
-    void initialize (DoFHandler<dim, spacedim> &dof_handler);
+    void initialize (const DoFHandler<dim, spacedim> &dof_handler);
 
     virtual OutputOperator<VECTOR> &
     operator << (const AnyData &vectors);
 
   private:
-    SmartPointer<DoFHandler<dim, spacedim>,
+    SmartPointer<const DoFHandler<dim, spacedim>,
                  DoFOutputOperator<VECTOR, dim, spacedim> > dof;
 
     const std::string filename_base;
@@ -70,8 +70,8 @@ namespace Algorithms
   };
 
   template <class VECTOR, int dim, int spacedim>
-  void DoFOutputOperator<VECTOR, dim, spacedim>::initialize(
-    DoFHandler<dim, spacedim> &dof_handler)
+  inline void
+  DoFOutputOperator<VECTOR, dim, spacedim>::initialize(const DoFHandler<dim, spacedim> &dof_handler)
   {
     dof = &dof_handler;
   }