Skip to content

Gun3P keyword reference

Input-file keywords read by Gun3P, grouped by the block that contains them, with the type and default value taken from the code. A blank Default means the code supplies no fixed value when the keyword is absent, or the entry is a block or switch. Presence required means the run stops without it. What each keyword does is explained in the module guides and the command syntax pages.

Boundary

Keyword Type Default Presence
ConditionType
Directory string "." optional
DirichletCustomizationIndex
DirichletType
DirichletValue list
Id
MixedType
MixedValue
NeumannCustomizationIndex
NeumannType
NeumannValue
Param
RobinCustomizationIndex
RobinFactor
RobinType
RobinValue
Sigma
SurfaceResistance

BoundaryCondition

Keyword Type Default Presence
ID

DCGunProblem

Keyword Type Default Presence
Base directory
Check level
ElectricAbsoluteTolerance
ElectricAbsoluteTolerance2
ElectricRelativeTolerance
ElectricRelativeTolerance2
FirstIterationForMagnetostaticProblem
Just dump emission map
JustGenerateTreecotree
MagneticAbsoluteTolerance
MagneticRelativeTolerance
MaxIterations
Perform tracking at last iteration
RunId
Save iteration data
SymmetryFactor int 0 optional (warns)
Trace level
Use input file for first solution
Use MPI Bcast strategy
Use MPI for exchanging data on ray segments
Use MPI for exchanging dofs

ElasticProblem

Keyword Type Default Presence
BasisOrder
Boundary block
CurvedSurfaces
MeshFile

ElectrostaticProblem

Keyword Type Default Presence
Outputs block

ModelInfo

Keyword Type Default Presence
BoundaryCondition block
File

Monitor

Keyword Type Default Presence
Angle
Center list
Corner list
Direction list
InitialDirection list
InitialPoint list
InnerRadius
Iteration frequency
Length
Lx
Ly
Maximum search distance
Meshline input file
Name
Normal list
Number of points
NumberOfAnglePoints
NumberOfLxPoints
NumberOfLyPoints
NumberOfRadiusPoints
Only on first iteration and post process
Only on post process
PlaneNormal list
Point A list
Point B list
Potential values
Radius
Search direction list
Type

Outputs

Keyword Type Default Presence
ElectrostaticFieldToken
FileName string "./gun3p_results/OUTPUT/E/test.txt" optional
Nx int 50 optional
Ny int 50 optional
Nz int 100 optional

RFHeating

Keyword Type Default Presence
ElasticProblem block

Tracker

Keyword Type Default Presence
Backward block
Domain block
Emitter position of ray to be traced list
Generate particle debug file
Id of ray to be traced
JobName
Max x for densities
Max y for densities
Monitor block
Print emission statistics
Print tracking statistics
Rank periodicity
timestepskip
Use meshline quick
Use timers for finds
Visualize emission positions with v3d
X number of densities
Y number of densities

Ward

Keyword Type Default Presence
Generate output for vizualization
Print details iter
Print details rank
Print get middle ray segs details
Print loop extremes details
Print loop internals details
Print only when magnetostatic dofs are in use
Print update ray segs details
Printing frequency
t

(top level or unspecified block)

Keyword Type Default Presence
Abs tolerance
AnodeBoundaryId
DCGunProblem block
EffectiveLength
ElectrostaticProblem block
EndPoint list
File
FiniteElement block
GradientDirection list
LocalizerGrid list
MagnetostaticProblem block
Max iterations
Method
Method for velocity during integration
NumberOfPointsPerSegment
ProblemType
PulseFactor
Rel tolerance
Solver
StartPoint list
TargetGradient
TargetPowerloss
ThermoElasticProblem block
ThermostaticProblem block
Tracker block
VoltageDirection list
WhichMode int 0 optional (warns)