Recent changes to common options

common options modified by Alex Valavanis

Alex Valavanis — Sat, 23 Apr 2016 17:00:27 -0000

--- v24
+++ v25
@@ -58,6 +58,7 @@

 ~~~~
 --Te # Carrier temperature [K]
+--Tl # Lattice temperature [K]
 ~~~~

 Precision

common options modified by Alex Valavanis

Alex Valavanis — Wed, 23 Mar 2016 10:07:41 -0000

--- v23
+++ v24
@@ -1,4 +1,4 @@
-This page documents a range of widely-used command-line options that are understood by multiple programs in the QWWAD suite:
+This page documents a range of widely-used **command-line options** that are understood by multiple programs in the QWWAD suite.  Options, which are only specifically applicable to one or two specialised programs are not listed here.

 Naming conventions
 ----
@@ -35,6 +35,7 @@

 ~~~~
 --alpha       # Non-parabolicity parameter [1/eV]
+--dcpermittivity # The relative dc permittivity for the entire structure
 --mass        # Effective mass of a particle, at the band-edge, relative to free
               # electron
 --wellmass    # Effective mass of a particle, at the band-edge, relative to free

common options modified by Alex Valavanis

Alex Valavanis — Sat, 12 Mar 2016 09:05:58 -0000

--- v22
+++ v23
@@ -65,6 +65,7 @@

 ~~~~
 --dE      # Step between energy samples [meV]
+--dt      # Step between time samples [s]
 --nenergy # Number of energy samples
 --nk      # Number of wave-vector samples
 --dzmax   # Maximum separation between spatial samples [angstrom]
@@ -83,6 +84,7 @@
 --nst     # Exact number of eigenstates to find
 --nstmax  # Maximum number of eigenstates to find
 --state   # A specific state index to study
+--time    # Total time for propagation of the simulation [s]
 ~~~~

 Filenames
@@ -100,8 +102,10 @@
 --dopingfile     # Name of the file that specifies the volume doping profile
 --energyfile     # Name of the file that specifies the energy eigenstates
 --interfacesfile # Name of the file that specifies interface locations in a heterostructure
+--infile         # Name of the file containing general input data
 --layerfile      # Name of the file that describes the layers in a heterostructure
 --massfile       # Name of the file that describes the (quantization) effective mass profile
+--outfile        # Name of the file containing general output data
 --populationfile # Name of file containing subband populations
 --totalpotentialfile # Name of the file that specifies the total confining potential
 --wffileprefix   # Prefix to use in wavefunction filenames

common options modified by Alex Valavanis

Alex Valavanis — Sat, 05 Mar 2016 15:42:34 -0000

--- v21
+++ v22
@@ -26,6 +26,7 @@
 ~~~~
 --barrierwidth # Width of barrier [angstrom]
 --wellwidth    # Width of quantum well [angstrom]
+--nper    # Number of periods within a periodic structure
 ~~~~

 Band structure
@@ -47,6 +48,7 @@
 --barrierpotential # The potential of the barriers [meV]
 --wavevector  # The wave-vector of the state being considered expressed relative
               # to pi/L, where L is the period length of the structure
+--nval        # The number of equivalent valleys in the band-edge
 ~~~~

 Temperature
@@ -69,7 +71,6 @@
 --zresmin # Minimum resolution of spatial samples [1/angstrom]
 --nz      # Number of spatial samples to use in calculations or output
 --nz1per  # Number of spatial samples within one period of a periodic structure
---nper    # Number of periods within a periodic structure
 ~~~~

 Calculation range

common options modified by Alex Valavanis

Alex Valavanis — Sat, 05 Mar 2016 15:24:52 -0000

--- v20
+++ v21
@@ -42,6 +42,7 @@
               # free electron, within the BARRIER region
 --particle    # The species of particle being considered 'e'=electron;
               # 'l'=light-hole; 'h'=heavy-hole
+--ptype       # Specifies the system as being p-doped
 --vcb         # Band-edge potential [meV]
 --barrierpotential # The potential of the barriers [meV]
 --wavevector  # The wave-vector of the state being considered expressed relative

