geos::FieldIdentifiers Class Reference

#include <FieldIdentifiers.hpp>

Public Member Functions
void	addFields (FieldLocation const location, std::vector< string > const &fieldNames)
	adds fields to the fields map using the location to define a convenient key. More...
template<typename T = std::vector< string >>
void	addElementFields (std::vector< string > const &fieldNames, T const &regionNames)
	adds element-based fields to the fields map using the element region names to define keys. More...
const std::map< string, array1d< string > > &	getFields () const
	Get the Fields object which is the map containing the fields existing for each location. More...
string	getRegionName (string const &key) const
	Get the Region Name object. More...
void	getLocation (string const &key, FieldLocation &location) const
	Get the Location object. More...

Detailed Description

Class to

Definition at line 43 of file FieldIdentifiers.hpp.

Member Function Documentation

addElementFields()

template<typename T = std::vector< string >>

void geos::FieldIdentifiers::addElementFields ( std::vector< string > const &  fieldNames, T const &  regionNames  )

inline

adds element-based fields to the fields map using the element region names to define keys.

Parameters

fieldNames	vector of names of the element-based fields to be added to the map.
regionNames	vector of the regions on which these fields exist.

Definition at line 66 of file FieldIdentifiers.hpp.

addFields()

void geos::FieldIdentifiers::addFields ( FieldLocation const  location, std::vector< string > const &  fieldNames  )

inline

adds fields to the fields map using the location to define a convenient key.

Parameters

location	location where the fields provided have been registered.
fieldNames	vector of names of the element-based fields to be added to the map.

Definition at line 53 of file FieldIdentifiers.hpp.

getFields()

const std::map< string, array1d< string > >& geos::FieldIdentifiers::getFields ( ) const

inline

Get the Fields object which is the map containing the fields existing for each location.

Returns

std::map< string, array1d< string > > const&

Definition at line 79 of file FieldIdentifiers.hpp.

getLocation()

void geos::FieldIdentifiers::getLocation ( string const &  key, FieldLocation &  location  ) const

inline

Get the Location object.

Parameters

key	key used to store the list of fields in the map.
location	mesh location where fields defined by the key provided were registered.

Definition at line 101 of file FieldIdentifiers.hpp.

getRegionName()

string geos::FieldIdentifiers::getRegionName ( string const &  key ) const

inline

Get the Region Name object.

Parameters

key	key used to store the list of fields in the map.

Returns

name of the region extracted from the key.

Definition at line 89 of file FieldIdentifiers.hpp.

---

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

• coreComponents/mesh/FieldIdentifiers.hpp