ParameterLib Namespace Reference

Detailed Description

The TimeDependentHeterogeneousParameter class implements a parameter that varies in time and space, i.e., it is a function \( (t, x) \mapsto f(t, x) \in T^n \).

Classes
struct	ConstantParameter
	Single, constant value parameter. More...
struct	CoordinateSystem
	A local coordinate system used for tensor transformations. More...
struct	CurveScaledParameter
struct	FunctionParameter
struct	GroupBasedParameter
struct	MeshElementParameter
	A parameter represented by a mesh property vector. More...
struct	MeshNodeParameter
	A parameter represented by a mesh property vector. More...
struct	Parameter
struct	ParameterBase
struct	RandomFieldMeshElementParameter
	A parameter represented by a mesh property vector. More...
struct	RasterParameter
class	SpatialPosition
class	TimeDependentHeterogeneousParameter

Functions
std::unique_ptr< ParameterBase >	createConstantParameter (std::string const &name, BaseLib::ConfigTree const &config)
Eigen::Matrix< double, 2, 2 >	getTransformationFromSingleBase2D (Parameter< double > const &unit_direction, SpatialPosition const &pos)
Eigen::Matrix< double, 3, 3 >	getTransformationFromSingleBase3D (Parameter< double > const &unit_direction, SpatialPosition const &pos)
Parameter< double > const *	parseBase1OrBase2 (BaseLib::ConfigTree const &config, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters, int const expected_component_number, std::string_view const base_tag_name)
void	checkThirdBaseExistanceFor2D (BaseLib::ConfigTree const &config)
void	confirmThirdBaseExplicit (BaseLib::ConfigTree const &config)
std::optional< ParameterLib::CoordinateSystem >	createCoordinateSystemWithImplicitBase (BaseLib::ConfigTree const &config, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters)
std::optional< ParameterLib::CoordinateSystem >	createCoordinateSystem (std::optional< BaseLib::ConfigTree > const &config, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters)
std::unique_ptr< ParameterBase >	createCurveScaledParameter (std::string const &name, BaseLib::ConfigTree const &config, std::map< std::string, std::unique_ptr< MathLib::PiecewiseLinearInterpolation > > const &curves)
std::unique_ptr< ParameterBase >	createFunctionParameter (std::string const &name, BaseLib::ConfigTree const &config, std::map< std::string, std::unique_ptr< MathLib::PiecewiseLinearInterpolation > > const &curves)
std::unique_ptr< ParameterBase >	createGroupBasedParameter (std::string const &name, BaseLib::ConfigTree const &config, MeshLib::Mesh const &mesh)
std::unique_ptr< ParameterBase >	createMeshElementParameter (std::string const &name, BaseLib::ConfigTree const &config, MeshLib::Mesh const &mesh)
std::unique_ptr< ParameterBase >	createMeshNodeParameter (std::string const &name, BaseLib::ConfigTree const &config, MeshLib::Mesh const &mesh)
std::unique_ptr< ParameterBase >	createParameter (BaseLib::ConfigTree const &config, std::vector< std::unique_ptr< MeshLib::Mesh > > const &meshes, std::vector< GeoLib::NamedRaster > const &named_rasters, std::map< std::string, std::unique_ptr< MathLib::PiecewiseLinearInterpolation > > const &curves)
std::optional< std::string >	isDefinedOnSameMesh (ParameterBase const &parameter, MeshLib::Mesh const &mesh)
std::unique_ptr< ParameterBase >	createRandomFieldMeshElementParameter (std::string const &name, BaseLib::ConfigTree const &config, MeshLib::Mesh &mesh)
std::unique_ptr< ParameterBase >	createRasterParameter (std::string const &name, BaseLib::ConfigTree const &config, std::vector< GeoLib::NamedRaster > const &named_rasters)
std::unique_ptr< ParameterBase >	createTimeDependentHeterogeneousParameter (std::string const &name, BaseLib::ConfigTree const &config)
ParameterBase *	findParameterByName (std::string const &parameter_name, std::vector< std::unique_ptr< ParameterBase > > const &parameters)
template<typename ParameterDataType >
Parameter< ParameterDataType > *	findParameterOptional (std::string const &parameter_name, std::vector< std::unique_ptr< ParameterBase > > const &parameters, int const num_components, MeshLib::Mesh const *const mesh=nullptr)
template<typename ParameterDataType >
Parameter< ParameterDataType > &	findParameter (std::string const &parameter_name, std::vector< std::unique_ptr< ParameterBase > > const &parameters, int const num_components, MeshLib::Mesh const *const mesh=nullptr)
template<typename ParameterDataType >
Parameter< ParameterDataType > &	findParameter (BaseLib::ConfigTree const &process_config, std::string const &tag, std::vector< std::unique_ptr< ParameterBase > > const &parameters, int const num_components, MeshLib::Mesh const *const mesh=nullptr)
template<typename ParameterDataType >
Parameter< ParameterDataType > *	findOptionalTagParameter (BaseLib::ConfigTree const &process_config, std::string const &tag, std::vector< std::unique_ptr< ParameterBase > > const &parameters, int const num_components, MeshLib::Mesh const *const mesh=nullptr)

Variables
static double const	tolerance = std::numeric_limits<double>::epsilon()
static constexpr char	error_info []
static constexpr char	normalization_error_info []

Function Documentation

checkThirdBaseExistanceFor2D()

void ParameterLib::checkThirdBaseExistanceFor2D

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

prj__local_coordinate_system__basis_vector_2

Definition at line 62 of file CreateCoordinateSystem.cpp.

{
    auto const base2_config =
        config.getConfigSubtreeOptional("basis_vector_2");
    if (base2_config)
    {
        OGS_FATAL(
            "The tag \"basis_vector_2\" is not needed for a 2D local "
            "coordinate system.");
    }
}

