Gun3P keyword reference¶

Auto-generated

This page was generated from the ACE3P source tree by tools/extract_keywords.py on 2026-10-20 (source revision v2026.10 2026-10-20). Keyword names, types, and defaults are taken directly from the code. Descriptions live in the module user guides and the command syntax pages. Do not edit this file by hand.

137 keywords found. Sections are the block named in a dotted key (EigenSolver.Tolerance) or, for bare keys, the name of the container variable the code reads them from (domainkvc becomes Domain). A blank Default means the code reads the keyword with find() and the fallback is not a literal, or the keyword is a block or switch. Presence required means the code aborts when the key is absent.

Boundary¶

Keyword	Type	Default	Presence	Read in
`ConditionType`				`gun3p/src/Gun3P_BdManager.C:39`
`Directory`	`string`	`"."`	optional	`gun3p/src/EMHeating.C:84`
`DirichletCustomizationIndex`				`gun3p/src/Gun3P_BdManager.C:54`
`DirichletType`				`gun3p/src/Gun3P_BdManager.C:50`
`DirichletValue`	`list`			`gun3p/src/Gun3P_BdManager.C:86`
`Id`				`gun3p/src/EMMeshMove.C:97`
`MixedType`				`gun3p/src/Gun3P_BdManager.C:204`
`MixedValue`				`gun3p/src/Gun3P_BdManager.C:220`
`NeumannCustomizationIndex`				`gun3p/src/Gun3P_BdManager.C:114`
`NeumannType`				`gun3p/src/Gun3P_BdManager.C:110`
`NeumannValue`				`gun3p/src/Gun3P_BdManager.C:127`
`Param`				`gun3p/src/Gun3P_BdManager.C:242`
`RobinCustomizationIndex`				`gun3p/src/Gun3P_BdManager.C:172`
`RobinFactor`				`gun3p/src/Gun3P_BdManager.C:160`
`RobinType`				`gun3p/src/Gun3P_BdManager.C:169`
`RobinValue`				`gun3p/src/Gun3P_BdManager.C:185`
`Sigma`				`gun3p/src/Gun3P_BdManager.C:137`
`SurfaceResistance`				`gun3p/src/Gun3P_BdManager.C:138`

BoundaryCondition¶

Keyword	Type	Default	Presence	Read in
`ID`				`gun3p/src/ScalarDiscreteDomain.C:266`

DCGunProblem¶

Keyword	Type	Default	Presence	Read in
`Base directory`				`gun3p/src/Environment.C:363`
`Check level`				`gun3p/src/Environment.C:369`
`ElectricAbsoluteTolerance`				`gun3p/src/ElectronGunProblem.C:339`
`ElectricAbsoluteTolerance2`				`gun3p/src/ElectronGunProblem.C:349`
`ElectricRelativeTolerance`				`gun3p/src/ElectronGunProblem.C:344`
`ElectricRelativeTolerance2`				`gun3p/src/ElectronGunProblem.C:354`
`FirstIterationForMagnetostaticProblem`				`gun3p/src/ElectronGunProblem.C:376`
`Just dump emission map`				`gun3p/src/Environment.C:411`
`JustGenerateTreecotree`				`gun3p/src/Environment.C:397`
`MagneticAbsoluteTolerance`				`gun3p/src/ElectronGunProblem.C:359`
`MagneticRelativeTolerance`				`gun3p/src/ElectronGunProblem.C:364`
`MaxIterations`				`gun3p/src/ElectronGunProblem.C:370`
`Perform tracking at last iteration`				`gun3p/src/ElectronGunProblem.C:431`
`RunId`				`gun3p/src/Environment.C:324`
`Save iteration data`				`gun3p/src/Environment.C:416`
`SymmetryFactor`	`int`	`0`	optional (warns)	`gun3p/src/LFDetuning.C:106`
`Trace level`				`gun3p/src/Environment.C:368`
`Use input file for first solution`				`gun3p/src/Environment.C:386`
`Use MPI Bcast strategy`				`gun3p/src/Environment.C:381`
`Use MPI for exchanging data on ray segments`				`gun3p/src/Environment.C:376`
`Use MPI for exchanging dofs`				`gun3p/src/Environment.C:371`

