Medium.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 <memory>
#include <span>
#include <string>
#include <vector>
 
#include "Phase.h"
 
namespace MaterialPropertyLib
{
class Property;
}
namespace MaterialPropertyLib
{
class Medium final
{
public:
    Medium(int const material_id,
           std::vector<std::unique_ptr<Phase>>&& phases,
           std::unique_ptr<PropertyArray>&& properties);

    Phase const& phase(std::size_t index) const;
    Phase const& phase(std::string const& phase_name) const;

    bool hasPhase(std::string const& phase_name) const;

    Property const& property(PropertyType const& p) const;
 
    Property const& operator[](PropertyType const& p) const;
 
    bool hasProperty(PropertyType const& p) const;

    std::size_t numberOfPhases() const;

    std::string description() 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);
    }
 
private:
    std::vector<std::unique_ptr<Phase>> const phases_;
    PropertyArray properties_;

    int const material_id_;
};
 
void checkRequiredProperties(
    Medium const& medium,
    std::span<PropertyType const> const required_properties);

Phase const& fluidPhase(Medium const& medium);
 
}  // namespace MaterialPropertyLib