ginac/tensor.h

   1 /** @file tensor.h
   2  *
   3  *  Interface to GiNaC's special 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_TENSOR_H__
  24 #define __GINAC_TENSOR_H__
  25
  26 #include "ex.h"
  27
  28 namespace GiNaC {
  29
  30
  31 /** This class holds one of GiNaC's predefined special tensors such as the
  32  *  delta and the metric tensors. They are represented without indices.
  33  *  To attach indices to them, wrap them in an object of class indexed. */
  34 class tensor : public basic
  35 {
  36         GINAC_DECLARE_REGISTERED_CLASS(tensor, basic)
  37
  38         // other constructors
  39 protected:
  40         tensor(unsigned ti);
  41
  42         // functions overriding virtual functions from bases classes
  43 protected:
  44         unsigned return_type(void) const { return return_types::noncommutative_composite; }
  45 };
  46
  47
  48 /** This class represents the delta tensor. If indexed, it must have exactly
  49  *  two indices of the same type. */
  50 class tensdelta : public tensor
  51 {
  52         GINAC_DECLARE_REGISTERED_CLASS(tensdelta, tensor)
  53
  54         // functions overriding virtual functions from bases classes
  55 public:
  56         void print(std::ostream & os, unsigned upper_precedence=0) const;
  57         ex eval_indexed(const basic & i) const;
  58         bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
  59 };
  60
  61
  62 /** This class represents a general metric tensor which can be used to
  63  *  raise/lower indices. If indexed, it must have exactly two indices of the
  64  *  same type which must be of class varidx or a subclass. */
  65 class tensmetric : public tensor
  66 {
  67         GINAC_DECLARE_REGISTERED_CLASS(tensmetric, tensor)
  68
  69         // functions overriding virtual functions from bases classes
  70 public:
  71         void print(std::ostream & os, unsigned upper_precedence=0) const;
  72         ex eval_indexed(const basic & i) const;
  73         bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const;
  74 };
  75
  76
  77 /** This class represents a Minkowski metric tensor. It has all the
  78  *  properties of a metric tensor and is (as a matrix) equal to
  79  *  diag(1,-1,-1,...) or diag(-1,1,1,...). */
  80 class minkmetric : public tensmetric
  81 {
  82         GINAC_DECLARE_REGISTERED_CLASS(minkmetric, tensmetric)
  83
  84         // other constructors
  85 public:
  86         /** Construct Lorentz metric tensor with given signature. */
  87         minkmetric(bool pos_sig);
  88
  89         // functions overriding virtual functions from bases classes
  90 public:
  91         void print(std::ostream & os, unsigned upper_precedence=0) const;
  92         ex eval_indexed(const basic & i) const;
  93
  94         // member variables
  95 private:
  96         bool pos_sig; /**< If true, the metric is diag(-1,1,1...). Otherwise it is diag(1,-1,-1,...). */
  97 };
  98
  99
 100 /** This class represents the totally antisymmetric epsilon tensor. If
 101  *  indexed, all indices must be of the same type and their number must
 102  *  be equal to the dimension of the index space. */
 103 class tensepsilon : public tensor
 104 {
 105         GINAC_DECLARE_REGISTERED_CLASS(tensepsilon, tensor)
 106
 107         // functions overriding virtual functions from bases classes
 108 public:
 109         void print(std::ostream & os, unsigned upper_precedence=0) const;
 110 };
 111
 112
 113 // utility functions
 114 inline const tensor &ex_to_tensor(const ex &e)
 115 {
 116         return static_cast<const tensor &>(*e.bp);
 117 }
 118
 119 /** Create a delta tensor with specified indices. The indices must be of class
 120  *  idx or a subclass. The delta tensor is always symmetric and its trace is
 121  *  the dimension of the index space.
 122  *
 123  *  @param i1 First index
 124  *  @param i2 Second index
 125  *  @return newly constructed delta tensor */
 126 ex delta_tensor(const ex & i1, const ex & i2);
 127
 128 /** Create a metric tensor with specified indices. The indices must be of
 129  *  class varidx or a subclass. A metric tensor with one covariant and one
 130  *  contravariant index is equivalent to the delta tensor.
 131  *
 132  *  @param i1 First index
 133  *  @param i2 Second index
 134  *  @return newly constructed metric tensor */
 135 ex metric_tensor(const ex & i1, const ex & i2);
 136
 137 /** Create a Minkowski metric tensor with specified indices. The indices
 138  *  must be of class varidx or a subclass. The Lorentz metric is a symmetric
 139  *  tensor with a matrix representation of diag(1,-1,-1,...) (negative
 140  *  signature, the default) or diag(-1,1,1,...) (positive signature).
 141  *
 142  *  @param i1 First index
 143  *  @param i2 Second index
 144  *  @param pos_sig Whether the signature is positive
 145  *  @return newly constructed Lorentz metric tensor */
 146 ex lorentz_g(const ex & i1, const ex & i2, bool pos_sig = false);
 147
 148 /** Create an epsilon tensor with two indices. The indices must be of class
 149  *  idx or a subclass, and have a dimension of 2.
 150  *
 151  *  @param i1 First index
 152  *  @param i2 Second index
 153  *  @return newly constructed epsilon tensor */
 154 ex epsilon_tensor(const ex & i1, const ex & i2);
 155
 156 } // namespace GiNaC
 157
 158 #endif // ndef __GINAC_TENSOR_H__