particles.h

Go to the documentation of this file.

// ------------------------------------------------------
//
// SPDX-License-Identifier: GPL-2.0-or-later
//
// SPDX-FileCopyrightText: Copyright (C) 2011-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_h
#define _aspect_postprocess_particle_h

#include <aspect/postprocess/interface.h>

#include <aspect/simulator_access.h>
#include <aspect/particle/property/interface.h>

#include <deal.II/particles/particle_handler.h>
#include <deal.II/base/data_out_base.h>

#include <thread>
#include <tuple>


namespace aspect
{
  namespace Postprocess
  {
    namespace internal
    {
      template <int dim>
      class ParticleOutput : public ::DataOutInterface<0,dim>
      {
        public:
          void build_patches(const Particles::ParticleHandler<dim> &particle_handler,
                             const aspect::Particle::Property::ParticlePropertyInformation &property_information,
                             const std::vector<std::string> &exclude_output_properties,
                             const bool only_group_3d_vectors);

        private:
          const std::vector<DataOutBase::Patch<0,dim>> &
          get_patches () const override;

          std::vector<std::string>
          get_dataset_names () const override;

          std::vector<
          std::tuple<unsigned int,
              unsigned int,
              std::string,
              DataComponentInterpretation::DataComponentInterpretation>>
              get_nonscalar_data_ranges () const override;

          std::vector<DataOutBase::Patch<0,dim>> patches;

          std::vector<std::string> dataset_names;

          std::vector<
          std::tuple<unsigned int,
              unsigned int,
              std::string,
              DataComponentInterpretation::DataComponentInterpretation>>
              vector_datasets;
      };
    }

    template <int dim>
    class Particles : public Interface<dim>, public ::aspect::SimulatorAccess<dim>
    {
      public:
        Particles();

        ~Particles() override;

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

        void save (std::map<std::string, std::string> &status_strings) const override;

        void load (const std::map<std::string, std::string> &status_strings) override;

        template <class Archive>
        void serialize (Archive &ar, const unsigned int version);

        static
        void
        declare_parameters (ParameterHandler &prm);

        void
        parse_parameters (ParameterHandler &prm) override;

      private:
        std::vector<double> output_interval;

        std::vector<double> last_output_time;

        void set_last_output_time (const unsigned int particle_manager,
                                   const double current_time);

        std::vector<unsigned int> output_file_number;

        std::vector<std::vector<std::string>> output_formats;

        std::map<std::string,std::vector<std::pair<double,std::string>>> times_and_pvtu_file_names;

        std::map<std::string,std::vector<std::vector<std::string>>> output_file_names_by_timestep;

        std::map<std::string,std::vector<XDMFEntry>> xdmf_entries;

        unsigned int group_files;

        std::string temporary_output_location;

        bool write_in_background_thread;

        std::thread background_thread;

        std::vector<std::vector<std::string>> exclude_output_properties;

        static
        void writer (const std::string &filename,
                     const std::string &temporary_filename,
                     const std::string &file_contents);

        void write_description_files (const internal::ParticleOutput<dim> &data_out,
                                      const std::string &description_file_prefix,
                                      const std::string &solution_file_directory,
                                      const std::string &solution_file_prefix,
                                      const std::vector<std::string> &filenames);
    };
  }
}

#endif