Skip to main content

Parameters

Everything a case needs is passed as keyword arguments to Parameters(...). This page lists all keys, grouped by what they do, with the value that applies when the key is left out.

Two rules apply to all of them: the object is validated at start-up (a wrong type or format stops the script), and unknown keywords are a Python error, not a warning — a misspelled key does not silently fall back to its default.

Run identity and output​

KeyTypeDefaultMeaning
NAMEstrrequiredName of the run. The run directory is created with this name next to the script
DTfloatrequiredTime step in seconds. Must not be larger than TSIM
TSIMfloatrequiredSimulated time in seconds
MESH_FILEstrrequiredGmsh mesh file
UNITfloat1.0Length unit of the mesh, in metres
DUMP_PATHstr"dumps"Subdirectory of the run directory for all dumps
LOGFILE_PATHstr"logfiles"Subdirectory of the run directory for the log files
LOGFILE_SERVERstr"log_server"Base name of the server log; .txt is appended
LOGFILE_CLIENTstr"log_client"Base name of the client logs, one per rank
SEED_FOR_FIRST_CLIENTint-1Seed of the random number generator. A negative value leaves the seed to the system
VERBOSE_SERVERintVERBOSE_NONEVerbosity of the server, as a combination of VERBOSE_* flags
VERBOSE_CLIENTintVERBOSE_NONEVerbosity of the clients

Dump files are named <NAME>_<file_template> inside DUMP_PATH. additional_path of a dumper instance adds another level below it.

Domain​

KeyTypeDefaultMeaning
BB6 floatsrequiredBounding box (x_min, y_min, z_min, x_max, y_max, z_max) in UNIT
BB_OPTIONS3 intsrequiredBehaviour of the box per direction: BB_SOLID, BB_PERIODIC, BB_OUT_MIN, BB_OUT_MAX, BB_OUT
MESH_DIVISION3 intsrequiredResolution of the internal element lookup grid per direction; the product is the number of grid cells
BORDER_TYPESdictrequiredNamed Border objects, each with the icodec of a physical group

A physical group that is not listed in BORDER_TYPES is not a wall for the particles: a particle that reaches it crosses it as if it were open space.

Physics switches​

The switches are integers, and any non-zero value means on.

KeyDefaultMeaning
USE_GRAVITY1Weight, from the GRAVITY field
USE_ELECTRIC_FORCE1Coulomb force qE
USE_MAGNETIC_FORCE1Lorentz force qv×B
USE_POLARIZATION_FORCE0Force on the induced dipole in a field gradient
USE_COLLISIONAL_DRAG1Friction with the neutral gas
USE_COULOMB_DRAG1Ion drag from Coulomb collisions
USE_COLLISIONAL_THERMOPHORESIS1Thermophoresis in the neutral gas
USE_COULOMB_THERMOPHORESIS1Thermophoresis in the plasma
USE_PARTICLE_CURRENTS1Charge the particles from the plasma species
USE_DEBYE_POLARIZATION_FORCE0Force from the polarised ion cloud
REFLECTION_COEFFICIENT1.0Gas-surface scattering: 1.0 specular, 0.0 full accommodation
LOW_KNUDSEN_NEUTRAL_GAS_CALCULATION0Use the continuum (Stokes) form of the neutral gas terms instead of the free-molecular one
MORE_ACCURATE_COULOMB_FORCE_CALCULATION0More expensive evaluation of the Coulomb interaction
CALCULATE_MESH_CONNECTIONS1Build the connectivity graph of touching particles (agglomerates)
REFERENCE_TEMPERATURE300.0Reference temperature for the gas property model, in K
REFERENCE_PRESSURE101325.0Reference pressure for the gas property model, in Pa

Numerical and termination control​

