crystal_preferred_orientation.h

Go to the documentation of this file.

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

#include <aspect/postprocess/interface.h>
#include <aspect/particle/manager.h>

#include <aspect/simulator_access.h>

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

#include <random>
#include <tuple>


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

        ~CrystalPreferredOrientation();


        void initialize () override;

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

        std::list<std::string>
        required_other_postprocessors () const 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:
        enum class Output
        {
          VolumeFraction, RotationMatrix, EulerAngles, not_found
        };

        Output string_to_output_enum(const std::string &string);

        mutable std::mt19937 random_number_generator;

        unsigned int random_number_seed;

        double output_interval;

        double last_output_time;

        void set_last_output_time (const double current_time);

        unsigned int output_file_number;

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

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

        std::vector<std::pair<double,std::vector<std::string>>> times_and_vtu_file_names;

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

        std::vector<XDMFEntry>  xdmf_entries;

        unsigned int group_files;

        std::string temporary_output_location;

        bool write_in_background_thread;

        std::thread background_thread_main;

        std::vector<std::pair<unsigned int,Output>> write_raw_cpo;

        bool compute_raw_euler_angles;

        std::thread background_thread_content_raw;

        std::vector<std::pair<unsigned int,Output>> write_draw_volume_weighted_cpo;

        bool compute_weighted_rotation_matrix;

        std::thread background_thread_content_draw_volume_weighting;

        bool compress_cpo_data_files;

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

#endif