common options modified by Alex Valavanis

Alex Valavanis — Sat, 05 Mar 2016 15:24:12 -0000

--- v19
+++ v20
@@ -91,13 +91,16 @@
 --alloyfile      # Name of the file that specifies the nominal alloy composition
 --alphafile      # Name of the file that specifies the band-edge non-parabolicity parameter (in the growth direction)
 --bandedgepotentialfile # Name of the file that specifies the band edge potential profile
+--carrierdensityfile # Name of the file that specifies the carrier density profile
 --chargefile     # Name of the file that specifies the charge density profile
 --dcpermittivityfile # Name of the file that specifies the dc permittivity profile
+--degeneracyfile # Name of the file containing subband degeneracies
 --dopingfile     # Name of the file that specifies the volume doping profile
 --energyfile     # Name of the file that specifies the energy eigenstates
 --interfacesfile # Name of the file that specifies interface locations in a heterostructure
 --layerfile      # Name of the file that describes the layers in a heterostructure
 --massfile       # Name of the file that describes the (quantization) effective mass profile
+--populationfile # Name of file containing subband populations
 --totalpotentialfile # Name of the file that specifies the total confining potential
 --wffileprefix   # Prefix to use in wavefunction filenames
 --wffileext      # Extension to use in wavefunction filenames

common options modified by Alex Valavanis

Alex Valavanis — Sat, 05 Mar 2016 13:28:44 -0000

--- v18
+++ v19
@@ -80,6 +80,7 @@
 --nkbt    # Maximum energy to consider, in multiples of Boltzmann constant times carrier temperature
 --nst     # Exact number of eigenstates to find
 --nstmax  # Maximum number of eigenstates to find
+--state   # A specific state index to study
 ~~~~

 Filenames

common options modified by Alex Valavanis

Alex Valavanis — Sat, 05 Mar 2016 13:15:21 -0000

--- v17
+++ v18
@@ -91,6 +91,7 @@
 --alphafile      # Name of the file that specifies the band-edge non-parabolicity parameter (in the growth direction)
 --bandedgepotentialfile # Name of the file that specifies the band edge potential profile
 --chargefile     # Name of the file that specifies the charge density profile
+--dcpermittivityfile # Name of the file that specifies the dc permittivity profile
 --dopingfile     # Name of the file that specifies the volume doping profile
 --energyfile     # Name of the file that specifies the energy eigenstates
 --interfacesfile # Name of the file that specifies interface locations in a heterostructure

common options modified by Alex Valavanis

Alex Valavanis — Sat, 05 Mar 2016 13:05:41 -0000

--- v16
+++ v17
@@ -90,6 +90,7 @@
 --alloyfile      # Name of the file that specifies the nominal alloy composition
 --alphafile      # Name of the file that specifies the band-edge non-parabolicity parameter (in the growth direction)
 --bandedgepotentialfile # Name of the file that specifies the band edge potential profile
+--chargefile     # Name of the file that specifies the charge density profile
 --dopingfile     # Name of the file that specifies the volume doping profile
 --energyfile     # Name of the file that specifies the energy eigenstates
 --interfacesfile # Name of the file that specifies interface locations in a heterostructure

common options modified by Alex Valavanis

Alex Valavanis — Sat, 24 Oct 2015 10:52:06 -0000

--- v15
+++ v16
@@ -91,8 +91,11 @@
 --alphafile      # Name of the file that specifies the band-edge non-parabolicity parameter (in the growth direction)
 --bandedgepotentialfile # Name of the file that specifies the band edge potential profile
 --dopingfile     # Name of the file that specifies the volume doping profile
+--energyfile     # Name of the file that specifies the energy eigenstates
 --interfacesfile # Name of the file that specifies interface locations in a heterostructure
 --layerfile      # Name of the file that describes the layers in a heterostructure
 --massfile       # Name of the file that describes the (quantization) effective mass profile
 --totalpotentialfile # Name of the file that specifies the total confining potential
+--wffileprefix   # Prefix to use in wavefunction filenames
+--wffileext      # Extension to use in wavefunction filenames
 ~~~~