path: root/src/Symmetry.c

/*@@
   @file      Symmetry.c
   @date      Mon Mar 15 15:09:00 1999
   @author    Gerd Lanfermann
   @desc 
     This file contains the routines for registering and applying symmetry 
     boundary conditions
   @enddesc 
 @@*/

#include <stdlib.h>
#include <stdio.h>

#include "cctk.h"
#include "cctk_parameters.h"
#include "Symmetry.h" 
#include "cctk_FortranString.h"

/*#define DEBUG_BOUND*/

 /*@@
   @routine    SetCartSymmetry
   @date       Mon Mar 15 15:10:58 1999
   @author     Gerd Lanfermann
   @desc 
   This routine sets the GH extension (EinsteinBoundGHex *bGHex), 
   which describes the symmetry  boundary type of each GF. Takes 
   the name of the GF ("implementation::gfname") and the symmetry operators 
   sx,sy,sz and inserts them in the array bGHex. 
   These values will looked up by ApplySym
   @enddesc 
   @calls     
   @calledby   
   @history 
 
   @endhistory 

@@*/

void SetCartSymmetry(cGH *GH, int *sym, const char *imp_gf) {
  
  DECLARE_CCTK_PARAMETERS

  SymmetryGHex *sGHex; 
  int index;

  /* Pointer to the SymmetryGHextension */
  sGHex  = (SymmetryGHex *)GH->extensions[CCTK_GHExtensionHandle("Symmetry")];

  /* now that we have the same, get the index to the GFs */
  index = CCTK_VarIndex(imp_gf);
  if (index<0) 
  {
    char *message;
    message = (char *)malloc((100*strlen(imp_gf))*sizeof(char));
    sprintf(message,"Grid function %s has no index",imp_gf);
    CCTK_WARN(0,message);
    free(message);
  };
  
  /* Reference the hash table in the GHex and tell it what kind of
     symmetry is being applied 
     (depending on sym and the grid layout) 
     If there is no symmetry necessary,set ESYM_NOSYM
     When we apply a symmetry and find ESYM_UNSET, something went wrong! 
   */

  if (CCTK_Equals(domain,"full")) 
  {

#ifdef DEBUG_BOUND
    printf(" Registered full grid symmetries for -%s- in SetCartSymmetry\n",imp_gf);
#endif

    sGHex->GFSym[index][0] = GFSYM_NOSYM;
    sGHex->GFSym[index][2] = GFSYM_NOSYM;
    sGHex->GFSym[index][4] = GFSYM_NOSYM;

  } 
  else if (CCTK_Equals(domain,"octant")) 
  {

#ifdef DEBUG_BOUND
    printf(" Registered octant symmetries for -%s- in SetCartSymmetry\n",imp_gf);
#endif

    sGHex->GFSym[index][0] = sym[0];
    sGHex->GFSym[index][2] = sym[1];
    sGHex->GFSym[index][4] = sym[2];

  } 
  else if (CCTK_Equals(domain,"quadrant")) 
  {

#ifdef DEBUG_BOUND
    printf("Registered quadrant symmetries for -%s- in SetCartSymmetry\n",imp_gf);
#endif    

    sGHex->GFSym[index][0] = sym[0];
    sGHex->GFSym[index][2] = sym[1];
    sGHex->GFSym[index][4] = GFSYM_NOSYM;

  } 
  else if (CCTK_Equals(domain,"bitant")) 
  {

#ifdef DEBUG_BOUND
    printf("Registered bitant symmetries for -%s- in SetCartSymmetry\n",imp_gf);
#endif    

    sGHex->GFSym[index][4] = sym[2];
    sGHex->GFSym[index][0] = GFSYM_NOSYM;
    sGHex->GFSym[index][2] = GFSYM_NOSYM;
  }

  /* All untouched GFSym[][] will hold GFSYM_UNSET */

  USE_CCTK_PARAMETERS

}

