GCC Code Coverage Report


Directory: ../../../builds/dumux-repositories/
File: /builds/dumux-repositories/dumux/dumux/common/balanceequationopts.hh
Date: 2024-05-04 19:09:25
Exec Total Coverage
Lines: 0 2 0.0%
Functions: 0 75 0.0%
Branches: 0 0 -%

Line Branch Exec Source
1 // -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2 // vi: set et ts=4 sw=4 sts=4:
3 //
4 // SPDX-FileCopyrightInfo: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
5 // SPDX-License-Identifier: GPL-3.0-or-later
6 //
7 /*!
8 * \file
9 * \ingroup Core
10 * \brief Traits class to set options used by the local residual when
11 * when evaluating the balance equations.
12 */
13 #ifndef BALANCE_EQUATION_OPTIONS_HH
14 #define BALANCE_EQUATION_OPTIONS_HH
15
16 namespace Dumux {
17
18 /*!
19 * \ingroup Core
20 * \brief Traits class to set options used by the local residual when
21 * when evaluating the balance equations.
22 * \todo include useMoles here
23 * \todo include replaceCompIdx here
24 */
25 template <class TypeTag>
26 class BalanceEquationOptions
27 {
28 public:
29
30 //! If a certain component is balanced in this model
31 // per default all phases are balanced. See e.g. Richards for an example where
32 // the air component exists but is not balanced. Or the tracer model where the
33 // carrier phase main component exists but is not balanced.
34 static constexpr bool mainComponentIsBalanced(int phaseIdx)
35 { return true; }
36 };
37
38 } // end namespace Dumux
39
40 #endif
41