References BaseLib::ConfigTree::getConfigSubtreeOptional(), and OGS_FATAL.

Referenced by createCoordinateSystem(), and createCoordinateSystemWithImplicitBase().

confirmThirdBaseExplicit()

void ParameterLib::confirmThirdBaseExplicit

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

prj__local_coordinate_system__basis_vector_2__implicit

Definition at line 75 of file CreateCoordinateSystem.cpp.

{
    auto const implicit_base2 =
        config.getConfigAttribute<bool>("implicit", false);
    if (implicit_base2)
    {
        OGS_FATAL("basis_vector_2 must be explicit.");
    }
}

References BaseLib::ConfigTree::getConfigAttribute(), and OGS_FATAL.

Referenced by createCoordinateSystem(), and createCoordinateSystemWithImplicitBase().

createConstantParameter()

std::unique_ptr< ParameterBase > ParameterLib::createConstantParameter	(	std::string const &	name,
		BaseLib::ConfigTree const &	config )

Input File Parameter

prj__parameters__parameter__type

Input File Parameter

prj__parameters__parameter__Constant__value

Input File Parameter

prj__parameters__parameter__Constant__values

Definition at line 19 of file ConstantParameter.cpp.

{
    config.checkConfigParameter("type", "Constant");
 
    // Optional case for single-component variables where the value can be used.
    // If the 'value' tag is found, use it and return. Otherwise continue with
    // then required tag 'values'.
    {
        auto const value =
            config.getConfigParameterOptional<std::vector<double>>("value");
 
        if (value)
        {
            if (value->size() != 1)
            {
                OGS_FATAL(
                    "Expected to read exactly one value, but {:d} were given.",
                    value->size());
            }
            DBUG("Using value {:g} for constant parameter.", (*value)[0]);
            return std::make_unique<ConstantParameter<double>>(name,
                                                               (*value)[0]);
        }
    }
 
    // Value tag not available; continue with required values tag.
    std::vector<double> const values =
        config.getConfigParameter<std::vector<double>>("values");
 
    if (values.empty())
    {
        OGS_FATAL("No value available for constant parameter.");
    }
 
    DBUG("Using following values for the constant parameter:");
    for (double const v : values)
    {
        (void)v;  // unused value if building w/o DBUG output.
        DBUG("\t{:g}", v);
    }
 
    return std::make_unique<ConstantParameter<double>>(name, values);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), BaseLib::ConfigTree::getConfigParameterOptional(), and OGS_FATAL.

Referenced by createParameter().

createCoordinateSystem()

std::optional< ParameterLib::CoordinateSystem > ParameterLib::createCoordinateSystem	(	std::optional< BaseLib::ConfigTree > const &	config,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters )

Input File Parameter

prj__local_coordinate_system__basis_vector_0

Input File Parameter

prj__local_coordinate_system__basis_vector_0__implicit

Input File Parameter

prj__local_coordinate_system__basis_vector_1

Input File Parameter

prj__local_coordinate_system__basis_vector_1__implicit

Input File Parameter

prj__local_coordinate_system__basis_vector_2

Definition at line 142 of file CreateCoordinateSystem.cpp.

{
    if (!config)
    {
        return {};
    }
 
    //
    // Fetch the first basis vector; its length defines the dimension.
    //
    auto const& config_base0 = config->getConfigSubtree("basis_vector_0");
    auto const implicit_base0 =
        config_base0.getConfigAttribute<bool>("implicit", false);
 
    // base0 and base1 can be implicit. If base0 is implicit, check whether
    // base1 is implicit.
    // If base1 is explicit, create a 2D system if its components is 2 or quit
    // if its components is not equal to 2.
    // Otherwise, read base2, create a 3D system if its components is 3 or quit
    // if its components is not equal to 3.
    if (implicit_base0)
    {
        return createCoordinateSystemWithImplicitBase(*config, parameters);
    }
 
    auto const base0_name = config_base0.getValue<std::string>();
    auto const& basis_vector_0 = ParameterLib::findParameter<double>(
        base0_name, parameters, 0 /* any dimension */);
    int const dimension = basis_vector_0.getNumberOfGlobalComponents();
    // check dimension
    if (dimension != 2 && dimension != 3)
    {
        OGS_FATAL(
            "Basis vector parameter '{:s}' must have two or three components, "
            "but it has {:d}.",
            base0_name, dimension);
    }
 
    // Fetch the second basis vector.
    auto const& config_base1 = config->getConfigSubtree("basis_vector_1");
    auto const implicit_base1 =
        config_base1.getConfigAttribute<bool>("implicit", false);
    if (implicit_base1)
    {
        OGS_FATAL(
            "Since basis_vector_0 is explicitly defined, basis_vector_1"
            " must be explicit as well.");
    }
    auto const base1_name = config_base1.getValue<std::string>();
    auto const& basis_vector_1 =
        ParameterLib::findParameter<double>(base1_name, parameters, dimension);
 
    if (dimension == 2)
    {
        checkThirdBaseExistanceFor2D(*config);
        return ParameterLib::CoordinateSystem{basis_vector_0, basis_vector_1};
    }
 
    // Parse the third basis vector, e2, for the three dimensional system.
    auto const& config_base2 = config->getConfigSubtree("basis_vector_2");
    confirmThirdBaseExplicit(config_base2);
 
    int const expected_component_number = 3;
    auto const basis_vector_2 = parseBase1OrBase2(
        config_base2, parameters, expected_component_number, "basis_vector_2");
 
    return ParameterLib::CoordinateSystem{basis_vector_0, basis_vector_1,
                                          *basis_vector_2};
}

