insertion mode stream_regionfill command

Purpose

insertion mode stream_regionfill is used to generate a continuous particle stream to fill a region (examples).

Syntax

insertion mode stream_regionfill keyword value

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

This command is an extension of the insertion command of mode stream. All keywords of the insertion mode stream are available (please see here)

Return to the insertion documentation.

Keywords	Description
region	obligatory, ID of the target region to be filled
target_mass_region ¹	desired mass to insert range: (0,∞); units: [mass]
target_volume_fraction_region ¹	desired volume fraction for the region range: (0,1); units: [-]
target_particle_count_region ¹	desired number of particles in the region range: [1,∞); units: [-]
monte_carlo_steps	number of Monte-Carlo steps for calculating the region’s volume default: 100000; range: [1,∞); units: [-]

¹ The keywords target_particle_count_region, target_volume_fraction_region and target_mass_region are mutually exclusive.

Examples

mesh id insFace material material1 solid no file meshes/insertion_face.stl
insertion mode stream_regionfill insertion_face insFace region reg1 target_mass_region 0.5 &
     particle_distribution pd1 velocity constant ( 0, 0, -1 ) id ins2

insertion mode stream_regionfill insertion_shape circle radius 0.01 center ( 0, 0, 0 ) &
     region reg1 target_particle_count_region 1500 particle_distribution pd1 &
     velocity constant ( 0, 0, -1 ) id ins2

insertion mode stream_regionfill insertion_shape square square x_axis ( 1, 0, 0 ) length 0.1 &
     center ( 0, 0, 0 ) region reg1 target_volume_fraction_region 0.2 particle_distribution pd1 &
     velocity constant ( 0, 0, -1 ) id ins2 monte_carlo_steps 10000

Description

This command behaves like a stream insertion command, but the insertion will stop once one of these criteria is fulfilled:

Either, the total mass of particles in a specified region reaches the value set by target_mass_region, the overall volumefraction in this region reaches target_volume_fraction_region or the total number of particles in the region reaches target_particle_count_region.

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

Restrictions

None.