Sigmoid.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/Property.h"
 
namespace MaterialPropertyLib
{
class Sigmoid final : public Property
{
public:
    Sigmoid(std::string name,
            double const steepness,
            double const midpoint,
            double const lower_bound,
            double const upper_bound,
            Variable const independent_variable);
 
    PropertyDataType value(VariableArray const& variable_array,
                           ParameterLib::SpatialPosition const& pos,
                           double const t,
                           double const dt) const override;
 
    PropertyDataType dValue(VariableArray const& variable_array,
                            Variable const variable,
                            ParameterLib::SpatialPosition const& pos,
                            double const t,
                            double const dt) const override;
 
    PropertyDataType d2Value(VariableArray const& variable_array,
                             Variable const variable1,
                             Variable const variable2,
                             ParameterLib::SpatialPosition const& pos,
                             double const t,
                             double const dt) const override;
 
private:
    bool derivativeVanishes(Variable const variable) const;
 
    double steepness_;  
    double midpoint_;   
    double lower_bound_;             
    double upper_bound_;             
    Variable independent_variable_;  
};
 
}  // namespace MaterialPropertyLib