cpo_bingham_average.h

Go to the documentation of this file.

/*
 Copyright (C) 2023 - 2026 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_particle_property_cpo_bingham_average_h
#define _aspect_particle_property_cpo_bingham_average_h

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

#include <array>
#include <random>

namespace aspect
{
  namespace Particle
  {
    namespace Property
    {


      enum class RotationFormat
      {
        full_matrix, euler_angles, quaternion
      };

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

          void
          initialize () override;

          void
          update () override;

          void
          initialize_one_particle_property (const Point<dim> &position,
                                            std::vector<double> &particle_properties) const override;

          void
          update_particle_properties (const ParticleUpdateInputs<dim> &inputs,
                                      typename ParticleHandler<dim>::particle_iterator_range &particles) const override;

          UpdateTimeFlags
          need_update () const override;

          UpdateFlags
          get_update_flags (const unsigned int component) const override;

          std::vector<std::pair<std::string, unsigned int>>
          get_property_information() const override;

          std::array<std::array<double,6>,3>
          compute_bingham_average(std::vector<Tensor<2,3>> matrices, std::integral_constant<int,6>) const;

          std::array<std::array<double,4>,3>
          compute_bingham_average(std::vector<Tensor<2,3>> matrices, std::integral_constant<int,4>) const;

          std::pair<std::array<double, 4>, std::array<std::array<double,2>,3>>
          compute_bingham_average(std::vector<Tensor<2,3>> matrices, std::integral_constant<int,2>) const;

          static
          void
          declare_parameters (ParameterHandler &prm);

          void
          parse_parameters (ParameterHandler &prm) override;

        private:
          unsigned int cpo_data_position;

          const Particle::Property::CrystalPreferredOrientation<dim> *cpo_particle_property;

          mutable std::mt19937 random_number_generator;

          unsigned int random_number_seed;

          unsigned int n_grains;

          unsigned int n_minerals;

          unsigned int n_samples;

          RotationFormat rotation_format;
      };
    }
  }
}

#endif