ElasticProblem¶

Keyword	Type	Read in
`BasisOrder`		`gun3p/src/EMMeshMove.C:71`
`Boundary`	`block`	`gun3p/src/EMMeshMove.C:95`
`CurvedSurfaces`		`gun3p/src/EMMeshMove.C:83`
`MeshFile`		`gun3p/src/EMMeshMove.C:75`

ElectrostaticProblem¶

Keyword	Type	Default	Presence	Read in
`Outputs`	`block`			`gun3p/src/outputConverter.C:373`

ModelInfo¶

Keyword	Type	Default	Presence	Read in
`BoundaryCondition`	`block`			`gun3p/src/ScalarDiscreteDomain.C:246`
`File`				`gun3p/src/ScalarDiscreteDomain.C:253`

Monitor¶

Keyword	Type	Read in
`Angle`		`gun3p/src/CircleMonitor.C:80`
`Center`	`list`	`gun3p/src/CircleMonitor.C:58`
`Corner`	`list`	`gun3p/src/RectangleMonitor.C:58`
`Direction`	`list`	`gun3p/src/SegmentMonitor.C:65`
`InitialDirection`	`list`	`gun3p/src/CircleMonitor.C:74`
`InitialPoint`	`list`	`gun3p/src/SegmentMonitor.C:57`
`InnerRadius`		`gun3p/src/DiscMonitor.C:81`
`Iteration frequency`		`gun3p/src/CircleMonitor.C:38`
`Length`		`gun3p/src/DiscMonitor.C:82`
`Lx`		`gun3p/src/RectangleMonitor.C:71`
`Ly`		`gun3p/src/RectangleMonitor.C:72`
`Maximum search distance`		`gun3p/src/EquipotMonitor.C:107`
`Meshline input file`		`gun3p/src/LineMonitor.C:50`
`Name`		`gun3p/src/CircleMonitor.C:42`
`Normal`	`list`	`gun3p/src/SegmentMonitor.C:73`
`Number of points`		`gun3p/src/CircleMonitor.C:83`
`NumberOfAnglePoints`		`gun3p/src/DiscMonitor.C:86`
`NumberOfLxPoints`		`gun3p/src/RectangleMonitor.C:75`
`NumberOfLyPoints`		`gun3p/src/RectangleMonitor.C:78`
`NumberOfRadiusPoints`		`gun3p/src/DiscMonitor.C:89`
`Only on first iteration and post process`		`gun3p/src/CircleMonitor.C:32`
`Only on post process`		`gun3p/src/CircleMonitor.C:28`
`PlaneNormal`	`list`	`gun3p/src/CircleMonitor.C:66`
`Point A`	`list`	`gun3p/src/EquipotMonitor.C:89`
`Point B`	`list`	`gun3p/src/EquipotMonitor.C:94`
`Potential values`		`gun3p/src/EquipotMonitor.C:73`
`Radius`		`gun3p/src/CircleMonitor.C:79`
`Search direction`	`list`	`gun3p/src/EquipotMonitor.C:101`
`Type`		`gun3p/src/GunTracker.C:2081`

Outputs¶

Keyword	Type	Default	Presence	Read in
`ElectrostaticFieldToken`				`gun3p/src/outputConverter.C:378`
`FileName`	`string`	`"./gun3p_results/OUTPUT/E/test.txt"`	optional	`gun3p/src/outputConverter.C:386`
`Nx`	`int`	`50`	optional	`gun3p/src/outputConverter.C:391`
`Ny`				`gun3p/src/outputConverter.C:395`
`Nz`	`int`	`100`	optional	`gun3p/src/outputConverter.C:399`

RFHeating¶

Keyword	Type	Default	Presence	Read in
`ElasticProblem`	`block`			`gun3p/src/EMMeshMove.C:59`

Tracker¶

