check/exam_indexed.cpp

   1 /** @file exam_indexed.cpp
   2  *
   3  *  Here we test manipulations on GiNaC's indexed objects. */
   4
   5 /*
   6  *  GiNaC Copyright (C) 1999-2008 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 #include <iostream>
  24 #include "ginac.h"
  25 using namespace std;
  26 using namespace GiNaC;
  27
  28 static unsigned check_equal(const ex &e1, const ex &e2)
  29 {
  30         ex e = e1 - e2;
  31         if (!e.is_zero()) {
  32                 clog << e1 << "-" << e2 << " erroneously returned "
  33                      << e << " instead of 0" << endl;
  34                 return 1;
  35         }
  36         return 0;
  37 }
  38
  39 static unsigned check_equal_simplify(const ex &e1, const ex &e2)
  40 {
  41         ex e = simplify_indexed(e1) - e2;
  42         if (!e.is_zero()) {
  43                 clog << "simplify_indexed(" << e1 << ")-" << e2 << " erroneously returned "
  44                      << e << " instead of 0" << endl;
  45                 return 1;
  46         }
  47         return 0;
  48 }
  49
  50 static unsigned check_equal_simplify(const ex &e1, const ex &e2, const scalar_products &sp)
  51 {
  52         ex e = simplify_indexed(e1, sp) - e2;
  53         if (!e.is_zero()) {
  54                 clog << "simplify_indexed(" << e1 << ")-" << e2 << " erroneously returned "
  55                      << e << " instead of 0" << endl;
  56                 return 1;
  57         }
  58         return 0;
  59 }
  60
  61 static unsigned delta_check()
  62 {
  63         // checks identities of the delta tensor
  64
  65         unsigned result = 0;
  66
  67         symbol s_i("i"), s_j("j"), s_k("k");
  68         idx i(s_i, 3), j(s_j, 3), k(s_k, 3);
  69         symbol A("A");
  70
  71         // symmetry
  72         result += check_equal(delta_tensor(i, j), delta_tensor(j, i));
  73
  74         // trace = dimension of index space
  75         result += check_equal(delta_tensor(i, i), 3);
  76         result += check_equal_simplify(delta_tensor(i, j) * delta_tensor(i, j), 3);
  77
  78         // contraction with delta tensor
  79         result += check_equal_simplify(delta_tensor(i, j) * indexed(A, k), delta_tensor(i, j) * indexed(A, k));
  80         result += check_equal_simplify(delta_tensor(i, j) * indexed(A, j), indexed(A, i));
  81         result += check_equal_simplify(delta_tensor(i, j) * indexed(A, i), indexed(A, j));
  82         result += check_equal_simplify(delta_tensor(i, j) * delta_tensor(j, k) * indexed(A, i), indexed(A, k));
  83
  84         return result;
  85 }
  86
  87 static unsigned metric_check()
  88 {
  89         // checks identities of the metric tensor
  90
  91         unsigned result = 0;
  92
  93         symbol s_mu("mu"), s_nu("nu"), s_rho("rho"), s_sigma("sigma");
  94         varidx mu(s_mu, 4), nu(s_nu, 4), rho(s_rho, 4), sigma(s_sigma, 4);
  95         symbol A("A");
  96
  97         // becomes delta tensor if indices have opposite variance
  98         result += check_equal(metric_tensor(mu, nu.toggle_variance()), delta_tensor(mu, nu.toggle_variance()));
  99
 100         // scalar contraction = dimension of index space
 101         result += check_equal(metric_tensor(mu, mu.toggle_variance()), 4);
 102         result += check_equal_simplify(metric_tensor(mu, nu) * metric_tensor(mu.toggle_variance(), nu.toggle_variance()), 4);
 103
 104         // contraction with metric tensor
 105         result += check_equal_simplify(metric_tensor(mu, nu) * indexed(A, nu), metric_tensor(mu, nu) * indexed(A, nu));
 106         result += check_equal_simplify(metric_tensor(mu, nu) * indexed(A, nu.toggle_variance()), indexed(A, mu));
 107         result += check_equal_simplify(metric_tensor(mu, nu) * indexed(A, mu.toggle_variance()), indexed(A, nu));
 108         result += check_equal_simplify(metric_tensor(mu, nu) * metric_tensor(mu.toggle_variance(), rho.toggle_variance()) * indexed(A, nu.toggle_variance()), indexed(A, rho.toggle_variance()));
 109         result += check_equal_simplify(metric_tensor(mu, rho) * metric_tensor(nu, sigma) * indexed(A, rho.toggle_variance(), sigma.toggle_variance()), indexed(A, mu, nu));
 110         result += check_equal_simplify(indexed(A, mu.toggle_variance()) * metric_tensor(mu, nu) - indexed(A, mu.toggle_variance()) * metric_tensor(nu, mu), 0);
 111         result += check_equal_simplify(indexed(A, mu.toggle_variance(), nu.toggle_variance()) * metric_tensor(nu, rho), indexed(A, mu.toggle_variance(), rho));
 112
 113         // contraction with delta tensor yields a metric tensor
 114         result += check_equal_simplify(delta_tensor(mu, nu.toggle_variance()) * metric_tensor(nu, rho), metric_tensor(mu, rho));
 115         result += check_equal_simplify(metric_tensor(mu, nu) * indexed(A, nu.toggle_variance()) * delta_tensor(mu.toggle_variance(), rho), indexed(A, rho));
 116
 117         return result;
 118 }
 119
 120 static unsigned epsilon_check()
 121 {
 122         // checks identities of the epsilon tensor
 123
 124         unsigned result = 0;
 125
 126         symbol s_mu("mu"), s_nu("nu"), s_rho("rho"), s_sigma("sigma"), s_tau("tau");
 127         symbol d("d");
 128         varidx mu(s_mu, 4), nu(s_nu, 4), rho(s_rho, 4), sigma(s_sigma, 4), tau(s_tau, 4);
 129         varidx mu_co(s_mu, 4, true), nu_co(s_nu, 4, true), rho_co(s_rho, 4, true), sigma_co(s_sigma, 4, true), tau_co(s_tau, 4, true);
 130
 131         // antisymmetry
 132         result += check_equal(lorentz_eps(mu, nu, rho, sigma) + lorentz_eps(sigma, rho, mu, nu), 0);
 133
 134         // convolution is zero
 135         result += check_equal(lorentz_eps(mu, nu, rho, nu_co), 0);
 136         result += check_equal(lorentz_eps(mu, nu, mu_co, nu_co), 0);
 137         result += check_equal_simplify(lorentz_g(mu_co, nu_co) * lorentz_eps(mu, nu, rho, sigma), 0);
 138
 139         // contraction with symmetric tensor is zero
 140         result += check_equal_simplify(lorentz_eps(mu, nu, rho, sigma) * indexed(d, sy_symm(), mu_co, nu_co), 0);
 141         result += check_equal_simplify(lorentz_eps(mu, nu, rho, sigma) * indexed(d, sy_symm(), nu_co, sigma_co, rho_co), 0);
 142         result += check_equal_simplify(lorentz_eps(mu, nu, rho, sigma) * indexed(d, mu_co) * indexed(d, nu_co), 0);
 143         result += check_equal_simplify(lorentz_eps(mu_co, nu, rho, sigma) * indexed(d, mu) * indexed(d, nu_co), 0);
 144         ex e = lorentz_eps(mu, nu, rho, sigma) * indexed(d, mu_co) - lorentz_eps(mu_co, nu, rho, sigma) * indexed(d, mu);
 145         result += check_equal_simplify(e, 0);
 146
 147         // contractions of epsilon tensors
 148         result += check_equal_simplify(lorentz_eps(mu, nu, rho, sigma) * lorentz_eps(mu_co, nu_co, rho_co, sigma_co), -24);
 149         result += check_equal_simplify(lorentz_eps(tau, nu, rho, sigma) * lorentz_eps(mu_co, nu_co, rho_co, sigma_co), -6 * delta_tensor(tau, mu_co));
 150
 151         return result;
 152 }
 153
 154 DECLARE_FUNCTION_2P(symm_fcn)
 155 REGISTER_FUNCTION(symm_fcn, set_symmetry(sy_symm(0, 1)));
 156 DECLARE_FUNCTION_2P(anti_fcn)
 157 REGISTER_FUNCTION(anti_fcn, set_symmetry(sy_anti(0, 1)));
 158
 159 static unsigned symmetry_check()
 160 {
 161         // check symmetric/antisymmetric objects
 162
 163         unsigned result = 0;
 164
 165         idx i(symbol("i"), 3), j(symbol("j"), 3), k(symbol("k"), 3), l(symbol("l"), 3);
 166         symbol A("A"), B("B"), C("C");
 167         ex e;
 168
 169         result += check_equal(indexed(A, sy_symm(), i, j), indexed(A, sy_symm(), j, i));
 170         result += check_equal(indexed(A, sy_anti(), i, j) + indexed(A, sy_anti(), j, i), 0);
 171         result += check_equal(indexed(A, sy_anti(), i, j, k) - indexed(A, sy_anti(), j, k, i), 0);
 172         e = indexed(A, sy_symm(), i, j, k) *
 173             indexed(B, sy_anti(), l, k, i);
 174         result += check_equal_simplify(e, 0);
 175         e = indexed(A, sy_symm(), i, i, j, j) *
 176             indexed(B, sy_anti(), k, l); // GiNaC 0.8.0 had a bug here
 177         result += check_equal_simplify(e, e);
 178
 179         symmetry R = sy_symm(sy_anti(0, 1), sy_anti(2, 3));
 180         e = indexed(A, R, i, j, k, l) + indexed(A, R, j, i, k, l);
 181         result += check_equal(e, 0);
 182         e = indexed(A, R, i, j, k, l) + indexed(A, R, i, j, l, k);
 183         result += check_equal(e, 0);
 184         e = indexed(A, R, i, j, k, l) - indexed(A, R, j, i, l, k);
 185         result += check_equal(e, 0);
 186         e = indexed(A, R, i, j, k, l) + indexed(A, R, k, l, j, i);
 187         result += check_equal(e, 0);
 188
 189         e = indexed(A, i, j);
 190         result += check_equal(symmetrize(e) + antisymmetrize(e), e);
 191         e = indexed(A, sy_symm(), i, j, k, l);
 192         result += check_equal(symmetrize(e), e);
 193         result += check_equal(antisymmetrize(e), 0);
 194         e = indexed(A, sy_anti(), i, j, k, l);
 195         result += check_equal(symmetrize(e), 0);
 196         result += check_equal(antisymmetrize(e), e);
 197
 198         e = (indexed(A, sy_anti(), i, j, k, l) * (indexed(B, j) * indexed(C, k) + indexed(B, k) * indexed(C, j)) + indexed(B, i, l)).expand();
 199         result += check_equal_simplify(e, indexed(B, i, l));
 200
 201         result += check_equal(symm_fcn(0, 1) + symm_fcn(1, 0), 2*symm_fcn(0, 1));
 202         result += check_equal(anti_fcn(0, 1) + anti_fcn(1, 0), 0);
 203         result += check_equal(anti_fcn(0, 0), 0);
 204
 205         return result;
 206 }
 207
 208 static unsigned scalar_product_check()
 209 {
 210         // check scalar product replacement
 211
 212         unsigned result = 0;
 213
 214     idx i(symbol("i"), 3), j(symbol("j"), 3);
 215     symbol A("A"), B("B"), C("C");
 216         ex e;
 217
 218     scalar_products sp;
 219     sp.add(A, B, 0); // A and B are orthogonal
 220     sp.add(A, C, 0); // A and C are orthogonal
 221     sp.add(A, A, 4); // A^2 = 4 (A has length 2)
 222
 223     e = (indexed(A + B, i) * indexed(A + C, i)).expand(expand_options::expand_indexed);
 224         result += check_equal_simplify(e, indexed(B, i) * indexed(C, i) + 4, sp);
 225         e = indexed(A, i, i) * indexed(B, j, j); // GiNaC 0.8.0 had a bug here
 226         result += check_equal_simplify(e, e, sp);
 227
 228         return result;
 229 }
 230
 231 static unsigned edyn_check()
 232 {
 233         // Relativistic electrodynamics
 234
 235         // Test 1: check transformation laws of electric and magnetic fields by
 236         // applying a Lorentz boost to the field tensor
 237
 238         unsigned result = 0;
 239
 240         symbol beta("beta");
 241         ex gamma = 1 / sqrt(1 - pow(beta, 2));
 242         symbol Ex("Ex"), Ey("Ey"), Ez("Ez");
 243         symbol Bx("Bx"), By("By"), Bz("Bz");
 244
 245         // Lorentz transformation matrix (boost along x axis)
 246         matrix L(4, 4);
 247         L =       gamma, -beta*gamma, 0, 0,
 248             -beta*gamma,       gamma, 0, 0,
 249                       0,           0, 1, 0,
 250                       0,           0, 0, 1;
 251
 252         // Electromagnetic field tensor
 253         matrix F(4, 4);
 254         F =  0, -Ex, -Ey, -Ez,
 255                 Ex,   0, -Bz,  By,
 256                 Ey,  Bz,   0, -Bx,
 257                 Ez, -By,  Bx,   0;
 258
 259         // Indices
 260         symbol s_mu("mu"), s_nu("nu"), s_rho("rho"), s_sigma("sigma");
 261         varidx mu(s_mu, 4), nu(s_nu, 4), rho(s_rho, 4), sigma(s_sigma, 4);
 262
 263         // Apply transformation law of second rank tensor
 264         ex e = (indexed(L, mu, rho.toggle_variance())
 265               * indexed(L, nu, sigma.toggle_variance())
 266               * indexed(F, rho, sigma)).simplify_indexed();
 267
 268         // Extract transformed electric and magnetic fields
 269         ex Ex_p = e.subs(lst(mu == 1, nu == 0)).normal();
 270         ex Ey_p = e.subs(lst(mu == 2, nu == 0)).normal();
 271         ex Ez_p = e.subs(lst(mu == 3, nu == 0)).normal();
 272         ex Bx_p = e.subs(lst(mu == 3, nu == 2)).normal();
 273         ex By_p = e.subs(lst(mu == 1, nu == 3)).normal();
 274         ex Bz_p = e.subs(lst(mu == 2, nu == 1)).normal();
 275
 276         // Check results
 277         result += check_equal(Ex_p, Ex);
 278         result += check_equal(Ey_p, gamma * (Ey - beta * Bz));
 279         result += check_equal(Ez_p, gamma * (Ez + beta * By));
 280         result += check_equal(Bx_p, Bx);
 281         result += check_equal(By_p, gamma * (By + beta * Ez));
 282         result += check_equal(Bz_p, gamma * (Bz - beta * Ey));
 283
 284         // Test 2: check energy density and Poynting vector of electromagnetic field
 285
 286         // Minkowski metric
 287         ex eta = diag_matrix(lst(1, -1, -1, -1));
 288
 289         // Covariant field tensor
 290         ex F_mu_nu = (indexed(eta, mu.toggle_variance(), rho.toggle_variance())
 291                     * indexed(eta, nu.toggle_variance(), sigma.toggle_variance())
 292                     * indexed(F, rho, sigma)).simplify_indexed();
 293
 294         // Energy-momentum tensor
 295         ex T = (-indexed(eta, rho, sigma) * F_mu_nu.subs(s_nu == s_rho)
 296                 * F_mu_nu.subs(lst(s_mu == s_nu, s_nu == s_sigma))
 297               + indexed(eta, mu.toggle_variance(), nu.toggle_variance())
 298                 * F_mu_nu.subs(lst(s_mu == s_rho, s_nu == s_sigma))
 299                 * indexed(F, rho, sigma) / 4).simplify_indexed() / (4 * Pi);
 300
 301         // Extract energy density and Poynting vector
 302         ex E = T.subs(lst(s_mu == 0, s_nu == 0)).normal();
 303         ex Px = T.subs(lst(s_mu == 0, s_nu == 1));
 304         ex Py = T.subs(lst(s_mu == 0, s_nu == 2));
 305         ex Pz = T.subs(lst(s_mu == 0, s_nu == 3));
 306
 307         // Check results
 308         result += check_equal(E, (Ex*Ex+Ey*Ey+Ez*Ez+Bx*Bx+By*By+Bz*Bz) / (8 * Pi));
 309         result += check_equal(Px, (Ez*By-Ey*Bz) / (4 * Pi));
 310         result += check_equal(Py, (Ex*Bz-Ez*Bx) / (4 * Pi));
 311         result += check_equal(Pz, (Ey*Bx-Ex*By) / (4 * Pi));
 312
 313         return result;
 314 }
 315
 316 static unsigned spinor_check()
 317 {
 318         // check identities of the spinor metric
 319
 320         unsigned result = 0;
 321
 322         symbol psi("psi");
 323         spinidx A(symbol("A")), B(symbol("B")), C(symbol("C")), D(symbol("D"));
 324         ex A_co = A.toggle_variance(), B_co = B.toggle_variance();
 325         ex e;
 326
 327         e = spinor_metric(A_co, B_co) * spinor_metric(A, B);
 328         result += check_equal_simplify(e, 2);
 329         e = spinor_metric(A_co, B_co) * spinor_metric(B, A);
 330         result += check_equal_simplify(e, -2);
 331         e = spinor_metric(A_co, B_co) * spinor_metric(A, C);
 332         result += check_equal_simplify(e, delta_tensor(B_co, C));
 333         e = spinor_metric(A_co, B_co) * spinor_metric(B, C);
 334         result += check_equal_simplify(e, -delta_tensor(A_co, C));
 335         e = spinor_metric(A_co, B_co) * spinor_metric(C, A);
 336         result += check_equal_simplify(e, -delta_tensor(B_co, C));
 337         e = spinor_metric(A, B) * indexed(psi, B_co);
 338         result += check_equal_simplify(e, indexed(psi, A));
 339         e = spinor_metric(A, B) * indexed(psi, A_co);
 340         result += check_equal_simplify(e, -indexed(psi, B));
 341         e = spinor_metric(A_co, B_co) * indexed(psi, B);
 342         result += check_equal_simplify(e, -indexed(psi, A_co));
 343         e = spinor_metric(A_co, B_co) * indexed(psi, A);
 344         result += check_equal_simplify(e, indexed(psi, B_co));
 345         e = spinor_metric(D, A) * spinor_metric(A_co, B_co) * spinor_metric(B, C) - spinor_metric(D, A_co) * spinor_metric(A, B_co) * spinor_metric(B, C);
 346         result += check_equal_simplify(e, 0);
 347
 348         return result;
 349 }
 350
 351 static unsigned dummy_check()
 352 {
 353         // check dummy index renaming/repositioning
 354
 355         unsigned result = 0;
 356
 357         symbol p("p"), q("q");
 358         idx i(symbol("i"), 3), j(symbol("j"), 3), n(symbol("n"), 3);
 359         varidx mu(symbol("mu"), 4), nu(symbol("nu"), 4);
 360         ex e;
 361
 362         e = indexed(p, i) * indexed(q, i) - indexed(p, j) * indexed(q, j);
 363         result += check_equal_simplify(e, 0);
 364
 365         e = indexed(p, i) * indexed(p, i) * indexed(q, j) * indexed(q, j)
 366           - indexed(p, n) * indexed(p, n) * indexed(q, j) * indexed(q, j);
 367         result += check_equal_simplify(e, 0);
 368
 369         e = indexed(p, mu, mu.toggle_variance()) - indexed(p, nu, nu.toggle_variance());
 370         result += check_equal_simplify(e, 0);
 371
 372         e = indexed(p, mu.toggle_variance(), nu, mu) * indexed(q, i)
 373           - indexed(p, mu, nu, mu.toggle_variance()) * indexed(q, i);
 374         result += check_equal_simplify(e, 0);
 375
 376         e = indexed(p, mu, mu.toggle_variance()) - indexed(p, nu.toggle_variance(), nu);
 377         result += check_equal_simplify(e, 0);
 378         e = indexed(p, mu.toggle_variance(), mu) - indexed(p, nu, nu.toggle_variance());
 379         result += check_equal_simplify(e, 0);
 380
 381         // GiNaC 1.2.1 had a bug here because p.i*p.i -> (p.i)^2
 382         e = indexed(p, i) * indexed(p, i) * indexed(p, j) + indexed(p, j);
 383         ex fi = exprseq(e.get_free_indices());
 384         if (!fi.is_equal(exprseq(j))) {
 385                 clog << "get_free_indices(" << e << ") erroneously returned "
 386                      << fi << " instead of (.j)" << endl;
 387                 ++result;
 388         }
 389
 390         return result;
 391 }
 392
 393 unsigned exam_indexed()
 394 {
 395         unsigned result = 0;
 396
 397         cout << "examining indexed objects" << flush;
 398
 399         result += delta_check();  cout << '.' << flush;
 400         result += metric_check();  cout << '.' << flush;
 401         result += epsilon_check();  cout << '.' << flush;
 402         result += symmetry_check();  cout << '.' << flush;
 403         result += scalar_product_check();  cout << '.' << flush;
 404         result += edyn_check();  cout << '.' << flush;
 405         result += spinor_check(); cout << '.' << flush;
 406         result += dummy_check(); cout << '.' << flush;
 407
 408         return result;
 409 }
 410
 411 int main(int argc, char** argv)
 412 {
 413         return exam_indexed();
 414 }