Commit 06de8c79 authored by Melanie Lipp's avatar Melanie Lipp Committed by Timo Koch
Browse files

[doxygen] Fix parameters which are not documented or do not exist.

parent 7a26b0ff
......@@ -90,6 +90,7 @@ class InteractionVolumeAssemblerBase
* expressions and the local system of equations
* within an mpfa interaction volume.
*
* \tparam DataHandle The data handle
* \tparam IV The interaction volume type implementation
* \tparam TensorFunc Lambda to obtain the tensor w.r.t.
* which the local system is to be solved
......@@ -97,6 +98,7 @@ class InteractionVolumeAssemblerBase
* \param handle The data handle in which the matrices are stored
* \param iv The interaction volume
* \param getT Lambda to evaluate the scv-wise tensors
* \param wijZeroThresh the zero threshold wij
*/
template< class DataHandle, class IV, class TensorFunc >
void assembleMatrices(DataHandle& handle, IV& iv, const TensorFunc& getT, Scalar<IV> wijZeroThresh = 0.0)
......
......@@ -69,7 +69,8 @@ public:
* on a constant tortuosity value
* \param volVars The Volume Variables
* \param phaseIdx the index of the phase
* \param compIdx the component index
* \param compIdxI the component index i
* \param compIdxJ the component index j
*/
template<class VolumeVariables>
static Scalar effectiveDiffusionCoefficient(const VolumeVariables& volVars,
......
......@@ -75,7 +75,8 @@ public:
*
* \param volVars The Volume Variables
* \param phaseIdx the index of the phase
* \param compIdx the component index
* \param compIdxI the component index i
* \param compIdxJ the component index j
*/
template<class VolumeVariables>
static Scalar effectiveDiffusionCoefficient(const VolumeVariables& volVars,
......
......@@ -221,10 +221,7 @@ public:
* \brief Evaluates the source term for all phases within a given
* sub control volume.
*
* \param element The element for which the source term is set
* \param fvGeometry The fvGeometry
* \param elemVolVars The element volume variables
* \param scv The sub control volume
* \param globalPos The global position
*/
NumEqVector sourceAtPos(const GlobalPosition& globalPos) const
{
......@@ -260,7 +257,6 @@ public:
* \brief Returns the analytical solution of the problem at a given position.
*
* \param globalPos The global position
* \param time The current simulation time
*/
auto analyticalSolution(const GlobalPosition& globalPos) const
{
......
......@@ -266,7 +266,6 @@ public:
* \brief Returns the analytical solution of the problem at a given position.
*
* \param globalPos The global position
* \param time The current simulation time
*/
PrimaryVariables analyticalSolution(const GlobalPosition& globalPos) const
{
......
......@@ -104,6 +104,7 @@ public:
* \param element The finite element
* \param fvGeometry The finite-volume geometry
* \param elemVolVars All volume variables for the element
* \param elemFluxVarsCache Flux variables caches for all faces in stencil
* \param scvf The sub control volume face
*
* Negative values mean influx.
......
Supports Markdown
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