Cabana_Grid_ParticleList.hpp

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2018-2023 by the Cabana authors                            *
 * All rights reserved.                                                     *
 *                                                                          *
 * This file is part of the Cabana library. Cabana is distributed under a   *
 * BSD 3-clause license. For the licensing terms see the LICENSE file in    *
 * the top-level directory.                                                 *
 *                                                                          *
 * SPDX-License-Identifier: BSD-3-Clause                                    *
 ****************************************************************************/

#ifndef CABANA_GRID_PARTICLELIST_HPP
#define CABANA_GRID_PARTICLELIST_HPP
 
#include <Cabana_AoSoA.hpp>
#include <Cabana_MemberTypes.hpp>
#include <Cabana_ParticleList.hpp>
#include <Cabana_SoA.hpp>
#include <Cabana_Tuple.hpp>
 
#include <Cabana_Grid_ParticleDistributor.hpp>
 
#include <memory>
#include <string>
#include <type_traits>
 
namespace Cabana
{
namespace Grid
{
 
//---------------------------------------------------------------------------//
template <class MemorySpace, int VectorLength, class... FieldTags>
class ParticleList
    : public Cabana::ParticleList<MemorySpace, VectorLength, FieldTags...>
{
  public:
    using memory_space = MemorySpace;
    using base = Cabana::ParticleList<memory_space, VectorLength, FieldTags...>;

    using traits = typename base::traits;
    using aosoa_type = typename base::aosoa_type;
    using tuple_type = typename base::tuple_type;
    template <std::size_t M>
    using slice_type = typename aosoa_type::template member_slice_type<M>;
    using particle_type = typename base::particle_type;
    using particle_view_type = typename base::particle_view_type;

    ParticleList( const std::string& label )
        : base( label )
    {
    }

    template <class LocalGridType>
    bool redistribute( const LocalGridType& local_grid,
                       const bool force_redistribute = false )
    {
        return redistribute(
            local_grid, Cabana::Field::Position<LocalGridType::num_space_dim>(),
            force_redistribute );
    }

    template <class PositionFieldTag, class LocalGridType>
    bool redistribute( const LocalGridType& local_grid, PositionFieldTag,
                       const bool force_redistribute = false )
    {
        return particleMigrate( local_grid, this->slice( PositionFieldTag() ),
                                _aosoa, local_grid.haloCellWidth(),
                                force_redistribute );
    }
 
  protected:
    using base::_aosoa;
};
 
template <class>
struct is_particle_list_impl : public std::false_type
{
};
 
template <class MemorySpace, int VectorLength, class... FieldTags>
struct is_particle_list_impl<
    ParticleList<MemorySpace, VectorLength, FieldTags...>>
    : public std::true_type
{
};

template <class T>
struct is_particle_list
    : public is_particle_list_impl<typename std::remove_cv<T>::type>::type
{
};
 
//---------------------------------------------------------------------------//
template <class MemorySpace, int VectorLength, class... FieldTags>
auto createParticleList( const std::string& label,
                         Cabana::ParticleTraits<FieldTags...> )
{
    return ParticleList<MemorySpace, VectorLength, FieldTags...>( label );
}

template <class MemorySpace, class... FieldTags>
auto createParticleList( const std::string& label,
                         Cabana::ParticleTraits<FieldTags...> )
{
    return ParticleList<
        MemorySpace,
        Cabana::Impl::PerformanceTraits<
            typename MemorySpace::execution_space>::vector_length,
        FieldTags...>( label );
}
 
//---------------------------------------------------------------------------//
 
} // namespace Grid
} // namespace Cabana
 
#endif // end CABANA_GRID_PARTICLELIST_HPP