CdrPlasmaPhysics implementation that reads plasma chemistry from a JSON input file. More...
#include <CD_CdrPlasmaJSON.H>
Public Types | |
| using | InitialDataFunction = std::function< Real(const RealVect a_position, const Real a_time)> |
| Function alias for initial data function. | |
| using | FunctionEN = std::function< Real(const Real a_E, const Real a_N)> |
| Function for encapsulating operations f = f(E,N). field in Townsend units. | |
| using | FunctionX = std::function< Real(const RealVect a_position)> |
| Function for encapsulating a function f = f(x) where x is the physical coordinates. | |
| using | FunctionEX = std::function< Real(const Real E, const RealVect x)> |
| Function for encapsulating a function f = f(E, x) where E is the electric field at physical coordinates x. | |
| using | FunctionT = std::function< Real(const Real a_T)> |
| Function for encapsulating a function f = f(T) where T is the temperature of some species. | |
| using | FunctionTT = std::function< Real(const Real a_T1, const Real a_T2)> |
| Function for encapsulating a function f = f(T1, T2) where T1/T2 are temperatures of two species. | |
Protected Types | |
| enum class | LookupMethod { Constant , FunctionX , FunctionT , FunctionTT , FunctionEN , FunctionEX , TableEN , TableEnergy , AlphaV , EtaV } |
| Enum class for distinguishing types of computation methods when computing transport data stuff. | |
| enum class | ReactionIntegrator { None , ExplicitEuler , ExplicitTrapezoidal , ExplicitMidpoint , ExplicitRK4 } |
| Enum for distinguishing integration methods. Note that 'None' just fills directly with source terms. | |
| enum class | ReactiveEnergyLoss { AddMean , SubtractMean , AddDirect , SubtractDirect , External } |
| Enum class for distinguishing how we add/lose energy when running LEA-based models. The user will specify how to do this in the chemistry file, where 'AddMean' means that we add the mean energy to the equation. Likewise, 'SubtractMean' implies removing the mean energy, and 'External' is a user-specified energy to be added/removed. | |
Static Protected Member Functions | |
| static void | throwParserError (const std::string &a_error) |
| Throw a parser error. | |
| static void | throwParserWarning (const std::string &a_warning) |
| Throw a parser warning. | |
| static bool | containsWildcard (const std::string &a_str) |
| Protect the @ character in a string. | |
| static bool | containsBracket (const std::string &a_str) |
| Protect all kinds of brackets in a string. | |
| static bool | isBracketed (const std::string &a_str) |
| Return true if string starts and ends with a parenthesis. | |
| static std::string | trim (const std::string &a_string) |
| Remove whitespace from string. | |
| static bool | doesFileExist (const std::string &a_filename) |
| Check if file exists. | |
Protected Attributes | |
| bool | m_verbose |
| Verbose or not. | |
| bool | m_plotGas |
| Plot gas pressure, density, and temperature. | |
| bool | m_plotAlpha |
| Plot Townsend ionization coefficient. | |
| bool | m_plotEta |
| Plot Townsend attachment coefficient. | |
| bool | m_discretePhotons |
| Using discrete photons or not. | |
| bool | m_skipReactions |
| A flag for skipping reactions completely. | |
| json | m_json |
| JSON definition. This is populated when calling parseJSON. | |
| ReactionIntegrator | m_reactionIntegrator |
| Reaction integrator. | |
| std::string | m_jsonFile |
| Input JSON file name. | |
| std::vector< json > | m_cdrSpeciesJSON |
| JSON entries for species in the defined field 'plasma species'. | |
| std::vector< json > | m_rteSpeciesJSON |
| JSON entries for species in photon_species. | |
| std::function< Real(const RealVect a_position, const Real a_time)> | m_initialSigma |
| Initial surface charge. | |
| FunctionX | m_gasPressure |
| Gas pressure (in Pascal). | |
| FunctionX | m_gasTemperature |
| Gas temperature (in Kelvin) | |
| FunctionX | m_gasDensity |
| Gas number density (in m^(-3)) | |
| Real | m_chemistryDt |
| Chemistry time step. | |
| std::vector< FunctionX > | m_neutralSpeciesDensities |
| Neutral species densities. | |
| std::vector< std::shared_ptr< NeutralSpeciesJSON > > | m_neutralSpecies |
| These are the neutral species. | |
| std::map< std::string, int > | m_neutralSpeciesMap |
| Map for figuring out which where in m_neutralSpecies a neutral species is found. | |
| std::map< int, std::string > | m_neutralSpeciesInverseMap |
| Inverse of m_neutralSpeciesMap. | |
| std::map< std::string, int > | m_cdrSpeciesMap |
| string-int encoding of the CDr species. | |
| std::map< int, std::string > | m_cdrSpeciesInverseMap |
| int-string encoding of the CDR species. | |
| std::map< int, bool > | m_cdrIsEnergySolver |
| int-bool encoding for determining if a solver is an energy solver. | |
| std::map< int, bool > | m_cdrHasEnergySolver |
| int-bool encoding for determining if a CDR solver HAS an associated energy solver. | |
| std::map< int, std::tuple< Real, Real, Real > > | m_cdrEnergyComputation |
| Parameters for computing the mean energy from energy density and density. | |
| std::map< int, int > | m_cdrTransportEnergyMap |
| int-int encoding for associating a transport solver with an energy solver. | |
| std::map< int, Real > | m_cdrMasses |
| Map of the species masses. This is needed for imposing BCs on the energy equations. | |
| std::map< std::string, int > | m_rteSpeciesMap |
| string-int encoding of the RTE species. | |
| std::map< int, std::string > | m_rteSpeciesInverseMap |
| int-string encoding of the RTE species. | |
| LookupMethod | m_alphaLookup |
| Lookup method for Townsend ionization coefficient. | |
| LookupMethod | m_etaLookup |
| Lookup method for Townsend attachment coefficient. | |
| Real | m_alphaConstant |
| For when we can use alpha = constant. | |
| Real | m_etaConstant |
| For when we can use eta = constant. | |
| FunctionEN | m_alphaFunctionEN |
| For when we can put alpha = alpha(E,N) as an analytic function. | |
| FunctionEN | m_etaFunctionEN |
| For when we can put eta = eta(E,N) as an analytic function. | |
| LookupTable1D< Real, 1 > | m_alphaTableEN |
| For when we can put alpha = table(E,N) | |
| LookupTable1D< Real, 1 > | m_etaTableEN |
| For when we can put eta = table(E,N) | |
| std::map< int, LookupMethod > | m_mobilityLookup |
| Mobility lookup method for each species. | |
| std::map< int, Real > | m_mobilityConstants |
| Map for constant mobilities. | |
| std::map< int, FunctionEN > | m_mobilityFunctionsEN |
| Map for function-based mobilities mu = mu(E,N) | |
| std::map< int, FunctionEX > | m_mobilityFunctionsEX |
| Map for function-based mobilities mu = mu(E,x) | |
| std::map< int, LookupTable1D< Real, 1 > > | m_mobilityTablesEN |
| Map for table-based mobilities. Stored as tables (E/N, mu*N) | |
| std::map< int, LookupTable1D< Real, 1 > > | m_mobilityTablesEnergy |
| Map for table-based mobilities as function of energy. | |
| std::map< int, LookupMethod > | m_diffusionLookup |
| Diffusion lookup method. | |
| std::map< int, Real > | m_diffusionConstants |
| Map for constant diffusion coefficients. | |
| std::map< int, FunctionEN > | m_diffusionFunctionsEN |
| Map for function-based diffusion coefficients. . | |
| std::map< int, LookupTable1D< Real, 1 > > | m_diffusionTablesEN |
| Map for table-based diffusion coefficients D = D(E,N). | |
| std::map< int, LookupTable1D< Real, 1 > > | m_diffusionTablesEnergy |
| Map for table-based diffusion coefficients as function of energy. | |
| std::map< int, LookupMethod > | m_temperatureLookup |
| Temperature lookup method. | |
| std::map< int, FunctionX > | m_temperatureConstants |
| Constant temperatures. | |
| std::map< int, LookupTable1D< Real, 1 > > | m_temperatureTablesEN |
| Temperatures as functions of E/N. | |
| std::map< int, std::string > | m_plasmaReactionDescriptions |
| Description of plasma reactions. Only used for I/O. | |
| std::map< int, LookupMethod > | m_plasmaReactionLookup |
| Map for figuring out how to look up the rate for a certain plasma reaction. | |
| std::map< int, Real > | m_plasmaReactionConstants |
| Constant plasma reaction rates. | |
| std::map< int, int > | m_plasmaReactionAlphaV |
| Plasma reaction rates that are alpha*|v|. | |
| std::map< int, int > | m_plasmaReactionEtaV |
| Plasma reaction rates that are eta*|v|. | |
| std::map< int, std::pair< int, FunctionT > > | m_plasmaReactionFunctionsT |
| Maps for functions of the type k = f(T) where T is the temperature of some species. | |
| std::map< int, std::tuple< int, int, FunctionTT > > | m_plasmaReactionFunctionsTT |
| Maps for functions of the type k = f(T1,T2) where T1 and T2 are the temperatures of some species. | |
| std::map< int, FunctionEN > | m_plasmaReactionFunctionsEN |
| Function-based plasma reaction rates. | |
| std::map< int, LookupTable1D< Real, 1 > > | m_plasmaReactionTablesEN |
| Map for table-based reaction coefficients, where k = k(E,N). | |
| std::map< int, std::pair< int, LookupTable1D< Real, 1 > > > | m_plasmaReactionTablesEnergy |
| Map for table-based reaction coefficients where k = k(energy). | |
| std::map< int, FunctionEX > | m_plasmaReactionEfficiencies |
| Scaled plasma reactions. These account for e.g. reaction efficiencies, collisional quenching, etc. | |
| std::vector< CdrPlasmaReactionJSON > | m_plasmaReactions |
| Plasma reactions. | |
| std::map< int, bool > | m_plasmaReactionPlot |
| Plot plasma reaction or not. | |
| std::map< int, std::pair< bool, int > > | m_plasmaReactionSolovievCorrection |
| Flag for whether or not reaction includes Soloviev energy correction. | |
| std::map< int, std::map< int, std::pair< ReactiveEnergyLoss, Real > > > | m_plasmaReactionEnergyLosses |
| For mapping reactive energy losses for all reactions. | |
| std::map< int, bool > | m_plasmaReactionHasEnergyLoss |
| Associative container for determining if a reaction is associated with an energy loss/gain. | |
| std::map< int, FunctionEX > | m_photoReactionEfficiencies |
| Flag for photo-reaction efficiencies. Includes Helmholtz corrections, if present. | |
| std::map< int, bool > | m_photoReactionUseHelmholtz |
| Map over the Helmholtz reconstructions. | |
| std::vector< CdrPlasmaPhotoReactionJSON > | m_photoReactions |
| Photo-reactions. | |
| std::map< int, std::list< std::pair< int, Real > > > | m_photoReactionEnergyLosses |
| Associated energy losses for a photo-reaction. | |
| std::map< int, bool > | m_photoReactionHasEnergyLoss |
| Associative container for determining if a reaction is associated with an energy loss/gain. | |
| std::map< int, LookupMethod > | m_electrodeReactionLookup |
| Lookup method for the electrode surface reaction rates. | |
| std::map< int, Real > | m_electrodeReactionConstants |
| Constant electrode reaction rate. | |
| std::map< int, FunctionEX > | m_electrodeReactionEfficiencies |
| Electrode reaction effiencies. Used for scaling reactions on electrodes in a "generic" way. | |
| std::vector< CdrPlasmaSurfaceReactionJSON > | m_electrodeReactions |
| List of electrode reactions. | |
| std::map< int, std::list< std::pair< int, Real > > > | m_electrodeReactionEnergyLosses |
| Associated energy losses for a surface reaction on electrodes. | |
| std::map< int, bool > | m_electrodeReactionHasEnergyLoss |
| Associative container for determining if a reaction is associated with an energy loss/gain. | |
| std::map< int, bool > | m_electrodeExtrapBC |
| A container which determines if we should add the extrapolated flux as an inflow condition. | |
| std::map< int, LookupMethod > | m_dielectricReactionLookup |
| Lookup method for the dielectric surface reaction rates. | |
| std::map< int, Real > | m_dielectricReactionConstants |
| Constant dielectric reaction rate. | |
| std::map< int, FunctionEX > | m_dielectricReactionEfficiencies |
| Dielectric reaction effiencies. Used for scaling reactions on dielectrics in a "generic" way. | |
| std::vector< CdrPlasmaSurfaceReactionJSON > | m_dielectricReactions |
| List of dielectric reactions. | |
| std::map< int, std::list< std::pair< int, Real > > > | m_dielectricReactionEnergyLosses |
| Associated energy losses for a surface reaction on dielectrics. | |
| std::map< int, bool > | m_dielectricReactionHasEnergyLoss |
| Associative container for determining if a reaction is associated with an energy loss/gain. | |
| std::map< int, bool > | m_dielectricExtrapBC |
| A container which determines if we should add the extrapolated flux as an inflow condition. | |
| std::map< std::pair< int, Side::LoHiSide >, std::map< int, LookupMethod > > | m_domainReactionLookup |
| Lookup method for the domain reaction rates. The pair is made up of an int representing direction (0=x, 1=y, 2=z) and a Side::LoHiSide representing side (Side::Lo, Side::Hi) | |
| std::map< std::pair< int, Side::LoHiSide >, std::map< int, Real > > | m_domainReactionConstants |
| Constant domain reaction rate. The pair is made up of an int representing direction (0=x, 1=y, 2=z) and a Side::LoHiSide representing side (Side::Lo, Side::Hi) | |
| std::map< std::pair< int, Side::LoHiSide >, std::map< int, FunctionEX > > | m_domainReactionEfficiencies |
| Domain reaction effiencies. Used for scaling reactions on domains in a "generic" way. The pair is made up of an int representing direction (0=x, 1=y, 2=z) and a Side::LoHiSide representing side (Side::Lo, Side::Hi) | |
| std::map< std::pair< int, Side::LoHiSide >, std::vector< CdrPlasmaSurfaceReactionJSON > > | m_domainReactions |
| List of domain reactions. The pair is made up of an int representing direction (0=x, 1=y, 2=z) and a Side::LoHiSide representing side (Side::Lo, Side::Hi) | |
| const std::map< char, int > | m_dirCharToInt {{'x', 0}, {'y', 1}, {'z', 2}} |
| map to translate dir from char to int | |
| const std::map< std::string, Side::LoHiSide > | m_sideStringToSide {{"lo", Side::Lo}, {"hi", Side::Hi}} |
| map to translate side from std::string to Side::LoHiSide | |
| std::map< std::tuple< int, Side::LoHiSide, int >, bool > | m_domainExtrapBC |
| A container which determines if we should add the extrapolated flux as an inflow condition. | |
 Protected Attributes inherited from Physics::CdrPlasma::CdrPlasmaPhysics | |
| Vector< RefCountedPtr< CdrSpecies > > | m_cdrSpecies |
| CDR species definitions. Subclasses populate this in their constructor. | |
| Vector< RefCountedPtr< RtSpecies > > | m_rtSpecies |
| RTE species definitions. Subclasses populate this in their constructor. | |
| int | m_numCdrSpecies |
| Number of CDR species. | |
| int | m_numRtSpecies |
| Number of RTE species. | |
Detailed Description
CdrPlasmaPhysics implementation that reads plasma chemistry from a JSON input file.
This class parses species definitions, transport coefficients, reaction rates, and boundary fluxes from a structured JSON file. Transport data (drift velocities, diffusion coefficients, ionization and attachment rates) may be specified as analytical expressions or as lookup tables in reduced-field coordinates (E/N). Reactions are parsed symbolically and evaluated at runtime by looping over the parsed reaction network.
The JSON file specifies CDR species, RTE species, neutral species, bulk reactions, photoionization reactions, and surface reactions. Energy-dependent reactions on domain boundaries are not yet supported.
Member Typedef Documentation
◆ FunctionEN
| using Physics::CdrPlasma::CdrPlasmaJSON::FunctionEN = std::function<Real(const Real a_E, const Real a_N)> |
Function for encapsulating operations f = f(E,N). field in Townsend units.
- Parameters
-
[in] a_E Electric field in SI units. [in] a_N Neutral density.
- Returns
- Returns f = f(E,N).
- Note
- a_E is in SI units and the neutral density is in m^-3.
◆ FunctionEX
| using Physics::CdrPlasma::CdrPlasmaJSON::FunctionEX = std::function<Real(const Real E, const RealVect x)> |
Function for encapsulating a function f = f(E, x) where E is the electric field at physical coordinates x.
- Parameters
-
[in] E Electric field magnitude in SI units. [in] x Physical coordinates
◆ FunctionT
Function for encapsulating a function f = f(T) where T is the temperature of some species.
- Parameters
-
[in] a_T Some temperature.
◆ FunctionTT
| using Physics::CdrPlasma::CdrPlasmaJSON::FunctionTT = std::function<Real(const Real a_T1, const Real a_T2)> |
Function for encapsulating a function f = f(T1, T2) where T1/T2 are temperatures of two species.
- Parameters
-
[in] a_T1 Some species temperature. [in] a_T2 Some other species temperature.
◆ FunctionX
Function for encapsulating a function f = f(x) where x is the physical coordinates.
- Parameters
-
[in] a_position Physical coordinates
- Returns
- Returns f(x)
◆ InitialDataFunction
| using Physics::CdrPlasma::CdrPlasmaJSON::InitialDataFunction = std::function<Real(const RealVect a_position, const Real a_time)> |
Function alias for initial data function.
- Parameters
-
[in] a_position Physical coordinates [in] a_time Time
Constructor & Destructor Documentation
◆ CdrPlasmaJSON()
Dummy constructor. Leaves object in undefined state.
This constructor is present in order to allow new derived class of CdrPlasmaJSON that instantiate without calling the all-defining base constructor.
- Parameters
-
[in] a_dummy Dummy argument.
Member Function Documentation
◆ addPhotoIonization()
|
protectedvirtual |
Add photoionization products to transport equations source terms.
- Parameters
-
[in,out] a_cdrSources Source terms for CDR densities. [in] a_rteDensities RTE mesh densities. [in] a_position Physical coordinates [in] a_E Electric field (SI units) [in] a_dt Time step [in] a_dx Grid resolution.
◆ advanceReactionNetwork()
|
overridevirtual |
Routine intended for advancing a reaction network over a time a_dt.
This routine assumes that the subsequent advance is in the form phi^(k+1) = phi^k + S*a_dt. Thus, this routine exists such that users can EITHER fill a_cdrSources and a_rteSources directly with an explicit rule, OR they can perform a fully implicit advance within this routine and set S from that.
- Parameters
-
[out] a_cdrSources Source terms for CDR equations. [out] a_rteSources Source terms for RTE equations. [in] a_cdrDensities Grid-based density for particle species. [in] a_cdrGradients Grid-based gradients for particle species. [in] a_rteDensities Grid-based densities for photons. [in] a_E Electric field. [in] a_pos Position in space. [in] a_dx Grid resolution. [in] a_dt Advanced time. [in] a_time Current time. [in] a_kappa Grid cell unit volume.
Implements Physics::CdrPlasma::CdrPlasmaPhysics.
◆ computeAlpha()
|
overridevirtual |
Compute alpha. Should return Townsend ionization coefficient.
This function is mostly used for the cell tagging classes, but can be used for reactions as well.
- Returns
- Computed alpha
- Parameters
-
[in] E E [in] a_position Position
Implements Physics::CdrPlasma::CdrPlasmaPhysics.
◆ computeCdrDielectricFluxes()
|
overridevirtual |
Compute CDR fluxes on dielectric-gas interfaces. This is used as a boundary condition in the CDR equations.
- Parameters
-
[in] a_time Time [in] a_pos Position [in] a_normal Normal vector. This points into the gas phase. [in] a_E Electric field [in] a_cdrDensities CDR densities (on the EB) [in] a_cdrVelocities Normal component of CDR velocities (on the EB). [in] a_cdrGradients Normal gradients of cdr densities [in] a_rteFluxes RTE fluxes (normal component only) [in] a_extrapCdrFluxes Extrapolated fluxes from the gas side.
- Returns
- Returns the flux on a dielectric interface cell. The vector ordering must be the same as m_cdrSpecies.
Implements Physics::CdrPlasma::CdrPlasmaPhysics.
◆ computeCdrDiffusionCoefficients()
|
overridevirtual |
Compute diffusion coefficients for the CDR equations.
- Parameters
-
[in] a_time Time [in] a_pos Position [in] a_E Electric field [in] a_cdrDensities CDR densities
- Returns
- Returns the diffusion coefficients for each CDR species. The vector ordering is the same as m_cdrSpecies.
Implements Physics::CdrPlasma::CdrPlasmaPhysics.
◆ computeCdrDomainFluxes()
|
overridevirtual |
Compute CDR fluxes through domain sides. This is used as a boundary condition in the CDR equations.
- Parameters
-
[in] a_time Time [in] a_pos Position [in] a_dir Direction (0 = x, 1=y etc) [in] a_side Side (low or high side) [in] a_E Electric field [in] a_cdrDensities CDR densities. [in] a_cdrVelocities CDR velocities (normal component only). [in] a_cdrGradients CDR gradients (normal component only) [in] a_rteFluxes RTE fluxes (normal component only) [in] a_extrapCdrFluxes Extrapolated fluxes from the gas side.
- Returns
- Computed cdr domain fluxes
Implements Physics::CdrPlasma::CdrPlasmaPhysics.
◆ computeCdrDriftVelocities()
|
overridevirtual |
Compute velocities for the CDR equations.
- Parameters
-
[in] a_time Time [in] a_pos Position [in] a_E Electric field [in] a_cdrDensities CDR densities
- Returns
- Returns the drift velocities for each CDR species. The vector ordering is the same as m_cdrSpecies.
Implements Physics::CdrPlasma::CdrPlasmaPhysics.
◆ computeCdrElectrodeFluxes()
|
overridevirtual |
Compute CDR fluxes on electrode-gas interfaces. This is used as a boundary condition in the CDR equations.
- Parameters
-
[in] a_time Time [in] a_pos Position [in] a_normal Boundary normal vector. This points into the gas phase. [in] a_E Electric field [in] a_cdrVelocities CDR velocities. Normal component only. [in] a_cdrDensities CDR densities. [in] a_cdrGradients Normal gradients of cdr densities [in] a_rteFluxes RTE fluxes (normal component only) [in] a_extrapCdrFluxes Extrapolated fluxes from the gas side.
- Returns
- Returns the flux on an electrode interface cell. The vector ordering must be the same as m_cdrSpecies.
Implements Physics::CdrPlasma::CdrPlasmaPhysics.
◆ computeEta()
|
overridevirtual |
Compute eta. Should return Townsend attachment coefficient.
This function is mostly used for the cell tagging classes, but can be used for reactions as well.
- Parameters
-
[in] a_E Electric field. [in] a_position Position
- Returns
- Computed eta
Implements Physics::CdrPlasma::CdrPlasmaPhysics.
◆ computePlasmaReactionRate()
|
protectedvirtual |
Compute the reaction rate for a plasma reaction.
This routine exists because we need to compute the rates both in advanceReactionNetwork and getPlotVariables. This function reduces code duplication.
- Parameters
-
[in] a_reactionIndex Reaction index [in] a_cdrDensities Plasma species densities. [in] a_cdrMobilities Plasma species mobilities. [in] a_cdrDiffusionCoefficients Plasma species diffusion coefficients. [in] a_cdrTemperatures Plasma species temperatures. [in] a_cdrEnergies Plasma species energies. [in] a_cdrGradients Plasma species gradients. [in] a_pos Position (physical coordinates) [in] a_vectorE Electric field (vector) [in] a_E Electric field magnitude (SI units) [in] a_Etd Electric field magnitude (Townsend units) [in] a_N Neutral density [in] a_alpha Townsend ionization coefficient [in] a_eta Townsend attachment coefficient [in] a_time Time
- Returns
- Computed plasma reaction rate
◆ computePlasmaSpeciesDiffusion()
|
protectedvirtual |
Compute the various plasma species diffusion coefficients.
- Parameters
-
[in] a_position Physical coordinates [in] a_E Electric field (SI units) [in] a_cdrDensities List of plasma species densities
- Returns
- Returns the diffusion coefficients for each CDR species. The vector ordering is the same as m_cdrSpecies.
◆ computePlasmaSpeciesEnergies()
|
protectedvirtual |
Compute the various plasma species energies. Returns a list of energies in electron-volts. We assume that temperature-energy relations are e = 3/2 * kB * T.
If a transported species is associated with an energy solver the energy is computed from e = (n_eps)/ne. Otherwise, we compute the energy and returns 3/2 * kB * T.
- Parameters
-
[in] a_position Physical coordinates [in] a_E Electric field (SI units) [in] a_cdrDensities List of plasma species densities.
- Returns
- Computed plasma species energies
◆ computePlasmaSpeciesMobilities()
|
protectedvirtual |
Compute the various plasma species mobilities.
- Parameters
-
[in] a_position Physical coordinates [in] a_E Electric field (SI units) [in] a_cdrDensities List of plasma species densities.
- Returns
- Computed plasma species mobilities
◆ computePlasmaSpeciesTemperatures()
|
protectedvirtual |
Compute the various plasma species temperatures.
- Parameters
-
[in] a_position Physical coordinates [in] a_E Electric field (SI units) [in] a_cdrDensities List of plasma species densities.
- Returns
- Computed plasma species temperatures
◆ containsBracket()
|
staticprotected |
Protect all kinds of brackets in a string.
- Parameters
-
[in] a_str Input string. If it contains any bracket we throw an error.
- Returns
- Return value
◆ containsWildcard()
|
staticprotected |
Protect the @ character in a string.
- Parameters
-
[in] a_str Input string. If it contains the at character we throw an error.
- Returns
- Return value
◆ doesFileExist()
|
staticprotected |
Check if file exists.
- Parameters
-
[in] a_filename File name
- Returns
- Return value
◆ fillSourceTerms()
|
protected |
Routine for filling the source terms in the reactive problem.
- Parameters
-
[out] a_cdrSources Contains source term for CDR equations. [out] a_rteSources Contains source terms for RTE equations. [in] a_cdrDensities CDR densities [in] a_cdrGradients CDR gradients at time a_time [in] a_E Electric field [in] a_pos Physical coordinates [in] a_dx Grid resolution [in] a_time Time [in] a_kappa Volume fraction
◆ getNumberOfPlotVariables()
|
overridevirtual |
Get number of plot variables for this physics class.
This is used by CdrPlasmaStepper for pre-allocating data that will be put in a plot file. The current implementation plots the gas pressure, temperature, and density
- Returns
- Number of plot variables
Reimplemented from Physics::CdrPlasma::CdrPlasmaPhysics.
◆ getPlotVariableNames()
|
overridevirtual |
Get plot variable names. The names and positions between this routine and getPlotVariables must be consistent!
- Returns
- Plot variable names
Reimplemented from Physics::CdrPlasma::CdrPlasmaPhysics.
◆ getPlotVariables()
|
overridevirtual |
Provide plot variables. This is used by CdrPlasmaStepper when writing plot files.
The plot variables should have length this->getNumberOfPlotVariables (as should getPlotVariableNames)
- Parameters
-
[in] a_cdrDensities Grid-based density for particle species. [in] a_cdrGradients Grid-based gradients for particle species. [in] a_rteDensities Grid-based densities for photons. [in] a_E Electric field. [in] a_dx Grid resolution. [in] a_dt Advanced time. [in] a_time Current time. [in] a_kappa Grid cell unit volume.
- Returns
- Plot variables
- Parameters
-
[in] a_position Position
Reimplemented from Physics::CdrPlasma::CdrPlasmaPhysics.
◆ getReactionSpecies()
|
protectedvirtual |
Get the int-encoding corresponding to species involved in some reaction.
- Parameters
-
[out] a_plasmaReactants Plasma reactants [out] a_neutralReactants Neutral reactants [out] a_photonReactants Photon reactants [out] a_plasmaProducts Plasma products [out] a_neutralProducts Neutral products [out] a_photonProducts Photon products [in] a_reactants Reactant names [in] a_products Reaction names
◆ initializePhotonSpecies()
|
protectedvirtual |
Initialize photon species.
This will initialize the radiative transfer species based on the "photon_species" field in the JSON file.
◆ initializePlasmaSpecies()
|
protectedvirtual |
Initialize species.
This will initialize the species based on the "plasma_species" field in the JSON file.
◆ initializeSigma()
|
protectedvirtual |
Initialize surface charge.
This will initialize the surface charge based on the "sigma" field in the JSON file. If you want more complex initial surface charges, you will have to either extend this routine or overwrite it.
◆ initialSigma()
|
overridevirtual |
Set the initial surface charge.
- Parameters
-
[in] a_time Time [in] a_pos Position
- Returns
- Return value
Implements Physics::CdrPlasma::CdrPlasmaPhysics.
◆ integrateReactions()
|
protectedvirtual |
Routine for integrating the reactive-only problem using various algorithms.
- Parameters
-
[in,out] a_cdrDensities On input, contains n(t). On output it contains n(t+dt). [out] a_photonProduction On input, should be equal to zero. On output it will contain the number of photons produced during the time step. [in] a_cdrGradients CDR gradients at time a_time [in] a_E Electric field [in] a_pos Physical coordinates [in] a_dx Grid resolution [in] a_dt Time step [in] a_kappa Volume fraction [in] a_time Description
◆ integrateReactionsExplicitEuler()
|
protected |
Routine for integrating the reactive-only problem using the explicit Euler rule.
- Parameters
-
[in,out] a_cdrDensities On input, contains n(t). On output it contains n(t+dt). [out] a_photonProduction On input, should be equal to zero. On output it will contain the number of photons produced during the time step. [in] a_cdrGradients CDR gradients at time a_time [in] a_E Electric field [in] a_pos Physical coordinates [in] a_dx Grid resolution [in] a_dt Time step [in] a_time Time [in] a_kappa Volume fraction
◆ integrateReactionsExplicitRK2()
|
protected |
Routine for integrating the reactive-only problem using a second order Runge-Kutta method.
This includes the tableu through the a_tableuAlpha parameter.
- Parameters
-
[in,out] a_cdrDensities On input, contains n(t). On output it contains n(t+dt). [out] a_photonProduction On input, should be equal to zero. On output it will contain the number of photons produced during the time step. [in] a_cdrGradients CDR gradients at time a_time [in] a_E Electric field [in] a_pos Physical coordinates [in] a_dx Grid resolution [in] a_dt Time step [in] a_time Time [in] a_kappa Volume fraction [in] a_tableuAlpha RK2 tableu alpha. Use 0.5 for midpoint and 1.0 for trapezoidal (Heun's method)
◆ integrateReactionsExplicitRK4()
|
protected |
Routine for integrating the reactive-only problem using the foruth order Runge-Kutta method.
- Parameters
-
[in,out] a_cdrDensities On input, contains n(t). On output it contains n(t+dt). [out] a_photonProduction On input, should be equal to zero. On output it will contain the number of photons produced during the time step. [in] a_cdrGradients CDR gradients at time a_time [in] a_E Electric field [in] a_pos Physical coordinates [in] a_dx Grid resolution [in] a_dt Time step [in] a_time Time [in] a_kappa Volume fraction
◆ integrateReactionsImplicitEuler()
|
protected |
Routine for integrating the reactive-only problem using the implicit Euler rule.
- Parameters
-
[in,out] a_cdrDensities On input, contains n(t). On output it contains n(t+dt). [out] a_photonProduction On input, should be equal to zero. On output it will contain the number of photons produced during the time step. [in] a_cdrGradients CDR gradients at time a_time [in] a_E Electric field [in] a_pos Physical coordinates [in] a_dx Grid resolution [in] a_dt Time step [in] a_time Time [in] a_kappa Volume fraction
◆ isBracketed()
|
staticprotected |
Return true if string starts and ends with a parenthesis.
- Parameters
-
[in] a_str Input string.
- Returns
- True if the first character in the string is ( and the last character is )
◆ isNeutralSpecies()
|
protected |
Return true if species exists in map and false otherwise.
- Parameters
-
[in] a_name Neutral species name
- Returns
- True if neutral species, false otherwise
◆ isPhotonSpecies()
|
protected |
Return true if species exists in map and false otherwise.
- Parameters
-
[in] a_name Rte species name
- Returns
- True if photon species, false otherwise
◆ isPlasmaSpecies()
|
protected |
Return true if species exists in map and false otherwise.
- Parameters
-
[in] a_name Cdr species name
- Returns
- True if plasma species, false otherwise
◆ parseDielectricReactionEnergyLosses()
|
protectedvirtual |
Parse dielectric-reaction energy losses.
- Parameters
-
[in] a_reactionIndex Reaction index. [in] a_reactionJSON Input reaction. Must be one of the entries in the 'dielectric reactions' array.
◆ parseDielectricReactionRate()
|
protectedvirtual |
Parse reaction rate for dielectric surface reactions.
- Parameters
-
[in] a_reactionIndex Reaction index. [in] a_reactionJSON Input reaction. Must be one of the entries in the 'electrode reactions' array.
◆ parseDielectricReactionScaling()
|
protectedvirtual |
Parse dielectric electrode reaction scaling for a specific reaction.
This can be used to adjust for e.g. positional or field dependence.
- Parameters
-
[in] a_reactionIndex Reaction index (this is the array index in the dielectric reaction array supplied in the JSON file) [in] a_reactionJSON JSON entry for the reaction in the JSON input file.
◆ parseDomainReactionRate()
|
protectedvirtual |
Parse reaction rate for domain reactions.
- Parameters
-
[in] a_reactionIndex Reaction index. [in] a_reactionJSON Input reaction. Must be one of the entries in the 'domain reactions' array. [in] a_sides List of the domain sides that this occurs at
◆ parseDomainReactionScaling()
|
protectedvirtual |
Parse domain reaction scaling for a specific reaction.
This can be used to adjust for e.g. positional or field dependence.
- Parameters
-
[in] a_reactionIndex Reaction index (this is the array index in the domain reaction array supplied in the JSON file) [in] a_reactionJSON JSON entry for the reaction in the JSON input file. [in] a_sides List of the domain sides that this occurs at
◆ parseElectrodeReactionEnergyLosses()
|
protectedvirtual |
Parse electrode-reaction energy losses.
- Parameters
-
[in] a_reactionIndex Reaction index. [in] a_reactionJSON Input reaction. Must be one of the entries in the 'electrode reactions' array.
◆ parseElectrodeReactionRate()
|
protectedvirtual |
Parse reaction rate for electrode surface reactions.
- Parameters
-
[in] a_reactionIndex Reaction index. [in] a_reactionJSON Input reaction. Must be one of the entries in the 'electrode reactions' array.
◆ parseElectrodeReactionScaling()
|
protectedvirtual |
Parse electrode reaction scaling for a specific reaction.
This can be used to adjust for e.g. positional or field dependence.
- Parameters
-
[in] a_reactionIndex Reaction index (this is the array index in the reaction array supplied in the JSON file) [in] a_reactionJSON JSON entry for the reaction in the JSON input file.
◆ parsePhotoReactionEnergyLosses()
|
protectedvirtual |
Parse photo-reaction energy losses.
- Parameters
-
[in] a_reactionIndex Reaction index. [in] a_reactionJSON Input reaction. Must be one of the entries in the 'photo reactions' array.
◆ parsePhotoReactionScaling()
|
protectedvirtual |
Parse scaling for photo-reactions. Includes Helmholtz corrections if doing Helmholtz reconstruction of photoionization profiles.
- Parameters
-
[in] a_reactionIndex Reaction index. [in] a_reactionJSON Input reaction. Must be one of the entries in the 'photo reactions' array.
◆ parsePlasmaReactionDescription()
|
protectedvirtual |
Parse plasma reaction descriptions.
- Parameters
-
[in] a_reactionIndex Reaction index. [in] a_reactionJSON Input reaction. Must be one of the entries in the 'plasma reactions' array. [in] a_wildcard Description
◆ parsePlasmaReactionEnergyLosses()
|
protectedvirtual |
Parse plasma reaction energy losses.
- Parameters
-
[in] a_reactionIndex Reaction index. [in] a_reactionJSON Input reaction. Must be one of the entries in the 'plasma reactions' array.
◆ parsePlasmaReactionPlot()
|
protectedvirtual |
Parse reaction plotting.
- Parameters
-
[in] a_reactionIndex Reaction index. [in] a_reactionJSON Input reaction. Must be one of the entries in the 'plasma reactions' array.
◆ parsePlasmaReactionRate()
|
protectedvirtual |
Parse reaction rate for plasma reaction.
- Parameters
-
[in] a_reactionIndex Reaction index. [in] a_reactionJSON Input reaction. Must be one of the entries in the 'plasma reactions' array.
Add the rate and lookup method.
◆ parsePlasmaReactionScaling()
|
protectedvirtual |
Parse scaling factors for reactions.
- Parameters
-
[in] a_index Reaction index. [in] a_reactionJSON Input reaction. Must be one of the entries in the 'plasma reactions' array.
◆ parsePlasmaReactionSoloviev()
|
protectedvirtual |
Parse plasma reaction energy correction.
- Parameters
-
[in] a_reactionIndex Reaction index. [in] a_reactionJSON Input reaction. Must be one of the entries in the 'plasma reactions' array.
◆ parsePlasmaSpeciesInitialData()
|
protectedvirtual |
Generate an initial data function for a given plasma species.
- Parameters
-
[in] a_json JSON field, usually (always?) describing one of the objects in the 'plasma species' field.
- Returns
- Return value
◆ parsePlasmaSpeciesInitialParticles()
|
protectedvirtual |
Generate initial particles for a given plasma species.
- Parameters
-
[in] a_json JSON field, usually (always?) describing one of the objects in the 'plasma species' field.
- Returns
- Return value
◆ parseReactionString()
|
protectedvirtual |
Parses a reaction string into reactangs and products.
- Parameters
-
[out] a_reactants Left-hand side of reaction [out] a_products Right-hand side of reaction [in] a_reaction Reaction string. Must be in format "a + b + c -> e + f + g".
◆ parseReactionWildcards()
|
protectedvirtual |
Make a reaction set into a superset. This parses wildcards '@' in reaction string.
- Parameters
-
[in] a_reactants List of reactants. Can contain wildcard. [in] a_products List of products. Can contain wildcard. [in] a_reaction JSON reaction entry.
- Returns
- Returns a list of reactants and products with wildcards replaced. The tuple entries are: <wildcard, reactants, products>
◆ parseRuntimeOptions()
|
overridevirtual |
Parse run-time class options.
Reimplemented from Physics::CdrPlasma::CdrPlasmaPhysics.
◆ sanctifyPhotoReaction()
|
protectedvirtual |
Check if a photo-reaction makes sense in terms of the species that have been defined.
This will throw errors if the species do not exist or charge is not conserved.
- Parameters
-
[in] a_reactants Reactants [in] a_products Reaction products [in] a_reaction Reaction string
◆ sanctifyPlasmaReaction()
|
protectedvirtual |
Check if a plasma-reaction makes sense in terms of the species that have been defined.
This will throw errors if the species do not exist or charge is not conserved.
- Parameters
-
[in] a_reactants Reactants [in] a_products Reaction products [in] a_reaction Reaction string
◆ sanctifySurfaceReaction()
|
protectedvirtual |
Check if a surface-reaction makes sense in terms of the species that have been defined.
- Parameters
-
[in] a_reactants Reactants [in] a_products Reaction products [in] a_reaction Reaction string
◆ sanityCheckSpecies()
|
protectedvirtual |
Do a species sanity check.
This will make sure that species names are not duplicates.
◆ throwParserError()
|
staticprotected |
Throw a parser error.
- Parameters
-
[in] a_error Error code.
◆ throwParserWarning()
|
staticprotected |
Throw a parser warning.
- Parameters
-
[in] a_warning Warning
◆ trim()
|
staticprotected |
Remove whitespace from string.
- Returns
- Return value
- Parameters
-
[in,out] a_string Description
Member Data Documentation
◆ m_cdrEnergyComputation
|
protected |
Parameters for computing the mean energy from energy density and density.
The energy is computed as e = max(Emin, min(Emax, E)) where E = n_energy/(min(n_density, safety));
◆ m_cdrMasses
Map of the species masses. This is needed for imposing BCs on the energy equations.
This is populated in initializePlasmaSpecies.
◆ m_cdrSpeciesInverseMap
|
protected |
int-string encoding of the CDR species.
This is needed because we sometimes need to use the species name for indexing in the vector.
- Note
- This is the inverse of m_cdrSpeciesMap
◆ m_cdrSpeciesMap
|
protected |
string-int encoding of the CDr species.
This is needed because we sometimes need to use the species name for indexing in the vector.
◆ m_cdrTransportEnergyMap
int-int encoding for associating a transport solver with an energy solver.
This is only defined for the species that has/is an energy solver. The first index is the transport solver index and the second index is the energy solver index.
◆ m_dielectricReactionEnergyLosses
|
protected |
Associated energy losses for a surface reaction on dielectrics.
The list is a list of species and the corresponding energy losses for a reaction. Note that although we write 'loss', this can also be an energy 'gain'.
◆ m_diffusionTablesEN
|
protected |
Map for table-based diffusion coefficients D = D(E,N).
Tables stored as (E/N, D*N)
◆ m_diffusionTablesEnergy
|
protected |
Map for table-based diffusion coefficients as function of energy.
Stored as tables (eV, D*N)
◆ m_domainExtrapBC
|
protected |
A container which determines if we should add the extrapolated flux as an inflow condition.
The first entry in the map is the species integer index. The tuple indicates (coordinate_direction, side, doExtrap).
◆ m_electrodeReactionEnergyLosses
|
protected |
Associated energy losses for a surface reaction on electrodes.
The list is a list of species and the corresponding energy losses for a reaction. Note that although we write 'loss', this can also be an energy 'gain'.
◆ m_mobilityTablesEnergy
|
protected |
Map for table-based mobilities as function of energy.
Stored as tables (eV, mu*N)
◆ m_photoReactionEnergyLosses
|
protected |
Associated energy losses for a photo-reaction.
The list is a list of species and the corresponding energy losses for a reaction. Note that although we write 'loss', this can also be an energy 'gain'.
◆ m_plasmaReactionEnergyLosses
|
protected |
For mapping reactive energy losses for all reactions.
The index in the first map is the reaction (i.e., index in m_plasmaReactions). The second map determines how reactive energy losses/gains are computed for each species. The first index in the second map indicates the species which will add/lose energy, and the std::pair indicates how this loss is computed.
◆ m_plasmaReactionFunctionsT
|
protected |
Maps for functions of the type k = f(T) where T is the temperature of some species.
In the tuple the first index in the pair indicates the species we are talking about here. A special rule is enforced when this index is < 0 in which case the temperature is replaced by the background gas temperature.
◆ m_plasmaReactionFunctionsTT
|
protected |
Maps for functions of the type k = f(T1,T2) where T1 and T2 are the temperatures of some species.
This signature is absolute horrific – what it means is that we have a reaction which should be evaluated as f(T1, T2), but we need to know which species are involved. By design, this should be general so that T1 and T2 can be the temperatures of any species, including neutral species. So, we make a tuple for indicating which species we are talking about. The first index in the tuple is the first species, the second is the second species and the third entry in the tuple is the actual function. A special rule occurs if one of the first two indices is < 0 in which case the temperature is replaced by the background gas temperature.
◆ m_plasmaReactionSolovievCorrection
|
protected |
Flag for whether or not reaction includes Soloviev energy correction.
If this is true, the rate for a reaction (in the local field approximation) will be modified as k * (1 + E.(D * grad(phi))/n *
◆ m_plasmaReactionTablesEnergy
|
protected |
Map for table-based reaction coefficients where k = k(energy).
The first index is the reaction index, while the pair describes which species energy and the tabulated data.
◆ m_rteSpeciesInverseMap
|
protected |
int-string encoding of the RTE species.
This is needed because we sometimes need to use the species name for indexing in the vector.
- Note
- This is the inverse of m_rteSpeciesMap
◆ m_rteSpeciesMap
|
protected |
string-int encoding of the RTE species.
This is needed because we sometimes need to use the species name for indexing in the vector.
The documentation for this class was generated from the following files:
- Physics/CdrPlasma/PlasmaModels/CdrPlasmaJSON/CD_CdrPlasmaJSON.H
- Physics/CdrPlasma/PlasmaModels/CdrPlasmaJSON/CD_CdrPlasmaJSON.cpp
