numa3d.h File Reference

#include <basic.h>
#include <mathfunctions.h>

Go to the source code of this file.

Data Structures
struct	Numa3D

Macros
#define	_NUMA3D_   "numa3d"
#define	_MODEL_NDIMS_   3
#define	_MODEL_NVARS_   5
#define	_XDIR_   0
#define	_YDIR_   1
#define	_ZDIR_   2
#define	_Numa3DGetFlowVars_(u, drho, uvel, vvel, wvel, dT, rho0)
#define	_Numa3DSetFlux_(f, dir, drho, uvel, vvel, wvel, dT, dP, rho0, T0)
#define	_Numa3DSetLinearFlux_(f, dir, drho, uvel, vvel, wvel, dT, dP, rho0, T0)
#define	_Numa3DSetSource_(s, param, uvel, vvel, drho, rho0)
#define	_Numa3DComputePressure_(params, T0, dT, P0, dP)
#define	_Numa3DComputeLinearizedPressure_(params, T0, dT, P0, dP)
#define	_Numa3DComputeSpeedofSound_(gamma, R, T0, dT, rho0, drho, EP, c)
#define	_Numa3DComputeLinearizedSpeedofSound_(gamma, R, T0, rho0, EP, c)
#define	_RUSANOV_UPWINDING_   "rusanov"
#define	_RF_CHAR_UPWINDING_   "rf-char" /* does not work! */

Functions
int	Numa3DInitialize (void *, void *)
int	Numa3DCleanup (void *)

Macro Definition Documentation

_NUMA3D_

#define _NUMA3D_   "numa3d"

Definition at line 26 of file numa3d.h.

_MODEL_NDIMS_

#define _MODEL_NDIMS_   3

Definition at line 31 of file numa3d.h.

_MODEL_NVARS_

#define _MODEL_NVARS_   5

Definition at line 32 of file numa3d.h.

_XDIR_

#define _XDIR_   0

Definition at line 35 of file numa3d.h.

_YDIR_

#define _YDIR_   1

Definition at line 36 of file numa3d.h.

_ZDIR_

#define _ZDIR_   2

Definition at line 37 of file numa3d.h.

_Numa3DGetFlowVars_

#define _Numa3DGetFlowVars_	(		u,
			drho,
			uvel,
			vvel,
			wvel,
			dT,
			rho0
	)

Value:

{ \
    drho = u[0]; \
    uvel = u[1]/(rho0+drho); \
    vvel = u[2]/(rho0+drho); \
    wvel = u[3]/(rho0+drho); \
    dT   = u[4]; \
  }

Definition at line 39 of file numa3d.h.

_Numa3DSetFlux_

#define _Numa3DSetFlux_	(		f,
			dir,
			drho,
			uvel,
			vvel,
			wvel,
			dT,
			dP,
			rho0,
			T0
	)

Value:

{ \
    if (dir == _XDIR_) { \
      f[0] = (rho0+drho) * uvel; \
      f[1] = (rho0+drho)*uvel*uvel + dP; \
      f[2] = (rho0+drho)*uvel*vvel; \
      f[3] = (rho0+drho)*uvel*wvel; \
      f[4] = uvel*(dT+T0); \
    } else if (dir == _YDIR_) { \
      f[0] = (rho0+drho) * vvel; \
      f[1] = (rho0+drho)*uvel*vvel; \
      f[2] = (rho0+drho)*vvel*vvel + dP; \
      f[3] = (rho0+drho)*wvel*vvel; \
      f[4] = vvel*(dT+T0); \
    } else if (dir == _ZDIR_) { \
      f[0] = (rho0+drho) * wvel; \
      f[1] = (rho0+drho)*uvel*wvel; \
      f[2] = (rho0+drho)*vvel*wvel; \
      f[3] = (rho0+drho)*wvel*wvel + dP; \
      f[4] = wvel*(dT+T0); \
    } \
  }

Definition at line 48 of file numa3d.h.

_Numa3DSetLinearFlux_

#define _Numa3DSetLinearFlux_	(		f,
			dir,
			drho,
			uvel,
			vvel,
			wvel,
			dT,
			dP,
			rho0,
			T0
	)

Value:

{ \
    if (dir == _XDIR_) { \
      f[0] = (rho0+drho) * uvel; \
      f[1] = dP; \
      f[2] = 0.0; \
      f[3] = 0.0; \
      f[4] = (rho0+drho)*uvel*T0/rho0; \
    } else if (dir == _YDIR_) { \
      f[0] = (rho0+drho) * vvel; \
      f[1] = 0.0; \
      f[2] = dP; \
      f[3] = 0.0; \
      f[4] = (rho0+drho)*vvel*T0/rho0; \
    } else if (dir == _ZDIR_) { \
      f[0] = (rho0+drho) * wvel; \
      f[1] = 0.0; \
      f[2] = 0.0; \
      f[3] = dP; \
      f[4] = (rho0+drho)*wvel*T0/rho0; \
    } \
  }

Definition at line 71 of file numa3d.h.

_Numa3DSetSource_

#define _Numa3DSetSource_	(		s,
			param,
			uvel,
			vvel,
			drho,
			rho0
	)

Value:

{ \
    s[0] =  0.0; \
    s[1] =  2.0*param->Omega*vvel*(rho0+drho); \
    s[2] = -2.0*param->Omega*uvel*(rho0+drho); \
    s[3] = -param->g*drho; \
    s[4] =  0.0; \
  }

Definition at line 94 of file numa3d.h.

_Numa3DComputePressure_

#define _Numa3DComputePressure_	(		params,
			T0,
			dT,
			P0,
			dP
	)

Value:

{ \
    double gamma    = params->gamma; \
    double Pref     = params->Pref; \
    double R        = params->R; \
    double P_total  = Pref * raiseto((R*(T0+dT)/Pref),gamma); \
    dP  = P_total - P0; \
  }

Definition at line 103 of file numa3d.h.

_Numa3DComputeLinearizedPressure_

#define _Numa3DComputeLinearizedPressure_	(		params,
			T0,
			dT,
			P0,
			dP
	)

Value:

{ \
    double gamma    = params->gamma; \
    dP  = (gamma*P0/T0) * dT; \
  }

Definition at line 112 of file numa3d.h.

_Numa3DComputeSpeedofSound_

#define _Numa3DComputeSpeedofSound_	(		gamma,
			R,
			T0,
			dT,
			rho0,
			drho,
			EP,
			c
	)

Value:

{ \
    c = sqrt(gamma*R*(T0+dT)*EP/(rho0+drho)); \
  }

Definition at line 118 of file numa3d.h.

_Numa3DComputeLinearizedSpeedofSound_

#define _Numa3DComputeLinearizedSpeedofSound_	(		gamma,
			R,
			T0,
			rho0,
			EP,
			c
	)

Value:

{ \
    c = sqrt(gamma*R*T0*EP/rho0); \
  }

Definition at line 123 of file numa3d.h.

_RUSANOV_UPWINDING_

#define _RUSANOV_UPWINDING_   "rusanov"

Definition at line 149 of file numa3d.h.

_RF_CHAR_UPWINDING_

#define _RF_CHAR_UPWINDING_   "rf-char" /* does not work! */

Definition at line 150 of file numa3d.h.

Function Documentation

Numa3DInitialize()

int Numa3DInitialize	(	void *	,
		void *
	)

Definition at line 24 of file Numa3DInitialize.c.

