SigmoidFunction.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) OpenGeoSys Community (opengeosys.org)
// SPDX-License-Identifier: BSD-3-Clause
 
#pragma once
 
#include "MaterialLib/MPL/VariableType.h"  // for VariableArray
#include "ParameterLib/SpatialPosition.h"
 
namespace MaterialPropertyLib
{
class SigmoidFunction final
{
public:
    SigmoidFunction(double const k, double const T_c, double const S_r);
 
    double value(double const& T) const;
 
    double dValue(double const& T) const;
 
    double d2Value(double const& T) const;
 
private:
    double const k_;    //< steepness (slope parameter)
    double const T_c_;  //< characteristic value
                        // (location of the step)
    double const S_r;   //< residual saturation
};
}  // namespace MaterialPropertyLib