KeyDefaultMeaning
MINOR_TIME_STEP_COUNT1Sub-steps per DT; a negative value is treated as 1
WALL_MODULUS1Parity of the inside-the-wall test; flip it for an inverted mesh orientation
CHECK_FOR_WALLS0Test whether a particle is inside a wall volume, not only on a crossing
CHECK_ALL_SURFACE_ANGLES_FOR_ROLLING_PARTICLES0Check all normals of an element for a rolling particle
TEMPERATURE_DIFFERENCE_FOR_INSTANT_EQUILIBRIUM10.0Temperature change per step above which a droplet is set to the gas temperature
MINIMUM_PARTICLE_SIZE0.0Radius at which a droplet is reset; 0 means the radius of the dry core
DELETE_PARTICLES_IF_INVALID_CHARGE0Remove a particle whose charge became unphysical
TERMINATION_LEVEL_IF_ALL_PARTICLES_VANISHEDNO_TERMINATIONWhat happens when no particle is left: NO_TERMINATION, TERMINATION_LEVEL_1, TERMINATION_LEVEL_2

TERMINATION_LEVEL_IF_ALL_PARTICLES_VANISHED is the switch to keep a long run from burning wall-clock time on an empty box: a case whose particles have all left or stuck produces nothing after that moment.

Content​

KeyTypeMeaning
SPECIES_LISTdict of SpeciesThe traced particle species, by name
PLASMA_SPECIES_LISTdict of PlasmaSpeciesThe plasma species that charge the particles; may be empty
BORDER_TYPESdict of BorderThe walls, by name
DUMPER_INSTANCESdict of DumperInstanceThe output files, by name
ELECTRICFieldElectric field, constant or from a potential file
MAGNETICFieldMagnetic field
GRAVITYFieldGravity

The three field slots may be None; a slot that is None and a switch that is on is not an error, the field simply contributes nothing.

Species keys​

Species describes the traced particle:

KeyDefaultMeaning
size_distribution_typeDISTRIBUTION_CONSTANTDISTRIBUTION_CONSTANT, DISTRIBUTION_UNIFORM, DISTRIBUTION_LOG_NORMAL, DISTRIBUTION_WEIBULL
size_distribution_param_11.0First radius parameter in metres (bound, mean or scale depending on the distribution)
size_distribution_param_20.0Second radius parameter (upper bound or width)
size_distribution_param_int0Integer parameter of the distribution
mass_density1.0Density of the particle material in kg/m³
dry_mass_density1.0Density of the non-volatile core
initial_charge_density0.0Initial charge per volume in C/m³
relative_permittivity1.0For the polarisation force
hamaker_constant1.0e-19For the van der Waals adhesion, in J
minimum_wall_distance4.0e-10Distance at which the adhesion is evaluated, in m
vapor_gas_constant1.0Vapour property of the condensable component
latent_heat1.0Latent heat of evaporation
dT_latent_heat0.0Temperature dependence of the latent heat
dT_mass_density0.0Temperature dependence of the density
saturation_pressure1.0Saturation pressure of the vapour
dT_saturation_pressure0.0Temperature dependence of the saturation pressure
diffusivity1.0Diffusion coefficient of the vapour in the gas
diffusivity_exponent1.0Temperature exponent of the diffusivity
molar_fraction1.0Molar fraction of the condensable component
specific_heat_p1.0Specific heat at constant pressure

Warning: the defaults are placeholders, not physical values. In particular mass_density = 1.0 and hamaker_constant = 1e-19 are only sensible for a rough test; a real case sets at least the density, the size distribution and, if adhesion matters, the Hamaker constant of the material pair.

PlasmaSpecies describes a species of the background plasma or gas:

KeyDefaultMeaning
mass1.0Particle mass in kg, e.g. 40*AMU
charge0Charge number, −1 for electrons, +1 for singly charged ions
densityFieldNumber density
temperatureFieldTemperature
velocityFieldDrift velocity, vector
pressureFieldPressure
energyFieldEnergy
temperature_gradientFieldFor thermophoresis
pressure_gradientFieldPressure gradient
heat_fluxFieldHeat flux
cross_section3.0e-19Collision cross-section in m², for the Knudsen number
specific_heat_p1.0Specific heat at constant pressure
heat_conductivity, dT_heat_conductivity1.0, 0.0Thermal conductivity and its temperature dependence
dynamic_viscosity, dT_dynamic_viscosity1.0, 0.0Dynamic viscosity and its temperature dependence
relative_humidity1.0Humidity of the gas, for droplet evaporation

Border and DumperInstance are documented with the fields they set on the scenario page and in the output section.