all_pml.h

// copyright by benedikt oswald, all rights reserved, 2002-2006.
// project - aqhdes2003
// file name - all_pml.h
// file type - C include file
// objective - defines all structures, the numproc and makros
// creation - 2004 mar 11 by holger gerhards
// modified - 2004 may 11 by holger gerhards, including timestep
// required software - UG 3.1 or higher
// rights for UG - cf. paper by Bastian et al., 1997
// file id -
// inheritance - apml.h
// feature - 


#ifndef __ALL_PML__
#define __ALL_PML__

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

#include "gm.h"                             /* for data structure                 */
#include "shapes.h"                         /* general element shape calculations */
#include "ugstruct.h"                       /* for GetStringValue                 */
#include "misc.h"                           /* for MIN, MAX, PI, ...              */
#include "ugdevices.h"                      /* for UserWrite, PrintErrorMessage   */
#include "commands.h"                       /* for GetCurrentMultigrid            */
#include "cmdint.h"                         /* for CreateCommand                  */
#include "cmdline.h"                        /* for command line processing        */
#include "general.h"                        /* for general desclarations          */
#include "np.h"                             /* for NUMPROC implementation         */
#include "assemble.h"                       /* for CreateCLASS implementation     */
#include "parallel.h"

// proprietary includes
#include "disconst.h"
#include "tdwaveforms.h"
#include "aqhdSysParams.h"
#include "aqhdReleaseInfo.h"
#include "aqhdPhysicoMath.h"
#include "aqhdBaseTypes.h"
#include "whitney.h"
#include "linmaterials.h"
#include "iinternalsrc.h"
#include "auxiliary.h"

/********* definition of constants ************/

/* return constants */
#define PML_BAD    1   
#define PML_OK     0
#define TIME_METHOD_BAD 3
#define PML_METHOD_BAD  3
#define BOUNDARY_BAD    3
#define PML_NO_CONNECTION 2


/* ... without words ... */
#define NUM_OF_BOUNDARY_SEGMENTS  6

/* some strings */
#define NEWMARK_METHOD      "newmark"
#define CENTRAL_DIFFERENCE  "central"

#define PML_TYPE_CONST       "constant"
#define PML_TYPE_LINEAR      "linear"
#define NO_PML_TYPE          "pmlfree"

#define PEC_BOUNDARY         "pec"
#define ABC_BOUNDARY         "abc"

#define T_PML_SOLVER_CLASS_NAME "pmlclass"
#define CONV_CLASS_NAME "conv"

/* order of Gau�-Quatrature for convolution */
#define CONV_GQ_ORDR  4
#define QUAD_POINTS  15 /* Zahl ist abh�ngig von der Ordnung der Quadratur */

/*************************************************************************/
/* struct for convolution per element in the case of constant parameters */

typedef struct
{
  INT elemid;
  
  DOUBLE g_i_x[6][QUAD_POINTS];        /* Werte, wenn x-pml-Parameter ungleich null */
  DOUBLE g_i_y[6][QUAD_POINTS];        /* Werte, wenn y-pml-Parameter ungleich null */
  DOUBLE g_i_z[6][QUAD_POINTS];        /* Werte, wenn z-pml-Parameter ungleich null */
  
} CONV_PER_ELEM_POINT_COMP;



/********************************************************************************/
/* struct for convolution per element in the case of linear channging parmaters */

typedef struct
{
  INT elemid;
  
  DOUBLE psi_j_xi[6][3];
  DOUBLE Sx_plus_Tx[6][6];
  DOUBLE Sy_plus_Ty[6][6];
  DOUBLE Sz_plus_Tz[6][6];
} CONV_PER_ELEM;


/**********************************************************************/
/* numproc for pml - includes constant and linear changing parameters */

