Page History

 ModelInfo:  {
  File: coarse.ncdf
  BoundaryCondition:   {
    Electric: 2
    Magnetic: 3 4
    Absorbing: 5 6
   }
 }

   MeshPartitioning:  {
        Method: PARMETIS   //the other option is ZOLTAN
        Zoltan: {          //if the main method is ZOLTAN, this container will provide further zoltan specific options
           Method: RCB
           Dimension: 1
           Partition Direction: Z
        }
   }

  FiniteElement: {
    Order: 2  

{panel:title=Table of Contents}
{toc:type=flat|separator=newline|outline=true|indent=30px|minLevel=2}
{panel}

h3. ModelInfo

Tell T3P which mesh file to load and what boundary conditions are used for the different side sets in the mesh file (default: Electric)
{code}
 ModelInfo:  {
  File: coarse.ncdf
  BoundaryCondition:   {
    Electric: 2
    Magnetic: 3 4
    Absorbing: 5 6
   }
 }
{code}

h3. MeshPartitioning

To specify the method to partition the mesh
{code}
   MeshPartitioning:  {
        Method: PARMETIS   //the other option is ZOLTAN
        Zoltan: {     //if theglobal mainorder methodof is ZOLTAN, this container will provide further zoltan specific optionsbasis functions (can be 1...6, 2 is recommended)
    CurvedSurfaces: on
      Method: RCB}

  Loading: {
    Type: BeamBoundaryLoading
    Analytical: on
    // Specify the right-handed coordinate system with its Z-axis along the beamline ( CrossProduct(X, Y) = Z = Direction specified above)
    Origin: 0.0 0.0 0.0
    XDirection: 1.0 0.0 0.0 }
{code}
\*Optional: Force analytical BeamBoundaryLoading (can be used if the beampipe is cylindrical). Not required. Default is OFF.


{code}
  Loading: {
    Type: BeamBoundaryLoading
    Analytical: on
    // Specify the right-handed coordinate system with its Z-axis along the beamline ( CrossProduct(X, Y) = Z = Direction specified above)
    Origin: 0.0 0.0 0.0
    XDirection: 1.0 0.0 0.0     //this is the direction of the beam offset, if any
    YDirection: 0.0 1.0 0.0
    Beampipe radius: 0.04
    Beam offset: 0             //offsetthis is inthe x-direction of the localbeam 2Doffset, coordinate system (value needs to be consistent with StartPoint specified above)
  }
{code}

h3. Time Integration Parameters

{code}
  TimeStepping: {if any
    YDirection: 0.0 1.0 0.0
    Beampipe radius: 0.04
    Beam MaximumTimeoffset: 0 10.e-10  //the maximal time to step
     DT: 2e-12 //offset in x-direction of the local 2D coordinate system (value needs to /be consistent with StartPoint specified above)
  }

  TimeStepping/delta T
  }
{code}

h3. Wakefield Monitor

<font color="red">need more expalantion</font>
{code}
   Monitor: {
    Type: WakeField MaximumTime: 10.e-10  //the maximal time to step
    Name: wake
 DT: 2e-12        InID: 5
    OutID: 6//delta T
  }

  Start contourMonitor: 0.05{
    End contourType: 0.10
WakeField    Start  // Weiland method (not for protruding structures, beam pipe radius must be the same on left and right side)
    Name: wake
    Start contour: 0.05  // z-position at which the beampipe-cavity transition starts
    End contour: 0.10    // z-position at which the beampipe-cavity transition ends
    Smax: 0.3            // the longitudinal wake potential will be recorded from s=0 to s=Smax
  }

   Monitor: {
     Type: Pointstructure: 0.0
    End structure: 0.15
    Smax: 0.3                   //
  }
{code}

h3. Point Monitor

To record the field values at specified location
{code}
   Monitor: {
     Type: Point             //point monitor
     Name: monA                                    //an output file called monA.out will be generated
point monitor
     Name: monA              //an output file called monA.out will be generated
                             //it contains: t Hx Hy Hz Ex Ey Ez
     Coordinate:  0.00002, 0.02, 0.1495  //the location
   }
{code}

h3. Power Monitor
{code}

  Monitor: {
    Type: Power
    ReferenceNumber: 4     //which reference surface to monitor
    Name: mymon2
    TimeStart: 0           //when power monitor starts
    TimeEnd:   30.0e-9     //when it ends
    TimeStep:  0.125e-11   //how often it records power density
  }
{code}

h3. Volume Monitor
{code}

  Monitor: {
    Type: Volume
    Name: vol
    TimeStart: 10.e-9          //when volume monitor starts
    TimeEnd:   500.e-9       //when it ends
    TimeStep:  50.e-9         //how often it records volume fields
  }
{code}

h3. CheckPoint

request T3P code to checkpointing itself every certain timesteps so that one can restart T3P.
{code}
  CheckPoint: {
    Action: restart             //default should be restart. If there is no data available, it will have fresh start.
    Ntimesteps: 100           //every 100 times steps, code will checkpoint itself
    Directory: CHECKPOINT   //the default directory to store checkpointing data
  }

{code}

h3. LinearSolver

The options for linear solvers in the implicit timestepping.
{code}
  LinearSolver: {
        Solver:              CG          //other options include MUMPS (direct solver,    faster for //otherless optionsthan include32 MUMPSCPUs) if it is compiled in
        Preconditioner:	  CHOLESKY       //other options include DIAGONAL
        PrintFrequency:      50                //if you want print solver convergence history
        QuietMode:              1	         //Set it to 1 if you do not want to print anything
        Tolerance:           1e-10            //relative tolerance
        MaxIterations:       3000            //maxima number of iterations before CG quits
  }

{code}

h3. Load a TEM waveguide mode on a coax port
{code}
 Loading: {
  Type: PortModeLoading  //loading type
  Port:  {
    ReferenceNumber: 3   //port is at reference surface 3
    Origin: 0.0 0.0 -0.011
    XDirection: 1.0 0.0 0.0
    YDirection: 0.0 1.0 0.0
    ESolver: {
      Type: Analytic
      Mode:  {
        WaveguideType: Coax
        ModeType: TEM
        A: 0.0011
        B: 0.0033
      }
    }
  }
  Excitation: {
    Power: 1.
    Pulse: {
      Type: Monochromatic
      Frequency: 10.5e9
      Rise periods: 150
      Fall periods: 150
      T0: 0.
      TMax: 100.e-9
    }
  }
 }
{code}