class Twiss : public Table

(Return to index)

Class Twiss Abstract base class for table buffers holding lattice function.

------------------------------------------------------------------------

Type:	Abstract
Superclasses:	public Table
Include file:	./Tables/Twiss.hh

Inheritance

Synopsis (including inherited members):

• Public members:
  • class Row ;
  • typedef TBeamline<Row> TLine ;
  • virtual ~Twiss () ;
  • virtual void doomPut (DoomWriter&)const ;
  • virtual void doomSummary (DoomWriter&)const = 0 ;
  • TLine::const_iterator begin ()const ;
  • TLine::iterator begin () ;
  • TLine::const_iterator end ()const ;
  • TLine::iterator end () ;
  • virtual void execute () ;
  • virtual double getCell (const PlaceRep&,const string&) ;
  • virtual CellArray getDefault ()const ;
  • virtual std::vector<double> getColumn (const RangeRep&,const string&) ;
  • const Row& getCurrent ()const ;
  • double getEX ()const ;
  • double getEY ()const ;
  • double getET ()const ;
  • virtual double getLength () ;
  • virtual const Beamline* getLine ()const ;
  • virtual std::vector<double> getRow (const PlaceRep&,const std::vector<string>&) ;
  • virtual bool isDependent (const string&)const ;
  • virtual Expressions::PtrToScalar<double> makeColumnExpression (const string&)const ;
  • virtual bool matches (Table*)const ;
  • void printTableBody (std::ostream&,const CellArray&)const ;
  • void printTableTitle (std::ostream&,const char*)const ;
  • void tfsBody (std::ostream&,const CellArray&)const ;
  • void tfsSummary (std::ostream&)const ;
  • virtual void tfsTwissDescriptors (std::ostream&)const = 0 ;
  • FMatrix<double,6,6> getCurlyA ()const ;
  • FMatrix<double,6,6> getCurlyA (const Row&)const ;
  • FMatrix<double,6,6> getMatrix (const Row&)const ;
  • FVector<double,6> getOrbit ()const ;
  • FVector<double,6> getOrbit (const Row&)const ;
  • FMatrix<double,6,6> getSigma ()const ;
  • FMatrix<double,6,6> getSigma (const Row&)const ;
  • double getS (const Row&,int,int)const ;
  • double getMUi (const Row&,int,int)const ;
  • double getBETi (const Row&,int,int)const ;
  • double getALFi (const Row&,int,int)const ;
  • double getBETik (const Row&,int,int)const ;
  • double getALFik (const Row&,int,int)const ;
  • double getGAMik (const Row&,int,int)const ;
  • double getCO (const Row&,int,int)const ;
  • double getDisp (const Row&,int,int)const ;
  • double getEigen (const Row&,int,int)const ;
  • double getSigma (const Row&,int,int)const ;
  • double getMatrix (const Row&,int,int)const ;
  • struct Cell ;
  • typedef std::vector<Cell> CellArray ;
  • virtual bool canReplaceBy (Object*) ;
  • virtual void fill () = 0 ;
  • static Table* find (const string&) ;
  • virtual const string getCategory ()const ;
  • virtual bool shouldTrace ()const ;
  • virtual bool shouldUpdate ()const ;
  • virtual void invalidate () ;
  • virtual void makeTFS (std::ostream&,const CellArray&)const = 0 ;
  • virtual void printTable (std::ostream&,const CellArray&)const = 0 ;
  • void tfsTableDescriptors (std::ostream&)const ;
  • virtual Object* clone (const string&) = 0 ;
  • void copyAttributes (const Object&) ;
  • virtual void doomGet (const DoomReader&) ;
  • virtual Attribute* findAttribute (const string&) ;
  • virtual const Attribute* findAttribute (const string&)const ;
  • virtual Object* makeTemplate (const string&,TokenStream&,Statement&) ;
  • virtual Object* makeInstance (const string&,Statement&) ;
  • virtual void parse (Statement&) ;
  • virtual void parseShortcut (Statement&) ;
  • virtual void print (std::ostream&)const ;
  • virtual void printHelp (std::ostream&)const ;
  • virtual void replace (Object*,Object*) ;
  • virtual void update () ;
  • bool isBuiltin ()const ;
  • virtual bool isShared ()const ;
  • virtual void setShared (bool) ;
  • void setDirty (bool) ;
  • bool isDirty ()const ;
  • void setFlag (bool) ;
  • bool isFlagged ()const ;
  • void setDoomTime (double) ;
  • double getDoomTime ()const ;
  • const Object* getBaseObject ()const ;
  • const string& getMadName ()const ;
  • Object* getParent ()const ;
  • bool isTreeMember (const Object*)const ;
  • void setMadName (const string&) ;
  • void setParent (Object*) ;
  • void clear () ;
  • int increment () ;
  • int occurrenceCount () ;
  • void registerReference (AttributeBase*) ;
  • void unregisterReference (AttributeBase*) ;
  • std::vector<Attribute> itsAttr ;
• Protected Members:
  • Twiss (int,const char*,const char*) ;
  • Twiss (const string&,Twiss*) ;
  • static const int numColumns ;
  • FVector<double,6> orbit ;
  • FMatrix<double,6,6> curly_A ;
  • bool dynamic ;
  • bool refill ;
  • bool builtin ;
  • bool modified ;
  • bool flagged ;
