Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
aspect::Particle::Generator::ProbabilityDensityFunction< dim > Class Template Reference
Inheritance diagram for aspect::Particle::Generator::ProbabilityDensityFunction< dim >:
Inheritance graph

Public Member Functions

void generate_particles (Particles::ParticleHandler< dim > &particle_handler) override
void parse_parameters (ParameterHandler &prm) override
- Public Member Functions inherited from aspect::Particle::Generator::Interface< dim >
 Interface ()
 ~Interface () override=default
virtual void initialize ()
virtual DEAL_II_DEPRECATED void generate_particles (std::multimap< Particles::internal::LevelInd, Particle< dim >> &particles)
std::pair< Particles::internal::LevelInd, Particle< dim > > generate_particle (const typename parallel::distributed::Triangulation< dim >::active_cell_iterator &cell, const types::particle_index id)
- Public Member Functions inherited from aspect::SimulatorAccess< dim >
 SimulatorAccess ()
 SimulatorAccess (const Simulator< dim > &simulator_object)
virtual ~SimulatorAccess ()=default
virtual void initialize_simulator (const Simulator< dim > &simulator_object)
const Introspection< dim > & introspection () const
const Simulator< dim > & get_simulator () const
const Parameters< dim > & get_parameters () const
SimulatorSignals< dim > & get_signals () const
MPI_Comm get_mpi_communicator () const
TimerOutput & get_computing_timer () const
const ConditionalOStream & get_pcout () const
double get_time () const
double get_timestep () const
double get_old_timestep () const
unsigned int get_timestep_number () const
const TimeStepping::Manager< dim > & get_timestepping_manager () const
unsigned int get_nonlinear_iteration () const
const parallel::distributed::Triangulation< dim > & get_triangulation () const
double get_volume () const
const Mapping< dim > & get_mapping () const
std::string get_output_directory () const
bool include_adiabatic_heating () const
bool include_latent_heat () const
bool include_melt_transport () const
int get_stokes_velocity_degree () const
double get_adiabatic_surface_temperature () const
double get_surface_pressure () const
bool convert_output_to_years () const
unsigned int get_pre_refinement_step () const
unsigned int n_compositional_fields () const
double get_end_time () const
void get_refinement_criteria (Vector< float > &estimated_error_per_cell) const
void get_artificial_viscosity (Vector< float > &viscosity_per_cell, const bool skip_interior_cells=false) const
void get_artificial_viscosity_composition (Vector< float > &viscosity_per_cell, const unsigned int compositional_variable) const
const LinearAlgebra::BlockVectorget_current_linearization_point () const
const LinearAlgebra::BlockVectorget_solution () const
const LinearAlgebra::BlockVectorget_old_solution () const
const LinearAlgebra::BlockVectorget_old_old_solution () const
const LinearAlgebra::BlockVectorget_reaction_vector () const
const LinearAlgebra::BlockVectorget_mesh_velocity () const
const DoFHandler< dim > & get_dof_handler () const
const FiniteElement< dim > & get_fe () const
const LinearAlgebra::BlockSparseMatrixget_system_matrix () const
const LinearAlgebra::BlockSparseMatrixget_system_preconditioner_matrix () const
const MaterialModel::Interface< dim > & get_material_model () const
const GravityModel::Interface< dim > & get_gravity_model () const
const InitialTopographyModel::Interface< dim > & get_initial_topography_model () const
const GeometryModel::Interface< dim > & get_geometry_model () const
const AdiabaticConditions::Interface< dim > & get_adiabatic_conditions () const
bool has_boundary_temperature () const
const BoundaryTemperature::Manager< dim > & get_boundary_temperature_manager () const
const BoundaryHeatFlux::Interface< dim > & get_boundary_heat_flux () const
bool has_boundary_composition () const
const BoundaryComposition::Manager< dim > & get_boundary_composition_manager () const
const BoundaryTraction::Manager< dim > & get_boundary_traction_manager () const
std::shared_ptr< const InitialTemperature::Manager< dim > > get_initial_temperature_manager_pointer () const
const InitialTemperature::Manager< dim > & get_initial_temperature_manager () const
std::shared_ptr< const InitialComposition::Manager< dim > > get_initial_composition_manager_pointer () const
const InitialComposition::Manager< dim > & get_initial_composition_manager () const
const std::set< types::boundary_id > & get_fixed_temperature_boundary_indicators () const
const std::set< types::boundary_id > & get_fixed_heat_flux_boundary_indicators () const
const std::set< types::boundary_id > & get_fixed_composition_boundary_indicators () const
const std::set< types::boundary_id > & get_mesh_deformation_boundary_indicators () const
const BoundaryVelocity::Manager< dim > & get_boundary_velocity_manager () const
const HeatingModel::Manager< dim > & get_heating_model_manager () const
const MeshRefinement::Manager< dim > & get_mesh_refinement_manager () const
const MeltHandler< dim > & get_melt_handler () const
const VolumeOfFluidHandler< dim > & get_volume_of_fluid_handler () const
const NewtonHandler< dim > & get_newton_handler () const
const MeshDeformation::MeshDeformationHandler< dim > & get_mesh_deformation_handler () const
const LateralAveraging< dim > & get_lateral_averaging () const
const AffineConstraints< double > & get_current_constraints () const
bool simulator_is_past_initialization () const
double get_pressure_scaling () const
bool pressure_rhs_needs_compatibility_modification () const
bool model_has_prescribed_stokes_solution () const
TableHandler & get_statistics_object () const
const Postprocess::Manager< dim > & get_postprocess_manager () const
const Particle::World< dim > & get_particle_world () const
Particle::World< dim > & get_particle_world ()
bool is_stokes_matrix_free ()
const StokesMatrixFreeHandler< dim > & get_stokes_matrix_free () const
RotationProperties< dim > compute_net_angular_momentum (const bool use_constant_density, const LinearAlgebra::BlockVector &solution, const bool limit_to_top_faces=false) const

