Function.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 <map>
#include <utility>
#include <vector>
 
#include "MaterialLib/MPL/Property.h"
#include "MaterialLib/MPL/VariableType.h"
#include "MathLib/InterpolationAlgorithms/PiecewiseLinearInterpolation.h"
 
namespace MaterialPropertyLib
{
struct D2ValueConfig
{
    std::string variable_name1;
    std::string variable_name2;
    std::vector<std::string> expressions;
};

class Function final : public Property
{
public:
    Function(
        std::string name,
        std::vector<std::string> const& value_string_expressions,
        std::vector<std::pair<std::string, std::vector<std::string>>> const&
            dvalue_string_expressions,
        std::vector<D2ValueConfig> const& d2value_string_expressions,
        std::map<std::string,
                 std::unique_ptr<MathLib::PiecewiseLinearInterpolation>> const&
            curves);
 
    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;
 
    ~Function();
 
private:
    template <int D>
    struct Implementation;
 
    std::unique_ptr<Implementation<2>> impl2_;
    std::unique_ptr<Implementation<3>> impl3_;
 
    std::variant<Function::Implementation<2>*, Function::Implementation<3>*>
    getImplementationForDimensionOfVariableArray(
        VariableArray const& variable_array) const;

    std::vector<Variable> required_variables_enum_;
};
}  // namespace MaterialPropertyLib