Happy New Year!
[ginac.git] / ginac / color.h
1 /** @file color.h
2  *
3  *  Interface to GiNaC's color (SU(3) Lie algebra) objects. */
4
5 /*
6  *  GiNaC Copyright (C) 1999-2019 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21  */
22
23 #ifndef GINAC_COLOR_H
24 #define GINAC_COLOR_H
25
26 #include "indexed.h"
27 #include "tensor.h"
28
29 #include <set>
30
31 namespace GiNaC {
32
33 /** This class holds a generator T_a or the unity element of the Lie algebra
34  *  of SU(3), as used for calculations in quantum chromodynamics. A
35  *  representation label (an unsigned 8-bit integer) is used to distinguish
36  *  elements from different Lie algebras (objects with different labels
37  *  commutate). These objects implement an abstract representation of the
38  *  group, not a specific matrix representation. The indices used for color
39  *  objects should not have a variance. */
40 class color : public indexed
41 {
42         GINAC_DECLARE_REGISTERED_CLASS(color, indexed)
43         // other constructors
44 public:
45         color(const ex & b, unsigned char rl = 0);
46         color(const ex & b, const ex & i1, unsigned char rl = 0);
47
48         // internal constructors
49         color(unsigned char rl, const exvector & v);
50         color(unsigned char rl, exvector && v);
51         void archive(archive_node& n) const override;
52         void read_archive(const archive_node& n, lst& sym_lst) override;
53
54         // functions overriding virtual functions from base classes
55 protected:
56         ex eval_ncmul(const exvector & v) const override;
57         bool match_same_type(const basic & other) const override;
58         ex thiscontainer(const exvector & v) const override;
59         ex thiscontainer(exvector && v) const override;
60         unsigned return_type() const override { return return_types::noncommutative; }
61         return_type_t return_type_tinfo() const override;
62
63         // non-virtual functions in this class
64 public:
65         unsigned char get_representation_label() const {return representation_label;}
66
67         // member variables
68 private:
69         unsigned char representation_label; /**< Representation label to distinguish independent color matrices coming from separated fermion lines */
70 };
71 GINAC_DECLARE_UNARCHIVER(color); 
72
73
74 /** This class represents the su(3) unity element. */
75 class su3one : public tensor
76 {
77         GINAC_DECLARE_REGISTERED_CLASS(su3one, tensor)
78
79         // non-virtual functions in this class
80 protected:
81         void do_print(const print_context & c, unsigned level) const;
82         void do_print_latex(const print_latex & c, unsigned level) const;
83 };
84 GINAC_DECLARE_UNARCHIVER(su3one);
85
86 /** This class represents an su(3) generator. */
87 class su3t : public tensor
88 {
89         GINAC_DECLARE_REGISTERED_CLASS(su3t, tensor)
90
91         // functions overriding virtual functions from base classes
92 public:
93         bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const override;
94
95         // non-virtual functions in this class
96 protected:
97         void do_print(const print_context & c, unsigned level) const;
98         void do_print_latex(const print_latex & c, unsigned level) const;
99 };
100 GINAC_DECLARE_UNARCHIVER(su3t);
101
102 /** This class represents the tensor of antisymmetric su(3) structure
103  *  constants. */
104 class su3f : public tensor
105 {
106         GINAC_DECLARE_REGISTERED_CLASS(su3f, tensor)
107
108         // functions overriding virtual functions from base classes
109 public:
110         ex eval_indexed(const basic & i) const override;
111         bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const override;
112 protected:
113         unsigned return_type() const override { return return_types::commutative; }
114
115         // non-virtual functions in this class
116 protected:
117         void do_print(const print_context & c, unsigned level) const;
118         void do_print_latex(const print_latex & c, unsigned level) const;
119 };
120 GINAC_DECLARE_UNARCHIVER(su3f);
121
122 /** This class represents the tensor of symmetric su(3) structure constants. */
123 class su3d : public tensor
124 {
125         GINAC_DECLARE_REGISTERED_CLASS(su3d, tensor)
126
127         // functions overriding virtual functions from base classes
128 public:
129         ex eval_indexed(const basic & i) const override;
130         bool contract_with(exvector::iterator self, exvector::iterator other, exvector & v) const override;
131 protected:
132         unsigned return_type() const override { return return_types::commutative; }
133
134         // non-virtual functions in this class
135 protected:
136         void do_print(const print_context & c, unsigned level) const;
137         void do_print_latex(const print_latex & c, unsigned level) const;
138 };
139 GINAC_DECLARE_UNARCHIVER(su3d);
140
141
142 // global functions
143
144 /** Create the su(3) unity element. This is an indexed object, although it
145  *  has no indices.
146  *
147  *  @param rl Representation label
148  *  @return newly constructed unity element */
149 ex color_ONE(unsigned char rl = 0);
150
151 /** Create an su(3) generator.
152  *
153  *  @param a Index
154  *  @param rl Representation label
155  *  @return newly constructed unity generator */
156 ex color_T(const ex & a, unsigned char rl = 0);
157
158 /** Create an su(3) antisymmetric structure constant.
159  *
160  *  @param a First index
161  *  @param b Second index
162  *  @param c Third index
163  *  @return newly constructed structure constant */
164 ex color_f(const ex & a, const ex & b, const ex & c);
165
166 /** Create an su(3) symmetric structure constant.
167  *
168  *  @param a First index
169  *  @param b Second index
170  *  @param c Third index
171  *  @return newly constructed structure constant */
172 ex color_d(const ex & a, const ex & b, const ex & c);
173
174 /** This returns the linear combination d.a.b.c+I*f.a.b.c. */
175 ex color_h(const ex & a, const ex & b, const ex & c);
176
177 /** Calculate color traces over the specified set of representation labels.
178  *
179  *  @param e Expression to take the trace of
180  *  @param rls Set of representation labels */
181 ex color_trace(const ex & e, const std::set<unsigned char> & rls);
182
183 /** Calculate color traces over the specified list of representation labels.
184  *
185  *  @param e Expression to take the trace of
186  *  @param rll List of representation labels */
187 ex color_trace(const ex & e, const lst & rll);
188
189 /** Calculate the trace of an expression containing color objects with a
190  *  specified representation label.
191  *
192  *  @param e Expression to take the trace of
193  *  @param rl Representation label */
194 ex color_trace(const ex & e, unsigned char rl = 0);
195
196 } // namespace GiNaC
197
198 #endif // ndef GINAC_COLOR_H