Initial conditions

The following inputs are defined using the prefix ic:

Description

Type

Default

regions

Regions used to define initial conditions. Supported region shapes include a box, cylinder, and sphere.

Strings

None

allow_regions_overlap

If enabled, particles will be generated/initialized more than once on areas where the IC regions intersect. This only applied to particle initializations. Fluid initial conditions are applied in the order defined in the inputs file, with later regions overwriting earlier ones.

Int

1

For each initial condition region the reference frame is defined using the prefix ic.[region_name]:

Description

Type

Default

reference_frame

Specifies the reference frame used to interpret velocity components and initialize the flow field within the given initial‑condition region.

Options:

  • inertial: A static (laboratory) reference frame.

  • rotating: Velocity fields specified in the region are interpreted relative to the rotating frame, and internally applies the appropriate transformation.

String

inertial

Fluid settings

For each initial condition region, the fluid inputs are defined using the compound prefix ic.[region_name].[fluid_name]:

Description

Type

Default

volfrac

Volume fraction [required].

Real

None

density

Fluid density.

Real

None

velocity

Velocity components.

Reals<3>

None

temperature

Fluid temperature.

Real

None

species.[species_name]

Mass fraction of species_name. Must be a fluid species.

Real

None

Solids settings

For each initial condition region, general solids inputs are defined using the compound prefix ic.[region_name]:

Description

Type

Default

solids

Name of solid type in IC region. Only one solid is allowed in an IC region.

String

None

packing

Specifies how auto-generated particles are placed in the IC region:

Options:

  • hcp - hex-centered packing

  • pseudo_random – random packing using a fixed random seed

  • random – random packing (not repeatable)

  • oneper – one particle per cell

  • eightper – eight particles per cell

  • n-cube – n^3 particles per cell where n is an integer

(NOTE: oneper is equivalent to 1-cube and eightper

to 2-cube)

String

None

granular_temperature

Adds specified granular temperature to particles in the IC region.

Real

For each initial condition region, the solid inputs are defined using the compound prefix ic.[region_name].[solid_name]:

Description

Type

Default

volfrac

Volume fraction.

Real

None

temperature

Temperature.

Real

None

species.[species_name]

Mass fraction of species_name. Must be a solid species.

Real

None

velocity

Velocity components.

Reals<3>

None

For automatically generated particles, diameter and density distributions can be specified.

The following inputs control the diameter distribution and are defined with the prefix ic.[region_name].[solid_name].diameter

Note that diameter distributions must define a weighting type, please refer to ReferenceParticleDistributions.

A superquadric type takes no diameter inputs: its size comes from [solid_name].superquadric.semi_axes (see superquadrics).

Description

Type

Default

distribution

Type of distribution for particle diameter in the IC region. This is only used for auto-generated particles.

Options:

  • constant - specified constant

  • uniform - uniform distribution

  • normal - normal distribution

  • log-normal - log-noremal distribution

  • custom - user-defined distribution

String

None

weighting

Weighting for diameter distribution.

Options:

  • number-weighted

  • volume-weighted

String

N/A

bins

Number of bins used when discretizing the diameter distribution to approximate the number of particles within an initial condition region.

Int

64

constant

Monodisperse (single valued) particle diameter. Required for constant distributions.

Real

None

mean

Distribution mean. Required for normal and log-normal distributions.

Real

None

std

Distribution standard deviation. Required for normal and log-normal distributions.

Real

None

min

Minimum diameter to clip distribution. Required for normal, log-normal, and uniform distributions.

Real

None

max

Maximum diameter to clip distribution. Required for normal, log-normal, and uniform distributions.

Real

None

custom

File name that specifies either the cumulative or probability distribution. Required for custom distributions.

String

None

interpolate

For custom distributions, enable linear interpolation between discrete bins. This option is only available when the initial distribution probability is zero.

Bool

false

The following inputs control the density distribution and are defined with the prefix ic.[region_name].[solid_name].density:

Description

Type

Default

distribution

Type of distribution for particle density in the IC region. This is only used for auto-generated particles.

Options:

  • constant - specified constant

  • uniform - uniform distribution

  • normal - normal distribution

  • log-normal - log-noremal distribution

  • custom - user-defined distribution

String

None

constant

Monodisperse (single valued) particle diameter. Required for constant distributions.

Real

None

mean

Distribution mean. Required for normal and log-normal distributions.

Real

None

std

Distribution standard deviation. Required for normal and log-normal distributions.

Real

None

min

Minimum density to clip distribution. Required for normal, log-normal, and uniform distributions.

Real

None

max

Maximum density to clip distribution. Required for normal, log-normal, and uniform distributions.

Real

None

custom

File name that specifies either the cumulative or probability distribution. Required for custom distributions.

String

None

interpolate

For custom distributions, enable linear interpolation between discrete bins. This option is only available when the initial distribution probability is zero.

Bool

false

The following inputs set the particle bond probability and are defined with the prefix ic.[region_name].[solid_name].bond_probability:

Description

Type

Default

distribution

Type of distribution for the particle bond probability, the chance that the particle makes a bond when it first touches another. Read only with bonds on (dem.bonds.solid.model); used by dem.bonds.formation = stochastic. Without it every particle’s bond probability is 0.

Options:

  • constant - specified constant

  • uniform - uniform distribution

  • normal - normal distribution

  • log-normal - log-normal distribution

String

None

constant

Bond probability, between 0 and 1. Required for constant distributions.

Real

None

mean

Distribution mean. Required for normal and log-normal distributions.

Real

None

std

Distribution standard deviation. Required for normal and log- normal distributions.

Real

None

min

