particle_distribution_score.h

Go to the documentation of this file.

// ------------------------------------------------------
//
// SPDX-License-Identifier: GPL-2.0-or-later
//
// SPDX-FileCopyrightText: Copyright (C) 2025-2026 by the ASPECT authors.
//
// This file is part of ASPECT.
//
// Detailed license information governing the source code and
// contributions can be found in the folder LICENSES and in
// LICENSE and CONTRIBUTING.md at the top level directory.
//
// ------------------------------------------------------


#ifndef _aspect_postprocess_particle_distribution_score_h
#define _aspect_postprocess_particle_distribution_score_h

#include <aspect/postprocess/interface.h>
#include <aspect/simulator_access.h>

#include <deal.II/base/table.h>

#include <vector>

namespace aspect
{
  namespace Postprocess
  {

    template <int dim>
    class ParticleDistributionScore : public Interface<dim>, public ::aspect::SimulatorAccess<dim>
    {
      public:
        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:
        unsigned int granularity;

        Table<dim,unsigned int>
        sort_particles_into_buckets(const typename Triangulation<dim>::active_cell_iterator &cell,
                                    const unsigned int particle_manager_index,
                                    const double bucket_width) const;
    };
  }
}


#endif