Species Kinds

cmplxRelBorisCylDF Species Kind

cmplxRelBorisCylDF

Works with VSimPD license.

Should be used in lieu of the cmplxRelBorisDF species kinds whenever polar, cylindrical, or tubular grids are used. An extension of the relBorisDF when one has made an expansion in either a single component direction in Cartesian coordinates or in the phi direction for cylindrical coordinates and then is left solving for the coefficients of that expansion. The coefficients are the real and imaginary field values.

Note

cmplxRelBorisCylDF is only permissible with doLinearDF = true and that it requires an understanding of setting up the proper fields in a MultiField block.

cmplxRelBorisDF Species Kind

cmplxRelBorisDF

Works with VSimPD license.

An extension of the relBorisDF when one has made an expansion in either a single component direction in Cartesian coordinates or in the phi direction for cylindrical coordinates and then is left solving for the coefficients of that expansion. The coefficients are the real and imaginary field values.

Note

cmplxRelBorisDF is only permissible with doLinearDF = true and that it requires an understanding of setting up the proper fields in a MultiField block.

<Species  electrons>
  kind = cmplxRelBorisDF
  charge = ELECCHARGE
  mass = ELECMASS
  # Must specify mode number of problem
  mode = K
  # Order matters in fields vector
  fields = [emField.nodalER emField.nodalEI emField.nodalBR emField.nodalBI]
  # Order matters in currDeps vector
  currDeps = [ JRDep JIDep ]
  bgEmField = B0
  doLinearDf = true
    .
    .
    .
</Species>

envBoris Species Kind

envBoris

Works with VSimPA license.

Describes particles that respond to both the Lorentz force and the ponderomotive force that arises in response to an envelope field in the laser envelope model.

In addition to the usual species parameters, an envBoris species requires some unique parameters, listed below.

Note

The envelope model is constructed for use with the MultiField input file architecture. See the MultiField section for more details.

freeRel Species Kind

freeRel

Works with VSimBase, VSimEM, VSimPD, VSimPA, and VSimMD licenses.

A free streaming particle model, used to calculate free streaming of a relativistic species. This does not add any extra parameters.

freeRelVW Species Kind

freeRelVW

Works with VSimBase, VSimEM, VSimPD, VSimPA, and VSimMD licenses.

A free streaming particle model, used to calculate free streaming of a variable-weight relativistic species. With variable weight methods, each particle has independent ratio of macroparticles to real particles. This does not add any extra parameters.

noMove Species Kind

noMove

Works with VSimBase, VSimEM, VSimPD, VSimPA, and VSimMD licenses.

Supports non-moving species. noMove can be used in a simulation to create a new non-moving particle that will always stay at the location defined by the particle source.

noMoveVW Species Kind

noMoveVW

Works with VSimBase, VSimEM, VSimPD, VSimPA, and VSimMD licenses.

Supports non-moving species with variable weight method. noMoveVW can be used in a simulation to create a new non-moving particle that will always stay at the location defined by the particle source.

nonRelBoris Species Kind

