Skip to content
Snippets Groups Projects
Commit b63ae50a authored by Norihiro Watanabe's avatar Norihiro Watanabe
Browse files

remove doxygen commments for removed template Mat/Vec parameters

parent 39f8273a
No related branches found
No related tags found
No related merge requests found
......@@ -27,7 +27,6 @@ enum class IterationResult : char
/*! Collection of basic methods every equation system must provide.
*
* \tparam Vector the type of the solution vector of the equation.
*/
class EquationSystem : public MathLib::MatrixSpecificationsProvider
{
......
......@@ -30,9 +30,6 @@ namespace NumLib
{
/*! Common interface for nonlinear solvers.
*
* \tparam Matrix the type of matrices occuring in the linearization of the
* equation.
* \tparam Vector the type of the solution vector of the equation.
*/
class NonlinearSolverBase
{
......@@ -67,9 +64,6 @@ public:
/*! Find a solution to a nonlinear equation.
*
* \tparam Matrix the type of matrices occuring in the linearization of the
* equation.
* \tparam Vector the type of the solution vector of the equation.
* \tparam NLTag a tag indicating the method used for solving the equation.
*/
template <NonlinearSolverTag NLTag>
......@@ -77,9 +71,6 @@ class NonlinearSolver;
/*! Find a solution to a nonlinear equation using the Newton-Raphson method.
*
* \tparam Matrix the type of matrices occuring in the linearization of the
* equation.
* \tparam Vector the type of the solution vector of the equation.
*/
template <>
class NonlinearSolver<NonlinearSolverTag::Newton> final
......@@ -132,9 +123,6 @@ private:
/*! Find a solution to a nonlinear equation using the Picard fixpoint iteration
* method.
*
* \tparam Matrix the type of matrices occuring in the linearization of the
* equation.
* \tparam Vector the type of the solution vector of the equation.
*/
template <>
class NonlinearSolver<NonlinearSolverTag::Picard> final
......
......@@ -20,9 +20,6 @@ namespace NumLib
/*! A System of nonlinear equations.
*
* \tparam Matrix the type of matrices occuring in the linearization of the
* equation.
* \tparam Vector the type of the solution vector of the equation.
* \tparam NLTag a tag indicating the method used for solving the equation.
*/
template <NonlinearSolverTag NLTag>
......@@ -32,10 +29,6 @@ class NonlinearSystem;
*
* The Newton-Raphson method will iterate the linearized equation
* \f$ \mathtt{Jac} \cdot (-\Delta x_i) = \mathtt{res} \f$.
*
* \tparam Matrix the type of matrices occuring in the linearization of the
* equation.
* \tparam Vector the type of the solution vector of the equation.
*/
template <>
class NonlinearSystem<NonlinearSolverTag::Newton> : public EquationSystem
......@@ -77,10 +70,6 @@ public:
*
* The Picard method will iterate the linearized equation
* \f$ \mathtt{A} \cdot x_i = \mathtt{rhs} \f$.
*
* \tparam Matrix the type of matrices occuring in the linearization of the
* equation.
* \tparam Vector the type of the solution vector of the equation.
*/
template <>
class NonlinearSystem<NonlinearSolverTag::Picard> : public EquationSystem
......
......@@ -26,8 +26,6 @@ namespace NumLib
* This is the interface an ODE has to implement in order to be solved with this
* ODE solver library.
*
* \tparam Matrix the type of matrices occuring in the linearization of the ODE.
* \tparam Vector the type of the solution vector of the ODE.
* \tparam ODETag a tag indicating the type of ODE.
* \tparam NLTag a tag indicating the method used for resolving nonlinearities.
*/
......@@ -35,9 +33,6 @@ template <ODESystemTag ODETag, NonlinearSolverTag NLTag>
class ODESystem;
/*! Interface for a first-order implicit quasi-linear ODE.
*
* \tparam Matrix the type of matrices occuring in the linearization of the ODE.
* \tparam Vector the type of the solution vector of the ODE.
*
* \see ODESystemTag::FirstOrderImplicitQuasilinear
*/
......
......@@ -27,8 +27,6 @@ namespace NumLib
* This is the interface of an ODE towards the TimeLoop.
* This interface is abstract, it represents any type of first-order ODE.
*
* \tparam Matrix the type of matrices occuring in the linearization of the ODE.
* \tparam Vector the type of the solution vector of the ODE.
* \tparam NLTag a tag indicating the method used for resolving nonlinearities.
*/
template <NonlinearSolverTag NLTag>
......@@ -45,8 +43,6 @@ public:
* This class represents a specific type of first-order ODE, as indicated by
* \c ODETag.
*
* \tparam Matrix the type of matrices occuring in the linearization of the ODE.
* \tparam Vector the type of the solution vector of the ODE.
* \tparam ODETag a tag indicating the type of ODE.
* \tparam NLTag a tag indicating the method used for resolving nonlinearities.
*/
......@@ -56,9 +52,6 @@ class TimeDiscretizedODESystem;
/*! Time discretized first order implicit quasi-linear ODE;
* to be solved using the Newton-Raphson method for resolving nonlinearities.
*
* \tparam Matrix the type of matrices occuring in the linearization of the ODE.
* \tparam Vector the type of the solution vector of the ODE.
*
* \see ODESystemTag::FirstOrderImplicitQuasilinear
*/
template <>
......@@ -153,9 +146,6 @@ private:
* to be solved using the Picard fixpoint iteration method for resolving
* nonlinearities.
*
* \tparam Matrix the type of matrices occuring in the linearization of the ODE.
* \tparam Vector the type of the solution vector of the ODE.
*
* \see ODESystemTag::FirstOrderImplicitQuasilinear
*/
template <>
......
......@@ -22,8 +22,6 @@ namespace NumLib
/*! Integrate a single first-order ODE system over time.
*
* \tparam Matrix the type of matrices occuring in the linearization of the ODE.
* \tparam Vector the type of the solution vector of the ODE.
*/
template <NonlinearSolverTag NLTag>
class TimeLoopSingleODE final
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment