VSim Reference¶
Overview¶
The VSim Reference manual describes in detail all Visual Setup parameters, all Vorpal input file blocks, and all macros that can be used.
VSim [VSi] is an arbitrary dimensional, electromagnetics and plasma simulation code consisting of two major components:
VSimComposer, the graphical user interface.
Vorpal [NC04], the VSim Computational Engine.
VSim also includes many more items such as Python, MPI, data analyzers, and a set of input simplifying macros.
Visual Setup¶
Text Setup¶
Global Variables¶
Grid¶
Decomposition¶
GridBoundary¶
GridBoundary Blocks¶
STRgn Blocks¶
EM Field¶
EmField Block¶
EmField Block Kinds¶
ComboEmField Block¶
Multifield¶
Multifield Block¶
Field Block¶
FieldUpdater Block¶
FieldUpdater Kinds¶
CPU updaters:¶
- copyCrossDev
- curlUpdater
- curlUpdaterCoordProd
- cutCellPoisson
- cylEdgeToNodeVec
- deyMittraConstrainUpdater
- deyMittraUpdater
- divUpdater
- divUpdaterCoordProd
- dummyUpdater
- edgeToNodeVec
- faceToNodeVec
- fieldBinOpUpdater
- geometryUpdater
- gradBndryUpdater
- gradVecUpdater
- gradVecUpdaterCoordProd
- importFromFileUpdater
- lightFrameEnvelopeUpdater
- lightFrameEnvForceUpdater
- linearApplyUpdater
- linearSolveUpdater
- linIterUpdater
- linPlasDielcUpdater
- malUpdater
- multiDielectricUpdater
- neutralBoltzmannUpdater
- open
- permittivityUpdater
- phaseShiftVecUpdater
- potentialUpdater
- setEpsilonUpdater
- smooth1D
- STFuncUpdater
- transferFromCrossDev
- transferToCrossDev
- unaryFieldOpUpdater
- userFuncUpdater
- yeeAmpereDielVecUpdater
- yeeAmpereUpdater
- yeeFaradayUpdater
CrossDev updaters:¶
FieldMultiUpdater Block¶
FieldMultiUpdater Kinds¶
MatrixFiller Block¶
MatrixFiller Kinds¶
[CoordProd]STFuncStencilElement Block¶
VectorReader Block¶
VectorReader Kinds¶
VectorWriter Block¶
VectorWriter Kinds¶
LinearSolver Block¶
LinearSolver Kinds¶
Scalar Block¶
Updater Blocks for Scalars¶
Updater Kinds for Scalars¶
UpdateStep and InitialUpdateStep Block¶
PmlRegion Block¶
Region Indices in Multifield Updaters¶
DielectricShape Block¶
ConductorShape Block¶
Conductor Block¶
ScalarDepositor and VectorDepositor¶
SumRhoJ¶
Fluid¶
Species¶
Species Blocks¶
Species Kinds¶
ParticleSink Blocks¶
ParticleSink Kinds¶
ParticleSource Blocks¶
ParticleSource Kinds¶
Generalized Sources:¶
Specialized Sources:¶
Secondary Sources:¶
PositionGenerator Block¶
PositionGenerator Kinds¶
VelocityGenerator Block¶
VelocityGenerator Kinds¶
Reactions¶
Reactions Blocks¶
Rates and Cross-Sections¶
Interactions (productGenerators)¶
- Binary Elastic
- Electron Scatter
- Binary Excitation
- Charge Exchange
- Binary Reaction
- Electron Attachment
- Negative Ion Detachment
- Impact Ionization
- Electron Ionization
- Dissociative Ionization
- Field Ionization
- Decay
- Binary Recombination
- Three Body Recombination
- Dissociative Recombination
- Electron Impact Dissociation
- Radiation Reaction
ImpactCollider / ImpactCollision¶
ImpactCollider Block¶
ImpactCollision Block¶
Monte Carlo Interactions (DEPRECATED)¶
Note
Collisions set up using the Monte Carlo Interactions frame work will still work in VSim 10 simulations, but we recommend converting simulations to the new Reactions Framework
MonteCarloInteractions Block¶
IncidentSelector Block¶
Interaction/NullInteraction Blocks¶
Interaction Kinds¶
Fully-Kinetic Interactions:¶
Partially-Kinetic Interactions:¶
Partially-Kinetic Interactions working with a neutral Fluid block:¶
NullInteraction Kinds¶
NullInteractions:¶
NullInteractions working with a neutralGas Fluid block:¶
Using Cross Section Data¶
History¶
Field History¶
Particle History¶
History Operation Histories¶
Feedback Histories¶
Scalar Histories¶
Tensor Histories¶
Feedback¶
External Circuit Model¶
Functions¶
NAFunc¶
OAFunc¶
STFunc¶
- STFunc Block
- cacheFunc
- chirpWavePulse
- constantFunc
- cosineFlattop
- cosineRamp
- expression (STFunc)
- feedbackSTFunc
- gaussian
- gaussianPulse
- halfSinePulse
- historyAsSTFunc
- ignoreArgFunc
- inverseFunc
- leakychannel
- multFunc
- planeWavePulse
- radialCosChannel
- scalarFunc
- sinePlaneWave
- sumFunc
- stPyFunc
- tagGen
- userFuncExpression
SVTFunc¶
Slab Block¶
Macros¶
Introduction to Macros¶
Selective Processing¶
Utility Macros¶
Directed Macros¶
Postprocessing Tools¶
Engine (Vorpal) Execution¶
Analyzers¶
Guide to Analyzers¶
Available Analyzers¶
- addPtclComponentKEeV.py
- annotateFieldOnLine.py
- annotateSpeciesAbsPtclData2.py
- annnotateSpeciesDataOnPlane.py
- compareFields.py
- compute2DantennaGainAndPhase.py
- computeAED.py
- computeBeam2ModeCoupling.py
- computeCavityG.py
- computeCumulativeSumHistory.py
- computeDebyeLength.py
- computeWaveguideModes.py
- computeEmittanceFromDump.py
- computeEmittanceOnPlane.py
- computeFarFieldFromKirchhoffBox.py
- computeFarFieldRadiation.py
- computeFieldCrossProduct.py
- computeFieldMaxAmplitude.py
- computeFieldRelIntensityHilbert.py
- computeGradient.py
- computeInverseQ.py
- computeMassFlux.py
- computePtclBalance.py
- computePtclImpactSpectrum.py
- computePtclLimits.py
- computePtclNumDensity.py
- computeS11Parameters.py
- computeSParamsFromHists.py
- computeSParamsViaOverlapIntegral.py
- computeSpectrogram.py
- computeTimeSeriesAmplitude.py
- computeTimeSeriesFrequency.py
- computeTransitTimeFactor.py
- convertFieldComponentCartToCylX.py
- convertFieldComponentCartToCylZ.py
- convertPtclComponentsCartToCylX.py
- convertPtclComponentsCartToCylZ.py
- createMissingPtclsDumps.py (deprecated in VSim 11)
- createParticleTracks.py
- exportSpecies.py
- extractModes.py
- extractModesViaOperator.py
- hfssToVsh5.py
- performLowPassFilter.py
- performTwoHistoryArithmetic.py
- putFieldOnSurfaceMesh.py
- removePtclComponent.py
- subselectParticles.py
- truncateHistory.py
- writeCutCellField.py