FieldIdentifiers.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2024 TotalEnergies
 * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2023-2024 Chevron
 * Copyright (c) 2019-     GEOS/GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */
 
#ifndef GEOS_MESH_MPICOMMUNICATIONS_FIELDIDENTIFIERS_HPP_
#define GEOS_MESH_MPICOMMUNICATIONS_FIELDIDENTIFIERS_HPP_
 
#include "common/DataTypes.hpp"
#include "common/format/StringUtilities.hpp"
#include "common/logger/Logger.hpp"
 
namespace geos
{
enum class FieldLocation
{
  Elem,   
  Face,   
  Edge,   
  Node    
};
 
 
class FieldIdentifiers
{
public:
 
  void addFields( FieldLocation const location, std::vector< string > const & fieldNames )
  {
    string key;
    generateKey( location, key );
    addFields( fieldNames, key );
  }
  template< typename T = std::vector< string > >
  void addElementFields( std::vector< string > const & fieldNames, T const & regionNames )
  {
    for( auto const & regionName : regionNames )
    {
      addFields( fieldNames, generateKey( regionName ) );
    }
  }
 
  std::map< string, array1d< string > > const & getFields() const
  {
    return m_fields;
  }
  string getRegionName( string const & key ) const
  {
    string regionName( key );
    regionName.erase( 0, std::string( m_locationKeys.elemsKey()).length());
    return regionName;
  }
  FieldLocation getLocation( string const & key ) const
  {
    FieldLocation location{};
    if( key.find( m_locationKeys.nodesKey() ) != string::npos )
    {
      location = FieldLocation::Node;
    }
    else if( key.find( m_locationKeys.edgesKey()) != string::npos )
    {
      location = FieldLocation::Edge;
    }
    else if( key.find( m_locationKeys.facesKey()) != string::npos )
    {
      location = FieldLocation::Face;
    }
    else if( key.find( m_locationKeys.elemsKey()) != string::npos )
    {
      location = FieldLocation::Elem;
    }
    else
    {
      GEOS_ERROR( GEOS_FMT( "Invalid key, {}, was provided. Location cannot be retrieved.", key ) );
    }
    return location;
  }
 
private:
  std::map< string, array1d< string > > m_fields;
 
  struct keysStruct
  {
    static constexpr char const * nodesKey() { return "nodes"; }
    static constexpr char const * edgesKey() { return "edges"; }
    static constexpr char const * facesKey() { return "faces"; }
    static constexpr char const * elemsKey() { return "elems/"; }
  } m_locationKeys;
 
  void generateKey( FieldLocation const location,
                    string & key ) const
 
  {
    switch( location )
    {
      case FieldLocation::Node:
      {
        key = m_locationKeys.nodesKey();
        break;
      }
      case FieldLocation::Edge:
      {
        key = m_locationKeys.edgesKey();
        break;
      }
      case FieldLocation::Face:
      {
        key = m_locationKeys.facesKey();
        break;
      }
      case FieldLocation::Elem:
      {
        GEOS_ERROR( "An element located field also requires a region name to be specified." );
        break;
      }
    }
  }
  string generateKey( string const & regionName ) const
  {
    return stringutilities::concat( "", m_locationKeys.elemsKey(), regionName );
  }
  void addFields( std::vector< string > const fieldNames, string const key )
  {
    for( string const & field : fieldNames )
    {
      m_fields[key].emplace_back( field );
    }
  }
};
 
} /* namespace geos */
 
#endif /* GEOS_MESH_MPICOMMUNICATIONS_FIELDIDENTIFIERS_HPP_ */