Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
dem_post_processing.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) 2021-2024 The Lethe Authors
2// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR LGPL-2.1-or-later
3
4#ifndef lethe_dem_post_processing_h
5#define lethe_dem_post_processing_h
6
7#include <core/utilities.h>
8
9#include <deal.II/particles/particle_handler.h>
10
11using namespace dealii;
12
13namespace DEM
14{
15 /**
16 * @brief enum that is used to identify which variables are calculated in the granular statistics
17 *
18 */
26
27 /**
28 * @brief Calculate statistics on a DEM ParticleHandler. At the moment, the
29 * following statistics are supported:
30 * - Translational kinetic energy
31 * - Rotational (angular) kinetic energy
32 * - Translational velocity
33 * - Rotational (angular) velocity
34 *
35 * @tparam dim An integer that denotes the number of spatial dimensions.
36 * @tparam PropertiesIndex Index of the properties used within the ParticleHandler.
37 * @tparam dem_statistics_variable Enum variable used to identify which
38 * granular statistics is being calculated
39 *
40 * @param particle_handler A reference to the particle handler being used for
41 * DEM
42 * @param mpi_communicator The MPI communicator
43 */
44 template <int dim, typename PropertiesIndex, dem_statistic_variable var>
47 const Particles::ParticleHandler<dim> &particle_handler,
48 const MPI_Comm &mpi_communicator);
49} // namespace DEM
50
51#endif
A simple container for storing basic statistical values.
Definition utilities.h:56
This namespace defines all the data containers and required operations on these containers for the DE...
statistics calculate_granular_statistics(const Particles::ParticleHandler< dim > &particle_handler, const MPI_Comm &mpi_communicator)
Calculate statistics on a DEM ParticleHandler. At the moment, the following statistics are supported:
dem_statistic_variable
enum that is used to identify which variables are calculated in the granular statistics