Keyword	Type	Read in
`Backward`	`block`	`gun3p/src/GunTracker.C:386`
`Domain`	`block`	`gun3p/src/GunTracker.C:480`
`Emitter position of ray to be traced`	`list`	`gun3p/src/GunTracker.C:472`
`Generate particle debug file`		`gun3p/src/GunTracker.C:441`
`Id of ray to be traced`		`gun3p/src/GunTracker.C:457`
`JobName`		`gun3p/src/GunTracker.C:375`
`Max x for densities`		`gun3p/src/GunTracker.C:451`
`Max y for densities`		`gun3p/src/GunTracker.C:452`
`Monitor`	`block`	`gun3p/src/GunTracker.C:2077`
`Print emission statistics`		`gun3p/src/GunTracker.C:431`
`Print tracking statistics`		`gun3p/src/GunTracker.C:426`
`Rank periodicity`		`gun3p/src/GunTracker.C:419`
`timestepskip`		`gun3p/src/GunTracker.C:447`
`Use meshline quick`		`gun3p/src/GunTracker.C:413`
`Use timers for finds`		`gun3p/src/GunTracker.C:421`
`Visualize emission positions with v3d`		`gun3p/src/GunTracker.C:436`
`X number of densities`		`gun3p/src/GunTracker.C:453`
`Y number of densities`		`gun3p/src/GunTracker.C:454`

Ward¶

Keyword	Type	Default	Presence	Read in
`Generate output for vizualization`				`gun3p/src/GunTracker.C:133`
`Print details iter`				`gun3p/src/GunTracker.C:167`
`Print details rank`				`gun3p/src/GunTracker.C:166`
`Print get middle ray segs details`				`gun3p/src/GunTracker.C:161`
`Print loop extremes details`				`gun3p/src/GunTracker.C:141`
`Print loop internals details`				`gun3p/src/GunTracker.C:146`
`Print only when magnetostatic dofs are in use`				`gun3p/src/GunTracker.C:151`
`Print update ray segs details`				`gun3p/src/GunTracker.C:156`
`Printing frequency`				`gun3p/src/GunTracker.C:139`
`t`				`gun3p/src/GunTracker.C:124`

(top level or unspecified block)¶

Keyword	Type	Default	Presence	Read in
`Abs tolerance`				`gun3p/src/NonlinearSolverMan.C:31`
`AnodeBoundaryId`				`gun3p/src/ElectrostaticProblem.C:59`
`DCGunProblem`	`block`			`gun3p/src/Environment.C:323`
`EffectiveLength`				`gun3p/src/EMHeating.C:46`
`ElectrostaticProblem`	`block`			`gun3p/src/Environment.C:328`
`EndPoint`	`list`			`gun3p/src/EMHeating.C:179`
`File`				`gun3p/src/EMMeshMove.C:44`
`FiniteElement`	`block`			`gun3p/src/ElectrostaticProblem.C:117`
`GradientDirection`	`list`			`gun3p/src/LFDetuning.C:93`
`LocalizerGrid`	`list`			`gun3p/src/EMHeating.C:79`
`MagnetostaticProblem`	`block`			`gun3p/src/Environment.C:333`
`Max iterations`				`gun3p/src/NonlinearSolverMan.C:30`
`Method`				`gun3p/src/EMHeating.C:34`
`Method for velocity during integration`				`gun3p/src/ElectrostaticProblem.C:72`
`NumberOfPointsPerSegment`				`gun3p/src/EMHeating.C:189`
`ProblemType`				`gun3p/src/ScalarDiscreteDomain.C:720`
`PulseFactor`				`gun3p/src/EMHeating.C:64`
`Rel tolerance`				`gun3p/src/NonlinearSolverMan.C:32`
`Solver`				`gun3p/src/LinearSolverMan.C:35`
`StartPoint`	`list`			`gun3p/src/EMHeating.C:176`
`TargetGradient`				`gun3p/src/EMHeating.C:51`
`TargetPowerloss`				`gun3p/src/EMHeating.C:57`
`ThermoElasticProblem`	`block`			`gun3p/src/Environment.C:341`
`ThermostaticProblem`	`block`			`gun3p/src/Environment.C:345`
`Tracker`	`block`			`gun3p/src/Environment.C:337`
`VoltageDirection`	`list`			`gun3p/src/LFDetuning.C:94`
`WhichMode`	`int`	`0`	optional (warns)	`gun3p/src/LFDetuning.C:107`