iinternalsrc.h

// copyright by benedikt oswald, all rights reserved, 2002-2006.
// project - aqhdes2003
// file name - newinternalsrc.h
// file type - C include file
// objective - define NUMPROC for internal source aka excitation of the em problem
// creation - 2003 oct 07 ~ 14:45:00 by benedikt oswald
// modified - 2004 feb 18 ~ 15:40:00 by holger gerhards
// modified - 2004 mar 23 ~ 15:21:00 by benedikt oswald, integrated into parallel version
// required software - UG 3.1 or higher
// rights for UG - cf. paper by Bastian et al., 1997
// file id -
// inheritance - iinternalsrc.h
// feature - defines the NUMPROCS required for the implementation of
// feature - internal excitation of the electric field governed
// feature - by the curl-curl equation for the electric field
// feature - with the implicit solver its, implemented in itdi.h and itdi,c

// hint - only some modifications on names

#ifndef __INTERNAL_SOURCE__
#define __INTERNAL_SOURCE__

// include standard header files
#include <math.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>

// include UG header files
#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                                    */

// proprietary includes
#include "whitney.h"                        /* include Whitney base function definitions and procedures          */
#include "tdwaveforms.h"                    /* time domain shapes of excitation: gaussian etc.                   */
#include "aqhdSysParams.h"                  /* get system parameters from standard include file                  */
#include "aqhdReleaseInfo.h"                /* get release information                                           */
#include "aqhdPhysicoMath.h"                /* get mathematical & physical constants                             */
#include "aqhdBaseTypes.h"                  /* get mathematical & physical constants                             */
#include "auxiliary.h"

/****************************************************************************/
/*                                                                          */
/* defines in the following order                                           */
/*                                                                          */
/*        compile time constants defining static data size (i.e. arrays)    */
/*        other constants                                                   */
/*        macros                                                            */
/*                                                                          */
/****************************************************************************/

#define IMPLICIT_INTERNAL_SOURCE_CLASS_NAME "internal_source"

/****************************************************************************/
/*                                                                          */
/* data structures used in this source file (exported data structures are   */
/*        in the corresponding include file!)                               */
/*                                                                          */
/****************************************************************************/

/* declare NUMPROC class and methods for internal voltage or current density source */
struct np_implicit_internal_source
{
  NP_BASE base;                            // inherits base class
  
  DOUBLE a0;                               // amplitude of source, ampere per square meter
  DOUBLE timedelay;                        // right shift of time domain waveform
  DOUBLE gspread;                          // variance s in Gaussian
  DOUBLE f0;                               // center frequency of sine modulated Gaussian pulse
  
  DOUBLE srcloc[DIM];                      // source location
  DOUBLE jdir[DIM];                        // vector of current density direction
  DOUBLE antlen;                           // length of antenna centered at srcloc[DIM]
  
  INT source;                              // code for source type
  char sourcetype[MAX_NUM_CHAR_FILENAME];  // string containing source type
  char tdshape[MAX_NUM_CHAR_FILENAME];     // string containing time domain shape description
  char fnsrcoutput[MAX_NUM_CHAR_FILENAME]; // string containing filename of source output file
  
  INT fl;                                  // from level with respect to multigrid
  INT tl;                                  // to level with respect to multigrid
  
  ELEMENT *theElement;                     // pointer to element containing source location
  
  VECDATA_DESC* force;                     // pointer to excitation aka force vector
  

    // function adapts the discrete system obtained from the FE approach
    // by setting the respective coefficients of the involved matrices
    DOUBLE (*ImplicitInternalSourceSetup)(struct np_implicit_internal_source *);

    // function calculates the value of the time domain excitation and
    // and adapts the right hand side of the linear system to be solved
    DOUBLE (*ImplicitInternalSourceUpdate)(struct np_implicit_internal_source *, DOUBLE);

};
typedef struct np_implicit_internal_source NP_IMPLICIT_INTERNAL_SOURCE;

/****************************************************************************/
/*                                                                          */
/* definition of exported global variables                                  */
/*                                                                          */
/****************************************************************************/

/****************************************************************************/
/*                                                                          */
/* definition of variables global to this source file only (static!)        */
/*                                                                          */
/****************************************************************************/

/****************************************************************************/
/*                                                                          */
/* forward declarations of functions used before they are defined           */
/*                                                                          */
/****************************************************************************/

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

INT InitImplicitInternalSource(void);

#endif

---