ginac/lortensor.h

   1 /** @file lortensor.h
   2  *
   3  *  Interface to GiNaC's Lorentz tensors. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999-2001 Johannes Gutenberg University Mainz, Germany
   7  *
   8  *  This program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License as published by
  10  *  the Free Software Foundation; either version 2 of the License, or
  11  *  (at your option) any later version.
  12  *
  13  *  This program is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *  GNU General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License
  19  *  along with this program; if not, write to the Free Software
  20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 #ifndef __GINAC_LORTENSOR_H__
  24 #define __GINAC_LORTENSOR_H__
  25
  26 #include <string>
  27 #include <vector>
  28 #include <iostream>
  29 #include "indexed.h"
  30 #include "lorentzidx.h"
  31
  32 #ifndef NO_NAMESPACE_GINAC
  33 namespace GiNaC {
  34 #endif // ndef NO_NAMESPACE_GINAC
  35
  36
  37 /** This class holds an object carrying Lorentz indices (of class
  38  *  lorentzidx). It can represent a general (symbolic) tensor of type
  39  *  (p,q), or one of the constant tensors g (the metric), delta (unity
  40  *  matrix) or epsilon (4-dimensional totally antisymmetric tensor). */
  41 class lortensor : public indexed
  42 {
  43         GINAC_DECLARE_REGISTERED_CLASS(lortensor, indexed)
  44
  45 // friends
  46
  47         friend lortensor lortensor_g(const ex & mu, const ex & nu);
  48         friend lortensor lortensor_delta(const ex & mu, const ex & nu);
  49         friend lortensor lortensor_epsilon(const ex & mu, const ex & nu,
  50                                                                            const ex & rho, const ex & sigma);
  51         friend lortensor lortensor_vector(const string & n, const ex & mu);
  52         friend lortensor lortensor_symbolic(const string & name, const exvector & iv);
  53
  54         friend ex simplify_lortensor_mul(const ex & m);
  55         friend ex simplify_lortensor(const ex & e);
  56
  57 // types
  58
  59 public:
  60         typedef enum {
  61                 invalid,           /**< not properly constructed */
  62                 lortensor_g,       /**< metric tensor */
  63                 lortensor_delta,   /**< unity matrix */
  64                 lortensor_epsilon, /**< four-dimensional totally antisymmetric tensor */
  65                 lortensor_symbolic /**< general symbolic Lorentz tensor */
  66         } lortensor_types;
  67
  68 // member functions
  69
  70         // other constructors
  71 protected:
  72         lortensor(lortensor_types const lt, const std::string & n);
  73         lortensor(lortensor_types const lt, const std::string & n, const ex & mu);
  74         lortensor(lortensor_types const lt, const std::string & n, const ex & mu, const ex & nu);
  75         lortensor(lortensor_types const lt, const std::string & n, const ex & mu, const ex & nu, const ex & rho);
  76         lortensor(lortensor_types const lt, const std::string & n, const ex & mu, const ex & nu, const ex & rho, const ex & sigma);
  77         lortensor(lortensor_types const lt, const std::string & n, const exvector & iv);
  78         lortensor(lortensor_types const lt, const std::string & n, unsigned s, const exvector & iv);
  79         lortensor(lortensor_types const lt, const std::string & n, unsigned s, exvector * ivp);
  80
  81         //functions overriding virtual functions from base classes
  82 public:
  83         void printraw(std::ostream & os) const;
  84         void printtree(std::ostream & os, unsigned indent) const;
  85         void print(std::ostream & os, unsigned upper_precedence=0) const;
  86         bool info(unsigned inf) const;
  87         ex eval(int level=0) const;
  88 protected:
  89         bool is_equal_same_type(const basic & other) const;
  90         unsigned return_type(void) const;
  91         unsigned return_type_tinfo(void) const;
  92         ex thisexprseq(const exvector & v) const;
  93         ex thisexprseq(exvector * vp) const;
  94
  95         // new virtual functions which can be overridden by derived classes
  96         // none
  97
  98         //non virtual functions in this class
  99 public:
 100         void setname(const std::string & n) {name = n;}
 101         std::string getname(void) const {return name;}
 102 protected:
 103         bool all_of_type_lorentzidx(void) const;
 104 private:
 105         std::string & autoname_prefix(void);
 106
 107         //member variables
 108
 109 protected:
 110         lortensor_types type; /**< Type of object */
 111         std::string name;     /**< Name of symbolic tensor */
 112         unsigned serial;      /**< Unique serial number for comparing symbolic tensors */
 113 private:
 114         static unsigned next_serial;
 115 };
 116
 117 // utility functions
 118
 119 inline const lortensor & ex_to_lortensor(const ex &e)
 120 {
 121         return static_cast<const lortensor &>(*e.bp);
 122 }
 123
 124 inline lortensor &ex_to_nonconst_lortensor(const ex &e)
 125 {
 126         return static_cast<lortensor &>(*e.bp);
 127 }
 128
 129 lortensor lortensor_g(const ex & mu, const ex & nu);
 130 lortensor lortensor_delta(const ex & mu, const ex & nu);
 131 lortensor lortensor_epsilon(const ex & mu, const ex & nu,
 132                             const ex & rho, const ex & sigma);
 133 lortensor lortensor_vector(const string & n, const ex & mu);
 134 lortensor lortensor_symbolic(const string & name, const exvector & iv);
 135
 136 ex simplify_lortensor_mul(const ex & m);
 137 ex simplify_lortensor(const ex & e);
 138
 139 #ifndef NO_NAMESPACE_GINAC
 140 } // namespace GiNaC
 141 #endif // ndef NO_NAMESPACE_GINAC
 142
 143 #endif // ndef __GINAC_LORTENSOR_H__