void FMODIFIER FORTRAN_NAME(SetCartSymmetry)(cGH *GH,  int *sym, ONE_FORTSTRING_ARG) {

  ONE_FORTSTRING_CREATE(imp_gf) 
  SetCartSymmetry(GH, sym, imp_gf);
  free(imp_gf);
} 




 /*@@
   @routine    ApplySymmetry
   @date       Mon Mar 15 15:16:28 1999
   @author     Gerd Lanfermann
   @desc 
      Takes the GH and the name of the group.

      Routine applies the symmetry BC to the GFs of a  group as set by SetSym 
      in GHExtension.  It is called by C or Fortran (via a wrapper) by 
      passing the group name. The assignment of the symmetries is carried out
      by the F routine FortranSym.
   @enddesc 
   @calls   FortranSym  
   @calledby   
   @history 
 
   @endhistory 

@@*/




int CartSymBCGroupI(cGH *GH, int groupnum) {

  void FORTRAN_NAME(SymmetryCondition)(int *, CCTK_REAL *, int *, int *, int *);
  
  DECLARE_CCTK_PARAMETERS

  SymmetryGHex *sGHex; 
  int first,last,index,j;
  int doSym[6];

  /* Get out if we are sure no symmetries should be applied */
  if (CCTK_Equals(domain,"full")) return 0;

  /* Get the pointer to the Symmetry GH extension */
  sGHex  = (SymmetryGHex*)GH->extensions[CCTK_GHExtensionHandle("Symmetry")];


  if (groupnum < 0) 
  {
    char *message=NULL;
    message = (char *)malloc(300*sizeof(char));
    sprintf(message,"Invalid group number %d",groupnum);
    CCTK_WARN(0,message);
    free(message);
  }

  /*get the index of the first GF in the group and how many Vars there are*/
  first = CCTK_FirstVarIndexI(groupnum);
  last  = first+CCTK_NumVarsInGroupI(groupnum)-1;

  /* loop over the variables in the group */
  for (index=first; index<=last; index++) {

    /* and check that we actually have a grid function (and not a scalar)*/
    if (CCTK_GroupTypeFromVarI(index) == GROUP_GF) {

      /*at this point, there should be NO ESYM_UNSET anymore 
        if there is, we forgot to register the symmetries for a GF */
      if ((sGHex->GFSym[index][0]==GFSYM_UNSET)||
	  (sGHex->GFSym[index][2]==GFSYM_UNSET)||
	  (sGHex->GFSym[index][4]==GFSYM_UNSET)) {
	char *message=NULL;
	message = (char *)malloc(300*sizeof(char));
	sprintf(message,"Cannot apply symmetry to >%s< (# %d) without registered symmetries",
		CCTK_GroupNameFromVarI(index),index);
	CCTK_WARN(1,message);
	free(message);
      }
      
      /* whether we want to apply sym depends on several things: */
      for (j=0;j<3;j++) 
      {
	doSym[2*j+1]=0;
	if ( (GH->cctk_lsh[j]>1) && (GH->cctk_bbox[2*j]==1) &&
	    (sGHex->GFSym[index][2*j] != GFSYM_UNSET) &&
	    (sGHex->GFSym[index][2*j] != GFSYM_NOSYM) 
	     )
	  doSym[2*j] = 1;
	else 
	  doSym[2*j] = 0;
      }

      /* Call the Fortran Symmetry Routine */
      FORTRAN_NAME(SymmetryCondition)(
	     GH->cctk_lsh,            
	     /* xyz-size of PE local grid */
	     GH->data[index][0],         
	     /* pointer to start of data array for GF[index]*/
	     GH->cctk_nghostzones,            
	     /* number of ghost zones */
	     sGHex->GFSym[index],  
	     /* the symmetries for this GF */
	     doSym
	     /* flags whether to apply syms */
	     );                       
    }
  }

  return 0;

  USE_CCTK_PARAMETERS

}





