From: kanschat 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 Mu+cAu, where u is the - * current state vector, M the mass matrix, A the - * operator in space and c is the time step size in - * explicit_data(). + * Its return value is Mu+cF(u), where u is the + * current state vector, M the mass matrix, F the + * operator in space and c is the adjusted + * time step size \f$ (1-\theta) \Delta t\f$. */ SmartPointer, ThetaTimestepping > 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 u of Mu-cAu=f, + * Its return value is the solution u of Mu-cF(u)=f, * where f is the dual space vector found in the "Previous * time" entry of the input data, M the mass matrix, - * A the operator in space and c is the time step - * size in explicit_data(). + * F the operator in space and c is the adjusted + * time step size \f$ \theta \Delta t\f$ */ SmartPointer, ThetaTimestepping > 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 ¶m); - void initialize (DoFHandler &dof_handler); + void initialize (const DoFHandler &dof_handler); virtual OutputOperator & operator << (const AnyData &vectors); private: - SmartPointer, + SmartPointer, DoFOutputOperator > dof; const std::string filename_base; @@ -70,8 +70,8 @@ namespace Algorithms }; template - void DoFOutputOperator::initialize( - DoFHandler &dof_handler) + inline void + DoFOutputOperator::initialize(const DoFHandler &dof_handler) { dof = &dof_handler; }