typedef struct
{
  NP_BASE base;                              // inherits base class

  NP_LINEAR_MATERIALS *linmat;               // provides linear, non-dispersive electrical materials
  NP_IMPLICIT_INTERNAL_SOURCE *internalsrc;  // provides internal source for the electric field

  DOUBLE dt;                                 // time step for explicit scheme
  DOUBLE t;                                  // current time
  INT timestep;                           // timestep * dt = t

  INT fl;                                    // from level with respect to multigrid
  INT tl;                                    // to level with respect to multigrid

  char timetype[MAX_NUM_CHAR_FILENAME];      // string containing time-marching-type (central, newmark) 

  DOUBLE beta;                               // newmark parameter
  DOUBLE gamma;                              // newmark parameter

  char pmltype[MAX_NUM_CHAR_FILENAME];       // string containing pml-type (constant, linear) 

  char boundary[MAX_NUM_CHAR_FILENAME];      // string containing pec-boundary- or abc-boundary-condition

  INT anzahl;                                // number of elements in pml-domain
  CONV_PER_ELEM *eleminfo_c;                 // for local convolution and const. pml-parameter
  CONV_PER_ELEM_POINT_COMP *eleminfo;        // for local convolution and linear pml-parameter
  
  DOUBLE pml_dist_x1;                        // thickness of pml-domain left   
  DOUBLE pml_dist_x2;                        // right
  DOUBLE pml_dist_y1;                        // front
  DOUBLE pml_dist_y2;                        // back
  DOUBLE pml_dist_z1;                        // bottom
  DOUBLE pml_dist_z2;                        // top

  DOUBLE sig_x1_inner;                       // pml-para. left inner wall 
  DOUBLE sig_x1_outer;                       // pml-para. left outer wall  etc.
  DOUBLE sig_x2_inner;   
  DOUBLE sig_x2_outer;                       // if mode2 = 0, const. pml-param., only inner value is used
  DOUBLE sig_y1_inner;   
  DOUBLE sig_y1_outer;  
  DOUBLE sig_y2_inner;   
  DOUBLE sig_y2_outer;  
  DOUBLE sig_z1_inner;  
  DOUBLE sig_z1_outer; 
  DOUBLE sig_z2_inner;  
  DOUBLE sig_z2_outer; 

  VECDATA_DESC* efldp;                       // pointer to electric field vector at t_(n+1)
  VECDATA_DESC* efldn;                       // pointer to electric field vector at t_n
  VECDATA_DESC* efldm;                       // pointer to electric field vector at t_(m-1)
  VECDATA_DESC* efldo;                       // pointer to electric field vector at t_(m-2)

  VECDATA_DESC* rhs;                         // pointer to right hand side vector

  VECDATA_DESC* force;                       // pointer to excitation force vector
  VECDATA_DESC* forcep;                      // pointer to excitation force vector for timestep n+1
  VECDATA_DESC* forcen;                      // pointer to excitation force vector for timestep n
  VECDATA_DESC* forcem;                      // pointer to excitation force vector for timestep n-1
  
  VECDATA_DESC* g_vecp;                      // pointer to convolution vector for timestep n+1
  VECDATA_DESC* g_vecn;                      // pointer to convolution vector for timestep n
  VECDATA_DESC* g_vecm;                      // pointer to convolution vector for timestep n-1
  
  MATDATA_DESC* pmat;                        // pointer to leftside matrix structure (in front of efldp)
  MATDATA_DESC* nmat;                        // pointer to matrix structure in front of efldn
  MATDATA_DESC* mmat;                        // pointer to matrix structure in front of efldm

  MATDATA_DESC* tmat;
  MATDATA_DESC* tpmat;
  MATDATA_DESC* tqmat;
  MATDATA_DESC* smat;
  MATDATA_DESC* rmat;
  MATDATA_DESC* xmat;

  MATDATA_DESC* hmat;                        // matrix structur for intermediate results
  
  INT (*Assemble)(NP_BASE *base, INT, char**);          // pointer to Assembling function
  INT (*PreProcess)(NP_BASE *base, INT, char**);        // pointer to PreProcessing function
  INT (*PostProcess)(NP_BASE *base, INT, char**);       // pointer to PostProcessing function

} NP_PML_SOLVER;


/********************************************************/
/********* function to initialize pml-num-proc **********/

INT InitPMLTimeIntegration(void);

/********************************************************/
/********************************************************/

#endif













 

---