Phase.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 "Component.h"
 
namespace MaterialPropertyLib
{
class Property;

enum class PhaseName
{
    Solid,
    AqueousLiquid,
    Gas,
    FrozenLiquid
};

[[nodiscard]] std::string_view toString(PhaseName phase_name);

[[nodiscard]] PhaseName fromString(std::string const& phase_name);

class Phase final
{
public:
    Phase(PhaseName phase_name,
          std::vector<std::unique_ptr<Component>>&& components,
          std::unique_ptr<PropertyArray>&& properties);

    Component const& component(std::size_t const& index) const;
    bool hasComponent(std::size_t const& index) const;

    Component const& component(std::string const& 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 numberOfComponents() const;

    std::string description() const;
 
public:
    PhaseName const phaseName;
 
private:
    std::vector<std::unique_ptr<Component>> const components_;

    PropertyArray properties_;
};
 
void checkRequiredProperties(
    Phase const& phase,
    std::span<PropertyType const> const required_properties);
 
}  // namespace MaterialPropertyLib