PhysicalParams:¶
Class containing the physical parameters for the run.
The idea is that the parameters you get out will always be interpolated to a TimeGrid.
This is why you only are allowed to change parameters through function calls as this allows for consistent updates with TimeGrid.
The reason for this is that if something changes, it is best if only you need to look at one place.
So let us say that this would be done in the relevant implementation of Solver class instead, then if something needs special treatment in
this class, you would need to update all implementations of Solver.
However, as it is implemented now it is hard to change a variables name (as this is fetched by this class property) but you always now that it is
consistent with the TimeGrid.
Therefore, there are two sets for each supplied physical parameter, the raw supplied parameter from which the interpolation is done and the
interpolated parameter. Example rawT which is the raw usersuppplied temperature and T which is its interpolated value.
-
class
PhysicalParams¶
Properties¶
Physical quantities:¶
-
T¶
Plasma temperature (eV), given in timesteps
-
n¶
Plasma density (m^{-3}), given in timesteps
-
Z¶
Plasma effective charge, given in timesteps
-
E¶
Electric field (V/m), given in timesteps
-
B¶
(optional) Magnetic field (T), only used for calculating synchrotron radiation reaction. If a magnetic field strength is provided, a term describing momentum loss due to synchrotron emission is included in the kinetic equation. If B is empty it is not included.
-
species¶
a struct used with the species properties so that species has the fields nj, Z0NetCharge, ZAtomicNumber, times:
- nj(jspecies, times) - matrix containing number density of each species as a function of time (m -3)
- ZAtomicNumber - atomic number of each species. row vector, not a function of time
- Z0NetCharge - net charge for each species. row vector, not a function of time
- times time steps, same as the timessteps vector in
timeGrid. - NB species cannot be set from SetPhysicalParameters.
NB overrides specified
Zandnsince nj and Z0NetCharge specifies the effective charge. (Z is the fully screened value) NB only used if useScreening ~= 0
-
rawspecies¶
Usersupplied species struct (non time interpolated)
a struct used with the species properties so that species has the fields nj, Z0NetCharge, ZAtomicNumber, times:
- nj(jspecies, times) - matrix containing number density of each species as a function of time (m -3)
- ZAtomicNumber - atomic number of each species. row vector, not a function of time
- Z0NetCharge - net charge for each species. row vector, not a function of time
- times time steps, where the ionization and densities are set
- NB species cannot be set from SetPhysicalParameters.
NB overrides specified
Zandnsince nj and Z0NetCharge specifies the effective charge. (Z is the fully screened value) NB only used if useScreening ~= 0
-
rawtT¶
times where rawT is defined, user supplied but to normalized time units (normalized)
-
rawtn¶
times where rawn is defined, user supplied but to normalized time units (normalized)
-
rawtZ¶
times where rawZ is defined, user supplied but to normalized time units (normalized)
-
rawtE¶
times where rawE is defined, user supplied but to normalized time units (normalized)
-
neTotalOverneFree¶
vector containing fraction density of total electrons compared to free electrons at all timesteps. Used when specicies is used (for impurities and boltzmann operator, and bound electrons are present). If no species are used or no source is used, this is set to 1.
-
nuees¶
Collisional frequency of electron electron collisions
-
deltas¶
thermal speed over speed of light
-
EOverEc¶
Electric field over the Critical Electrical field
-
EOverED¶
Electric field over the Dreicer Electrical field
-
lnLambdas¶
Coloumb logarithm
Functions:¶
-
this = PhysicalParams(reference,timeGrid,varargin)
Set Physical properties:¶
-
setParams(this, varargin)¶
Set params in standard matlab syntax, e.i. ‘name’ followed by value. Does not support update of reference or TimeGrid.
-
setPhysicalParameters(o, T, n, Z, E, varargin)¶
Usage:
- setPhysicalParameters(T,n,Z,E)
- setPhysicalParameters(T,n,Z,E,B)
- setPhysicalParameters(T,n,Z,E,B,tT,tn,tZ,tE)
t* should be in normalized units.
If t* is in seconds, simply multiply by reference.nueeRef.
-
setspecies(this, species)¶
Sets the species struct
-
setT(this, T, tT)¶
Sets the temperature.
tT is the time at which the temperature is defined.
tT is optional if T is scalar.
tT should be in normalized units (simply if tn is in seconds, mulitply by reference.nueeRef)
-
setn(this, n, tn)¶
Sets the density (m^-3).
tn is the time at which the density is defined.
tn is optional if n is scalar.
tn should be in normalized units (simply if tn is in seconds, mulitply by reference.nueeRef)
-
setZ(this, Z, tZ)¶
Sets the charge of plasma.
tZ is the time at which the charge is defined.
tZ is optional if Z is scalar.
tZ should be in normalized units (simply if tn is in seconds, mulitply by reference.nueeRef)
-
setE(this, E, tE)¶
Sets the Electric field (V/m)
tE is the time at which the electric field is defined.
tE is optional if E is scalar.
tE should be in normalized units (simply if tn is in seconds, mulitply by reference.nueeRef)
-
setB(this, B)¶
Sets the magnetic field (Teslas).
Misc.¶
-
interpolatePhysicalParams(this)¶
-
updateRawTimes(this, nueeRefNew)¶
PHYSICALPARAMS DO NOT USE THIS FUNCTION, IT IS ONLY FOR REFERENCE CLASS. NO SOLUTION FOUND WHERE ONLY REFERENCE CLASS CAN GET THE RAW TIMES FOUND WHERE YOU ALSO CAN USE THE FUNCTION. DONT USE THIS FUNCTION UNLESS IN REFERENCE CLASS