References checkThirdBaseExistanceFor2D(), confirmThirdBaseExplicit(), createCoordinateSystemWithImplicitBase(), OGS_FATAL, and parseBase1OrBase2().

Referenced by ProjectData::ProjectData().

createCoordinateSystemWithImplicitBase()

std::optional< ParameterLib::CoordinateSystem > ParameterLib::createCoordinateSystemWithImplicitBase	(	BaseLib::ConfigTree const &	config,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters )

Input File Parameter

prj__local_coordinate_system__basis_vector_1

Input File Parameter

prj__local_coordinate_system__basis_vector_1__implicit

Input File Parameter

prj__local_coordinate_system__basis_vector_2

Definition at line 87 of file CreateCoordinateSystem.cpp.

{
    auto const& config_base1 = config.getConfigSubtree("basis_vector_1");
 
    // Parse the second vectors.
    auto const implicit_base1 =
        config_base1.getConfigAttribute<bool>("implicit", false);
 
    if (!implicit_base1)
    {
        // For 2D problem.
        // Only the following case is accepted:
        // <basis_vector_0 implicit = false/>
        // <basis_vector_1> [two-component parameter] </basis_vector_1>.
        int const expected_component_number = 2;
        auto const basis_vector_1 =
            parseBase1OrBase2(config_base1, parameters,
                              expected_component_number, "basis_vector_1");
 
        checkThirdBaseExistanceFor2D(config);
 
        return ParameterLib::CoordinateSystem(*basis_vector_1);
    }
 
    // For 3D problem.
    // Only the following case is accepted:
    // <basis_vector_0 implicit = false/>
    // <basis_vector_1 implicit = false>.
    // <basis_vector_2> [three-component parameter] </basis_vector_2>.
 
    // Parse the third basis vector, e2, for the three dimensional system.
    auto const config_base2 =
        config.getConfigSubtreeOptional("basis_vector_2");
    if (!config_base2)
    {
        OGS_FATAL(
            "Both \"basis_vector_0\" and \"basis_vector_1\" are implicit but "
            "\"basis_vector_2\" does not exist. If 2D coordinate system is "
            "considered, please change \"basis_vector_1\" to explicit. If 3D "
            "coordinate system is considered, please add \"basis_vector_2\".");
    }
 
    confirmThirdBaseExplicit(*config_base2);
 
    int const expected_component_number = 3;
    auto const basis_vector_2 = parseBase1OrBase2(
        *config_base2, parameters, expected_component_number, "basis_vector_2");
    return ParameterLib::CoordinateSystem(*basis_vector_2);
}

References checkThirdBaseExistanceFor2D(), confirmThirdBaseExplicit(), BaseLib::ConfigTree::getConfigAttribute(), BaseLib::ConfigTree::getConfigSubtree(), BaseLib::ConfigTree::getConfigSubtreeOptional(), OGS_FATAL, and parseBase1OrBase2().

Referenced by createCoordinateSystem().

createCurveScaledParameter()

std::unique_ptr< ParameterBase > ParameterLib::createCurveScaledParameter	(	std::string const &	name,
		BaseLib::ConfigTree const &	config,
		std::map< std::string, std::unique_ptr< MathLib::PiecewiseLinearInterpolation > > const &	curves )

Input File Parameter

prj__parameters__parameter__type

Input File Parameter

prj__parameters__parameter__CurveScaled__curve

Input File Parameter

prj__parameters__parameter__CurveScaled__parameter

Definition at line 17 of file CurveScaledParameter.cpp.

{
    config.checkConfigParameter("type", "CurveScaled");
 
    auto curve_name = config.getConfigParameter<std::string>("curve");
    DBUG("Using curve {:s}", curve_name);
 
    auto const curve_it = curves.find(curve_name);
    if (curve_it == curves.end())
    {
        OGS_FATAL("Curve `{:s}' does not exists.", curve_name);
    }
 
    auto referenced_parameter_name =
        config.getConfigParameter<std::string>("parameter");
    DBUG("Using parameter {:s}", referenced_parameter_name);
 
    // TODO other data types than only double
    return std::make_unique<CurveScaledParameter<double>>(
        name, *curve_it->second, referenced_parameter_name);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), and OGS_FATAL.

Referenced by createParameter().

createFunctionParameter()

std::unique_ptr< ParameterBase > ParameterLib::createFunctionParameter	(	std::string const &	name,
		BaseLib::ConfigTree const &	config,
		std::map< std::string, std::unique_ptr< MathLib::PiecewiseLinearInterpolation > > const &	curves )

Input File Parameter

prj__parameters__parameter__type

Input File Parameter

prj__parameters__parameter__Function__expression

Definition at line 17 of file FunctionParameter.cpp.

{
    config.checkConfigParameter("type", "Function");
 
    std::vector<std::string> vec_expressions;
 
    for (auto const& p : config.getConfigSubtreeList("expression"))
    {
        std::string const expression_str = p.getValue<std::string>();
        vec_expressions.emplace_back(expression_str);
    }
 
    return std::make_unique<FunctionParameter<double>>(name, vec_expressions,
                                                       curves);
}

References BaseLib::ConfigTree::checkConfigParameter(), and BaseLib::ConfigTree::getConfigSubtreeList().

Referenced by createParameter().

createGroupBasedParameter()

std::unique_ptr< ParameterBase > ParameterLib::createGroupBasedParameter	(	std::string const &	name,
		BaseLib::ConfigTree const &	config,
		MeshLib::Mesh const &	mesh )

Input File Parameter

prj__parameters__parameter__type

Input File Parameter

prj__parameters__parameter__Group__group_id_property

Input File Parameter

prj__parameters__parameter__Group__index_values

Input File Parameter

