T3P and Pic3P (tfe3p) 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.
145 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.
ESolver¶
| Keyword | Type | Default | Presence | Read in |
|---|---|---|---|---|
NumberOfModes |
tfe3p/src/WaveguidePortBC.C:1715 |
Excitation¶
| Keyword | Type | Default | Presence | Read in |
|---|---|---|---|---|
Pulse |
block |
tfe3p/src/Application.C:789 |
Excitation.Pulse¶
| Keyword | Type | Default | Presence | Read in |
|---|---|---|---|---|
Frequency |
double |
0.0 |
required | tfe3p/src/PortModeLoading.C:92 |
Grid¶
| Keyword | Type | Default | Presence | Read in |
|---|---|---|---|---|
EndDense |
tfe3p/src/Grid2D.C:58 |
|||
Filename |
tfe3p/src/Grid2D.C:28 |
|||
Fraction |
tfe3p/src/Grid2D.C:60 |
|||
Method |
tfe3p/src/Grid2D.C:9 |
|||
NPoints |
tfe3p/src/Grid2D.C:52 |
|||
Radius |
double |
0 |
optional (warns) | tfe3p/src/MON_ProjsAlongLine.C:122 |
StartDense |
tfe3p/src/Grid2D.C:57 |
LinearSolver¶
| Keyword | Type | Default | Presence | Read in |
|---|---|---|---|---|
Solver |
tfe3p/src/Application.C:615 |
Loading¶
| Keyword | Type | Default | Presence | Read in |
|---|---|---|---|---|
Particles |
block |
tfe3p/src/Application.C:108 |
||
Solenoid |
block |
tfe3p/src/Particles.C:314 |
||
Direction |
list |
tfe3p/src/DipoleLoading.C:174 |
||
DriveField |
block |
tfe3p/src/ParticlesFields.C:523 |
||
EigenMode |
block |
tfe3p/src/ParticlesFields.C:524 |
||
Symmetry factor |
tfe3p/src/Application.C:888 |
|||
SymmetryFactor |
tfe3p/src/Application.C:889 |
|||
Type |
string |
"*undefined*" |
required | tfe3p/src/MonitorMan.C:34 |
Loading.Particles¶
| Keyword | Type | Default | Presence | Read in |
|---|---|---|---|---|
Metis |
switch (on/off) |
tfe3p/src/ParticlesFields.C:423 |
||
DisableZoltan |
switch (on/off) |
tfe3p/src/ParticlePartitionManager.C:149 |
||
NumParticleCPUs |
std::min(1200, commsize) |
optional | tfe3p/src/ParticlePartitionManager.C:155 |
|
Tracking |
switch (on/off) |
tfe3p/src/ParticlePartitionManager.C:158 |
||
TrackingOnly |
switch (on/off) |
tfe3p/src/ParticlePartitionManager.C:158 |
||
ZoltanAutoMigrate |
switch (on/off) |
tfe3p/src/ParticlePartitionManager.C:152 |
||
ZoltanDebugLevel |
int |
0 |
optional | tfe3p/src/ParticlePartitionManager.C:167 |
Loading.Particles.Distribution¶
| Keyword | Type | Default | Presence | Read in |
|---|---|---|---|---|
DCEmission |
block |
tfe3p/src/Particles.C:394 |
||
DumpPICMesh |
switch (on/off) |
tfe3p/src/Particles.h:830 |
||
FieldEmission |
block |
tfe3p/src/Particles.C:380 |
||
ThermionicEmission |
block |
tfe3p/src/Particles.C:387 |
Loading.Particles.Monitors¶
| Keyword | Type | Default | Presence | Read in |
|---|---|---|---|---|
DumpPhases |
tfe3p/src/Particles.C:178 |
|||
DumpPositions |
tfe3p/src/Particles.C:176 |
|||
ObserverPlaneZ-Positions |
block |
tfe3p/src/Particles.C:210 |
||
ObserverPlaneZPositions |
block |
tfe3p/src/Particles.C:209 |
Loading.RF.Projector¶
| Keyword | Type | Default | Presence | Read in |
|---|---|---|---|---|
LinearSolver |
block |
tfe3p/src/ParticlesFields.C:121 |
LoadingInfo¶
| Keyword | Type | Default | Presence | Read in |
|---|---|---|---|---|
BeamBoundaryLoading |
switch (on/off) |
tfe3p/src/Application.C:928 |
||
BeamLoading |
switch (on/off) |
tfe3p/src/Application.C:910 |
||
BoundaryID |
int |
Get(mainkvc, "LoadingInfo.BoundaryID") |
optional | tfe3p/src/MON_WakeField.C:54 |
LoadingInfo.Bunch¶
| Keyword | Type | Default | Presence | Read in |
|---|---|---|---|---|
Sigma |
tfe3p/src/Application.C:954 |
ModelInfo¶
| Keyword | Type | Default | Presence | Read in |
|---|---|---|---|---|
Material |
block |
tfe3p/src/Application.C:855 |
||
Tolerant |
switch (on/off) |
tfe3p/src/Application.C:194 |
ObserverPlaneZPositions¶
| Keyword | Type | Default | Presence | Read in |
|---|---|---|---|---|
Z |
tfe3p/src/Particles.C:214 |
Omega3PMap¶
| Keyword | Type | Default | Presence | Read in |
|---|---|---|---|---|
DumpPoissonMap |
switch (on/off) |
tfe3p/src/ParticlesFields.C:537 |
PETScOption¶
| Keyword | Type | Default | Presence | Read in |
|---|---|---|---|---|
Jacobian |
tfe3p/src/TSNMNonlinear.C:45 |
|||
KSP |
tfe3p/src/TSNMNonlinear.C:33 |
|||
PC |
tfe3p/src/TSNMNonlinear.C:39 |
|||
Runtime |
tfe3p/src/TSNMNonlinear.C:57 |
PoissonMap¶
| Keyword | Type | Default | Presence | Read in |
|---|---|---|---|---|
DumpPoissonMap |
switch (on/off) |
tfe3p/src/DriveFields.C:111 |
||
EndPoint |
tfe3p/src/DriveFields.C:104 |
PoP2D¶
| Keyword | Type | Default | Presence | Read in |
|---|---|---|---|---|
StartPoint |
list |
tfe3p/src/MON_WakeFieldNapoly.C:1737 |
Port¶
| Keyword | Type | Default | Presence | Read in |
|---|---|---|---|---|
ReferenceNumber |
tfe3p/src/Application.C:785 |
|||
ESolver |
block |
tfe3p/src/WaveguidePortBC.C:699 |
PRegion¶
| Keyword | Type | Default | Presence | Read in |
|---|---|---|---|---|
ExcitationPort |
tfe3p/src/Application.C:768 |
|||
Object |
tfe3p/src/Application.C:766 |
TimeStepping¶
| Keyword | Type | Default | Presence | Read in |
|---|---|---|---|---|
Nonlinear |
tfe3p/src/TSolverMan.C:40 |
|||
ChangingTimes |
tfe3p/src/TSNewmarkIntgl.C:61 |
|||
DT |
double |
required | tfe3p/src/MON_ProjsAlongLine.C:100 |
|
MaximumTime |
tfe3p/src/Application.C:602 |
|||
Nonlinear |
tfe3p/src/TSNewmarkIntgl.C:78 |
|||
PETScOption |
block |
tfe3p/src/TSNMNonlinear.C:29 |
||
Smax |
tfe3p/src/Application.C:595 |
|||
ZeroInitialSolution |
switch (on/off) |
tfe3p/src/TSNewmarkIntgl.C:75 |
(top level or unspecified block)¶
| Keyword | Type | Default | Presence | Read in |
|---|---|---|---|---|
A |
double |
0. |
optional (warns) | tfe3p/src/Particles.C:1132 |
Alpha |
tfe3p/src/MeshRefinement.C:612 |
|||
Analytical |
switch (on/off) |
tfe3p/src/BeamBoundaryLoading.C:71 |
||
Attribute |
tfe3p/src/Application.C:861 |
|||
B |
double |
0. |
optional (warns) | tfe3p/src/Particles.C:1133 |
Beam offset (alias BeamOffset) |
double |
0.0 |
required | tfe3p/src/BeamBoundaryLoading.C:416 |
BeamCurrentDensity |
double |
0. |
optional (warns) | tfe3p/src/Particles.C:1162 |
Beampipe radius (alias BeampipeRadius) |
double |
0.0 |
required | tfe3p/src/BeamBoundaryLoading.C:415 |
BeamSize |
double |
0.0 |
required | tfe3p/src/MeshRefinement.C:557 |
Beta0 |
double |
0. |
optional (warns) | tfe3p/src/Particles.C:1163 |
Charge |
tfe3p/src/MON_WakeFieldNapoly.C:1223 |
|||
CheckPoint |
block |
tfe3p/src/Application.C:276 |
||
Component |
required | tfe3p/src/ParticlesIO.C:870 |
||
ContourPoints |
tfe3p/src/MON_ProjsAlongLine.C:48 |
|||
Coordinate |
list |
tfe3p/src/DipoleLoading.C:151 |
||
DampMatrix |
tfe3p/src/Application.C:466 |
|||
DampMatrixAscii |
tfe3p/src/Application.C:461 |
|||
debugCheckPoint |
tfe3p/src/MON_WakeFieldNapoly.C:990 |
|||
DipoleType |
tfe3p/src/PDipoleLoading.C:179 |
|||
DOF |
list |
tfe3p/src/MON_ProjsNearPt.C:289 |
||
DS |
tfe3p/src/MON_WakeFieldNapoly.C:1031 |
|||
EmitterSubDivisionLevel |
int |
10 |
optional (warns) | tfe3p/src/Particles.C:1126 |
EmitThreshold |
double |
0.0 |
optional (warns) | tfe3p/src/Particles.C:1107 |
End contour |
tfe3p/src/MON_WakeFieldNapoly.C:1168 |
|||
End structure |
tfe3p/src/MON_WakeFieldNapoly.C:1190 |
|||
Excitation |
block |
tfe3p/src/DipoleLoading.C:203 |
||
FieldComponent |
required | tfe3p/src/DriveFields.C:45 |
||
FieldEnhancement |
double |
1.0 |
optional (warns) | tfe3p/src/Particles.C:1103 |
Frequency (alias ESolver.Frequency) |
double |
1e12 |
optional (warns) | tfe3p/src/MON_ModeVoltage.C:85 |
Grid |
block |
tfe3p/src/MON_WakeField.C:95 |
||
In boundary reference number |
tfe3p/src/MON_WakeFieldNapoly.C:1201 |
|||
InputFile |
tfe3p/src/SurfaceFieldInterpolation.C:27 |
|||
Intervals |
size_t |
1000u |
optional (warns) | tfe3p/src/MON_ProjsAlongLine.C:53 |
Linear Solver |
block |
tfe3p/src/TSNewmarkIntgl.C:65 |
||
LinearSolver |
block |
tfe3p/src/MeshRefinement.C:617 |
||
Loading |
block |
tfe3p/src/ParticlesFields.C:512 |
||
MassMatrix |
tfe3p/src/Application.C:456 |
|||
MassMatrixAscii |
tfe3p/src/Application.C:451 |
|||
MaxCurrentDensity |
double |
1e15 |
optional (warns) | tfe3p/src/Particles.C:1104 |
MaxIterations |
tfe3p/src/LinearSolverMan.C:30 |
|||
MeshRefinement |
block |
tfe3p/src/Application.C:134 |
||
Name |
tfe3p/src/MON_DriveFieldPoint.C:36 |
|||
NumSample |
200u |
optional | tfe3p/src/BeamLoading.C:53 |
|
Omega3PMap |
block |
tfe3p/src/DriveFields.C:71 |
||
Origin |
NML_Point3(0, 0, 0) |
optional (warns) | tfe3p/src/BeamBoundaryLoading.C:417 |
|
Out boundary reference number |
tfe3p/src/MON_WakeFieldNapoly.C:1212 |
|||
PackingFactor |
double |
1.0 |
optional (warns) | tfe3p/src/Particles.C:1105 |
PathXY a |
list |
tfe3p/src/MON_WakeFieldNapoly.C:1102 |
||
PathXY b1 |
list |
tfe3p/src/MON_WakeFieldNapoly.C:1113 |
||
PathXY b2 |
list |
tfe3p/src/MON_WakeFieldNapoly.C:1124 |
||
Plane Dz |
tfe3p/src/MON_WakeFieldNapoly.C:1052 |
|||
PML |
block |
tfe3p/src/Application.C:858 |
||
PoissonMap |
block |
tfe3p/src/DriveFields.C:50 |
||
Preconditioner |
tfe3p/src/LinearSolverMan.C:27 |
|||
PrintFrequency |
int |
10 |
optional | tfe3p/src/Application.C:96 |
ProjectionAlpha |
tfe3p/src/MeshRefinement.C:611 |
|||
PSubtract |
tfe3p/src/MON_WakeFieldNapoly.C:998 |
|||
QFactor |
double |
1e100 |
optional | tfe3p/src/DriveFields.C:53 |
QSubtract |
tfe3p/src/MON_WakeFieldNapoly.C:997 |
|||
ReferenceNumber |
int |
0 |
required | tfe3p/src/MON_EmittedCurrent.C:25 |
rMax |
double |
1e-2 |
optional (warns) | tfe3p/src/ParticlesIO.C:794 |
rMin |
double |
0. |
optional (warns) | tfe3p/src/ParticlesIO.C:793 |
rStep |
(r1 - r0) / 100. |
optional (warns) | tfe3p/src/ParticlesIO.C:795 |
|
ScalingFactor |
double |
1.0 |
required | tfe3p/src/SurfaceLoading.C:42 |
Smin |
tfe3p/src/MON_WakeFieldNapoly.C:1135 |
|||
Start contour |
tfe3p/src/MON_WakeFieldNapoly.C:1157 |
|||
Start structure |
tfe3p/src/MON_WakeFieldNapoly.C:1179 |
|||
StiffMatrix |
tfe3p/src/Application.C:446 |
|||
StiffMatrixAscii |
tfe3p/src/Application.C:441 |
|||
Subtract |
tfe3p/src/MON_WakeFieldNapoly.C:996 |
|||
t initial |
double |
0.0 |
optional | tfe3p/src/TSNewmarkIntgl.C:34 |
TimeEnd |
m_dumpstep > 0. ? maxt : 0 |
optional (warns) | tfe3p/src/MON_FieldNodeVolume.C:57 |
|
TimeStart |
int |
0 |
optional (warns) | tfe3p/src/MON_FieldNodeVolume.C:54 |
TimeStep |
double |
0. |
optional (warns) | tfe3p/src/MON_FieldNodeVolume.C:49 |
Tolerance |
tfe3p/src/DipoleLoading.C:191 |
|||
TotalCharge |
double |
-1.0 |
optional (warns) | tfe3p/src/Particles.C:1106 |
TSNewmarkIntgl |
block |
tfe3p/src/Application.C:121 |
||
WorkFunction |
double |
4.5 |
optional (warns) | tfe3p/src/Particles.C:1102 |
XDirection |
NML_Vector3(1., 0, 0) |
optional (warns) | tfe3p/src/BeamBoundaryLoading.C:418 |
|
YDirection |
NML_Vector3(0, 1., 0) |
optional (warns) | tfe3p/src/BeamBoundaryLoading.C:419 |
|
zMax |
zmax |
optional (warns) | tfe3p/src/ParticlesIO.C:797 |
|
zMin |
m_cathodecenter.z() |
optional (warns) | tfe3p/src/ParticlesIO.C:796 |
|
zStep |
(z1 - z0) / 1000. |
optional (warns) | tfe3p/src/ParticlesIO.C:798 |