Static Public Member Functions

static void declare_parameters (ParameterHandler &prm)
- Static Public Member Functions inherited from aspect::Particle::Generator::Interface< dim >
static void declare_parameters (ParameterHandler &prm)
- Static Public Member Functions inherited from aspect::SimulatorAccess< dim >
static void get_composition_values_at_q_point (const std::vector< std::vector< double >> &composition_values, const unsigned int q, std::vector< double > &composition_values_at_q_point)

Private Attributes

types::particle_index n_particles
bool random_cell_selection
unsigned int random_number_seed
Functions::ParsedFunction< dim > function

Additional Inherited Members

- Protected Member Functions inherited from aspect::Particle::Generator::Interface< dim >
DEAL_II_DEPRECATED std::pair< Particles::internal::LevelInd, Particle< dim > > generate_particle (const Point< dim > &position, const types::particle_index id) const
Particles::ParticleIterator< dim > insert_particle_at_position (const Point< dim > &position, const types::particle_index id, Particles::ParticleHandler< dim > &particle_handler) const
- Protected Attributes inherited from aspect::Particle::Generator::Interface< dim >
std::mt19937 random_number_generator

Detailed Description

template<int dim>
class aspect::Particle::Generator::ProbabilityDensityFunction< dim >

Generates a random distribution of particles over the simulation domain. The particle density is determined by a user-defined probability density function in the parameter file. This is done using a "roulette wheel" style selection. Every cell is weighted by the value of the provided function at its center multiplied with the cell volume. Then a map between the accumulated cell weight and the cell index of the current cell is constructed. Consequently, a random number between zero and the global integral of the probability density function uniquely defines one particular cell. Afterwards, every process generates n_global_particles random numbers, but only generates a particle if it is the owner of the active cell that is associated with this random number.

Definition at line 62 of file probability_density_function.h.

Member Function Documentation

§ generate_particles()

template<int dim>
void aspect::Particle::Generator::ProbabilityDensityFunction< dim >::generate_particles ( Particles::ParticleHandler< dim > &  particle_handler)

Generate a set of particles in the given particle handler. The particle density is set by an analytically prescribed density function that is set as an input parameter.

[in,out]particle_handlerThe particle handler into which the generated particles should be inserted.

Reimplemented from aspect::Particle::Generator::Interface< dim >.

§ declare_parameters()

template<int dim>
static void aspect::Particle::Generator::ProbabilityDensityFunction< dim >::declare_parameters ( ParameterHandler &  prm)

Declare the parameters this class takes through input files.

§ parse_parameters()

template<int dim>
void aspect::Particle::Generator::ProbabilityDensityFunction< dim >::parse_parameters ( ParameterHandler &  prm)

Read the parameters this class declares from the parameter file.

Reimplemented from aspect::Particle::Generator::Interface< dim >.

Member Data Documentation

§ n_particles

template<int dim>
types::particle_index aspect::Particle::Generator::ProbabilityDensityFunction< dim >::n_particles

Number of particles to create

Definition at line 99 of file probability_density_function.h.

§ random_cell_selection

template<int dim>
bool aspect::Particle::Generator::ProbabilityDensityFunction< dim >::random_cell_selection

If true, particle numbers per cell are calculated randomly according to their respective probability density. If false, first determine how many particles each cell should have based on the integral of the density over each of the cells, and then once we know how many particles we want on each cell, choose their locations randomly within each cell.

Definition at line 109 of file probability_density_function.h.

§ random_number_seed

template<int dim>
unsigned int aspect::Particle::Generator::ProbabilityDensityFunction< dim >::random_number_seed

The seed for the random number generator that controls the particle generation.

Definition at line 115 of file probability_density_function.h.

§ function

template<int dim>
Functions::ParsedFunction<dim> aspect::Particle::Generator::ProbabilityDensityFunction< dim >::function

A function object representing the particle location probability density.

Definition at line 121 of file probability_density_function.h.

The documentation for this class was generated from the following file: