Component.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 <span>
 
#include "Property.h"
 
namespace MaterialPropertyLib
{
class Component
{
public:
    Component();

    Component(std::string const& component_name,
              std::unique_ptr<PropertyArray>&& properties);
    virtual ~Component() = default;

    Property const& property(PropertyType const& /*p*/) const;
 
    Property const& operator[](PropertyType const& p) const;
 
    bool hasProperty(PropertyType const& p) const;
 
    template <typename T>
    T value(PropertyType const p) const
    {
        return property(p).template value<T>();
    }
 
    template <typename T>
    T value(PropertyType const p, VariableArray const& variable_array) const
    {
        return property(p).template value<T>(variable_array);
    }
 
    template <typename T>
    T dValue(PropertyType const p,
             VariableArray const& variable_array,
             Variable const variable) const
    {
        return property(p).template dValue<T>(variable_array, variable);
    }
 
    template <typename T>
    T d2Value(PropertyType const p,
              VariableArray const& variable_array,
              Variable const variable1,
              Variable const variable2) const
    {
        return property(p).template d2Value<T>(variable_array, variable1,
                                               variable2);
    }

    std::string description() const;
 
public:
    std::string const name;
 
protected:
    PropertyArray properties_;
};

std::unique_ptr<Component> newComponent(std::string const& component_name,
                                        bool& isCustomComponent);
 
void checkRequiredProperties(
    Component const& c,
    std::span<PropertyType const> const required_properties);
 
}  // namespace MaterialPropertyLib