particle_distribution_statistics.h

Go to the documentation of this file.

/*
  Copyright (C) 2025 - by the authors of the ASPECT code.

  This file is part of ASPECT.

  ASPECT is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2, or (at your option)
  any later version.

  ASPECT is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with ASPECT; see the file LICENSE.  If not see
  <http://www.gnu.org/licenses/>.
*/

#ifndef _aspect_postprocess_particle_distribution_statistics_h
#define _aspect_postprocess_particle_distribution_statistics_h

#include <aspect/particle/distribution.h>
#include <deal.II/base/function_lib.h>
#include <aspect/particle/manager.h>

namespace aspect
{
  namespace Postprocess
  {

    template <int dim>
    class ParticleDistributionStatistics : public Interface<dim>, public ::aspect::SimulatorAccess<dim>
    {
      public:
        void initialize() override;

        std::pair<std::string,std::string>
        execute (TableHandler &statistics) override;

        std::list<std::string>
        required_other_postprocessors() const override;

        static
        void
        declare_parameters (ParameterHandler &prm);

        void
        parse_parameters (ParameterHandler &prm) override;

      private:
        bool KDE_per_particle;

        unsigned int granularity;

        double bandwidth;

        typename Particle::ParticlePDF<dim>::KernelFunction kernel_function;

        std::vector<typename Particles::ParticleHandler<dim>::particle_iterator_range>
        get_neighboring_particle_ranges(const typename Triangulation<dim>::active_cell_iterator &cell,
                                        const typename Particles::ParticleHandler<dim> &particle_handler);

        void
        fill_PDF_from_cell(const typename Triangulation<dim>::active_cell_iterator &cell,
                           Particle::ParticlePDF<dim> &pdf);

        void insert_kernel_sum_into_pdf(const typename Triangulation<dim>::active_cell_iterator &cell,
                                        const Point<dim> reference_point,
                                        const std::array<unsigned int,dim> table_index,
                                        const unsigned int particles_in_cell,
                                        Particle::ParticlePDF<dim> &pdf);

        double
        apply_selected_kernel_function(const double distance) const;

        double
        kernelfunction_uniform(const double distance) const;

        double
        kernelfunction_triangular(const double distance) const;

        double
        kernelfunction_gaussian(const double distance) const;

        std::unique_ptr<GridTools::Cache<dim>> grid_cache;
    };
  }
}


#endif