Minimum bond probability, at least 0. Required for normal, log- normal, and uniform distributions.

Real

None

max

Maximum bond probability, at most 1. Required for normal, log- normal, and uniform distributions.

Real

None

Templates

An initial condition region can build its solid from templates (see templates) instead of generating spheres. This needs mfix.particle_init_type = Auto; the region must be a box, and a run either builds grains from templates or generates spheres, not both. A grain of a clump type is a rigid clump, and one of a sphere type a bonded agglomerate (see templates). There are two ways to place the grains:

  • One template filling the region. template names the template and placement is volfrac or count. The grains’ sizes come from diameter, their volume-equivalent diameter (constant, normal, log-normal, uniform or custom, number-weighted for all but custom), and they are placed at random, the largest first. volfrac is used only with placement = volfrac.

  • Every grain listed in a file. With placement = file, each line of placement.file gives a grain’s template, center, diameter and, optionally, orientation. Grains of several templates and sizes can be mixed this way.

In both, the grain density comes from density (constant) and the velocity from velocity; packing is not used.

The following inputs are defined with the prefix ic.[region_name].[solid_name]:

Description

Type

Default

template

Template (dem.templates) the region fills with grains of this solid, in place of generating spheres. Not used with placement = file, where each grain names its own.

String

None

count

Number of grains, with placement = count.

Int

None

orientation

Orientation of each grain, unless the grain file gives one.

Options:

  • random - a random rotation

  • fixed - the template’s body axes along x, y and z

  • file - as in the file the template was designed from

String

random

placement

How the grains are placed in the region.

Options:

  • volfrac - at random, to the volume fraction volfrac

  • count - count grains at random

  • file - every grain as listed in placement.file

String

volfrac

The following inputs are defined with the prefix ic.[region_name].[solid_name].placement:

Description

Type

Default

file

With placement = file, a text file with one grain per line: the template name, the center x y z (the members’ center of mass, inside the region), the volume-equivalent diameter, and optionally an orientation as a unit quaternion w x y z that turns the template’s body axes. Text after # is a comment.

String

None

gap

Least gap between members of different grains. For bonded agglomerates with initial bonds it defaults to four times dem.bonds.contact.tolerance times the largest member radius, so that no two grains start bonded.

Real

0

random_seed

Seed for the grains’ positions, sizes and orientations.

Int

1

max_attempts

Tries per grain before the placement gives up.

Int

10000

Below is an example of a grain file with two templates; the second grain is turned 90 degrees about x.

# template  x     y     z     d     [qw qx qy qz]
flake       0.10  0.30  0.10  0.08
rod         0.25  0.30  0.10  0.05  0.7071068 0.7071068 0 0

The following input must be preceded by the prefix mfix:

Description

Type

Default

particle_init_type

Particle initialization method.

Options:

  • Auto - automatic particle generation

  • ASCIIFile - read particle data from file particle_input.dat

String

ASCIIFile

The following input must be preceded by the prefix particles:

Description

Type

Default

removeOutOfRange

Remove particles at initialization that are touching a wall.

Int

1

Below is an example for specifying an initial condition for a fluid (fluid) and one solid (solid0).

mfix.particle_init_type = Auto

particles.removeOutOfRange = 1

ic.regions  = bed0  bed1

ic.bed0.fluid.volfrac   =  0.725
ic.bed0.fluid.density   =  1.0
ic.bed0.fluid.velocity  =  0.015  0.00  0.00
ic.bed0.fluid.temperature =  383.0
ic.bed0.fluid.species.CO  =  0.3
ic.bed0.fluid.species.CO2 =  0.2
ic.bed0.fluid.species.O2  =  0.5

ic.bed0.solids  = my_solid0

ic.bed0.packing = pseudo_random

ic.bed0.my_solid0.volfrac  =  0.275
ic.bed0.my_solid0.temperature  =  400.0
ic.bed0.my_solid0.species.Fe2O3 =  0.4
ic.bed0.my_solid0.species.FeO   =  0.6

ic.bed0.my_solid0.velocity =  0.00  0.00  0.00

ic.bed0.my_solid0.diameter.distribution = constant
ic.bed0.my_solid0.diameter.constant =  100.0e-6

ic.bed0.my_solid0.density.distribution  = constant
ic.bed0.my_solid0.density.constant  = 1000.0

ic.bed1.fluid.volfrac   =  0.925
ic.bed1.fluid.density   =  1.0
ic.bed1.fluid.velocity  =  0.015  0.00  0.00
ic.bed1.fluid.temperature =  383.0
ic.bed1.fluid.species.CO  =  0.5
ic.bed1.fluid.species.CO2 =  0.5
ic.bed1.fluid.species.O2  =  0.0

ic.bed1.solids  = solid0
ic.bed1.packing = pseudo_random

ic.bed1.solid0.volfrac  =  0.075
ic.bed1.solid0.temperature  =  450.0
ic.bed1.solid0.species.Fe2O3 =  0.0
ic.bed1.solid0.species.FeO   =  1.0

ic.bed1.solid0.velocity =  0.10  0.00  0.00


ic.bed1.solid0.diameter.distribution = uniform
ic.bed1.solid0.diameter.weighting = number-weighted
ic.bed1.solid0.diameter.bins = 20
ic.bed1.solid0.diameter.min =   90.0e-6
ic.bed1.solid0.diameter.max =  110.0e-6

ic.bed1.solid0.density.distribution  = normal
ic.bed1.solid0.density.mean  = 900.0
ic.bed1.solid0.density.std  =   30.0
ic.bed1.solid0.density.min  =  800.0
ic.bed1.solid0.density.max  = 1000.0