prj__parameters__parameter__Group__index_values__index

Input File Parameter

prj__parameters__parameter__Group__index_values__value

Input File Parameter

prj__parameters__parameter__Group__index_values__values

Definition at line 19 of file GroupBasedParameter.cpp.

{
    config.checkConfigParameter("type", "Group");
 
    // get a property vector of group IDs
    std::string const group_id_property_name =
        config.getConfigParameter<std::string>("group_id_property");
    DBUG("Using group_id_property {:s}", group_id_property_name);
 
    auto const& group_id_property =
        mesh.getProperties().getPropertyVector<int>(group_id_property_name);
 
    // parse mapping data
    using Values = std::vector<double>;
    std::map<int, Values> vec_index_values;
    for (auto p : config.getConfigSubtreeList("index_values"))
    {
        auto const index = p.getConfigParameter<int>("index");
        {
            auto const value = p.getConfigParameterOptional<double>("value");
 
            if (value)
            {
                Values values(1, *value);
                vec_index_values.emplace(index, values);
                continue;
            }
        }
 
        // Value tag not available; continue with required values tag.
        Values const values = p.getConfigParameter<Values>("values");
 
        if (values.empty())
        {
            OGS_FATAL("No value available for constant parameter.");
        }
 
        vec_index_values.emplace(index, values);
    }
 
    // check the input
    for (auto p : vec_index_values)
    {
#ifndef USE_PETSC  // In case of partitioned meshes not all of the material ids
                   // might be available in the particular partition, therefore
                   // the check is omitted.
        if (std::find(group_id_property->begin(), group_id_property->end(),
                      p.first) == group_id_property->end())
        {
            OGS_FATAL(
                "Specified property index {:d} does not exist in the property "
                "vector {:s}",
                p.first, group_id_property_name);
        }
#endif
 
        auto const n_values = vec_index_values.begin()->second.size();
        if (p.second.size() != n_values)
        {
            OGS_FATAL(
                "The length of some values ({:d}) is different from the first "
                "one ({:d}). The length should be same for all index_values.",
                p.second.size(), n_values);
        }
    }
 
    if (group_id_property->getMeshItemType() == MeshLib::MeshItemType::Node)
    {
        return std::make_unique<
            GroupBasedParameter<double, MeshLib::MeshItemType::Node>>(
            name, mesh, *group_id_property, vec_index_values);
    }
    if (group_id_property->getMeshItemType() == MeshLib::MeshItemType::Cell)
    {
        return std::make_unique<
            GroupBasedParameter<double, MeshLib::MeshItemType::Cell>>(
            name, mesh, *group_id_property, vec_index_values);
    }
 
    OGS_FATAL("Mesh item type of the specified property is not supported.");
}

References MeshLib::Cell, BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), BaseLib::ConfigTree::getConfigSubtreeList(), MeshLib::Mesh::getProperties(), MeshLib::Properties::getPropertyVector(), MeshLib::Node, and OGS_FATAL.

Referenced by createParameter().

createMeshElementParameter()

std::unique_ptr< ParameterBase > ParameterLib::createMeshElementParameter	(	std::string const &	name,
		BaseLib::ConfigTree const &	config,
		MeshLib::Mesh const &	mesh )

Input File Parameter

prj__parameters__parameter__type

Input File Parameter

prj__parameters__parameter__MeshElement__field_name

Definition at line 18 of file MeshElementParameter.cpp.

{
    config.checkConfigParameter("type", "MeshElement");
    auto const field_name =
        config.getConfigParameter<std::string>("field_name");
    DBUG("Using field_name {:s}", field_name);
 
    // TODO other data types than only double
    auto const& property =
        mesh.getProperties().getPropertyVector<double>(field_name);
 
    if (property->getMeshItemType() != MeshLib::MeshItemType::Cell)
    {
        OGS_FATAL("The mesh property `{:s}' is not an element property.",
                  field_name);
    }
 
    return std::make_unique<MeshElementParameter<double>>(name, mesh,
                                                          *property);
}

References MeshLib::Cell, BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), MeshLib::Mesh::getProperties(), MeshLib::Properties::getPropertyVector(), and OGS_FATAL.

Referenced by createParameter().

createMeshNodeParameter()

std::unique_ptr< ParameterBase > ParameterLib::createMeshNodeParameter	(	std::string const &	name,
		BaseLib::ConfigTree const &	config,
		MeshLib::Mesh const &	mesh )

Input File Parameter

prj__parameters__parameter__type

Input File Parameter

prj__parameters__parameter__MeshNode__field_name

Definition at line 18 of file MeshNodeParameter.cpp.

{
    config.checkConfigParameter("type", "MeshNode");
    auto const field_name =
        config.getConfigParameter<std::string>("field_name");
    DBUG("Using field_name {:s}", field_name);
 
    // TODO other data types than only double
    auto const& property =
        mesh.getProperties().getPropertyVector<double>(field_name);
 
    if (property->getMeshItemType() != MeshLib::MeshItemType::Node)
    {
        OGS_FATAL("The mesh property `{:s}' is not a nodal property.",
                  field_name);
    }
 
    return std::make_unique<MeshNodeParameter<double>>(name, mesh, *property);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), MeshLib::Mesh::getProperties(), MeshLib::Properties::getPropertyVector(), MeshLib::Node, and OGS_FATAL.

Referenced by createParameter().

createParameter()

std::unique_ptr< ParameterBase > ParameterLib::createParameter	(	BaseLib::ConfigTree const &	config,
		const std::vector< std::unique_ptr< MeshLib::Mesh > > &	meshes,
		std::vector< GeoLib::NamedRaster > const &	named_rasters,
		std::map< std::string, std::unique_ptr< MathLib::PiecewiseLinearInterpolation > > const &	curves )

