Skip to content
Snippets Groups Projects
Commit 506903be authored by Christoph Lehmann's avatar Christoph Lehmann
Browse files

[PL] Doxygen warnings and docu

parent 660261f5
No related branches found
No related tags found
No related merge requests found
...@@ -89,7 +89,14 @@ struct SecondaryVariableFunctions final ...@@ -89,7 +89,14 @@ struct SecondaryVariableFunctions final
} }
const unsigned num_components; //!< Number of components of the variable. const unsigned num_components; //!< Number of components of the variable.
//! Computes the value of the field at every node of the underlying mesh.
Function const eval_field; Function const eval_field;
//! If the secondary variable is extrapolated from integration points to
//! mesh nodes, this function computes the extrapolation residual. For
//! further information check the specific NumLib::Extrapolator
//! documentation.
Function const eval_residuals; Function const eval_residuals;
}; };
...@@ -144,6 +151,7 @@ private: ...@@ -144,6 +151,7 @@ private:
/*! Creates an object that computes a secondary variable via extrapolation of /*! Creates an object that computes a secondary variable via extrapolation of
* integration point values. * integration point values.
* *
* \param num_components The number of components of the secondary variable.
* \param extrapolator The extrapolator used for extrapolation. * \param extrapolator The extrapolator used for extrapolation.
* \param local_assemblers The collection of local assemblers whose integration * \param local_assemblers The collection of local assemblers whose integration
* point values will be extrapolated. * point values will be extrapolated.
......
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