XSim Reference
Overview
The XSim Reference manual describes in detail
Visual Setup parameters
Vorpal input file blocks
Macros
Analyzers
XSim [XSi] is an arbitrary dimensional, electromagnetics and electrostatics simulation code consisting of two major components:
XSimComposer, the graphical user interface.
Vorpal [NC04], the XSim Computational Engine.
XSim also includes many more items such as Python, MPI, data analyzers, and a set of input simplifying macros.
Visual Setup
Text Setup
Setup Basics
Text-based (.pre) Input File Structure
Global Variables
Device Selection
Grid
Decomposition
GridBoundary
Multifield
- ..toctree::
- maxdepth:
1
xsimref_mf_regularcrossdev.rst
Multifield Block
Field Block
FieldUpdater Block
FieldUpdater Kinds
- applyVolAvgInvEpsCrossDev
- applyVolAvgInvEpsPostLossCrossDev
- applyVolAvgInvEpsPreLossCrossDev
- compCurlCrossDev
- compCurlCylCrossDev
- constFuncCrossDev
- copyCrossDev
- DeyMittraAmpereCrossDev
- DeyMittraAmpereVecCrossDev
- DeyMittraFaradayCrossDev
- DeyMittraFaradayVecCrossDev
- DispCorrFaradayCrossDev
- gaussFuncCrossDev
- ImportFromFileCrossDev
- InitVolAvgInvEpsCrossDev
- InitVolAvgLorentzInvEpsCrossDev
- MalCrossDev
- MoreAccComboInvEpsCrossDev
- multiplyCrossDev
- oneFieldOpCrossDev
- PhaseShiftCrossDev
- RatioFieldOpCrossDev
- reciprocalFieldOpCrossDev
- SetLorentzDielOpsCrossDev
- SetToEdgeFracsCrossDev
- SetToInvFaceFracsCrossDev
- setToSTFuncCrossDev
- SetToValueCrossDev
- SumCrossDev
- twoFieldOpCrossDev
- UpdateStepCrossDev
- VolAvgLorentzJCrossDev
History
Macros
Introduction to Macros
Selective Processing
Utility Macros
Postprocessing Tools
Engine (Vorpal) Execution
Analyzers
Guide to Analyzers
Available Analyzers
- annotateFieldOnLine.py
- compareFields.py
- compute2DantennaGainAndPhase
- computeBeam2ModeCoupling.py
- computeCavityG.py
- computeCumulativeSumHistory.py
- computeFarFieldFromKirchhoffBox.py
- computeFieldCrossProduct.py
- computeFieldMaxAmplitude.py
- computeFieldRelIntensityHilbert.py
- computeFieldTimeAverage.py
- computeFieldTimeAverageSequence.py
- computeGradient.py
- computeInverseQ.py
- computeSParamsFromHistsSubSampling.py
- computeSParamsFromHists.py
- computeSParamsViaOverlapIntegral.py
- computeSpectrogram.py
- computeTimeSeriesAmplitude.py
- computeTimeSeriesFrequency.py
- computeTransitTimeFactor.py
- computeWaveguideModes.py
- convertFieldComponentCartToCylX.py
- convertFieldComponentCartToCylZ.py
- convertSlabToPointHistories.py
- extractModes.py
- extractModesViaOperator.py
- hfssToVsh5.py
- importExternalField.py
- performLowPassFilter.py
- performTwoHistoryArithmetic.py
- putFieldOnSurfaceMesh.py
- truncateHistory.py
- writeCutCellField.py