Constructs a new ParameterBase from the given configuration.

The meshes vector is used to set up parameters from mesh input data. The named_rasters vector is used to set up parameters from raster input data.

Input File Parameter

prj__parameters__parameter__name

Input File Parameter

prj__parameters__parameter__type

Input File Parameter

prj__parameters__parameter__mesh

Definition at line 27 of file Parameter.cpp.

{
    auto const name = config.getConfigParameter<std::string>("name");
    auto const type = config.peekConfigParameter<std::string>("type");
 
    // Either the mesh name is given, or the first mesh's name will be
    // taken.
    auto const mesh_name =
        config.getConfigParameter<std::string>("mesh", meshes[0]->getName());
 
    auto const& mesh = MeshLib::findMeshByName(meshes, mesh_name);
 
    // Create parameter based on the provided type.
    if (type == "Constant")
    {
        INFO("ConstantParameter: {:s}", name);
        return createConstantParameter(name, config);
    }
    if (type == "CurveScaled")
    {
        INFO("CurveScaledParameter: {:s}", name);
        return createCurveScaledParameter(name, config, curves);
    }
    if (type == "Function")
    {
        INFO("FunctionParameter: {:s}", name);
        return createFunctionParameter(name, config, curves);
    }
    if (type == "Group")
    {
        INFO("GroupBasedParameter: {:s}", name);
        return createGroupBasedParameter(name, config, mesh);
    }
    if (type == "MeshElement")
    {
        INFO("MeshElementParameter: {:s}", name);
        return createMeshElementParameter(name, config, mesh);
    }
    if (type == "MeshNode")
    {
        INFO("MeshNodeParameter: {:s}", name);
        return createMeshNodeParameter(name, config, mesh);
    }
    if (type == "RandomFieldMeshElement")
    {
        auto& mesh_var = MeshLib::findMeshByName(meshes, mesh_name);
        INFO("RandomFieldMeshElement: {:s}", name);
        return createRandomFieldMeshElementParameter(name, config, mesh_var);
    }
    if (type == "Raster")
    {
        INFO("RasterParameter: {:s}", name);
        return createRasterParameter(name, config, named_rasters);
    }
    if (type == "TimeDependentHeterogeneousParameter")
    {
        INFO("TimeDependentHeterogeneousParameter: {:s}", name);
        return createTimeDependentHeterogeneousParameter(name, config);
    }
 
    OGS_FATAL("Cannot construct a parameter of given type '{:s}'.", type);
}

References createConstantParameter(), createCurveScaledParameter(), createFunctionParameter(), createGroupBasedParameter(), createMeshElementParameter(), createMeshNodeParameter(), createRandomFieldMeshElementParameter(), createRasterParameter(), createTimeDependentHeterogeneousParameter(), MeshLib::findMeshByName(), BaseLib::ConfigTree::getConfigParameter(), INFO(), OGS_FATAL, and BaseLib::ConfigTree::peekConfigParameter().

Referenced by ProjectData::parseParameters().

createRandomFieldMeshElementParameter()

std::unique_ptr< ParameterBase > ParameterLib::createRandomFieldMeshElementParameter	(	std::string const &	name,
		BaseLib::ConfigTree const &	config,
		MeshLib::Mesh &	mesh )

Input File Parameter

prj__parameters__parameter__type

Input File Parameter

prj__parameters__parameter__RandomFieldMeshElementParameter__field_name

Input File Parameter

prj__parameters__parameter__RandomFieldMeshElementParameter__range

Input File Parameter

prj__parameters__parameter__RandomFieldMeshElementParameter__seed

Definition at line 22 of file RandomFieldMeshElementParameter.cpp.

{
    config.checkConfigParameter("type", "RandomFieldMeshElement");
    auto const field_name =
        config.getConfigParameter<std::string>("field_name");
    auto const range =
        config.getConfigParameter<std::vector<double>>("range");
    if (range.size() != 2)
    {
        OGS_FATAL(
            "The range needs to have two components, but {:d} were given.",
            range.size());
    }
    auto const seed =
        config.getConfigParameter<int>("seed");
    DBUG("Generating field {:s} with range {:g} to {:g} and seed {:d}.",
         field_name, range[0], range[1], seed);
 
    std::vector<double> values(mesh.getElements().size());
 
    std::mt19937 generator(seed);
    std::uniform_real_distribution<> distr(range[0], range[1]);
    auto gen = [&distr, &generator]() { return distr(generator); };
    generate(begin(values), end(values), gen);
 
    MeshLib::addPropertyToMesh(mesh, field_name, MeshLib::MeshItemType::Cell, 1,
                               values);
 
    auto const& property =
        mesh.getProperties().getPropertyVector<double>(field_name);
 
    if (property->getMeshItemType() != MeshLib::MeshItemType::Cell)
    {
        OGS_FATAL("The mesh property `{:s}' is not an element property.",
                  field_name);
    }
 
    return std::make_unique<RandomFieldMeshElementParameter<double>>(name, mesh,
                                                                     *property);
}

References MeshLib::addPropertyToMesh(), MeshLib::Cell, BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), MeshLib::Mesh::getElements(), MeshLib::Mesh::getProperties(), MeshLib::Properties::getPropertyVector(), and OGS_FATAL.

Referenced by createParameter().

createRasterParameter()

std::unique_ptr< ParameterBase > ParameterLib::createRasterParameter	(	std::string const &	name,
		BaseLib::ConfigTree const &	config,
		std::vector< GeoLib::NamedRaster > const &	named_rasters )

Input File Parameter

prj__parameters__parameter__type

Definition at line 19 of file RasterParameter.cpp.

