ConstantParameter.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 "Parameter.h"
 
namespace ParameterLib
{
template <typename T>
struct ConstantParameter final : public Parameter<T>
{
    explicit ConstantParameter(std::string const& name_, T const& value)
        : Parameter<T>(name_), _values({value})
    {
    }

    explicit ConstantParameter(std::string const& name_, std::vector<T> values)
        : Parameter<T>(name_), _values(std::move(values))
    {
        assert(!_values.empty());
    }
 
    bool isTimeDependent() const override { return false; }
 
    int getNumberOfGlobalComponents() const override
    {
        return static_cast<int>(_values.size());
    }
 
    std::vector<T> operator()(double const /*t*/,
                              SpatialPosition const& pos) const override
    {
        if (!this->_coordinate_system)
        {
            return _values;
        }
 
        return this->rotateWithCoordinateSystem(_values, pos);
    }
 
    Eigen::Matrix<T, Eigen::Dynamic, Eigen::Dynamic> getNodalValuesOnElement(
        MeshLib::Element const& element, double const /*t*/) const override
    {
        auto const n_nodes = element.getNumberOfNodes();
        Eigen::Matrix<T, Eigen::Dynamic, Eigen::Dynamic> result(
            n_nodes, getNumberOfGlobalComponents());
 
        // Column vector of values, copied for each node.
        auto const row_values =
            Eigen::Map<Eigen::Matrix<T, Eigen::Dynamic, 1> const>(
                _values.data(), _values.size());
        for (unsigned i = 0; i < n_nodes; ++i)
        {
            result.row(i) = row_values;
        }
        return result;
    }
 
private:
    std::vector<T> const _values;
};
 
std::unique_ptr<ParameterBase> createConstantParameter(
    std::string const& name, BaseLib::ConfigTree const& config);
 
}  // namespace ParameterLib