Commit 034ad1c7 authored by Dominik Riesterer's avatar Dominik Riesterer
Browse files

Updated Documentation

git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@11229 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent 9977b8a4
// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// vi: set et ts=4 sw=4 sts=4:
/*****************************************************************************
* Copyright (C) 2010-2011 by Philipp Nuske *
* Copyright (C) 2008-2011 by Andreas Lauser *
* Copyright (C) 2008-2009 by Melanie Darcis *
* *
* Institute for Modelling Hydraulic and Environmental Systems *
* University of Stuttgart, Germany *
* email: <givenname>.<name>@iws.uni-stuttgart.de *
* See the file COPYING for full copying permissions. *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
......@@ -14,7 +10,7 @@
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
......@@ -62,9 +58,21 @@ class MPNCFluxVariablesEnergy<TypeTag, /*enableEnergy=*/true, /*kineticEnergyTra
typedef typename FVElementGeometry::SubControlVolumeFace SCVFace;
public:
/*!
* \brief The constructor
*/
MPNCFluxVariablesEnergy()
{}
/*!
* \brief update
*
* \param problem The problem
* \param element The finite element
* \param fvGeometry The finite-volume geometry in the fully implicit scheme
* \param face The SCV (sub-control-volume) face
* \param fluxVars The flux variables
* \param elemVolVars The volume variables of the current element
*/
void update(const Problem & problem,
const Element & element,
const FVElementGeometry & fvGeometry,
......@@ -99,6 +107,8 @@ public:
/*!
* \brief The total heat flux \f$[J/s]\f$ due to heat conduction
* of the rock matrix over the sub-control volume's face.
*
* \param energyEqIdx The index of the energy equation
*/
DimVector temperatureGradient(const unsigned int energyEqIdx) const
{
......
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