anonymous_namespace{CreateComponent.cpp} Namespace Reference

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

Function Documentation

createComponent()

std::unique_ptr< MaterialPropertyLib::Component > anonymous_namespace{CreateComponent.cpp}::createComponent	(	int const	geometry_dimension,
		BaseLib::ConfigTree const &	config,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > &	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__components__component__name

Input File Parameter

prj__media__medium__phases__phase__components__component__properties

Definition at line 16 of file CreateComponent.cpp.

{
    using namespace MaterialPropertyLib;
    // Parsing the component name
    auto const& component_name = config.getConfigParameter<std::string>("name");
 
    // Check whether a name is given or not
    if (component_name.empty())
    {
        OGS_FATAL("Component name is a mandatory field and cannot be empty.");
    }
 
    // Parsing component properties. If a component name is given and this
    // component is predefined in the class implementation, properties
    // become optional. The default values of properties will be overwritten
    // if specified.
    std::unique_ptr<PropertyArray> properties = createProperties(
        geometry_dimension,
        config.getConfigSubtreeOptional("properties"), parameters,
        local_coordinate_system, curves);
 
    // If a name is given, it must conform with one of the derived component
    // names in the following list:
    if (boost::iequals(component_name, "water"))
    {
        return std::make_unique<Water>(std::move(properties));
    }
 
    if (!properties)
    {
        // No component properties are provided. If the component is not
        // specified, this results in a fatal error, since an unspecified
        // component has no properties.
        OGS_FATAL("No Properties defined for unspecified component");
    }
 
    return std::make_unique<Component>(component_name, std::move(properties));
}

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