Ikarus::ResultTypeMap< ParameterType > Class Template Reference

Class representing a map of result types to result arrays. More...

#include <ikarus/finiteelements/ferequirements.hh>

Inheritance diagram for Ikarus::ResultTypeMap< ParameterType >:

Public Types
using	ResultArray = Eigen::Matrix< ParameterType, Eigen::Dynamic, Eigen::Dynamic, 0, 9, 3 >

Public Member Functions
void	insertOrAssignResult (ResultType &&resultType, const ResultArray &resultArray)
	Insert or assign a result to the map. More...
ResultArray &	getResult (const ResultType &resultType)
	Get the result array for a specific result type. More...
auto &	getSingleResult ()
	Get the result array for a single result type. More...

Detailed Description

template<typename ParameterType = double>
class Ikarus::ResultTypeMap< ParameterType >

This class provides a mapping between different result types and their corresponding result arrays. It allows inserting or assigning results and retrieving results based on the result type.

Template Parameters

ParameterType

Type of the parameters, defaulting to double.

Member Typedef Documentation

ResultArray

template<typename ParameterType = double>

using Ikarus::ResultTypeMap< ParameterType >::ResultArray = Eigen::Matrix<ParameterType, Eigen::Dynamic, Eigen::Dynamic, 0, 9, 3>

Member Function Documentation

getResult()

template<typename ParameterType = double>

ResultArray & Ikarus::ResultTypeMap< ParameterType >::getResult ( const ResultType &  resultType )

inline

This function retrieves the result array for the specified result type.

Parameters

resultType

The type of the result to be retrieved.

Returns

Reference to the result array.

Exceptions

std::out_of_range

if the specified result type is not found in the map.

Here is the caller graph for this function:

getSingleResult()

template<typename ParameterType = double>

auto & Ikarus::ResultTypeMap< ParameterType >::getSingleResult ( )

inline

This function retrieves the result array when only a single result type is present in the map.

Returns

Reference to the result array.

Exceptions

Dune::RangeError

if the map does not contain a single result.

Here is the caller graph for this function:

insertOrAssignResult()

template<typename ParameterType = double>

void Ikarus::ResultTypeMap< ParameterType >::insertOrAssignResult ( ResultType &&  resultType, const ResultArray &  resultArray  )

inline

This function inserts or assigns the specified result array to the map with the given result type.

Parameters

resultType	The type of the result to be inserted or assigned.
resultArray	The result array to be inserted or assigned.

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• ferequirements.hh