insertion mode rate_in_region command

Purpose

insertion mode rate_in_region is used to generate a pack of particles inside a region (examples).

Note

This command is supported by Aspherix GPU.

Syntax

insertion mode pack keyword value

General insertion keywords are documented here. This document only describes the specific keywords for the insertion of a pack of particles.

Return to the insertion documentation.

Keywords

Description

region

obligatory, ID of the region where the particles will be generated

massrate ¹
mass insertion rate
range: (0,∞); units: [mass / time]

particlerate ¹
particle insertion rate
range: [1,∞); units: [1 / time]

target_mass ²
desired mass to insert
range: (0,∞); units: [mass]

target_particle_count ²
desired number of particles to insert
range: [1,∞); units: [-]

check_distance_from_subdomain_border
yes or no or maximum_radius or bounding_sphere or bounding_box, allows
to change distance to subdomain border for the insertion of nonspherical particles
default: yes (= bounding_box)

monte_carlo_steps
number of Monte-Carlo steps for calculating the region’s volume
default: 100000; range: [1,∞); units: [-]
¹ The keywords particlerate and massrate are mutually exclusive.
² The keywords target_particle_count and target_mass are mutually exclusive.

Examples

insertion mode rate_in_region region insertion_region particlerate 3000 &
      particle_distribution p1 velocity constant ( -1, 0, -3 )

insertion mode rate_in_region region insertion_region insert_every_time 1e-2 massrate 6 &
      target_mass 60 particle_distribution p1 velocity constant ( -1, 0, -3 ) id i2

insertion mode rate_in_region region insertion_region particlerate 3000 &
      target_particle_count 6000 particle_distribution p1 velocity constant ( -1, 0, -3 )

insertion mode rate_in_region region insertion_region massrate 1 &
      particle_distribution p1 velocity constant ( -1, 0, -3 ) &
      check_distance_from_subdomain_border maximum_radius monte_carlo_steps 10000

Description

The command places as many particles in a region as required for reaching a specified massrate or particlerate.

If neither of the quantities is defined, a case-dependent default particle rate is inserted.

The total number of inserted particles is limited either by the target_mass or the target_number_of_particles. The number of particles always applies to the number of particle templates / particle conglomerates for composed particles such as multispheres, fibers or concave triangulated particles.

If the general insertion keyword check_overlap is set to yes (default), optimized or legacy, then check_distance_from_subdomain_border keyword can be used to control the insertion distance of particles from processor domain borders. Valid options are maximum_radius (of a single sphere within a multisphere particle), bounding_radius (of the whole particle, the default if check_overlap = legacy), or bounding_box (only valid and the default if check_overlap = optimized).

The monte_carlo_steps keyword is used to control the number of Monte-Carlo tries that are used for the volume calculation.