Detailed Description

Handles configuration of several secondary variables from the project file.

Definition at line 114 of file SecondaryVariable.h.

#include <SecondaryVariable.h>

Public Member Functions
void	addNameMapping (std::string const &internal_name, std::string const &external_name)
	Register a variable with the given internal and external names.

void	addSecondaryVariable (std::string const &internal_name, SecondaryVariableFunctions &&fcts)

SecondaryVariable const &	get (std::string const &external_name) const
	Returns the secondary variable with the given external name.

std::map< std::string, std::string >::const_iterator	begin () const

std::map< std::string, std::string >::const_iterator	end () const

Private Attributes
std::map< std::string, std::string >	_map_external_to_internal

std::map< std::string, SecondaryVariable >	_configured_secondary_variables

Member Function Documentation

◆ addNameMapping()

void ProcessLib::SecondaryVariableCollection::addNameMapping	(	std::string const &	internal_name,
		std::string const &	external_name )

Register a variable with the given internal and external names.

Definition at line 15 of file SecondaryVariable.cpp.

{
    // TODO check for missing secondary vars.
    // TODO check primary vars, too
    BaseLib::insertIfKeyUniqueElseError(
        _map_external_to_internal, external_name, internal_name,
        "Secondary variable names must be unique.");
}

References _map_external_to_internal, and BaseLib::insertIfKeyUniqueElseError().

Referenced by ProcessLib::createSecondaryVariables().

◆ addSecondaryVariable()

void ProcessLib::SecondaryVariableCollection::addSecondaryVariable	(	std::string const &	internal_name,
		SecondaryVariableFunctions &&	fcts )

Set up a secondary variable.

Parameters

internal_name	the tag in the project file associated with this secondary variable.
fcts	functions that compute the variable.

Note: Only variables requested by the user in the project file will be configured. All other variables are silently ignored.

Definition at line 25 of file SecondaryVariable.cpp.

{
    if (!_configured_secondary_variables
             .emplace(std::make_pair(
                 internal_name,
                 SecondaryVariable{internal_name /* TODO change */,
                                   std::move(fcts)}))
             .second)
    {
        OGS_FATAL(
            "The secondary variable with internal name `{:s}' has already been "
            "set up.",
            internal_name);
    }
}

References _configured_secondary_variables, and OGS_FATAL.

◆ begin()

std::map< std::string, std::string >::const_iterator ProcessLib::SecondaryVariableCollection::begin ( ) const

Definition at line 43 of file SecondaryVariable.cpp.

{
    return _map_external_to_internal.cbegin();
}

References _map_external_to_internal.

◆ end()

std::map< std::string, std::string >::const_iterator ProcessLib::SecondaryVariableCollection::end ( ) const

Definition at line 49 of file SecondaryVariable.cpp.

{
    return _map_external_to_internal.cend();
}

References _map_external_to_internal.

◆ get()

SecondaryVariable const & ProcessLib::SecondaryVariableCollection::get ( std::string const & external_name ) const

Returns the secondary variable with the given external name.

Definition at line 54 of file SecondaryVariable.cpp.

{
    auto const it = _map_external_to_internal.find(external_name);
 
    if (it == _map_external_to_internal.cend())
    {
        OGS_FATAL(
            "A secondary variable with external name '{:s}' has not been set "
            "up.",
            external_name);
    }
 
    auto const& internal_name = it->second;
    auto const it2 = _configured_secondary_variables.find(internal_name);
 
    if (it2 == _configured_secondary_variables.end())
    {
        OGS_FATAL(
            "A secondary variable with internal name '{:s}' has not been set "
            "up.",
            internal_name);
    }
 
    return it2->second;
}