int CartSymBCVarI(cGH *GH, int varnum) {

  void FORTRAN_NAME(SymmetryCondition)(int *, CCTK_REAL *, int *, int *, int *);
  
  DECLARE_CCTK_PARAMETERS

  SymmetryGHex *sGHex; 
  int j;
  int doSym[6];

  /* Get out if we are sure no symmetries should be applied */
  if (CCTK_Equals(domain,"full")) return 0;


  /* Get the pointer to the Symmetry GH extension */
  sGHex  = (SymmetryGHex*)GH->extensions[CCTK_GHExtensionHandle("Symmetry")];

    /* and check that we actually have a grid function (and not a scalar)*/
    if (CCTK_GroupTypeFromVarI(varnum) == GROUP_GF) {



      /*at this point, there should be NO ESYM_UNSET anymore 
        if there is, we forgot to register the symmetries for a GF */
      if ((sGHex->GFSym[varnum][0]==GFSYM_UNSET)||
	  (sGHex->GFSym[varnum][2]==GFSYM_UNSET)||
	  (sGHex->GFSym[varnum][4]==GFSYM_UNSET)) {
	char *message=NULL;
	message = (char *)malloc(300*sizeof(char));
	sprintf(message,"Cannot apply symmetry to >%s< (# %d) without registered symmetries",
		CCTK_GroupNameFromVarI(varnum),varnum);
	CCTK_WARN(1,message);
	free(message);
      }
      
      /* whether we want to apply sym depends on several things: */
      for (j=0;j<3;j++) 
      {
	doSym[2*j+1]=0;
	if ( (GH->cctk_lsh[j]>1) && (GH->cctk_bbox[2*j]==1) &&
	    (sGHex->GFSym[varnum][2*j] != GFSYM_UNSET) &&
	    (sGHex->GFSym[varnum][2*j] != GFSYM_NOSYM) 
	     )
	  doSym[2*j] = 1;
	else 
	  doSym[2*j] = 0;
      }

      /* Call the Fortran Symmetry Routine */
      FORTRAN_NAME(SymmetryCondition)(
	     GH->cctk_lsh,            
	     /* xyz-size of PE local grid */
	     GH->data[varnum][0],         
	     /* pointer to start of data array for GF[varnum]*/
	     GH->cctk_nghostzones,            
	     /* number of ghost zones */
	     sGHex->GFSym[varnum],  
	     /* the symmetries for this GF */
	     doSym
	     /* flags whether to apply syms */
	     );                       
    }

    return 0;

    USE_CCTK_PARAMETERS

}


int CartSymBCVar(cGH *GH, char *name) 
{

  int index;
  index = CCTK_VarIndex(name);
  CartSymBCVarI(GH,index);
  return 0;

}

int CartSymBCGroup(cGH *GH, char *name) 
{

  int index;
  int retval;
  index = CCTK_GroupIndex(name);
  retval = CartSymBCGroupI(GH,index);
  return retval;

}

void FMODIFIER FORTRAN_NAME(CartSymBCVar)(int *ierr, cGH *GH, ONE_FORTSTRING_ARG) 
{ 

  ONE_FORTSTRING_CREATE(name)  
  *ierr = CartSymBCVar(GH,name);
  free(name);
}

void FMODIFIER FORTRAN_NAME(CartSymBCGroup)(int *ierr, cGH *GH, ONE_FORTSTRING_ARG) 
{ 

  ONE_FORTSTRING_CREATE(name)  
  *ierr = CartSymBCGroup(GH,name);
  free(name);
}

void FMODIFIER FORTRAN_NAME(ApplySymmetry)(cGH *GH, ONE_FORTSTRING_ARG) 
{ 

  ONE_FORTSTRING_CREATE(name)  
  CartSymBCGroup(GH,name);
  free(name);
}

void FMODIFIER FORTRAN_NAME(CartSymBCVarI)(int *ierr, cGH *GH, int *index) 
{ 
  *ierr = CartSymBCVarI(GH,*index);
}

void FMODIFIER FORTRAN_NAME(CartSymBCGRoupI)(int *ierr, cGH *GH, int *index) 
{ 
  *ierr = CartSymBCGroupI(GH,*index);
}