ParticleMeshGenerator.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_GENERATORS_PARTICLEMESHGENERATOR_HPP
#define GEOS_MESH_GENERATORS_PARTICLEMESHGENERATOR_HPP
 
#include "mesh/generators/MeshGeneratorBase.hpp"
 
#include "common/format/EnumStrings.hpp"
 
namespace geos
{
 
class ParticleManager;
class SpatialPartition;
 
class ParticleMeshGenerator : public MeshGeneratorBase
{
public:
 
  ParticleMeshGenerator( const string & name, Group * const parent );
 
  virtual ~ParticleMeshGenerator() override = default;
 
  static string catalogName() { return "ParticleMesh"; }
 
  virtual Group * createChild( string const & childKey, string const & childName ) override;
 
  virtual void fillParticleBlockManager( ParticleBlockManager & particleBlockManager, ParticleManager & particleManager, SpatialPartition const & partition ) override;
 
  void importFieldOnArray( Block block,
                           string const & blockName,
                           string const & meshFieldName,
                           bool isMaterialField,
                           dataRepository::WrapperBase & wrapper ) const override;
 
protected:
 
  struct viewKeyStruct
  {
    constexpr static char const * particleFilePathString() { return "particleFile"; }
    constexpr static char const * headerFilePathString() { return "headerFile"; }
    constexpr static char const * particleBlockNamesString() { return "particleBlockNames"; }
    constexpr static char const * particleTypesString() { return "particleTypes"; }
  };
 
  void postInputInitialization() override;
 
  int m_dim;
 
  real64 m_min[3];
 
  real64 m_max[3];
 
private:
 
  Path m_particleFilePath;
 
  Path m_headerFilePath;
 
  string_array m_blockNames;
 
  string_array m_particleType;
 
public:
 
};
 
} /* namespace geos */
 
#endif /* GEOS_MESH_GENERATORS_PARTICLEMESHGENERATOR_HPP */