nonRelBoris`

Works with VSimBase, VSimEM, VSimPD, VSimPA, and VSimMD licenses.

Non-relativistic push using the Boris algorithm, used to calculate an electromagnetic Boris update to the particle velocities for non-relativistic particles.

nonRelES Species Kind

nonRelES

Works with VSimBase, VSimEM, VSimPD, VSimPA, and VSimMD licenses.

Calculates electrostatic updates to the particle velocities for non-relativistic particles; no magnetic fields affect the particles.

nonRelESEffMassExtd Species Kind

nonRelESEffMassExtd

Works with VSimSD licence.

Particle species that uses the electrostatic update to push electrons and holes in a diamond material. The essential difference to regular relBoris species is that in diamond, electrons and holes have effective masses that are different from their values in vacuum. Generally, the effective masses are represented by two-dimensional tensors. However, for holes the tensor is diagonal with equal diagonal elements. For electrons, the tensor is also diagonal but one of the components is different (longitudinal effective mass) from the other two (transverse effective masses). Moreover, the position of the longitudinal effective mass component depends on the conduction band valley an electron is in. The model includes six band valleys along each of the main coordinate axes in reciprocal space. The different effective masses are used both in the ballistic push and in the Monte Carlo scattering processes. The longitudinal and transverse effective masses, together with the different conduction band valleys lead to important effects when modeling electron emission with conservation of transverse electron momentum.

nonRelESVW Species Kind

nonRelESVW

Works with VSimBase, VSimEM, VSimPD, VSimPA, and VSimMD licenses.

Calculates electrostatic updates to the particle velocities for non-relativistic particles; no magnetic fields affect the particles. With variable weight methods, each particle has independent ratio of macroparticles to real particles. This does not add any extra parameters.

relBoris Species Kind

relBoris

Works with VSimBase, VSimEM, VSimPD, VSimPA, and VSimMD licenses.

Calculates an electromagnetic Boris update to the particle velocities.

relBorisBallisticVW Species Kind

relBorisBallisticVW

Works with VSimBase, VSimEM, VSimPD, VSimPA, and VSimMD licenses.

Creates ballistic particles. Particles are ballistic if they do not undergo acceleration. Using this kind requires the additional parameter moveDimVec, which specifies the directions in which the particle is allowed to move. For example, moveDimVec = [1 0 0] will allow movement only along the x direction, whereas moveDimVec = [0 1 1] will allow movement along the y and z directions. If moveDimVec is not specified, three-dimensional movement is the default.

relBorisCyl Species Kind

relBorisCyl

Works with VSimPD and VSimMD licenses.

Should be used in lieu of the relBoris species kinds whenever polar, cylindrical, or tubular grids are used. Provides a Boris pusher for these coordinate systems.

relBorisCylVW Species Kind

relBorisCylVW

Works with VSimPD and VSimMD licenses.

Should be used in lieu of the relBorisVW species kinds whenever polar, cylindrical, or tubular grids are used. Provides a Boris pusher with variable-weight particles for these coordinate systems.

relBorisCylVWTagged Species Kind

relBorisCylVWTagged

Works with VSimPD and VSimMD licenses.

Should be used in lieu of the relBorisVWTagged species kinds whenever polar, cylindrical, or tubular grids are used. Provides a Boris pusher with variable-weight particles for these coordinate systems. This species also allows for assigning a unique tag identifier to each macroparticle for trajectory tracking.

relBorisDF Species Kind

relBorisDF

Works with VSimPD license.

Relativistic Boris delta-F. A particle species that solves for the perturbation of the equilibrium distribution, \(\Delta f\), given that \(f = f_0 + \Delta f\). Removes a significant amount of noise from the particle-in-cell simulations. Requires vmin and vmax parameters and includes an optional doLinearDF flag that allows use of either linear DF or nonlinear DF.

relBorisCylDF Species Kind

relBorisCylDF

Works with VSimPD license.

Should be used in lieu of the relBorisDF species kinds whenever polar, cylindrical, or tubular grids are used. A relativistic Boris delta-F. A particle species that solves for the perturbation of the equilibrium distribution, \(\Delta f\), given that \(f = f_0 + \Delta f\). Removes a significant amount of noise from the particle-in-cell simulations. Requires vmin and vmax parameters and includes an optional doLinearDF flag that allows use of either linear DF or nonlinear DF.

relBorisEffMassExtd Species Kind

relBorisEffMassExtd

Works with VSimSD licence.

Particle species that uses the electromagnetic Boris update to push electrons and holes in a diamond material. The essential difference to regular relBoris species is that in diamond, electrons and holes have effective masses that are different from their values in vacuum. Generally, the effective masses are represented by two-dimensional tensors. However, for holes the tensor is diagonal with equal diagonal elements. For electrons, the tensor is also diagonal but one of the components is different (longitudinal effective mass) from the other two (transverse effective masses). Moreover, the position of the longitudinal effective mass component depends on the conduction band valley an electron is in. The model includes six band valleys along each of the main coordinate axes in reciprocal space. The different effective masses are used both in the ballistic push and in the Monte Carlo scattering processes. The longitudinal and transverse effective masses, together with the different conduction band valleys lead to important effects when modeling electron emission with conservation of transverse electron momentum.

relBorisFuncVW Species Kind

relBorisFuncVW

Works with VSimPD and VSimMD licenses.

Particle species that uses the electromagnetic Boris update to the particle velocities where the macroparticle to real particle ratio is controlled by a user-specified STFunc. Results using this species are only valid when the particle positions are displaced by a small amount from a equilibrium position by the electromagnetic fields. Useful for modeling the appearance of a plasma whose general time and density dependence are known. Requires STFunc block of arbitrary name that sets the weight of the particles; this one required block is unique to the species.

relBorisTagged Species Kind

relBorisTagged

Works with VSimBase, VSimEM, VSimPD, VSimPA, and VSimMD licenses.

Applies an electromagnetic Boris update to the particle velocities. This species assigns a unique tag identifier to each macroparticle for trajectory tracking.

relBorisVW Species Kind

relBorisVW

Works with VSimPD and VSimMD licenses.

Implementation of the relBoris update includes updates specific to variable weight algorithms. With variable weight methods, each particle has independent ratio of macroparticles to real particles.

relBorisVWScale Species Kind

relBorisVWScale

Works with VSimPD and VSimMD licenses.

Used to scan multiple power levels searching for multipacting resonances. Each particle has a scaling parameter that multiplies the electromagnetic field, allowing multiple power or voltage levels to exist in a simulation simultaneously. The use of multiple coexisting power or voltage levels is only consistent with small amounts of charge and current which have little to no effect on the applied fields. Thus, generally speaking, this species is not expected to use or require charge and/or current depositors. This species assigns a unique tag identifier to each macroparticle for trajectory tracking.

relBorisVWTagged Species Kind

relBorisVWTagged

Works with VSimBase, VSimEM, VSimPD, VSimPA, and VSimMD licenses.

Implementation of the relBoris updater that includes updates specific to variable weight algorithms. In variable weight methods, each particle has an independent ratio of macroparticles to real particles. This species also allows for assigning a unique tag identifier to each macroparticle for trajectory tracking.