• Friends:
  • class Insertion ;
  • class Period ;

Documentation:

• Public members:

  class Row ;

  Structure for a row of the Twiss table.

  TLine::const_iterator begin ()const ;

  Access to first row.
  Version for constant table.

  TLine::iterator begin () ;

  Access to first row.
  Version for non-constant table.

  virtual void doomPut (DoomWriter&)const ;

  Write the table to the DOOM data base.

  virtual void doomSummary (DoomWriter&)const = 0 ;

  Fill in summary record.

  TLine::const_iterator end ()const ;

  Access to last row.
  Version for constant table.

  TLine::iterator end () ;

  Access to last row.
  Version for non-constant table.

  virtual void execute () ;

  Check validity of the table definition.

  double getALFik (const Row&,int,int)const ;

  Mais-Ripken alpha functions.
  First index (0 ... 2) is plane, second index (0 ... 2) is mode.

  double getBETik (const Row&,int,int)const ;

  Mais-Ripken beta functions.
  First index (0 ... 2) is plane, second index (0 ... 2) is mode.

  double getCO (const Row&,int,int)const ;

  Closed orbit.
  Index (0 ... 5) is plane.

  virtual double getCell (const PlaceRep&,const string&) ;

  Return a selected value in a selected row.

  virtual std::vector<double> getColumn (const RangeRep&,const string&) ;

  Return column col of this table, limited by range.

  FMatrix<double,6,6> getCurlyA ()const ;

  Return initial curly A matrix.

  FMatrix<double,6,6> getCurlyA (const Row&)const ;

  Curly A map for given row.

  const Row& getCurrent ()const ;

  Return current table row in iteration.

  virtual CellArray getDefault ()const ;

  Return the default print columns.

  double getDisp (const Row&,int,int)const ;

  Dispersion.
  Index (0 ... 5) is plane.

  double getET ()const ;

  Return emittance for mode 3.

  double getEX ()const ;

  Return emittance for mode 1.

  double getEY ()const ;

  Return emittance for mode 2.

  double getEigen (const Row&,int,int)const ;

  Eigenvectors.
  First index (0 ... 5) is plane, second index (0 ... 5) is column.

  double getGAMik (const Row&,int,int)const ;

  Mais-Ripken gamma functions.
  First index (0 ... 2) is plane, second index (0 ... 2) is mode.

  virtual double getLength () ;

  Return the length of the table.

  virtual const Beamline* getLine ()const ;

  Return embedded CLASSIC beamline.

  double getMUi (const Row&,int,int)const ;

  Three modes, "naive" Twiss functions.
  Index (0 ... 2) is mode.

  FMatrix<double,6,6> getMatrix (const Row&)const ;

  Accumulated transfer map.

  double getMatrix (const Row&,int,int)const ;

  Transfer matrix.
  First index (0 ... 5) is row, second index (0 ... 5) is column.

  FVector<double,6> getOrbit ()const ;

  Return initial closed orbit.

  FVector<double,6> getOrbit (const Row&)const ;

  Get orbit in given row.

  virtual std::vector<double> getRow (const PlaceRep&,const std::vector<string>&) ;

  Return a table row, possible user-defined.

  double getS (const Row&,int,int)const ;

  Arc length for given row.

  FMatrix<double,6,6> getSigma ()const ;

  Initial envelope (Sigma) matrix.

  FMatrix<double,6,6> getSigma (const Row&)const ;

  Envelope (Sigma) matrix for given row.

  double getSigma (const Row&,int,int)const ;

  Sigma matrix.
  Both indices (0 ... 5) refer to planes.

  virtual bool isDependent (const string&)const ;

  Check dependency.
  Return true, if this table depends on the named object.

  virtual Expressions::PtrToScalar<double> makeColumnExpression (const string&)const ;

  Return column expression.
  Return an expression which denotes a column of the twiss table, identified by its name.

  virtual bool matches (Table*)const ;

  Check compatibility.
  True, if rhs is derived from Twiss.

  void printTableBody (std::ostream&,const CellArray&)const ;

  Print the body to this TWISS table.

  void printTableTitle (std::ostream&,const char*)const ;

  Print standard information about the TWISS table.

  void tfsBody (std::ostream&,const CellArray&)const ;

  Write TFS body for this table.

  void tfsSummary (std::ostream&)const ;

  List TFS descriptors for table summary.
  Writes the maximum and r.m.s. orbit and dispersion.

  virtual void tfsTwissDescriptors (std::ostream&)const = 0 ;

  Write TFS descriptors for a TWISS table.
  Writes the line and beam info, as well as length and tunes.

• Protected members:

  Twiss (int,const char*,const char*) ;

  The common attributes for all objects having the "TWISS" interface. Exemplar constructor.
  Must be accessible to classes Insertion and Period.

  Twiss (const string&,Twiss*) ;

  Clone constructor.

  FMatrix<double,6,6> curly_A ;

  The initial curly A matrix.

  static const int numColumns ;

  Number of table columns.

  FVector<double,6> orbit ;

  The initial closed orbit.

• Friends:

  class Insertion ;

  The TWISSTRACK command.

  class Period ;

  The TWISS command.