aboutsummaryrefslogtreecommitdiff
path: root/Tools/CodeGen/CodeGenSymmetries.m
blob: e8d521c43440272212952a389197b43fb0834997 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
(*  Copyright 2004-2013 Sascha Husa, Ian Hinder, Christiane Lechner

    This file is part of Kranc.

    Kranc is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    Kranc is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with Kranc; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*)

BeginPackage[
  "CodeGenSymmetries`",
  {"Errors`", "Helpers`", "Kranc`", "CodeGenCactus`", "MapLookup`", "CodeGenKranc`",
   "CodeGenC`", "CodeGen`"}];

CreateSymmetriesRegistrationSource::usage = "";

Begin["`Private`"];

(* ------------------------------------------------------------------------ 
   Symmetries Registration
   ------------------------------------------------------------------------ *)

(* Symmetries registration spec = {FullName -> "impl::GFname", 
                                    Sym      -> {symX, symY, symZ}} *)

DefFn[symmetriesBlock[spec_] :=
  Module[
    {i, dim},

    If[!MatchQ[spec, {FullName -> _String, Sym -> {_,_,_}}],
       ThrowError["symmetriesBlock: Expecting a symmetry registration spec but got ", spec]];

    sym = lookup[spec, Sym];
    dim = Length[sym];
    
    {Table[{"sym[", i - 1, "] = ", sym[[i]], ";\n"}, {i, 1, dim}],
     "SetCartSymVN(cctkGH, sym, ", Quote[lookup[spec, FullName]], ");\n\n"}]];

(* syms is a list of rules mapping gridfunctions to their symmetry structures *)
DefFn[
  calcSymmetry[gf_, syms_] :=
  Module[
    {},
    If[mapContains[syms, gf],
       Return[lookup[syms,gf]],
       (* FIXME: We are defaulting to scalar symmetries if no information is
          available.  This shouldn't happen, but I am bypassing this check
          temporarily. *)
       Print["WARNING: defaulting to symmetries of a scalar for "<>ToString[gf]];
       Return[{1,1,1}]]]];


(* This function guesses the symmetries based on component names as we
   have not been given them *)
DefFn[
  calcSymmetry[gf_] :=
  Module[
    {sym = {1,1,1} (* default *), q, string},
    string = ToString@gf;
    While[
      IntegerQ[q = ToExpression@StringTake[string, -1]],
      sym[[q]] = -sym[[q]];
      string = StringDrop[string, -1]];
    sym]];

(* Given a symmetries registration structure as defined above, return a
   C CodeGen structure of a source file which will register the symmetries. *)
DefFn[
  CreateSymmetriesRegistrationSource[thornName_, implementationName_, GFs_, reflectionSymmetries_, debug_] :=
  Module[
    {spec, j, lang, tmp},

    If[debug, Print["Registering Symmetries for: ", GFs]];

    lang = CodeGenC`SOURCELANGUAGE;
    CodeGenC`SOURCELANGUAGE = "C";

    spec = Map[{FullName -> implementationName <> "::" <> ToString@#,
                Sym      -> If[reflectionSymmetries === False,
                                 calcSymmetry[#],
                                 calcSymmetry[#, Union@reflectionSymmetries]]} &,
                 GFs];

    tmp = {FileHeader["C"],
           
           Map[IncludeFile, 
               {"cctk.h", "cctk_Arguments.h", "cctk_Parameters.h", "Symmetry.h"}],

           DefineCCTKFunction[
             thornName <> "_RegisterSymmetries", "void", 
             If[Length[spec] > 0,
                {CommentedBlock["array holding symmetry definitions",
                                "CCTK_INT sym[3];\n\n"],
                 CommentedBlock["Register symmetries of grid functions",
                                Map[symmetriesBlock, spec]]},
                {}]]};

    CodeGenC`SOURCELANGUAGE = lang;

    tmp]];

End[];

EndPackage[];