{
    config.checkConfigParameter("type", "Raster");
 
    auto const& named_raster = BaseLib::getIfOrError(
        named_rasters,
        [&name](auto const& named_raster)
        { return name == named_raster.raster_name; },
        "Could not find raster '" + name);
 
    DBUG("Using the raster '{}' for the raster parameter.", name);
 
    return std::make_unique<RasterParameter>(name, named_raster);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), and BaseLib::getIfOrError().

Referenced by createParameter().

createTimeDependentHeterogeneousParameter()

std::unique_ptr< ParameterBase > ParameterLib::createTimeDependentHeterogeneousParameter	(	std::string const &	name,
		BaseLib::ConfigTree const &	config )

Input File Parameter

prj__parameters__parameter__type

Input File Parameter

prj__parameters__parameter__TimeDependentHeterogeneousParameter__time_series

Input File Parameter

prj__parameters__parameter__TimeDependentHeterogeneousParameter__time_series__pair

Input File Parameter

prj__parameters__parameter__TimeDependentHeterogeneousParameter__time_series__pair__time

Input File Parameter

prj__parameters__parameter__TimeDependentHeterogeneousParameter__time_series__pair__parameter_name

Definition at line 113 of file TimeDependentHeterogeneousParameter.cpp.

{
    config.checkConfigParameter("type", "TimeDependentHeterogeneousParameter");
    auto const time_series_config =
        config.getConfigSubtree("time_series");
 
    std::vector<TimeDependentHeterogeneousParameter::PairTimeParameterName>
        time_series;
    for (auto const p : time_series_config.getConfigSubtreeList("pair"))
    {
        auto time = p.getConfigParameter<double>("time");
        auto parameter_name =
            p.getConfigParameter<std::string>("parameter_name");
        time_series.emplace_back(time, parameter_name);
    }
 
    if (time_series.empty())
    {
        OGS_FATAL(
            "Time dependent heterogeneous parameter '{:s}' doesn't contain "
            "necessary time series data.",
            name);
    }
 
    if (!std::is_sorted(
            time_series.begin(), time_series.end(),
            [](TimeDependentHeterogeneousParameter::PairTimeParameterName const&
                   p0,
               TimeDependentHeterogeneousParameter::PairTimeParameterName const&
                   p1) { return p0.first < p1.first; }))
    {
        OGS_FATAL(
            "The points in time in the time series '{:s}' aren't in ascending "
            "order.",
            name);
    }
 
    return std::make_unique<TimeDependentHeterogeneousParameter>(
        name, std::move(time_series));
}

References BaseLib::ConfigTree::checkConfigParameter(), BaseLib::ConfigTree::getConfigSubtree(), and OGS_FATAL.

Referenced by createParameter().

findOptionalTagParameter()

template<typename ParameterDataType >

Parameter< ParameterDataType > * ParameterLib::findOptionalTagParameter	(	BaseLib::ConfigTree const &	process_config,
		std::string const &	tag,
		std::vector< std::unique_ptr< ParameterBase > > const &	parameters,
		int const	num_components,
		MeshLib::Mesh const *const	mesh = nullptr )

Find a parameter of specific type for a name given in the process configuration under the optional tag. If the tag is not present, a nullptr will be returned. The parameter must have the specified number of components. In the process config a parameter is referenced by a name. For example it will be looking for a parameter named "K" in the list of parameters when the tag is "hydraulic_conductivity":

<process>
    ...
    <hydraulic_conductivity>K</hydraulic_conductivity>
</process>

and return a pointer to that parameter. Additionally it checks for the type of the found parameter.

Input File Parameter

special OGS input file parameter

Definition at line 162 of file Utils.h.

{
    // Find parameter name in process config.
    auto const name =
        process_config.getConfigParameterOptional<std::string>(tag);
 
    if (!name)
    {
        return nullptr;
    }
    return &findParameter<ParameterDataType>(*name, parameters, num_components,
                                             mesh);
}

References BaseLib::ConfigTree::getConfigParameterOptional().

Referenced by ProcessLib::ComponentTransport::createComponentTransportProcess(), ProcessLib::LargeDeformation::createLargeDeformationProcess(), and ProcessLib::SmallDeformation::createSmallDeformationProcess().

findParameter() [1/2]

template<typename ParameterDataType >

Parameter< ParameterDataType > & ParameterLib::findParameter	(	BaseLib::ConfigTree const &	process_config,
		std::string const &	tag,
		std::vector< std::unique_ptr< ParameterBase > > const &	parameters,
		int const	num_components,
		MeshLib::Mesh const *const	mesh = nullptr )

Find a parameter of specific type for a name given in the process configuration under the tag. The parameter must have the specified number of components. In the process config a parameter is referenced by a name. For example it will be looking for a parameter named "K" in the list of parameters when the tag is "hydraulic_conductivity":

<process>
    ...
    <hydraulic_conductivity>K</hydraulic_conductivity>
</process>

and return a reference to that parameter. Additionally it checks for the type of the found parameter.

Input File Parameter

special OGS input file parameter

Definition at line 133 of file Utils.h.

{
    // Find parameter name in process config.
    auto const name = process_config.getConfigParameter<std::string>(tag);
 
    return findParameter<ParameterDataType>(name, parameters, num_components,
                                            mesh);
}

References BaseLib::ConfigTree::getConfigParameter().

findParameter() [2/2]

template<typename ParameterDataType >

Parameter< ParameterDataType > & ParameterLib::findParameter	(	std::string const &	parameter_name,
		std::vector< std::unique_ptr< ParameterBase > > const &	parameters,
		int const	num_components,
		MeshLib::Mesh const *const	mesh = nullptr )

Find a parameter of specific type for a given name.

Template Parameters

ParameterDataType

the data type of the parameter

Parameters

