Commit 0efb1d15 authored by Praetorius, Simon's avatar Praetorius, Simon
Browse files

Correct documentation of DirichletBC

parent d5f93fea
......@@ -35,12 +35,12 @@ namespace AMDiS
* \tparam Mat Matrix
* \tparam Sol Vector of solution
* \tparam Rhs Vector of rhs
* \tparam RB Basis of the row FE space
* \tparam RTP Treepath to the row node this constraint applies to
* \tparam CB Basis of the column FE space
* \tparam CTP Treepath to the column node this constraint applies to
* \tparam RowSubBasis SubspaceBasis of the row FE space
* \tparam ColSubBasis SubspaceBasis of the column FE space
* \tparam ValueGridFct Type of the GridFunction representing the Dirichlet values.
**/
template <class Mat, class Sol, class Rhs, class RowSubBasis, class ColSubBasis, class ValueGridFct>
template <class Mat, class Sol, class Rhs, class RowSubBasis, class ColSubBasis,
class ValueGridFct>
class DirichletBC
: public BoundaryCondition<Mat, Sol, Rhs>
{
......@@ -65,7 +65,8 @@ namespace AMDiS
, values_(FWD(values))
{}
// fill \ref dirichletNodes_ with 1 or 0 whether DOF corresponds to the boundary or not.
/// Fill \ref dirichletNodes_ with 1 or 0 whether DOF corresponds to the
/// boundary or not.
/**
* \see BoundaryCondition::init
**/
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment