Skip to content
Snippets Groups Projects
Commit 3c61555a authored by Dmitri Naumov's avatar Dmitri Naumov
Browse files

[MPL] Cleanup comments and assign todo.

parent 832240cf
No related branches found
No related tags found
No related merge requests found
...@@ -2,15 +2,12 @@ ...@@ -2,15 +2,12 @@
* \file * \file
* \author Norbert Grunwald * \author Norbert Grunwald
* \date Jul 07 2020 * \date Jul 07 2020
* \brief
* *
* \file
* \copyright * \copyright
* Copyright (c) 2012-2020, OpenGeoSys Community (http://www.opengeosys.org) * Copyright (c) 2012-2020, OpenGeoSys Community (http://www.opengeosys.org)
* Distributed under a Modified BSD License. * Distributed under a Modified BSD License.
* See accompanying file LICENSE.txt or * See accompanying file LICENSE.txt or
* http://www.opengeosys.org/project/license * http://www.opengeosys.org/project/license
*
*/ */
#include "MaterialLib/MPL/Properties/AverageMolarMass.h" #include "MaterialLib/MPL/Properties/AverageMolarMass.h"
...@@ -55,15 +52,15 @@ PropertyDataType AverageMolarMass::value( ...@@ -55,15 +52,15 @@ PropertyDataType AverageMolarMass::value(
"to two components."); "to two components.");
} }
// TODO: Task here is to retrieve the individual molar fractions of each // TODO (grunwald) : Task here is to retrieve the individual molar fractions
// compontne in the phase. Those are not static properties (as in case of // of each compontne in the phase. Those are not static properties (as in
// molar mass), but they depend on some state-dependent rule. Option 1 is to // case of molar mass), but they depend on some state-dependent rule. Option
// call that rule here, option 2 would be to wrap this composition info into // 1 is to call that rule here, option 2 would be to wrap this composition
// some container and to put it into the variable_array. This would have to // info into some container and to put it into the variable_array. This
// be a vector of variable size, depending on the number of components. // would have to be a vector of variable size, depending on the number of
// Unfortunately, the data types of MPL::VariableArray do not include such a // components. Unfortunately, the data types of MPL::VariableArray do not
// type. // include such a type.
//
// Therefore, I go with option 1 here, which unfortunately only allows the // Therefore, I go with option 1 here, which unfortunately only allows the
// use of binary mixtures at the moment. // use of binary mixtures at the moment.
auto const molar_fraction = auto const molar_fraction =
...@@ -110,7 +107,7 @@ PropertyDataType AverageMolarMass::dValue( ...@@ -110,7 +107,7 @@ PropertyDataType AverageMolarMass::dValue(
"phase components only."); "phase components only.");
} }
// TODO: This should return a vector of length // TODO (grunwald) : This should return a vector of length
// phase->numberOfComponents(). Currently, this feature is implemented // phase->numberOfComponents(). Currently, this feature is implemented
// for binary phases only. // for binary phases only.
auto const dxnC = phase->property(PropertyType::mole_fraction) auto const dxnC = phase->property(PropertyType::mole_fraction)
......
...@@ -2,16 +2,14 @@ ...@@ -2,16 +2,14 @@
* \file * \file
* \author Norbert Grunwald * \author Norbert Grunwald
* \date Jul 07 2020 * \date Jul 07 2020
* \brief
* *
* \file
* \copyright * \copyright
* Copyright (c) 2012-2020, OpenGeoSys Community (http://www.opengeosys.org) * Copyright (c) 2012-2020, OpenGeoSys Community (http://www.opengeosys.org)
* Distributed under a Modified BSD License. * Distributed under a Modified BSD License.
* See accompanying file LICENSE.txt or * See accompanying file LICENSE.txt or
* http://www.opengeosys.org/project/license * http://www.opengeosys.org/project/license
*
*/ */
#pragma once #pragma once
#include "BaseLib/ConfigTree.h" #include "BaseLib/ConfigTree.h"
...@@ -23,10 +21,10 @@ class Medium; ...@@ -23,10 +21,10 @@ class Medium;
class Phase; class Phase;
class Component; class Component;
/** /**
* \class AverageMolarMass * Molar mass of a mixture by mole fraction weighted average \f$ M=\Sigma_\zeta
* \brief Molar mass of a mixture by mole fraction weighted average * x_{n,\alpha}^{\zeta}M^{\zeta}\f$.
* \f$ M=\Sigma_\zeta x_{n,\alpha}^{\zeta}M^{\zeta}\f$ *
* \details This property must be a phase property * This property must be a phase property.
*/ */
class AverageMolarMass final : public Property class AverageMolarMass final : public Property
{ {
...@@ -49,5 +47,4 @@ public: ...@@ -49,5 +47,4 @@ public:
ParameterLib::SpatialPosition const& pos, ParameterLib::SpatialPosition const& pos,
double const t, double const dt) const override; double const t, double const dt) const override;
}; };
} // namespace MaterialPropertyLib } // namespace MaterialPropertyLib
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