parameter_name	name of the requested parameter
parameters	list of parameters in which it will be searched
num_components	the number of components of the parameters or zero if any number is acceptable
mesh	an optional mesh pointer used for test whether the parameter is defined on the given mesh. No test is performed if the pointer is a nullptr.

See also

The documentation of the other findParameter() function.

Definition at line 101 of file Utils.h.

{
    auto* parameter = findParameterOptional<ParameterDataType>(
        parameter_name, parameters, num_components, mesh);
 
    if (!parameter)
    {
        OGS_FATAL(
            "Could not find parameter `{:s}' in the provided parameters list.",
            parameter_name);
    }
    return *parameter;
}

References OGS_FATAL.

Referenced by ProcessLib::LIE::HydroMechanics::createHydroMechanicsProcess(), MaterialLib::PorousMedium::createPermeabilityModel(), and ProcessLib::ThermoMechanicalPhaseField::createThermoMechanicalPhaseFieldProcess().

findParameterByName()

ParameterBase * ParameterLib::findParameterByName	(	std::string const &	parameter_name,
		std::vector< std::unique_ptr< ParameterBase > > const &	parameters )

Find an optional parameter of specific type for a given name.

Template Parameters

ParameterDataType

the data type of the parameter

Parameters

parameter_name	name of the requested parameter
parameters	list of parameters in which it will be searched

Definition at line 15 of file Utils.cpp.

{
    // Find corresponding parameter by name.
    auto const it =
        std::find_if(parameters.cbegin(), parameters.cend(),
                     [&parameter_name](std::unique_ptr<ParameterBase> const& p)
                     { return p->name == parameter_name; });
 
    if (it == parameters.end())
    {
        return nullptr;
    }
 
    DBUG("Found parameter `{:s}'.", (*it)->name);
    return it->get();
}

References DBUG().

Referenced by findParameterOptional().

findParameterOptional()

template<typename ParameterDataType >

Parameter< ParameterDataType > * ParameterLib::findParameterOptional	(	std::string const &	parameter_name,
		std::vector< std::unique_ptr< ParameterBase > > const &	parameters,
		int const	num_components,
		MeshLib::Mesh const *const	mesh = nullptr )

Find an optional parameter of specific type for a given name.

Template Parameters

ParameterDataType

the data type of the parameter

Parameters

parameter_name	name of the requested parameter
parameters	list of parameters in which it will be searched
num_components	the number of components of the parameters or zero if any number is acceptable
mesh	an optional mesh pointer used for test whether the parameter is defined on the given mesh. No test is performed if the pointer is a nullptr.

See also

The documentation of the other findParameter() function.

Definition at line 42 of file Utils.h.

{
    // Find corresponding parameter by name.
    ParameterBase* parameter_ptr =
        findParameterByName(parameter_name, parameters);
    if (parameter_ptr == nullptr)
    {
        return nullptr;
    }
 
    // Check the type correctness of the found parameter.
    auto* const parameter =
        dynamic_cast<Parameter<ParameterDataType>*>(parameter_ptr);
    if (!parameter)
    {
        OGS_FATAL("The read parameter `{:s}' is of incompatible type.",
                  parameter_name);
    }
 
    if (num_components != 0 &&
        parameter->getNumberOfGlobalComponents() != num_components)
    {
        OGS_FATAL(
            "The read parameter `{:s}' has the wrong number of components "
            "({:d} instead of {:d}).",
            parameter_name, parameter->getNumberOfGlobalComponents(),
            num_components);
    }
 
    // Test the parameter's mesh only if there is a "test"-mesh provided.
    if (mesh != nullptr)
    {
        if (auto const error = isDefinedOnSameMesh(*parameter, *mesh))
        {
            OGS_FATAL(
                "The found parameter is not suitable for the use on the "
                "required mesh.\n{:s}",
                error->c_str());
        }
    }
 
    return parameter;
}

References findParameterByName(), isDefinedOnSameMesh(), and OGS_FATAL.

getTransformationFromSingleBase2D()

Eigen::Matrix< double, 2, 2 > ParameterLib::getTransformationFromSingleBase2D	(	Parameter< double > const &	unit_direction,
		SpatialPosition const &	pos )

Definition at line 100 of file CoordinateSystem.cpp.

{
    Eigen::Matrix<double, 2, 2> t;
#ifndef NDEBUG
    if (std::abs(Eigen::Map<Eigen::Vector2d>(
                     unit_direction(0 /* time independent */, pos).data())
                     .norm() -
                 1) > tolerance)
    {
        OGS_FATAL(normalization_error_info, unit_direction.name);
    }
#endif  // NDEBUG
 
    auto normal = unit_direction(0 /* time independent */, pos);
    // base 0: ( normal[1], -normal[0])^T
    // base 1: ( normal[0], normal[1])^T
    t << normal[1], normal[0], -normal[0], normal[1];
 
#ifndef NDEBUG
    if (std::abs(t.determinant() - 1) > tolerance)
    {
        OGS_FATAL(error_info, t.determinant(), tolerance);
    }
#endif  // NDEBUG
    return t;
}

getTransformationFromSingleBase3D()

Eigen::Matrix< double, 3, 3 > ParameterLib::getTransformationFromSingleBase3D	(	Parameter< double > const &	unit_direction,
		SpatialPosition const &	pos )

Definition at line 159 of file CoordinateSystem.cpp.

