anonymous_namespace{CreatePhase.cpp} Namespace Reference

Functions
std::unique_ptr< MaterialPropertyLib::Phase >	createPhase (int const geometry_dimension, BaseLib::ConfigTree const &config, std::vector< std::unique_ptr< ParameterLib::ParameterBase >> const &parameters, ParameterLib::CoordinateSystem const *const local_coordinate_system, std::map< std::string, std::unique_ptr< MathLib::PiecewiseLinearInterpolation >> const &curves)

Function Documentation

createPhase()

std::unique_ptr<MaterialPropertyLib::Phase> anonymous_namespace{CreatePhase.cpp}::createPhase	(	int const	geometry_dimension,
		BaseLib::ConfigTree const &	config,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase >> const &	parameters,
		ParameterLib::CoordinateSystem const *const	local_coordinate_system,
		std::map< std::string, std::unique_ptr< MathLib::PiecewiseLinearInterpolation >> const &	curves
	)

Input File Parameter:

prj__media__medium__phases__phase__type

Input File Parameter:

prj__media__medium__phases__phase__components

Input File Parameter:

prj__media__medium__phases__phase__properties

Definition at line 27 of file CreatePhase.cpp.

{
    using namespace MaterialPropertyLib;
 
    auto&& phase_type = config.getConfigParameter<std::string>("type");
 
    if (phase_type.empty())
    {
        OGS_FATAL("Phase type is a mandatory field and cannot be empty.");
    }
 
    std::array<std::string, 4> const allowed_phase_types = {
        {"Solid", "AqueousLiquid", "NonAqueousLiquid", "Gas"}};
 
    if (std::none_of(allowed_phase_types.begin(),
                     allowed_phase_types.end(),
                     [&phase_type](std::string const& type)
                     { return phase_type == type; }))
    {
        ERR("Phase type should be one of:");
        for (auto const& type : allowed_phase_types)
        {
            ERR("{:s}", type);
        }
        OGS_FATAL("Wrong phase type '{:s}' given.", phase_type);
    }
 
    // Parsing of optional components.
    auto components = createComponents(
        geometry_dimension,
        config.getConfigSubtreeOptional("components"), parameters,
        local_coordinate_system, curves);
 
    // Properties of optional properties.
    auto properties = createProperties(
        geometry_dimension,
        config.getConfigSubtreeOptional("properties"), parameters,
        local_coordinate_system, curves);
 
    if (components.empty() && !properties)
    {
        OGS_FATAL(
            "Neither tag <components> nor tag <properties> has been set for "
            "the phase '{:s}'.",
            phase_type);
    }
 
    return std::make_unique<Phase>(std::move(phase_type), std::move(components),
                                   std::move(properties));
}

References MaterialPropertyLib::createComponents(), MaterialPropertyLib::createProperties(), ERR(), BaseLib::ConfigTree::getConfigParameter(), BaseLib::ConfigTree::getConfigSubtreeOptional(), and OGS_FATAL.

Referenced by MaterialPropertyLib::createPhases().