Files
opm-common/opm/material/eos/PengRobinsonParams.hpp
Andreas Lauser 99a61df00a re-add the vim and emacs modelines
conceptually, this may not be the purest conceivable solution, but it
is the most practical one.
2015-06-18 13:47:26 +02:00

93 lines
2.2 KiB
C++

// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// vi: set et ts=4 sw=4 sts=4:
/*
Copyright (C) 2012 by Bernd Flemisch
Copyright (C) 2011-2013 by Andreas Lauser
This file is part of the Open Porous Media project (OPM).
OPM is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
OPM 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
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with OPM. If not, see <http://www.gnu.org/licenses/>.
*/
/*!
* \file
* \copydoc Opm::PengRobinsonParams
*/
#ifndef OPM_PENG_ROBINSON_PARAMS_HPP
#define OPM_PENG_ROBINSON_PARAMS_HPP
#include <opm/material/common/Valgrind.hpp>
namespace Opm
{
/*!
* \brief Stores and provides access to the Peng-Robinson parameters
*
* See:
*
* R. Reid, et al.: The Properties of Gases and Liquids, 4th edition,
* McGraw-Hill, 1987, pp. 43-44
*/
template <class Scalar>
class PengRobinsonParams
{
public:
/*!
* \brief Returns the attractive parameter 'a' of the
* Peng-Robinson fluid.
*/
Scalar a() const
{ return a_; }
/*!
* \brief Returns the repulsive parameter 'b' of the Peng-Robinson
* fluid.
*/
Scalar b() const
{ return b_; }
/*!
* \brief If run under valgrind, this method produces an warning
* if the parameters where not determined correctly.
*/
void checkDefined() const
{
#ifndef NDEBUG
Valgrind::CheckDefined(a_);
Valgrind::CheckDefined(b_);
#endif
}
/*!
* \brief Set the attractive parameter 'a' of the Peng-Robinson
* fluid.
*/
void setA(Scalar value)
{ a_ = value; }
/*!
* \brief Set the repulsive parameter 'b' of the Peng-Robinson
* fluid.
*/
void setB(Scalar value)
{ b_ = value; }
protected:
Scalar a_;
Scalar b_;
};
} // namespace Opm
#endif