{
    auto e2 = unit_direction(0 /* time independent */, pos);
#ifndef NDEBUG
    if (std::abs(Eigen::Map<Eigen::Vector3d>(e2.data()).norm() - 1.0) >
        tolerance)
    {
        OGS_FATAL(normalization_error_info, unit_direction.name);
    }
#endif
 
    // Find the id of the first non-zero component of e2:
    auto const it = std::max_element(e2.begin(), e2.end(),
                                     [](const double a, const double b)
                                     { return std::abs(a) < std::abs(b); });
    const auto id = std::distance(e2.begin(), it);
    // Get other two component ids:
    const auto id_a = (id + 1) % 3;
    const auto id_b = (id + 2) % 3;
 
    // Compute basis vector e1 orthogonal to e2
    using Vector3 = Eigen::Vector3d;
    Vector3 e1(0.0, 0.0, 0.0);
 
    if (std::abs(e2[id_a]) < tolerance)
    {
        e1[id_a] = 1.0;
    }
    else if (std::abs(e2[id_b]) < tolerance)
    {
        e1[id_b] = 1.0;
    }
    else
    {
        e1[id_a] = 1.0;
        e1[id_b] = -e2[id_a] / e2[id_b];
    }
 
    e1.normalize();
 
    auto eigen_mapped_e2 = Eigen::Map<Vector3>(e2.data());
 
    auto e0 = e1.cross(eigen_mapped_e2);
    // |e0| = |e1 x e2| = |e1||e2|sin(theta) with theta the angle between e1 and
    // e2. Since |e1| = |e2| = 1.0, and theta = pi/2, we have |e0|=1. Therefore
    // e0 is normalized by nature.
 
    Eigen::Matrix<double, 3, 3> t;
    t.col(0) = e0;
    t.col(1) = e1;
    t.col(2) = eigen_mapped_e2;
 
#ifndef NDEBUG
 
    if (std::abs(t.determinant() - 1) > tolerance)
    {
        OGS_FATAL(error_info, t.determinant(), tolerance);
    }
 
#endif  // NDEBUG
 
    return t;
}

Referenced by ParameterLib::CoordinateSystem::transformationFromSingleBase_3d().

isDefinedOnSameMesh()

std::optional< std::string > ParameterLib::isDefinedOnSameMesh	(	ParameterBase const &	parameter,
		MeshLib::Mesh const &	mesh )

Checks whether the parameter can be used on the given mesh. The parameter's domain of definition can be arbitrary (like for constant parameters), or the parameter is defined on a mesh. In the latter case that mesh must be equal to the given mesh.

Returns

nothing if the parameter can be used on the given mesh, or an error string otherwise.

Definition at line 99 of file Parameter.cpp.

{
    // Arbitrary domain of definition.
    if (parameter.mesh() == nullptr)
    {
        return {};
    }
 
    // Equal meshes.
    if (*parameter.mesh() == mesh)
    {
        return {};
    }
 
    return "The parameter's domain of definition mesh '" +
           parameter.mesh()->getName() + "' differs from the used mesh '" +
           mesh.getName() +
           "'. The same mesh (the same name) has to be referenced in the "
           "project file. Possible reasons are:\n - the parameter used for the "
           "initial condition is not defined on the bulk mesh,\n - the "
           "parameter's domain of definition mesh differs from the boundary "
           "condition or source term domain of definition mesh.";
}

References MeshLib::Mesh::getName(), and ParameterLib::ParameterBase::mesh().

Referenced by findParameterOptional().

parseBase1OrBase2()

Parameter< double > const * ParameterLib::parseBase1OrBase2	(	BaseLib::ConfigTree const &	config,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters,
		int const	expected_component_number,
		std::string_view const	base_tag_name )

Definition at line 28 of file CreateCoordinateSystem.cpp.

{
    auto const base_parameter_name = config.getValue<std::string>();
    auto const& basis_vector = ParameterLib::findParameter<double>(
        base_parameter_name, parameters, 0 /* any dimension */);
 
    int const component_number = basis_vector.getNumberOfGlobalComponents();
    if (base_tag_name == "basis_vector_1" && component_number != 2)
    {
        OGS_FATAL(
            "The case of implicit \"basis_vector_0\" and "
            "explicit \"basis_vector_1\" is for a 2D coordinate system. The "
            "parameter for \"basis_vector_1\", {:s}, must have "
            "two components but it has {:d}. In addition, \"basis_vector_2\" "
            "should not exist in this case.",
            base_parameter_name, component_number);
    }
 
    if (component_number != expected_component_number)
    {
        OGS_FATAL(
            "The read parameter `{:s}' for tag {:s} has the wrong number of "
            "components ({:d} instead of {:d}).",
            base_parameter_name, base_tag_name, component_number,
            expected_component_number);
    }
 
    return &basis_vector;
}

References BaseLib::ConfigTree::getValue(), and OGS_FATAL.

Referenced by createCoordinateSystem(), and createCoordinateSystemWithImplicitBase().

Variable Documentation

error_info

constexpr char ParameterLib::error_info[]

staticconstexpr

Initial value:

=
    "The determinant of the coordinate system transformation matrix is '{:g}', "
    "which is not sufficiently close to unity with the tolerance of '{:g}'. "
    "Please adjust the accuracy of the local system bases"

Definition at line 26 of file CoordinateSystem.cpp.

Referenced by ParameterLib::CoordinateSystem::transformation(), and ParameterLib::CoordinateSystem::transformation_3d().

normalization_error_info

constexpr char ParameterLib::normalization_error_info[]

staticconstexpr

Initial value:

=
    "The direction vector given by parameter {:s} for local_coordinate_system "
    "is not normalized to unit length"

Definition at line 31 of file CoordinateSystem.cpp.

Referenced by ParameterLib::CoordinateSystem::transformation().

tolerance

double const ParameterLib::tolerance = std::numeric_limits<double>::epsilon()

static

Definition at line 24 of file CoordinateSystem.cpp.

Referenced by ParameterLib::CoordinateSystem::transformation(), and ParameterLib::CoordinateSystem::transformation_3d().