{
  HyPar           *solver  = (HyPar*)         s;
  MPIVariables    *mpi     = (MPIVariables*)  m; 
  Numa3D          *physics = (Numa3D*)        solver->physics;
  int             ferr     = 0;

  static int count = 0;

  if (solver->nvars != _MODEL_NVARS_) {
    fprintf(stderr,"Error in Numa3DInitialize(): nvars has to be %d.\n",_MODEL_NVARS_);
    return(1);
  }
  if (solver->ndims != _MODEL_NDIMS_) {
    fprintf(stderr,"Error in Numa3DInitialize(): ndims has to be %d.\n",_MODEL_NDIMS_);
    return(1);
  }

  /* default values */
  physics->gamma  = 1.4; 
  physics->R      = 287.058;        /* J kg^{-1} K^{-1} */
  physics->Omega  = 7.2921150E-05;  /* rad s^{-1}       */
  physics->g      = 9.8;            /* m s^{-2}         */

  physics->Pref   = 101327.0;       /* N m^{-2}         */
  physics->Tref   = 288.15;         /* Kelvin           */

  strcpy(physics->upwind,_RUSANOV_UPWINDING_);

  /* default choice of initial atmosphere */
  physics->init_atmos = 1;

  /* reading physical model specific inputs - all processes */
  if (!mpi->rank) {
    FILE *in;
    if (!count) printf("Reading physical model inputs from file \"physics.inp\".\n");
    in = fopen("physics.inp","r");
    if (!in) printf("Warning: File \"physics.inp\" not found. Using default values.\n");
    else {
      char word[_MAX_STRING_SIZE_];
      ferr = fscanf(in,"%s",word); if (ferr != 1) return(1);
      if (!strcmp(word, "begin")){
          while (strcmp(word, "end")){
              ferr = fscanf(in,"%s",word); if (ferr != 1) return(1);
          if (!strcmp(word, "gamma")) { 
            ferr = fscanf(in,"%lf",&physics->gamma); if (ferr != 1) return(1);
          } else if (!strcmp(word,"R")) {
            ferr = fscanf(in,"%lf",&physics->R); if (ferr != 1) return(1);
          } else if (!strcmp(word,"g")) {
            ferr = fscanf(in,"%lf",&physics->g); if (ferr != 1) return(1);
          } else if (!strcmp(word,"Omega")) {
            ferr = fscanf(in,"%lf",&physics->Omega); if (ferr != 1) return(1);
          } else if (!strcmp(word,"Pref")) {
            ferr = fscanf(in,"%lf",&physics->Pref); if (ferr != 1) return(1);
          } else if (!strcmp(word,"Tref")) {
            ferr = fscanf(in,"%lf",&physics->Tref); if (ferr != 1) return(1);
          } else if (!strcmp(word,"init_atmos")) {
            ferr = fscanf(in,"%d",&physics->init_atmos); if (ferr != 1) return(1);
          } else if (!strcmp(word,"upwinding")) {
            ferr = fscanf(in,"%s",physics->upwind); if (ferr != 1) return(1);
          } else if (strcmp(word,"end")) {
            char useless[_MAX_STRING_SIZE_];
            ferr = fscanf(in,"%s",useless); if (ferr != 1) return(ferr);
            printf("Warning: keyword %s in file \"physics.inp\" with value %s not ",word,useless);
            printf("recognized or extraneous. Ignoring.\n");
          }
        }
        } else {
          fprintf(stderr,"Error: Illegal format in file \"physics.inp\".\n");
        return(1);
        }
    }
    fclose(in);
  }

#ifndef serial
  IERR MPIBroadcast_double    (&physics->gamma      ,1                ,0,&mpi->world); CHECKERR(ierr);
  IERR MPIBroadcast_double    (&physics->R          ,1                ,0,&mpi->world); CHECKERR(ierr);
  IERR MPIBroadcast_double    (&physics->g          ,1                ,0,&mpi->world); CHECKERR(ierr);
  IERR MPIBroadcast_double    (&physics->Omega      ,1                ,0,&mpi->world); CHECKERR(ierr);
  IERR MPIBroadcast_double    (&physics->Pref       ,1                ,0,&mpi->world); CHECKERR(ierr);
  IERR MPIBroadcast_double    (&physics->Tref       ,1                ,0,&mpi->world); CHECKERR(ierr);
  IERR MPIBroadcast_integer   (&physics->init_atmos ,1                ,0,&mpi->world); CHECKERR(ierr);
  IERR MPIBroadcast_character ( physics->upwind     ,_MAX_STRING_SIZE_,0,&mpi->world); CHECKERR(ierr);
#endif

  /* calculate the mean hydrostatic atmosphere as a function of altitude */
  if (physics->init_atmos == 1) {
    physics->StandardAtmosphere = Numa3DCalculateStandardAtmosphere_1;
  } else if (physics->init_atmos == 2) {
    physics->StandardAtmosphere = Numa3DCalculateStandardAtmosphere_2;
  } else {
    if (!mpi->rank) {
      fprintf(stderr,"Error in Numa3DInitialize(): invalid choice of initial atmosphere (init_atmos).\n");
      return(1);
    }
  }
  CHECKERR(ierr);

  /* initializing physical model-specific functions */
  if (!strcmp(solver->SplitHyperbolicFlux,"yes")) 
    solver->dFFunction    = Numa3DStiffFlux;
  else solver->dFFunction = NULL;
  solver->FFunction       = Numa3DFlux;
  solver->ComputeCFL      = Numa3DComputeCFL;
  solver->SFunction       = Numa3DSource;
  if (!strcmp(physics->upwind,_RUSANOV_UPWINDING_)) {
    solver->Upwind        = Numa3DRusanovFlux;
    if (!strcmp(solver->SplitHyperbolicFlux,"yes")) 
      solver->UpwinddF    = Numa3DRusanovLinearFlux;
    else solver->UpwinddF = NULL;
  } else {
    if (!mpi->rank) fprintf(stderr,"Error in Numa3DInitialize(): Invalid choice of upwinding scheme.\n");
    return(1);
  }

  /* set the value of gamma in all the boundary objects */
  int n;
  DomainBoundary  *boundary = (DomainBoundary*) solver->boundary;
  for (n = 0; n < solver->nBoundaryZones; n++)  boundary[n].gamma = physics->gamma;

  count++;
  return(0);
}

Numa3DCleanup()

int Numa3DCleanup

(

void *

)

Definition at line 5 of file Numa3DCleanup.c.

{
  return(0);
}