VORPAL Documentation Set¶
Contents:
Learning VORPAL by Example¶
Beginner Tutorials¶
If you are new to VORPAL or VorpalComposer, start with the VorpalComposer Introduction and The Simulation Process links below before starting the other tutorials.
Electrostatic Tutorial
- Electrostatic Simulation Tutorial
- Lesson 1: Boundary Conditions for Electrostatic Simulations
- Lesson 2: Increase the Number of Time Steps
- Lesson 3: Add Particle Boundary Conditions
- Lesson 4: Change Boundary Conditions at the X-Upper Wall from Dirichlet to Neumann
- Lesson 5: Modify the Electrostatic Solver
- Lesson 6: Increase the Resolution of the Simulation
Electromagnetic Tutorial
Multifield Tutorial
Solving Classical Physics Problems¶
After you are familiar with the process for performing simulations in VORPAL, you can practice applying VORPAL to classic computational physics problems. By using VORPAL for solving these familiar problems, you can assure yourself that VORPAL simulations are based on accurate physical models.
Advanced VORPAL Examples¶
Advanced VORPAL Examples will help you learn:
- what kinds of physics you can model with VORPAL
- which VORPAL features to use for modeling particular phenomena
- answers to common questions you might have when using or modifying input files
- Introduction
- basicFieldUpdates: Advanced field updates using space-time functions
- bremsXRayEmit: Bremsstrahlung X-Ray emission for electron primaries impact at wall surface
- cellSpecies: Particle infrastructure optimized for particle dominated simulations
- coldrelramp: Relativistic fluid dynamics with a laser
- crabcavpython: Advanced geometry specification
- cylHeatEqtn: Heat equation solver in cylindrical coordinates
- envelope: The laser envelope model
- externalMagnetic: Import constant external magnetic field from a data file
- fieldEmitterTxemit: field-thermal and photo emitter
- gridBndryLoad: Loading particles into a grid boundary region
- heatEqtn: Heat equation solver
- ionElecs: particle beam source and surface interaction
- linosc: Advanced electromagnetic PIC
- pmlmw: Wave absorbing boundaries
- polarAxisEM: The polar coordinate system
- shapes: Advanced cell volume calculations
- specifiedPower: Use of feedback to fix the input power
- sputter: particle beam source and surface interaction
- textFilePtclSource: Loading particle data from text files
- userDefinedIonIndSecElecEmit: user defined secondary electron emitters for ion primaries
Appendices¶
Input files used in the Beginner Tutorials:
Input files used in the Classical Physics Problems:
- dipoleLikeCharge.pre
- dipoleUnlikeCharge.pre
- lpa.pre
- modeAnalysis.pre
- modeAnalysis.py
- photonicCrystal.pre
- photonicCrystal.py
- pillbox.pre
- sMatrix.pre
- twostream.pre
- twostreamEnPlot.pro
- waveScattering01.pre
- waveScattering02.pre
- waveScattering03.pre
- waveScattering04.pre
- waveguideMetal.pre
- gasStoppingCyc.pre
- multipacting01.pre
- multipacting02.pre
Input files used in the Advanced Examples:
- basicFieldUpdates.pre
- bremXRayEmit.pre
- cellSpecies.pre
- coldrelramp.pre
- crabcavpython.pre
- crabcavpython.py
- cylHeatEqtn.pre
- envelope.pre
- envelope.py
- externalMagnetic.pre
- externalMagnetic.py
- fieldEmitterTxemit.pre
- gridBndryLoad.pre
- heatEqtn.pre
- ionElecs.pre
- linosc.pre
- pmlmw.pre
- polarAxisEM.pre
- shapes.pre
- specifiedPower.pre
- sputter.pre
- textFilePtclSource.pre
- userDefinedIonIndSecElecEmit.pre
VORPAL User Guide¶
Introduction¶
Basic Concepts¶
Simulations¶
VORPAL in depth:
- Running VorpalComposer in Parallel
- Running VORPAL from the Command Line
- HDF5 Format VORPAL Output Files
- Advanced Topics in Electrostatic Simulation
- Advanced Topics in Electromagnetic Simulation
- Modeling a Time-Dependent or Space-Dependent Value on a Boundary
- Creating a Circularly Polarized Pulse
- Launching a Pulse of Arbitrary Temporal Profile
- Launching a Wave from X-Upper Boundary of Simulation
- Absorbing a Wave
- Simulating a Non-Vacuum
- Additional Types of Electromagnetic Boundary Conditions
- Defining Multiple Electromagnetic Fields
- Advanced Topics in Particle Simulation
- Monte Carlo Interactions Package
GPU Computing¶
Troubleshooting¶
Debugging the input file:
VORPAL Reference Manual¶
Introduction¶
Input File Basics¶
GridBoundary¶
Monte Carlo Interactions¶
MonteCarloInteractions Block
IncidentSelector Block
Interactions Block
Interaction Kinds
NullInteraction Kinds
Multifield¶
Multifield Block
Field Block
FieldUpdater block
FieldMultiUpdater Block
FieldUpdater Kinds
- curlUpdater
- curlUpdaterCoordProd
- deyMittraUpdater
- deyMittraConstrainUpdater
- divUpdater
- divUpdaterCoordProd
- dummyUpdater
- edgeToNodeVec
- epetraUpdater
- faceToNodeVec
- fieldBinOpUpdater
- fieldSqrDiagUpdater
- geometryUpdater
- gradVecUpdater
- gradVecUpdaterCoordProd
- lightFrameEnvelopeUpdater
- lightFrameEnvForceUpdater
- linIterUpdater
- linPlasDielcUpdater
- m2x2VecUpdater
- neutralBoltzmannUpdater
- open
- phaseShiftVecUpdater
- poissonUpdater
- setEpsilonUpdater:
- smooth1D
- spaceScalarFieldFuncUpdater
- STFuncUpdater
- unaryFieldOpUpdater
- yeeAmpereDielVecUpdater
- yeeAmpereUpdater
- yeeConductorUpdater
- yeeFaradayUpdater
- gpuAmpereUpdater
- gpuFaradayUpdater
- gpuDeyMittraFaradayUpdater
- gpuGeometryUpdater
- gpuCopyUpdater
- gpuBinaryUpdater
- gpuEMOpen
- gpuSTFuncUpdater
UpdateStep and InitialUpdateStep Block
PmlRegion Block
Region Indices in Multifield Updaters
ScalarDepositor and VectorDepositor¶
Copyright and Trademark Information¶
VORPAL © 2002-2011 University of Colorado and Tech-X Corporation. All rights reserved.
VORPAL © 1999-2002 University of Colorado. All rights reserved.
VORPAL © 2008-2011 Tech-X Corporation. All rights reserved.
For VORPAL licensing details please email sales@txcorp.com.
All trademarks are the property of their respective owners.
Redistribution of all VORPAL simulation input file code block examples from the VORPAL 5.0 Document Set, including the VORPAL User Guide, VORPAL Reference Manual, and Learning VORPAL by Example, is allowed provided that this copyright statement is also included with the redistribution.
