T3P and Pic3P (tfe3p) keyword reference¶

Input-file keywords read by T3P and Pic3P (tfe3p), 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.

ESolver¶

Keyword	Type	Default	Presence
`NumberOfModes`

Excitation¶

Keyword	Type	Default	Presence
`Pulse`	`block`

Excitation.Pulse¶

Keyword	Type	Default	Presence
`Frequency`	`double`	`0.0`	required

Grid¶

Keyword	Type	Default	Presence
`EndDense`
`Filename`
`Fraction`
`Method`
`NPoints`
`Radius`	`double`	`0`	optional (warns)
`StartDense`

LinearSolver¶

Keyword	Type	Default	Presence
`Solver`

Loading¶

Keyword	Type	Default	Presence
`Particles`	`block`
`Solenoid`	`block`
`Direction`	`list`
`DriveField`	`block`
`EigenMode`	`block`
`Symmetry factor`
`SymmetryFactor`
`Type`	`string`	`"undefined"`	required

Loading.Particles¶

Keyword	Type	Default	Presence
`Metis`	`switch (on/off)`
`DisableZoltan`	`switch (on/off)`
`NumParticleCPUs`		`std::min(1200, commsize)`	optional
`Tracking`	`switch (on/off)`
`TrackingOnly`	`switch (on/off)`
`ZoltanAutoMigrate`	`switch (on/off)`
`ZoltanDebugLevel`	`int`	`0`	optional

Loading.Particles.Distribution¶

Keyword	Type	Default	Presence
`DCEmission`	`block`
`DumpPICMesh`	`switch (on/off)`
`FieldEmission`	`block`
`ThermionicEmission`	`block`

Loading.Particles.Monitors¶

Keyword	Type	Default	Presence
`DumpPhases`
`DumpPositions`
`ObserverPlaneZ-Positions`	`block`
`ObserverPlaneZPositions`	`block`

Loading.RF.Projector¶

Keyword	Type	Default	Presence
`LinearSolver`	`block`

LoadingInfo¶

Keyword	Type	Default	Presence
`BeamBoundaryLoading`	`switch (on/off)`
`BeamLoading`	`switch (on/off)`
`BoundaryID`	`int`	`Get(mainkvc, "LoadingInfo.BoundaryID")`	optional

LoadingInfo.Bunch¶

Keyword	Type	Default	Presence
`Sigma`

ModelInfo¶

Keyword	Type	Default	Presence
`Material`	`block`
`Tolerant`	`switch (on/off)`

ObserverPlaneZPositions¶

Keyword	Type	Default	Presence
`Z`

Omega3PMap¶

Keyword	Type	Default	Presence
`DumpPoissonMap`	`switch (on/off)`

PETScOption¶

Keyword	Type	Default	Presence
`Jacobian`
`KSP`
`PC`
`Runtime`

PoissonMap¶

Keyword	Type	Default	Presence
`DumpPoissonMap`	`switch (on/off)`
`EndPoint`

PoP2D¶

Keyword	Type	Default	Presence
`StartPoint`	`list`

Port¶

Keyword	Type	Default	Presence
`ReferenceNumber`
`ESolver`	`block`

PRegion¶

Keyword	Type	Default	Presence
`ExcitationPort`
`Object`

TimeStepping¶

Keyword	Type	Presence
`Nonlinear`
`ChangingTimes`
`DT`	`double`	required
`MaximumTime`
`Nonlinear`
`PETScOption`	`block`
`Smax`
`ZeroInitialSolution`	`switch (on/off)`

(top level or unspecified block)¶

Keyword	Type	Default	Presence
`A`	`double`	`0.`	optional (warns)
`Alpha`
`Analytical`	`switch (on/off)`
`Attribute`
`B`	`double`	`0.`	optional (warns)
`Beam offset` (alias `BeamOffset`)	`double`	`0.0`	required
`BeamCurrentDensity`	`double`	`0.`	optional (warns)
`Beampipe radius` (alias `BeampipeRadius`)	`double`	`0.0`	required
`BeamSize`	`double`	`0.0`	required
`Beta0`	`double`	`0.`	optional (warns)
`Charge`
`CheckPoint`	`block`
`Component`			required
`ContourPoints`
`Coordinate`	`list`
`DampMatrix`
`DampMatrixAscii`
`debugCheckPoint`
`DipoleType`
`DOF`	`list`
`DS`
`EmitterSubDivisionLevel`	`int`	`10`	optional (warns)
`EmitThreshold`	`double`	`0.0`	optional (warns)
`End contour`
`End structure`
`Excitation`	`block`
`FieldComponent`			required
`FieldEnhancement`	`double`	`1.0`	optional (warns)
`Frequency` (alias `ESolver.Frequency`)	`double`	`1e12`	optional (warns)
`Grid`	`block`
`In boundary reference number`
`InputFile`
`Intervals`	`size_t`	`1000u`	optional (warns)
`Linear Solver`	`block`
`LinearSolver`	`block`
`Loading`	`block`
`MassMatrix`
`MassMatrixAscii`
`MaxCurrentDensity`	`double`	`1e15`	optional (warns)
`MaxIterations`
`MeshRefinement`	`block`
`Name`
`NumSample`		`200u`	optional
`Omega3PMap`	`block`
`Origin`		`NML_Point3(0, 0, 0)`	optional (warns)
`Out boundary reference number`
`PackingFactor`	`double`	`1.0`	optional (warns)
`PathXY a`	`list`
`PathXY b1`	`list`
`PathXY b2`	`list`
`Plane Dz`
`PML`	`block`
`PoissonMap`	`block`
`Preconditioner`
`PrintFrequency`	`int`	`10`	optional
`ProjectionAlpha`
`PSubtract`
`QFactor`	`double`	`1e100`	optional
`QSubtract`
`ReferenceNumber`	`int`	`0`	required
`rMax`	`double`	`1e-2`	optional (warns)
`rMin`	`double`	`0.`	optional (warns)
`rStep`		`(r1 - r0) / 100.`	optional (warns)
`ScalingFactor`	`double`	`1.0`	required
`Smin`
`Start contour`
`Start structure`
`StiffMatrix`
`StiffMatrixAscii`
`Subtract`
`t initial`	`double`	`0.0`	optional
`TimeEnd`		`m_dumpstep > 0. ? maxt : 0`	optional (warns)
`TimeStart`	`int`	`0`	optional (warns)
`TimeStep`	`double`	`0.`	optional (warns)
`Tolerance`
`TotalCharge`	`double`	`-1.0`	optional (warns)
`TSNewmarkIntgl`	`block`
`WorkFunction`	`double`	`4.5`	optional (warns)
`XDirection`		`NML_Vector3(1., 0, 0)`	optional (warns)
`YDirection`		`NML_Vector3(0, 1., 0)`	optional (warns)
`zMax`		`zmax`	optional (warns)
`zMin`		`m_cathodecenter.z()`	optional (warns)
`zStep`		`(z1 - z0) / 1000.`	optional (warns)