probability_density_function.h

Go to the documentation of this file.

/*
 Copyright (C) 2015 - 2022 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_generator_probability_density_function_h
#define _aspect_particle_generator_probability_density_function_h

#include <aspect/particle/generator/interface.h>

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

namespace aspect
{
  namespace Particle
  {
    namespace Generator
    {
      template <int dim>
      DeclException1 (ProbabilityFunctionNegative,
                      Point<dim>,
                      << "Your probability density function in the particle generator "
                      "returned a negative probability density for the following position: "
                      << arg1 << ". Please check your function expression.");


      template <int dim>
      class ProbabilityDensityFunction : public Interface<dim>
      {
        public:
          void
          generate_particles(Particles::ParticleHandler<dim> &particle_handler) override;

          // avoid -Woverloaded-virtual
          // TODO: remove this using directive once the following deprecated
          // function in the interface class has been removed:
          // generate_particles(std::multimap<Particles::internal::LevelInd, Particle<dim>> &particles)
          using Generator::Interface<dim>::generate_particles;

          static
          void
          declare_parameters (ParameterHandler &prm);

          void
          parse_parameters (ParameterHandler &prm) override;

        private:
          types::particle_index n_particles;

          bool random_cell_selection;

          unsigned int random_number_seed;

          Functions::ParsedFunction<dim> function;
      };

    }
  }
}

#endif